Access / Erasure

  • Published on Feb 25, 2025
Post
/gdpr

This endpoint access any personal data associated with known given identities from Branch Metrics.

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
Expand All
object
subject_request_type
string Required

The type of post request being sent. In this case “access”

Valid values[ "access", "erasure" ]
Exampleaccess
subject_identities
Array of object (subject_identities_array)
object
identity_type
string Required

The type of identity being sent. It can be “BROWSER_ID”, “DEVICE_ID”, “USER_ID”, or “DEVELOPER_ID”.

Valid values[ "BROWSER_ID", "DEVICE_ID", "USER_ID", "DEVELOPER_ID" ]
ExampleDEVICE_ID
identity_value
string

The value as per the identity_type, IDFA, Google_advertising_id, etc.

ExampleXXXX-0000-xxxx
identity_format
string Required

To be sent as “raw”. Branch currently only supports “raw”.

Exampleraw
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
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
404

Not Found/Incorrect API URL

Result
Unable to generate XML
429

Rate Limit Reached

Result
"{\n    \"error\": {\n        \"code\": 429,\n        \"message\": \"Rate limit reached.\"\n    }\n}"
Expand All
object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400