Transaction

The Redact API can be used to remove personal data from a CDR stored in the Nexmo platform. Personal data held in the platform generally means a person's phone number, and for messages, the body of the message itself.

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, messageorworkflow
    sms
    None
  • type
    string

    Required if redacting SMS data


    Must be one of: inboundoroutbound
    outbound
    outbound

204 HTTP response

No content

401 HTTP response

403 HTTP response

404 HTTP response

422 HTTP response

429 HTTP response