Once the status of the original DSR indicates there are files available to download, it is possible to get a list of these files for download.
GET
/v1/data-subject-request/{id}/download-keys
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 the Request Compilation
Request Parameters
Header Parameters
authorization string An API key generated from the Transcend dashboard: https://app.transcend.io/infrastructure/api-keys. |
x-sombra-authorization string 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-type string Specifying content-type: application/json for a JSON response from the Transcend API. |
Query Parameters
limit number The maximum number of file keys to return on this page. |
offset number The pagination offset. |
Path Parameters
id string The request ID (returned from "Submit a DSR") |
Response
200 (OK)
application/json
This request was found. Responds with a paginated list of files and their metadata. To download the file, make a separate request for each file using their `downloadKey` from this response.
Response Body
totalCount number (required) Total number of files available for download. |
nodes array<object> (required) List of files available for download. |
_links object (required) Pagination information |
Response Body Example
Sample response:
{ "totalCount": 25, "nodes": [ { "downloadKey": "superlongstring1", "error": null, "mimetype": "text/plain", "size": 16, "fileName": "Personal identifier/Name.txt" }, { "downloadKey": "superlongstring2", "error": null, "mimetype": "application/json", "size": 3124, "fileName": "User online activities/usage.json" }, { "downloadKey": "superlongstring3", "error": null, "mimetype": "video/mp4", "size": 456711231, "fileName": "User profile/mymovie.mp4" } ], "_links": { "self": "/v1/data-subject-request/da13d328-3f9d-40d5-9312-9f4fcf3ad0d2/download-keys?limit=3&offset=3", "prev": "/v1/data-subject-request/da13d328-3f9d-40d5-9312-9f4fcf3ad0d2/download-keys?limit=3&offset=0", "next": "/v1/data-subject-request/da13d328-3f9d-40d5-9312-9f4fcf3ad0d2/download-keys?limit=3&offset=6" } }
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.
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.