Community OpenAPI document · agent-readySecurityCompliancebasic1 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Redact the personally identifiable content of a specific Vonage transactional record (SMS, voice call, verification, message) from Vonage's logs.
Use for: I need to redact a specific SMS message from Vonage logs for a GDPR request, Remove a voice call record from Nexmo's retained logs, Honour a right-to-erasure request against a Verify transaction, Scrub PII from a Messages API record by message-id
Not supported: Does not send messages, manage user consent records, or audit access logs - use for redacting specific Vonage transactional records only.
The Nexmo Redact API gives privacy and compliance teams a controlled way to scrub the personally identifiable content of a specific transactional record from Vonage's logs. A single POST endpoint accepts a transaction id and product type and removes the message body, recipient number, and other PII from Vonage's retained records, helping organisations meet GDPR right-to-erasure and similar privacy obligations on demand.
Install Jentic One Beta
Connect the Redact API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Redact API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fnexmo-redact-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fnexmo-redact-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Redact API.
Redact a specific SMS transaction from Vonage's retained message logs
Redact a specific voice call record from Vonage's retained call logs
Redact a specific verification request from Vonage's retained Verify logs
Redact a specific Messages API record across SMS, MMS, WhatsApp, and Viber
Honour user GDPR right-to-erasure requests programmatically against Vonage's logs
Use Cases
Patterns agents use Redact API for, with concrete tasks.
★ GDPR right-to-erasure on transactional logs
When a customer submits a right-to-erasure request, the compliance team identifies the affected SMS, voice, or verification transactions in their own systems, then calls POST /transaction with each id and product to scrub PII from Vonage's retained logs. Closing the loop on Vonage's side means the organisation can attest that no copy of the message body or number remains in any system under its control.
POST /transaction with id=MESSAGE_ID and product=sms for each message tied to the data subject
Voice call PII scrubbing
Customer support and trust teams that record voice calls or store recipient numbers in Vonage's retained logs can call the Redact API after a complaint or breach to remove the PII associated with a specific call. This is critical when a recording has been flagged as containing sensitive information that should not have been captured.
POST /transaction with id=CALL_UUID and product=voice for the affected call
Verify and Messages API cleanup
Organisations using Vonage's Verify or Messages APIs can redact a specific verification or rich-message record by transaction id. Because the endpoint requires the original transaction id, redactions are scoped and auditable - you cannot accidentally erase records you do not specifically reference.
POST /transaction with id=REQUEST_ID, product=verify, and type=verify-request to scrub the verification record
AI agent compliance automation via Jentic
An AI agent that handles privacy ticket workflows can call the Redact API through Jentic each time a right-to-erasure request is approved. The agent reads transaction ids from its own ticket store, searches Jentic for the redact operation, and executes one POST /transaction per record, all with credentials supplied by your Jentic One instance.
Search Jentic for 'redact a vonage transaction', load POST /transaction, and execute with id and product for each ticket-linked record
Key Endpoints
1 endpoints — the nexmo redact api gives privacy and compliance teams a controlled way to scrub the personally identifiable content of a specific transactional record from vonage's logs.
METHOD
PATH
DESCRIPTION
POST
/transaction
Redact a specific SMS, voice, verify, or messages record by id
POST
/transaction
Redact a specific SMS, voice, verify, or messages record by id
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
R
Redact API
- Foundational (D-)43/100
90
Foundational Compliance79
Developer Experience & Jentic Compatibility57
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
90
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
60%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
79
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
64%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
57
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C+Signals: 4
79%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Redact API by hand means encoding your api_key and api_secret as an HTTP basic header on every request and posting redaction requests to the api.nexmo.com/v1/redact host. Through Jentic you install once, import the Redact API from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
The Redact API exposes a single endpoint and carries the transaction id and product in the request body, so scoping is by operation rather than by resource: limit the agent to the operation it needs, which is redacting a transaction. That single redaction call is the only thing it can run.
Credential isolation
Your Nexmo api_key and api_secret are stored once, encrypted, by your own Jentic One instance and encoded as HTTP basic at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'redact a Vonage transaction', and Jentic returns the POST /transaction operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Redact API through Jentic.
What authentication does the Nexmo Redact API use?
The Redact API uses HTTP Basic authentication with your Nexmo apiKey as the username and apiSecret as the password - different from most other Vonage APIs that take credentials as query parameters. Through Jentic those credentials are encoded automatically and the agent only ever sees a scoped token.
Can I redact more than one record in a single request?
No - POST /transaction redacts exactly one record per call, identified by the id and product fields. For bulk erasure pipelines, loop through the transaction ids in your ticketing system and post one redaction per record. The request is intentionally narrow to keep the audit trail tight.
What are the rate limits for the Redact API?
The OpenAPI spec does not encode a numeric rate limit. The endpoint is intended for compliance workflows, not high-throughput automation, so a sensible client serialises requests and reconciles failures rather than running unbounded concurrency.
How do I redact a transaction through Jentic?
Run pip install jentic, search for 'redact a vonage transaction', and Jentic returns POST /transaction. Execute with id=TRANSACTION_ID and product (sms, voice, verify, or messages) and Jentic returns Vonage's confirmation.
What products can the Redact API target?
The product field accepts sms, voice, verify, and messages, covering every PII-bearing log Vonage retains for transactional traffic. The optional type field further narrows verify requests into verify-request, verify-check, and similar subtypes.
Is the Nexmo Redact API free to call?
Vonage does not charge per redaction request - the API exists to support compliance obligations. The cost of the original SMS, voice, or verification transaction is unaffected by a later redaction.
Can I limit what my agent is allowed to do with the Nexmo Redact API?
Yes. The Redact API exposes a single operation, POST /transaction, and because you run Jentic One yourself, your own rules decide whether the agent may call it and which credentials it uses. You can restrict the agent to just that one redaction operation, so the only action it can perform is scrubbing a specific Vonage transactional record by id and product. Your Nexmo api_key and api_secret stay stored and encrypted on your own instance and are encoded as HTTP basic only at execution time, never entering the agent's prompt or logs.
GET STARTED