External Callback Controller

getExternalCallback upsertExternalCallback

getExternalCallback

Method

GET

Content-Type

application/json

URL

https://irm.trustarc.com/server/api/v1/external/callback

Headers

Authorization: Bearer <access_token>

URL Parameters

N/A

Sample Request

N/A

Sample Success Response

{
  "id": "9023a7aa-cc33-481e-ba16-7cb30256ff98",
  "url": "https://postb.in/1597705804302-2410853756591",
  "requestTypeIds": ["00000000-0000-0000-0000-000000004001"],
  "formIds": ["605dcdd3-e8ac-472e-a788-b8d56a85042f"],
  "dataSubjectTypeIds": ["00000000-0000-0000-0000-000000003001"],
  "requestStatuses": ["UNVERIFIED"],
  "brandNames": ["Some Brand Name"],
  "residentOfs": ["AS_CN"],
  "requestVerificationTypes": ["EMAIL"],
  "accountId": "3c4d3d3c-d728-4bc5-9f9a-b1e56a1ea17e"
}

Where:

id — Auto-generated callback identifier.

url — Callback URL to be called.

requestTypeIds — List of request type IDs.

formIds — List of form IDs.

dataSubjectTypeIds — List of data subject type IDs.

requestStatuses — List of request statuses, from the Request Status API.

brandNames — List of brand names.

residentOfs — List of jurisdictions.

requestVerificationTypes — List of request verification types, from the Request Verification API.

accountId — AAA account ID.

Response Codes

Code: 200 OK

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

upsertExternalCallback

Method

POST

Content-Type

application/json

URL

https://irm.trustarc.com/server/api/v1/external/callback

Headers

Authorization: Bearer <access_token>

URL Parameters

N/A

Sample Request

[
  {
    "id": "9023a7aa-cc33-481e-ba16-7cb30256ff98",
    "url": "https://postb.in/1597705804302-2410853756591",
    "requestTypeIds": ["00000000-0000-0000-0000-000000004001"],
    "formIds": ["605dcdd3-e8ac-472e-a788-b8d56a85042f"],
    "dataSubjectTypeIds": ["00000000-0000-0000-0000-000000003001"],
    "requestStatuses": ["UNVERIFIED"],
    "brandNames": ["Some Brand Name"],
    "residentOfs": ["AS_CN"],
    "requestVerificationTypes": ["EMAIL"],
    "accountId": "3c4d3d3c-d728-4bc5-9f9a-b1e56a1ea17e"
  }
]

Where:

id — Auto-generated callback identifier.

url — Callback URL to be called.

requestTypeIds — List of request type IDs.

formIds — List of form IDs.

dataSubjectTypeIds — List of data subject type IDs.

requestStatuses — List of request statuses, from the Request Status API.

brandNames — List of brand names.

residentOfs — List of resident ofs.

requestVerificationTypes — List of request verification types, from the Request Verification API.

accountId — AAA account ID.

Sample Success Response

[
  {
    "id": "9023a7aa-cc33-481e-ba16-7cb30256ff98",
    "url": "https://postb.in/1597705804302-2410853756591",
    "requestTypeIds": ["00000000-0000-0000-0000-000000004001"],
    "formIds": ["605dcdd3-e8ac-472e-a788-b8d56a85042f"],
    "dataSubjectTypeIds": ["00000000-0000-0000-0000-000000003001"],
    "requestStatuses": ["UNVERIFIED"],
    "brandNames": ["Some Brand Name"],
    "residentOfs": ["AS_CN"],
    "requestVerificationTypes": ["EMAIL"],
    "accountId": "3c4d3d3c-d728-4bc5-9f9a-b1e56a1ea17e"
  }
]

Where:

id — Auto-generated callback identifier.

url — Callback URL to be called.

requestTypeIds — List of request type IDs.

formIds — List of form IDs.

dataSubjectTypeIds — List of data subject type IDs.

requestStatuses — List of request statuses, from the Request Status API.

brandNames — List of brand names.

residentOfs — List of resident ofs.

requestVerificationTypes — List of request verification types, from the Request Verification API.

accountId — AAA account ID.

Response Codes

Code: 200 OK

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

TrustArc · IRM — External Callback API Reference · support.trustarc.com

Search

External Callback Controller