Before processing a new DSR, we can coordinate with your server to:

  1. Confirm that this request should be processed (or canceled, or put on hold).
  2. Obtain additional user identifiers, such as a phone number, to find the data subject with.

See the uploading enriched identifiers guide for more information.

POST

/v1/enrich-identifiers

In your request headers, pass authorization: Bearer <<token>>.

If you're self-hosting Sombra, also add the request header x-sombra-authorization: Bearer <<sombraInternalKey>>. You can read more about request authorization here.

Requires scope:

Manage Request Identity Verification

authorizationstring
An API key generated from the Transcend dashboard: https://app.transcend.io/infrastructure/api-keys.
x-sombra-authorizationstring
The Sombra internal key. This header is only needed for self-hosted Sombra gateways. See https://docs.transcend.io/docs/dsr-automation/api-integration/authentication#authenticating-to-sombra
content-typestring
Specify content-type: application/json for a JSON response from the Transcend API.
x-transcend-noncestring
A reusable token sent in Transcend's webhook for this job, and returned by you when uploading the result of this job back to Transcend. Called a 'nonce' for legacy reasons, but is actually reusable.

application/json

enrichedIdentifiersobject
An object where the keys are the identifier names (i.e. email, phone, idfa, ...), and the values are a list of enriched identifiers.
statusstringenum:"CANCELED" | "ON_HOLD"
templateIdstring (uuid)
When status is set to ON_HOLD or CANCELED, you may include the ID of a custom email template to send to the data subject.
templateTitlestring
When status is set to ON_HOLD or CANCELED, you may include the title of a custom email template to send to the data subject.

Request Body Examples

Add additional user identifiers to this request:

{
  "enrichedIdentifiers": {
    "googleAnalyticsInternalId": [
      {
        "value": "SOME-GOOGLE-ANALYTICS-ID"
      }
    ],
    "gpadvid": [
      {
        "value": "b20f48d8-9f50-447a-a446-1d398a9f9b1b"
      }
    ]
  }
}

Cancel a request:

{
  "status": "CANCELED"
}

Cancel a request and send a custom email by template ID:

{
  "status": "CANCELED",
  "templateId": "9a4d0c4d-22d7-4717-a4e3-9bdf48a256f0"
}

Cancel a request and send a custom email by template title:

{
  "status": "CANCELED",
  "templateTitle": "Custom Email Template"
}

Put a request on hold for manual review:

{
  "status": "ON_HOLD"
}

200 (OK)

application/json

Your request was received without an issue.

400 (Bad Request)

application/json

While this request passed authentication, the input is malformed. Please double-check that your code conforms to our API specification.

401 (Unauthorized)

application/json

There was a problem authenticating your request. This may be an issue with the Transcend API key ("authorization" header), or the Sombra API key ("x-sombra-authorization" header used for self-hosted gateways only).

409 (Conflict)

application/json

You're attempting to modify a DSR that is not in a modifiable state. For example, the DSR may have already completed, or been revoked.

413 (Request Entity Too Large)

application/json

The request body is too large. JSON and raw bodies must be less than 50MB. URL encoded bodies must be less than 30MB.

429 (Too Many Requests)

application/json

You are sending requests too quickly and have hit our rate limit. If you hit this, you'll need to throttle your request velocity or try again later.

Response Headers

Retry-Afterinteger
X-RateLimit-Limitinteger
X-RateLimit-Remaininginteger
X-RateLimit-Resetinteger

500 (Internal Server Error)

application/json

A 5xx error means there is either an issue with your self-hosted gateway, or a Transcend server is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.

502 (Bad Gateway)

application/json

An upstream service on Transcend's side is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.