List the outstanding identifiers that need to be processed for a particular integration and type of DSR. This route will list requests in order from oldest to newest requests.You can define new identifiers that your integration requires in order to process requests here. On the DSR Automation tab for your data, ensure these identifiers are exposed to your script or service.
GET
/v1/data-silo/{id}/pending-requests/{type}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:
API Key must be associated to this integration
authorizationstringAn API key generated from the Transcend dashboard: https://app.transcend.io/infrastructure/api-keys. |
x-sombra-authorizationstringThe 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-typestringSpecify content-type: application/json for a JSON response from the Transcend API. |
limitnumberdefault:50min:1max:5,000The number of results to return |
offsetnumberdefault:0min:0The page offset when paging over data. |
200 (OK)
application/jsonReturns a list of outstanding identifiers that need to be processed for the requested integration and DSR type.
Response Body
itemsarray<object>(required)List of outstanding identifiers to process. |
Response Body Examples
List Outstanding Requests:
{
"items": [
{
"identifier": "test@transcend.io",
"type": "email",
"coreIdentifier": "test@transcend.io",
"dataSiloId": "9d5a7a41-f102-435c-b80d-38c2b378ecac",
"requestId": "14f448c3-6497-4991-9b04-1b979e6d3e5b",
"nonce": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lenp6enp6eiIsImlhdCI6MTUxNjIzOTAyMn0.shMmFXcM3VqXGZryrgoIWlY_7Rhbpk76CeFh98iP4M8",
"requestCreatedAt": "2022-03-20T08:06:58.555Z",
"daysUntilOverdue": -2,
"locale": "en",
"dataSubjectType": "customer",
"country": "US",
"countrySubDivision": "US-CA",
"attributes": [
{
"key": "client_handle",
"values": [
"coca-corp"
]
}
]
},
{
"identifier": "mkturtle",
"type": "username",
"coreIdentifier": "test+turtle@transcend.io",
"dataSiloId": "9d5a7a41-f102-435c-b80d-38c2b378ecac",
"requestId": "14f448c3-6497-4991-9b04-1b979e6d3e5b",
"nonce": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"requestCreatedAt": "2022-03-20T08:06:58.555Z",
"daysUntilOverdue": -2,
"locale": "en",
"dataSubjectType": "customer",
"country": "US",
"countrySubDivision": "US-CA",
"attributes": []
},
{
"identifier": "test@acme.com",
"type": "email",
"coreIdentifier": "test@acme.com",
"dataSiloId": "9d5a7a41-f102-435c-b80d-38c2b378ecac",
"requestId": "b2be9ddb-0b0b-4262-8061-aece39c7a4bd",
"nonce": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lenp6enp6eiIsImlhdCI6MTUxNjIzOTAyMn0.shMmFXcM3VqXGZryrgoIWlY_7Rhbpk76CeFh98iP4M8",
"requestCreatedAt": "2022-04-21T08:05:58.455Z",
"daysUntilOverdue": 30,
"locale": "fr-FR",
"dataSubjectType": "employee",
"country": null,
"countrySubDivision": null,
"attributes": [
{
"key": "client_handle",
"values": [
"acme"
]
}
]
},
{
"identifier": "+16126883289",
"type": "phone",
"coreIdentifier": "test+phone@transcend.io",
"dataSiloId": "9d5a7a41-f102-435c-b80d-38c2b378ecac",
"requestId": "b2be9ddb-0b0b-4262-8061-aece39c7a4bd",
"nonce": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"requestCreatedAt": "2022-04-21T08:05:58.455Z",
"daysUntilOverdue": 30,
"locale": "fr-FR",
"dataSubjectType": "employee",
"country": "US",
"countrySubDivision": null,
"attributes": []
}
]
}
List Preference Changes:
{
"items": [
{
"identifier": "test@transcend.io",
"type": "email",
"coreIdentifier": "test@transcend.io",
"dataSiloId": "9d5a7a41-f102-435c-b80d-38c2b378ecac",
"requestId": "24b79b35-18cd-48b1-a63b-cff2fdb10ed0",
"nonce": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lenp6enp6eiIsImlhdCI6MTUxNjIzOTAyMn0.shMmFXcM3VqXGZryrgoIWlY_7Rhbpk76CeFh98iP4M8",
"requestCreatedAt": "2022-03-20T08:06:58.555Z",
"daysUntilOverdue": 10,
"locale": "en",
"dataSubjectType": "customer",
"country": "US",
"countrySubDivision": "US-CA",
"purpose": {
"purpose": "Marketing",
"enabled": true,
"preferences": [
{
"topic": "Frequency",
"choice": {
"selectValue": "Daily"
}
},
{
"topic": "Channel",
"choice": {
"selectValues": [
"Sms",
"Email"
]
}
},
{
"topic": "GoPaperless",
"choice": {
"booleanValue": true
}
}
]
},
"attributes": [
{
"key": "client_handle",
"values": [
"coca-corp"
]
}
]
}
]
}
400 (Bad Request)
application/jsonWhile this request passed authentication, the input is malformed. Please double-check that your code conforms to our API specification.
401 (Unauthorized)
application/jsonThere 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/jsonThe 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/jsonYou 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/jsonA 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/jsonAn 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.