Download / Status Request

  • Published on Feb 25, 2025
Prev Next
Post
/gdpr/status

Gets the current status of the request for the given request_id generated from the Access/Erasure POST request.

Security
API Key
Query parameter nameapp_id

app_id | Unique identifier for Branch app of requested data.

API Key
Header parameter nameAccess-Token

api_key | Key that encapsulates the users permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

Body parameters
object
request_id
string

The UUID generated for the request made. This can be used to check the status of the request at a later time.

ExampleXXXX-0000-xxxx
Responses
200

Ok

object
request_id
string

The UUID generated for the request made. This can be used to check the status of the request at a later time.

ExampleXXXX-0000-xxxx
request_status
string

This is the status of your request. It can be one of “SUCCESS”: The request has been fulfilled. “PENDING”: A correct request has been received and is currently in the queue “IN_PROGRESS”: The request is currently being acted on.

ExampleSUCCESS
request_type
string

Request type requested by the user

ExampleACCESS
export_url
string

The pre-assigned s3 URL link to download the CSV file containing the identity objects requested.

Examplehttps://branch-exports.s3.amazonaws.com/unique-csv-file-name-here.csv?Signature={SIGNATURE_HERE}%3D&AWSAccessKeyId={AWS_ACCESS_KEY_ID_HERE}&Expires={EXPIRATION_HERE}
400

Authentication Failed

Result
"{\n    \"error\": {\n        \"message\": \"Authentication failed !\",\n        \"code\": 400\n    }\n}"
Expand All
object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400