Redact API

Nexmo provides Redact API to help organisations meet their privacy compliance obligations. Redact API allows you to redact private information on demand, allowing you to meet your own compliance needs.

Download OpenAPI 3 Definition
Improve this specification

Redact a specific message

POST https://api.nexmo.com/v1/redact/transaction

Query Parameter

Key Description Example Default
api_key
Required | string

Your API key

 abcd1234 None
api_secret
string

Your API secret. Required unless sig is provided

 abcdef0123456789 None

Request body application/json

Key Description Example Default
id
Required | string

The transaction ID to redact

 None None
product
Required | string

Product name that the ID provided relates to


Must be one of: sms, voice, number-insight, verify, verify-sdk or messages 		sms None
type
Required | string

Required if redacting SMS data


Must be one of: inbound or outbound 		outbound outbound 
Success
{
  "type": "UNAUTHORIZED",
  "error_title": "Unauthorized"
}
Premature Redaction
Unprovisioned 
{
  "type": "https://developer.nexmo.com/api-errors/redact#premature-redaction",
  "title": "Premature Redaction",
  "detail": "You must wait 60 minutes before redacting ID '0A000000B0C9A1234'",
  "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
  "type": "https://developer.nexmo.com/api-errors#unprovisioned",
  "title": "Authorisation error",
  "detail": "User=ABC123 is not provisioned to redact product=SMS",
  "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
  "type": "https://developer.nexmo.com/api-errors#invalid-id",
  "title": "Invalid ID",
  "detail": "ID '0A000000B0C9A1234' could not be found (type=MT)",
  "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Invalid JSON
Unsupported Product 
{
  "type": "https://developer.nexmo.com/api-errors#invalid-json",
  "title": "Invalid JSON",
  "detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries",
  "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
  "type": "https://developer.nexmo.com/api-errors/redact#invalid-product",
  "title": "Invalid Product",
  "detail": "No product corresponding to supplied string sms2!",
  "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
  "type": "https://developer.nexmo.com/api-errors/redact#rate-limit",
  "title": "Rate Limit Hit",
  "detail": "Please wait, then retry your request",
  "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}