Redact API
The Redact API helps organisations meet their privacy compliance obligations. It provides controlled, on-demand redaction of private information from transactional records in the long-term storage. Note, Redact API does not have the capability to redact the short-lived server logs that are retained for a few weeks. For SMS customers that need immediate redaction, Vonage suggests using Advanced Auto-redact.
Available Operations
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
209ab3c7536542b91e8b5aef032f6861The transaction ID to redact
smsProduct name that the ID provided relates to
smsvoicenumber-insightverifyverify-sdkmessagesoutboundoutboundRequired if redacting SMS data
inboundoutboundExample Request
{
"id": "209ab3c7536542b91e8b5aef032f6861",
"product": "sms",
"type": "outbound"
}{
"id": "209ab3c7536542b91e8b5aef032f6861",
"product": "sms",
"type": "outbound"
}Errors
The following is a non-exhaustive list of error codes that may occur while using this API.
These codes are in addition to any of our generic error codes.
| Code | Information |
|---|---|
| invalid-product | Description The provided product is invalid Resolution Modify your request to provide a valid product |
| premature-redaction | Description There is a 1 hour time period before data can be redacted to allow for all data to propagate through the Vonage system Resolution Wait until the data becomes valid for redaction |
| rate-limit | Description The request was rate limited Resolution The Redact API supports 170 requests per second. Slow down your request rate |