Once a DSR has been submitted, it will take some time to complete. The status of the DSR can be accessed via the following endpoint. Read more about DSR State here.

GET

/v1/data-subject-request/{id}

Request Authorization

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:

View Incoming Requests

Header Parameters

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.

Path Parameters

idstring (uuid)
The request ID (returned from "Submit a DSR")

Response

200 (OK)

application/json

This request was found. The response body contains details of the request's state.

Response Body

idstring (uuid)min length:1(required)
statusstringmin length:1(required)enum:"REQUEST_MADE" | "FAILED_VERIFICATION" | "ENRICHING" | "ON_HOLD" | "WAITING" | "COMPILING" | "APPROVING" | "DELAYED" | "COMPLETED" | "DOWNLOADABLE" | "VIEW_CATEGORIES" | "CANCELED" | "SECONDARY" | "SECONDARY_COMPLETED" | "SECONDARY_APPROVING" | "REVOKED"
typestringmin length:1(required)enum:"ACCESS" | "ERASURE" | "RECTIFICATION" | "RESTRICTION" | "BUSINESS_PURPOSE" | "PLACE_ON_LEGAL_HOLD" | "REMOVE_FROM_LEGAL_HOLD" | "AUTOMATED_DECISION_MAKING_OPT_OUT" | "USE_OF_SENSITIVE_INFORMATION_OPT_OUT" | "CONTACT_OPT_OUT" | "SALE_OPT_OUT" | "TRACKING_OPT_OUT" | "CUSTOM_OPT_OUT" | "AUTOMATED_DECISION_MAKING_OPT_IN" | "USE_OF_SENSITIVE_INFORMATION_OPT_IN" | "SALE_OPT_IN" | "TRACKING_OPT_IN" | "CONTACT_OPT_IN" | "CUSTOM_OPT_IN"
subjectTypestringmin length:1(required)
emailstringmin length:1(required)
coreIdentifierstringmin length:1(required)

Response Body Examples

Request is still processing:

{
  "id": "da13d328-3f9d-40d5-9312-9f4fcf3ad0d2",
  "status": "COMPILING",
  "type": "ACCESS",
  "subjectType": "customer",
  "email": "user@example.com",
  "coreIdentifier": "id-123456789"
}

Access request is ready for download:

{
  "id": "da13d328-3f9d-40d5-9312-9f4fcf3ad0d2",
  "status": "DOWNLOADABLE",
  "type": "ACCESS",
  "subjectType": "customer",
  "email": "user@example.com",
  "coreIdentifier": "id-123456789"
}

Erasure request has been fulfilled:

{
  "id": "8d5688c7-3f9d-40d5-9312-9f4fcf3ad0e4",
  "status": "SECONDARY_COMPLETED",
  "type": "ERASURE",
  "subjectType": "customer",
  "email": "user@example.com",
  "coreIdentifier": "id-123456789"
}

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).

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.

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.