Compliance Registrations resource - Branded Calling

(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 Registration resource represents a Branded Calling bundle. A Compliance Registration is a submission of required compliance data for a specific regulation and brand. It includes brand assets, tracks review and approval status, and enables associated phone numbers to display the brand information on the called party's mobile phone.

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

Create a Compliance Registration

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

Request body parameters

US Basic Branded CallingUS Enhanced Branded CallingNon-US Branded Calling

Parameter	Type	Required	Description
`regulationId`	string	Yes	The ID of the Compliance Regulation. Pattern: `^RN[0-9a-fA-F]{32}$` Min length: 34 Max length: 34
`regulationVersion`	integer	Yes	The version of Compliance Regulation.
`comments`	string	Yes	Additional information about the Compliance Registration.
`friendlyName`	string	Yes	The name that you assigned to describe the Compliance Registration.
`statusNotificationEmail`	string<email>	Yes	The email address that will receive updates when the Compliance Registration changes status.
`statusCallbackUrl`	string	No	The status callback URL.
`brandedCaller.displayName`	string	Yes	The display name to be shown on the called party's mobile phone. Must start with a letter and can only contain letters, numbers, periods, commas, and spaces. Min length: 1 Max length: 15
`brandedCaller.displayLongName`	string	No	An optional longer version of the display name to be shown on the called party's mobile phone. Must align with `brandedCaller.displayName` Min length: 1 Max length: 32

Parameter	Type	Required	Description
`regulationId`	string	Yes	The ID of the Compliance Regulation. Pattern: `^RN[0-9a-fA-F]{32}$` Min length: 34 Max length: 34
`regulationVersion`	integer	Yes	The version of Compliance Regulation.
`comments`	string	Yes	Additional information about the Compliance Registration.
`friendlyName`	string	Yes	The name that you assigned to describe the Compliance Registration.
`statusNotificationEmail`	string<email>	Yes	The email address that will receive updates when the Compliance Registration changes status.
`statusCallbackUrl`	string	No	The status callback URL.
`brandedCaller.displayName`	string	Yes	The display name to be shown on the called party's mobile phone. Must start with a letter and can only contain letters, numbers, periods, commas, and spaces. Min length: 1 Max length: 15
`brandedCaller.displayCallReason`	string	Yes	The call reason to be shown on the called party's mobile phone. Min length: 1 Max length: 64
`brandedCaller.displayLogoUrl`	string<url>	Yes	The URL of the logo to be shown on the called party's mobile phone. Supported file extensions are `.bmp` and `.png`.
`useCase.category`	string	Yes	The use case category of the Branded Calling. Possible values: `ACCOUNT_NOTIFICATION`, `AGENTS_FRANCHISES`, `CARRIER_EXEMPT`, `CHARITY`, `CUSTOMER_CARE`, `DELIVERY_NOTIFICATION`, `EMERGENCY`, `FRAUD_ALERT`, `HIGHER_EDUCATION`, `K12_EDUCATION`, `LOW_VOLUME`, `MARKETING`, `MIXED`, `POLITICAL`, `POLLING_VOTING`, `PROXY`, `PUBLIC_SERVICE_ANNOUNCEMENT`, `SECURITY_ALERT`, `SOCIAL`, `SOLE_PROPRIETOR`, `SWEEPSTAKE`
`useCase.description`	string	Yes	A description of the branded calling use case.
`useCase.consentDescription`	string	Yes	A description of the consent for the Branded calling use case.
`useCase.callVolumeDaily`	integer	Yes	The number of calls expected to be placed per day.
`useCase.categoryApple`	string	No	The use case category of the Branded Calling Apple business connect.
`authorizedContact.firstName`	string	Yes	The first name of the authorized contact.
`authorizedContact.lastName`	string	Yes	The last name of the authorized contact.
`authorizedContact.mobilePhoneE164`	string	Yes	The mobile phone number of the authorized contact, in E.164 format.
`authorizedContact.verificationEmail`	string<email>	Yes	The verification email address of the authorized contact.
`authorizedRepresentative1.firstName`	string	Yes	The first name of the authorized representative.
`authorizedRepresentative1.lastName`	string	Yes	The last name of the authorized representative.
`authorizedRepresentative1.email`	string<email>	Yes	The email address of the authorized representative.
`authorizedRepresentative1.phoneE164`	string	Yes	The phone number of the authorized representative, in E.164 format.
`authorizedRepresentative1.jobPosition`	string	Yes	The job position of the authorized representative. Possible values: `Director`, `GM`, `VP`, `CEO`, `CFO`, `General Counsel`, `Other`
`address.id`	string	Yes	The ID of the address. Must be a valid SID. Pattern: `^AD[0-9a-fA-F]{32}$` Min length: 34 Max length: 34 .
`business.legalName`	string	Yes	The legal name of the business entity. Min length:1 Max length:255
`business.tradeName`	string	No	The trade name, or Doing Business As (DBA) name, under which the business operates when it differs from the legal name. Min length:1 Max length:255
`business.entityType`	string	Yes	The entity type of the business. Possible values: `Sole Proprietorship`, `Partnership`, `Limited Liability Corporation`, `Co-operative`, `Non-profit Corporation`, `Corporation`
`business.identityType`	string	Yes	The identity type of the business. Possible values: `direct_customer`, `isv_reseller_or_partner`
`business.isSubassigned`	string	Yes	Whether you, as an independent software vendor (ISV), sub-assign a Twilio phone number to your customer. If you're a direct customer, this value must be `NO`. Possible values: `YES`, `NO`
`business.registrationAuthority`	string	Yes	The authority or agency that the business is registered with. Possible values: `EIN` (US), `DUNS`
`business.registrationNumber`	string	Yes	The prevailing national tax ID associated with the legal name. Min length: 1 Max length: 21
`business.industry`	string	Yes	The industry the business operates in. Possible values: `AGRICULTURE`, `AUTOMOTIVE`, `BANKING`, `CONSTRUCTION`, `CONSUMER`, `EDUCATION`, `ELECTRONICS`, `ENERGY`, `ENGINEERING`, `FAST_MOVING_CONSUMER_GOODS`, `FINANCIAL`, `FINTECH`, `FOOD_AND_BEVERAGE`, `GOVERNMENT`, `HEALTHCARE`, `HOSPITALITY`, `INSURANCE`, `JEWELRY`, `LEGAL`, `MANUFACTURING`, `MEDIA`, `NOT_FOR_PROFIT`, `OIL_AND_GAS`, `ONLINE`, `PROFESSIONAL_SERVICES`, `RAW_MATERIALS`, `REAL_ESTATE`, `RELIGION`, `RETAIL`, `TECHNOLOGY`, `TELECOMMUNICATIONS`, `TRANSPORTATION`, `TRAVEL`
`business.websiteUrl`	string<url>	Yes	The URL of the business website.
`business.privacyNoticeUrl`	string<url>	No	The privacy notice or policy website that explains how the business collects, uses, and protects personal data.
`business.employeeCount`	integer	Yes	The number of employees in the business.

Parameter	Type	Required	Description
`regulationId`	string	Yes	The ID of the Compliance Regulation. Pattern: `^RN[0-9a-fA-F]{32}$` Min length: 34 Max length: 34
`regulationVersion`	integer	Yes	The version of Compliance Regulation.
`comments`	string	Yes	Additional information about the Compliance Registration.
`friendlyName`	string	Yes	The name that you assigned to describe the Compliance Registration.
`statusNotificationEmail`	string<email>	Yes	The email address that will receive updates when the Compliance Registration changes status.
`statusCallbackUrl`	string	No	The status callback URL.
`brandedCaller.displayName`	string	Yes	The display name to be shown on the called party's mobile phone. Must start with a letter and can only contain letters, numbers, periods, commas, and spaces. Min length: 1 Max length: 15
`useCase.category`	string	Yes	The use case category of the Branded Calling. Possible values: `ACCOUNT_NOTIFICATION`, `AGENTS_FRANCHISES`, `CARRIER_EXEMPT`, `CHARITY`, `CUSTOMER_CARE`, `DELIVERY_NOTIFICATION`, `EMERGENCY`, `FRAUD_ALERT`, `HIGHER_EDUCATION`, `K12_EDUCATION`, `LOW_VOLUME`, `MARKETING`, `MIXED`, `POLITICAL`, `POLLING_VOTING`, `PROXY`, `PUBLIC_SERVICE_ANNOUNCEMENT`, `SECURITY_ALERT`, `SOCIAL`, `SOLE_PROPRIETOR`, `SWEEPSTAKE`
`useCase.description`	string	Yes	A description of the branded calling use case.
`useCase.consentDescription`	string	Yes	A description of the consent for the Branded calling use case.
`useCase.callVolumeDaily`	integer	Yes	The number of calls expected to be placed per day.
`useCase.categoryApple`	string	No	The use case category of the Branded Calling Apple business connect.
`authorizedContact.firstName`	string	Yes	The first name of the authorized contact.
`authorizedContact.lastName`	string	Yes	The last name of the authorized contact.
`authorizedContact.mobilePhoneE164`	string	Yes	The mobile phone number of the authorized contact, in E.164 format.
`authorizedContact.verificationEmail`	string<email>	Yes	The verification email address of the authorized contact.
`authorizedRepresentative1.firstName`	string	Yes	The first name of the authorized representative.
`authorizedRepresentative1.lastName`	string	Yes	The last name of the authorized representative.
`authorizedRepresentative1.email`	string<email>	Yes	The email address of the authorized representative.
`authorizedRepresentative1.phoneE164`	string	Yes	The phone number of the authorized representative, in E.164 format.
`authorizedRepresentative1.jobPosition`	string	Yes	The job position of the authorized representative. Possible values: `Director`, `GM`, `VP`, `CEO`, `CFO`, `General Counsel`, `Other`
`address.id`	string	Yes	The ID of the address. Must be a valid SID. Pattern: `^AD[0-9a-fA-F]{32}$` Min length: 34 Max length: 34 .
`business.legalName`	string	Yes	The legal name of the business entity. Min length:1 Max length:255
`business.tradeName`	string	No	The trade name or Doing Business As (DBA) name that the business operates under, if different from the legal name. Min length:1 Max length:255
`business.entityType`	string	Yes	The entity type of the business. Possible values: `Sole Proprietorship`, `Partnership`, `Limited Liability Corporation`, `Co-operative`, `Non-profit Corporation`, `Corporation`
`business.identityType`	string	Yes	The identity type of the business. Possible values: `direct_customer`, `isv_reseller_or_partner`
`business.isSubassigned`	string	Yes	Whether you, as an independent software vendor (ISV), sub-assign a Twilio phone number to your customer. If you're a direct customer, this value must be `NO`. Possible values: `YES`, `NO`
`business.registrationAuthority`	string	Yes	The authority or agency that the business is registered with. Possible values: `EIN` (US), `DUNS`
`business.registrationNumber`	string	Yes	The prevailing national tax ID associated with the legal name. Min length: 1 Max length: 21
`business.industry`	string	Yes	The industry the business operates in. Possible values: `AGRICULTURE`, `COMMUNICATION`, `CONSTRUCTION`, `EDUCATION`, `ENERGY`, `ENTERTAINMENT`, `FINANCIAL`, `GAMBLING`, `GOVERNMENT`, `HEALTHCARE`, `HOSPITALITY`, `HUMAN_RESOURCES`, `INSURANCE`, `LEGAL`, `MANUFACTURING`, `NGO`, `POLITICAL`, `POSTAL`, `PROFESSIONAL`, `REAL_ESTATE`, `RETAIL`, `TECHNOLOGY`, `TRANSPORTATION`
`business.websiteUrl`	string<url>	Yes	The URL of the business website.
`business.privacyNoticeUrl`	string<url>	No	The privacy notice or policy website that explains how the business collects, uses, and protects personal data.
`business.employeeCount`	integer	Yes	The number of employees in the business.

US Basic Branded CallingUS Enhanced Branded CallingNon-US Branded Calling

US Basic Branded Calling: Create a Compliance Registration

1curl -X POST 'https://trusthub.twilio.com/v4/Compliance/Registrations' \
2--header 'Content-Type: application/json' \
3--data-raw '{
4  "data": {
5    "brandedCaller": {
6        "voiceIntegrityRegistrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
7        "displayName": "Brand Name",
8        "displayLongName": "Brand long name"
9    }
10  },
11  "regulationId": "RNca63d1066fbd5e44eac02d0b3cf6d019",
12  "regulationVersion": 13,
13  "comments": "Sample comment",
14  "friendlyName": "Registration friendlyName",
15  "statusNotificationEmail": "notifcation@email.com",
16  "statusCallbackUrl": "https://statuscallback.example.com"
17}'
18-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "comments": null,
3  "data": {
4    "brandedCaller": {
5      "displayLongName": "Brand long name",
6      "displayName": "Brand Name",
7      "voiceIntegrityRegistrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"
8    }
9  },
10  "dataErrors": null,
11  "dateCreated": "2025-10-21T19:01:30Z",
12  "dateExpires": null,
13  "dateUpdated": "2025-10-21T19:01:30Z",
14  "documentLinks": [],
15  "friendlyName": "Registration friendlyName",
16  "id": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17  "regulationId": "RNca63d1066fbd5e44eac02d0b3cf6d019",
18  "regulationVersion": 13,
19  "status": "DRAFT",
20  "statusCallbackUrl": "https://statuscallback.example.com",
21  "statusNotificationEmail": "notifcation@email.com"
22}

US Enhanced Branded Calling: Create a Compliance Registration

1curl -X POST 'https://trusthub.twilio.com/v4/Compliance/Registrations' \
2--header 'Content-Type: application/json' \
3--data-raw '{
4  "data": {
5    "address": {
6        "id": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
7    },
8    "authorizedRepresentative1": {
9      "firstName": "Bob",
10      "lastName": "Smith",
11      "email": "bsmith@email.com",
12      "phoneE164": "+19832979578",
13      "jobPosition": "CEO"
14    },
15    "useCase": {
16        "category": "HIGHER_EDUCATION",
17        "description": "UseCase description",
18        "consentDescription": "Consent description",
19        "callVolumeDaily": 100,
20        "categoryApple": "Optional category"
21
22    },
23    "authorizedContact": {
24        "firstName": "John",
25        "lastName": "Doe",
26        "mobilePhoneE164": "+19318339216",
27        "verificationEmail": "johndoe@email.com"
28    },
29    "brandedCaller": {
30        "displayName": "Brand Display Name",
31        "displayCallReason": "Call Reason",
32        "displayLogoUrl": "https://www.logo.example.com"
33    },
34    "business": {
35        "legalName": "Business Name",
36        "entityType": "Partnership",
37        "identityType": "direct_customer",
38        "isSubassigned": "NO",
39        "registrationNumber": "123456789",
40        "registrationAuthority": "EIN",
41        "industry": "RAW_MATERIALS",
42        "websiteUrl": "https://www.wesbite.example.com",
43        "employeeCount": 1000
44    }
45  },
46  "regulationId": "RNa0b74679be7511921f4d2e3094fa6d23",
47  "regulationVersion": 9,
48  "comments": "Sample comment",
49  "friendlyName": "Registration friendlyName",
50  "statusNotificationEmail": "notifcation@email.com",
51  "statusCallbackUrl": "https://statuscallback.example.com"
52}'
53-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "comments": null,
3  "data": {
4    "address": {
5      "id": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
6    },
7    "authorizedContact": {
8      "firstName": "John",
9      "lastName": "Doe",
10      "mobilePhoneE164": "+19318339216",
11      "verificationEmail": "johndoe@email.com"
12    },
13    "authorizedRepresentative1": {
14      "email": "bsmith@email.com",
15      "firstName": "Bob",
16      "jobPosition": "CEO",
17      "lastName": "Smith",
18      "phoneE164": "+19832979578"
19    },
20    "brandedCaller": {
21      "displayCallReason": "Call Reason",
22      "displayLogoUrl": "https://www.logo.example.com",
23      "displayName": "Brand Display Name"
24    },
25    "business": {
26      "employeeCount": 1000,
27      "entityType": "Partnership",
28      "identityType": "direct_customer",
29      "industry": "RAW_MATERIALS",
30      "isSubassigned": "NO",
31      "legalName": "Business Name",
32      "registrationAuthority": "EIN",
33      "registrationNumber": "123456789",
34      "websiteUrl": "https://www.website.example.com"
35    },
36    "useCase": {
37      "callVolumeDaily": 100,
38      "category": "HIGHER_EDUCATION",
39      "categoryApple": "Optional category",
40      "consentDescription": "Consent description",
41      "description": "UseCase description"
42    }
43  },
44  "dataErrors": null,
45  "dateCreated": "2025-10-16T10:21:20Z",
46  "dateExpires": null,
47  "dateUpdated": "2025-10-16T10:21:21Z",
48  "documentLinks": [],
49  "friendlyName": "Registration friendlyName",
50  "id": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
51  "regulationId": "RNa0b74679be7511921f4d2e3094fa6d23",
52  "regulationVersion": 9,
53  "status": "DRAFT",
54  "statusCallbackUrl": "https://statuscallback.example.com",
55  "statusNotificationEmail": "notifcation@email.com"
56}

The following example is for the United Kingdom (country: GB).

Non-US Branded Calling (UK): Create a Compliance Registration

1curl -X POST 'https://trusthub.twilio.com/v4/Compliance/Registrations' \
2--header 'Content-Type: application/json' \
3--data-raw '{
4  "data": {
5    "address": {
6        "id": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
7    },
8    "authorizedRepresentative1": {
9      "firstName": "Bob",
10      "lastName": "Smith",
11      "email": "bsmith@email.com",
12      "phoneE164": "+19832979578",
13      "jobPosition": "CEO"
14    },
15    "useCase": {
16        "category": "HIGHER_EDUCATION",
17        "description": "UseCase description",
18        "consentDescription": "Consent description",
19        "callVolumeDaily": 100
20
21    },
22    "authorizedContact": {
23        "firstName": "John",
24        "lastName": "Doe",
25        "mobilePhoneE164": "+19318339216",
26        "verificationEmail": "johndoe@email.com"
27    },
28    "brandedCaller": {
29        "displayName": "Brand Display Name"
30    },
31    "business": {
32        "legalName": "Business Name",
33        "entityType": "Partnership",
34        "identityType": "direct_customer",
35        "isSubassigned": "NO",
36        "registrationNumber": "123456789",
37        "registrationAuthority": "CRN",
38        "industry": "RAW_MATERIALS",
39        "websiteUrl": "https://www.website.example.com",
40        "employeeCount": 1000
41    }
42  },
43  "regulationId": "RN304faa2408f673b68867fe5cb65b7f50",
44  "regulationVersion": 4,
45  "comments": "Sample comment",
46  "friendlyName": "Registration friendlyName",
47  "statusNotificationEmail": "notifcation@email.com",
48  "statusCallbackUrl": "https://statuscallback.example.com"
49}'
50-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "comments": null,
3  "data": {
4    "address": {
5      "id": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
6    },
7    "authorizedContact": {
8      "firstName": "John",
9      "lastName": "Doe",
10      "mobilePhoneE164": "+19318339216",
11      "verificationEmail": "johndoe@email.com"
12    },
13    "authorizedRepresentative1": {
14      "email": "bsmith@email.com",
15      "firstName": "Bob",
16      "jobPosition": "CEO",
17      "lastName": "Smith",
18      "phoneE164": "+19832979578"
19    },
20    "brandedCaller": {
21      "displayName": "Brand Display Name"
22    },
23    "business": {
24      "employeeCount": 1000,
25      "entityType": "Partnership",
26      "identityType": "direct_customer",
27      "industry": "RAW_MATERIALS",
28      "isSubassigned": "NO",
29      "legalName": "Business Name",
30      "registrationAuthority": "CRN",
31      "registrationNumber": "123456789",
32      "websiteUrl": "https://www.website.example.com"
33    },
34    "useCase": {
35      "callVolumeDaily": 100,
36      "category": "HIGHER_EDUCATION",
37      "consentDescription": "Consent description",
38      "description": "UseCase description"
39    }
40  },
41  "dataErrors": null,
42  "dateCreated": "2025-10-16T10:21:20Z",
43  "dateExpires": null,
44  "dateUpdated": "2025-10-16T10:21:21Z",
45  "documentLinks": [],
46  "friendlyName": "Registration friendlyName",
47  "id": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
48  "regulationId": "RN304faa2408f673b68867fe5cb65b7f50",
49  "regulationVersion": 4,
50  "status": "DRAFT",
51  "statusCallbackUrl": "https://statuscallback.example.com",
52  "statusNotificationEmail": "notifcation@email.com"
53}

Retrieve a list of Compliance Registrations

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

Query parameters

Parameter	Type	Description
`status`	string	The status of the Compliance Registration. Possible values: `DRAFT`, `PENDING_REVIEW`, `IN_REVIEW`, `TWILIO_APPROVED`, `TWILIO_REJECTED`
`friendlyName`	string	The friendly name of the Compliance Registration.
`regulationId`	string	The ID of the Compliance Regulation.
`dateExpires`	string	The date and time when the registration expires, in UTC (ISO 8601 format).
`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 Registrations

1curl -X GET 'https://trusthub.twilio.com/v4/Compliance/Registrations?regulationId=RNa0b74679be7511921f4d2e3094fa6d23&pageSize=2' \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "items": [
3    {
4      "comments": null,
5      "dateCreated": "2025-11-10T18:31:56Z",
6      "dateExpires": null,
7      "dateUpdated": "2025-11-10T18:31:56Z",
8      "friendlyName": "Branded Calling Registration",
9      "id": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10      "regulationId": "RNa0b74679be7511921f4d2e3094fa6d23",
11      "regulationVersion": 9,
12      "status": "DRAFT"
13    },
14    {
15      "comments": null,
16      "dateCreated": "2025-11-10T18:17:28Z",
17      "dateExpires": null,
18      "dateUpdated": "2025-11-10T18:17:28Z",
19      "friendlyName": "Registration Friendly Name",
20      "id": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
21      "regulationId": "RNa0b74679be7511921f4d2e3094fa6d23",
22      "regulationVersion": 9,
23      "status": "IN_REVIEW"
24    }
25  ],
26  "meta": {
27    "key": "items",
28    "nextToken": "eyJwYWdlVG9rZW4iOnsicG9pbnRlciI6IkJVYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWIiLCJkaXJlY3Rpb24iOiJORVhUIn0sImZpbHRlcnMiOnsicmVndWxhdGlvbklkIjoiUk5BMGI3NDY3OWJlNzUxMTkyMWY0ZDJlMzA5NGZhNmQyMyJ9fQ==",
29    "pageSize": 2,
30    "previousToken": null
31  }
32}

Retrieve a Compliance Registration

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

Path parameters

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

Retrieve a Compliance Registration

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

Output

1{
2  "comments": null,
3  "data": {
4    "address": {
5      "id": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
6    },
7    "authorizedContact": {
8      "firstName": "John",
9      "lastName": "Doe",
10      "mobilePhoneE164": "+19318339216",
11      "verificationEmail": "johndoe@email.com"
12    },
13    "authorizedRepresentative1": {
14      "email": "bsmith@email.com",
15      "firstName": "Bob",
16      "jobPosition": "CEO",
17      "lastName": "Smith",
18      "phoneE164": "+19832979578"
19    },
20    "brandedCaller": {
21      "displayCallReason": "Call Reason",
22      "displayLogoUrl": "https://www.logo.example.com",
23      "displayName": "Brand Display Name"
24    },
25    "business": {
26      "employeeCount": 1000,
27      "entityType": "Partnership",
28      "identityType": "direct_customer",
29      "industry": "RAW_MATERIALS",
30      "isSubassigned": "NO",
31      "legalName": "Business Name",
32      "registrationAuthority": "EIN",
33      "registrationNumber": "123456789",
34      "websiteUrl": "https://www.website.example.com"
35    },
36    "useCase": {
37      "callVolumeDaily": 100,
38      "category": "HIGHER_EDUCATION",
39      "categoryApple": "Optional category",
40      "consentDescription": "Consent description",
41      "description": "UseCase description"
42    }
43  },
44  "dataErrors": null,
45  "dateCreated": "2025-10-17T09:59:16Z",
46  "dateExpires": null,
47  "dateUpdated": "2025-10-17T09:59:16Z",
48  "documentLinks": [
49    {
50      "dateCreated": "2025-11-12T09:05:31Z",
51      "documentId": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
52      "id": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
53      "registrationId": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
54      "status": "DRAFT"
55    }
56  ],
57  "friendlyName": "Registration friendlyName",
58  "id": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
59  "regulationId": "RNa0b74679be7511921f4d2e3094fa6d23",
60  "regulationVersion": 9,
61  "status": "DRAFT",
62  "statusCallbackUrl": "https://statuscallback.example.com",
63  "statusNotificationEmail": "notifcation@email.com"
64}

Update a Compliance Registration

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

To update a Compliance Registration, make a PATCH request to the Compliance Registration resource. To submit a Compliance Registration for review, set the status parameter in the request body to PENDING_REVIEW.

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

Path parameters

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

Request body parameters

See Create a Compliance Registration.

Update a Compliance Registration

1curl -X PATCH 'https://trusthub.twilio.com/v4/Compliance/Registrations/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' \
2--header 'Content-Type: application/json' \
3--data-raw '{
4  "data": {
5   "address": {
6        "id": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
7    },
8    "authorizedRepresentative1": {
9      "firstName": "Bob",
10      "lastName": "Smith",
11      "email": "bsmith@email.com",
12      "phoneE164": "+19832979578",
13      "jobPosition": "CEO"
14    },
15    "useCase": {
16        "category": "HIGHER_EDUCATION",
17        "description": "UseCase description",
18        "consentDescription": "Consent description",
19        "callVolumeDaily": 100,
20        "categoryApple": "Optional category"
21
22    },
23    "authorizedContact": {
24        "firstName": "John",
25        "lastName": "Doe",
26        "mobilePhoneE164": "+19318339216",
27        "verificationEmail": "johndoe@email.com"
28    },
29    "brandedCaller": {
30        "displayName": "Brand Display Name",
31        "displayCallReason": "Call Reason",
32        "displayLogoUrl": "https://www.logo.example.com"
33    },
34    "business": {
35        "legalName": "Business Name",
36        "entityType": "Partnership",
37        "identityType": "direct_customer",
38        "isSubassigned": "NO",
39        "registrationNumber": "123456789",
40        "registrationAuthority": "EIN",
41        "industry": "RAW_MATERIALS",
42        "websiteUrl": "https://www.website.example.com",
43        "employeeCount": 1000
44    }
45  },
46  "comments": "Sample comment",
47  "friendlyName": "Registration friendlyName",
48  "statusNotificationEmail": "notifcation@email.com",
49  "statusCallbackUrl": "https://statuscallback.example.com"
50}'
51-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "comments": null,
3  "data": {
4    "address": {
5      "id": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
6    },
7    "authorizedContact": {
8      "firstName": "John",
9      "lastName": "Doe",
10      "mobilePhoneE164": "+19318339216",
11      "verificationEmail": "johndoe@email.com"
12    },
13    "authorizedRepresentative1": {
14      "email": "bsmith@email.com",
15      "firstName": "Bob",
16      "jobPosition": "CEO",
17      "lastName": "Smith",
18      "phoneE164": "+19832979578"
19    },
20    "brandedCaller": {
21      "displayCallReason": "Call Reason",
22      "displayLogoUrl": "https://www.logo.example.com",
23      "displayName": "Brand Display Name"
24    },
25    "business": {
26      "employeeCount": 1000,
27      "entityType": "Partnership",
28      "identityType": "direct_customer",
29      "industry": "RAW_MATERIALS",
30      "isSubassigned": "NO",
31      "legalName": "Business Name",
32      "registrationAuthority": "EIN",
33      "registrationNumber": "123456789",
34      "websiteUrl": "https://www.website.example.com"
35    },
36    "useCase": {
37      "callVolumeDaily": 100,
38      "category": "HIGHER_EDUCATION",
39      "categoryApple": "Optional category",
40      "consentDescription": "Consent description",
41      "description": "UseCase description"
42    }
43  },
44  "dataErrors": null,
45  "dateCreated": "2025-10-17T09:59:16Z",
46  "dateExpires": null,
47  "dateUpdated": "2025-10-17T10:04:49Z",
48  "documentLinks": [],
49  "friendlyName": "Registration friendlyName",
50  "id": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
51  "regulationId": "RNa0b74679be7511921f4d2e3094fa6d23",
52  "regulationVersion": 9,
53  "status": "DRAFT",
54  "statusCallbackUrl": "https://statuscallback.example.com",
55  "statusNotificationEmail": "notification@email.com"
56}

Submit the Compliance Registration

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

Delete a Compliance Registration

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

Path parameters

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

Delete a Compliance Registration

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