Compliance DocumentLinks resource

(new)

Private beta

The Trust Hub API resources for Branded Calling are in private beta, and the information contained in this document is subject to change. This means that some features aren't yet implemented and others may be changed before the product is declared as generally available. Private beta products aren't covered by a Service Level Agreement (SLA).

To request access, complete the request form.

A Compliance DocumentLink resource represents a link that associates a Document with a Compliance Registration.

See Related how-to documentation to learn the steps to use the info on this page.

Create a Compliance DocumentLink

POST https://trusthub.twilio.com/v4/Compliance/DocumentLinks

Request body parameters

Parameter	Type	Required	Description
`documentId`	string	Yes	The ID of the Document to link. Pattern: `^RD[0-9a-fA-F]{32}$` Min length: 34 Max length: 34
`registrationId`	string	Yes	The ID of the Compliance Registration to link. Pattern: `^BU[0-9a-fA-F]{32}$` Min length: 34 Max length: 34

Create a Compliance DocumentLink

1curl -X POST 'https://trusthub.twilio.com/v4/Compliance/DocumentLinks' \
2--header 'Content-Type: application/json' \
3--data '{
4  "documentId": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "registrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
6}'
7-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "dateCreated": "2025-10-16T10:30:35Z",
3  "documentId": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "id": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "registrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "status": "DRAFT"
7}

Retrieve a list of Compliance DocumentLinks

GET https://trusthub.twilio.com/v4/Compliance/DocumentLinks

Query parameters

Parameter	Type	Description
`documentId`	string	The ID of the Compliance Document to link. Pattern: `^RD[0-9a-fA-F]{32}$` Min length: 34 Max length: 34
`registrationId`	string	The ID of the Compliance Registration to link. Pattern: `^BU[0-9a-fA-F]{32}$` Min length: 34 Max length: 34
`pageSize`	integer	The maximum number of items to return in a single response. Min: 1 Max: 1000 Default: 50
`pageToken`	string	A URL-safe, Base64-encoded token that specifies which page of results to return. This token contains the position information needed to retrieve the next set of results. If not specified, the API returns the first page of results.

Retrieve a list of Compliance DocumentLinks

1curl -X GET 'https://trusthub.twilio.com/v4/Compliance/DocumentLinks?documentId=RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&registrationId=BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "items": [
3    {
4      "dateCreated": "2025-10-17T10:37:37Z",
5      "documentId": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "id": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7      "registrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8      "status": "DRAFT"
9    }
10  ],
11  "meta": {
12    "key": "items",
13    "nextToken": null,
14    "pageSize": 1,
15    "previousToken": null
16  }
17}

Retrieve a Compliance DocumentLink

GET https://trusthub.twilio.com/v4/Compliance/DocumentLinks/{id}

Path parameters

Parameter	Type	Required	Description
`id`	string	Yes	The ID of the Compliance DocumentLink. Pattern: `^BV[0-9a-fA-F]{32}$` Min length: 34 Max length: 34

Retrieve a Compliance DocumentLink

1curl -X GET 'https://trusthub.twilio.com/v4/Compliance/DocumentLinks/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "dateCreated": "2025-10-17T10:37:37Z",
3  "documentId": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "id": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "registrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "status": "DRAFT"
7}

Update a Compliance DocumentLink

PATCH https://trusthub.twilio.com/v4/Compliance/DocumentLinks/{id}

Note: You can make this request only if the status value is DRAFT or TWILIO_REJECTED.

Path parameters

Parameter	Type	Required	Description
`id`	string	Yes	The ID of the Compliance DocumentLink. Pattern: `^BV[0-9a-fA-F]{32}$` Min length: 34 Max length: 34

Update a Compliance DocumentLink

1curl -X PATCH 'https://trusthub.twilio.com/v4/Compliance/DocumentLinks/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' \
2--header 'Content-Type: application/json' \
3--data '{
4  "documentId": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"
5}'
6-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "dateCreated": "2025-10-17T10:37:37Z",
3  "documentId": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
4  "id": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "registrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "status": "DRAFT"
7}

Delete a Compliance DocumentLink

DELETE https://trusthub.twilio.com/v4/Compliance/DocumentLinks/{id}

Path parameters

Parameter	Type	Required	Description
`id`	string	Yes	The ID of the Compliance DocumentLink. Pattern: `^BV[0-9a-fA-F]{32}$` Min length: 34 Max length: 34

Delete a Compliance DocumentLink

1curl -X DELETE 'https://trusthub.twilio.com/v4/Compliance/DocumentLinks/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN