External Callback Controller

getExternalCallback

MethodGET
Prod URLhttps://irm.trustarc.com/server/api/v1/external/callback
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
URL ParametersN/A
Sample RequestN/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 Request Status API
  • brandNames – list of brand names
  • residentOfs – list of jurisdictions
  • requestVerificationTypes – list of request verification types, from Request Verification API
  • accountId – aaa account id
Success ResponseCode: 200 OK
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

 

upsertExternalCallback

MethodPOST
Prod URLhttps://irm.trustarc.com/server/api/v1/external/callback
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
URL ParametersN/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 Request Status API
  • brandNames – list of brand names
  • residentOfs – list of resident ofs
  • requestVerificationTypes – list of request verification types, from 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 Request Status API
  • brandNames – list of brand names
  • residentOfs – list of resident ofs
  • requestVerificationTypes – list of request verification types, from Request Verification API
  • accountId – aaa account id
Success ResponseCode: 200 OK
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found