Compliance Regulations 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.

The Compliance Regulations resource represents the compliance requirements for a Compliance Registration in a specific country or type. Each Compliance Regulation specifies the required data fields, supporting documents, and validations.

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

Retrieve a list of Compliance Regulations

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

Query parameters

Parameter	Type	Description
`type`	string	The type of the Compliance Regulation. For Branded Calling, the value must be `VOICE_TRUST`.
`subType`	string	The sub-type of the Compliance Regulation, specific to a compliance regulation type. For Branded Calling (`type=VOICE_TRUST`), the value must be `BRANDED_CALLS`.
`country`	array of strings	The country where the Compliance Regulation is applicable. Possible values: `US` (United States), `GB` (United Kingdom), `DE` (Germany), `CA` (Canada)
`endUserType`	string	The type of the customer. Supports multiple values. Possible values: `BUSINESS`, `INDIVIDUAL`.
`id`	array of strings	The ID of the Compliance Regulation. Supports multiple values. Pattern: `^RN[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 Regulations

1curl -X GET 'https://trusthub.twilio.com/v4/Compliance/Regulations?type=VOICE_TRUST&country=US&country=GB' \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "items": [
3    {
4      "country": "GB",
5      "endUserType": "BUSINESS",
6      "friendlyName": "Branded Calling - UK",
7      "id": "RN304faa2408f673b68867fe5cb65b7f50",
8      "schema": {
9        "$schema": "http://json-schema.org/draft-07/schema#",
10        "additionalProperties": false,
11        "properties": {
12          "address": {
13            "additionalProperties": false,
14            "description": "Physical address of your business.",
15            "properties": {
16              "id": {
17                "description": "Must be a valid address",
18                "maxLength": 34,
19                "minLength": 34,
20                "pattern": "^AD[0-9a-fA-F]{32}$",
21                "title": "Address id",
22                "type": "string"
23              }
24            },
25            "required": [
26              "id"
27            ],
28            "type": "object"
29          },
30          "authorizedContact": {
31            "additionalProperties": false,
32            "description": "If you are an ISV registering for Branded Calling on behalf of an end user, please ensure the brand contact is an individual from the end user's company.",
33            "properties": {
34              "firstName": {
35                "description": "The first name of the authorized contact.",
36                "minLength": 1,
37                "title": "First Name",
38                "type": "string"
39              },
40              "lastName": {
41                "description": "The last name of the authorized contact.",
42                "minLength": 1,
43                "title": "Last Name",
44                "type": "string"
45              },
46              "mobilePhoneE164": {
47                "description": "The mobile phone number of the authorized contact.",
48                "pattern": "^\\+[1-9]\\d{1,14}$",
49                "title": "Mobile Phone Number",
50                "type": "string"
51              },
52              "verificationEmail": {
53                "description": "The verification email address of the authorized contact.",
54                "format": "email",
55                "minLength": 1,
56                "pattern": "^\\S+@\\S+\\.\\S+$",
57                "title": "Verification Email Address",
58                "type": "string"
59              }
60            },
61            "required": [
62              "firstName",
63              "lastName",
64              "verificationEmail",
65              "mobilePhoneE164"
66            ],
67            "type": "object"
68          },
69          "authorizedRepresentative1": {
70            "additionalProperties": false,
71            "description": "Authorized Representative #1",
72            "properties": {
73              "email": {
74                "description": "The email address of the authorized representative.",
75                "format": "email",
76                "minLength": 1,
77                "pattern": "^\\S+@\\S+\\.\\S+$",
78                "title": "Email Address",
79                "type": "string"
80              },
81              "firstName": {
82                "description": "The first name of the authorized representative.",
83                "minLength": 1,
84                "title": "First Name",
85                "type": "string"
86              },
87              "jobPosition": {
88                "description": "The job position of the authorized representative.",
89                "enum": [
90                  "Director",
91                  "GM",
92                  "VP",
93                  "CEO",
94                  "CFO",
95                  "General Counsel",
96                  "Other"
97                ],
98                "title": "Job Position",
99                "type": "string"
100              },
101              "lastName": {
102                "description": "The last name of the authorized representative.",
103                "minLength": 1,
104                "title": "Last Name",
105                "type": "string"
106              },
107              "phoneE164": {
108                "description": "The phone number of the authorized representative.",
109                "minLength": 1,
110                "pattern": "^\\+[1-9]\\d{1,14}$",
111                "title": "Phone Number",
112                "type": "string"
113              }
114            },
115            "required": [
116              "firstName",
117              "lastName",
118              "email",
119              "phoneE164",
120              "jobPosition"
121            ],
122            "type": "object"
123          },
124          "brandedCaller": {
125            "additionalProperties": false,
126            "description": "The information that will be shown on the terminating handset for outbound calls.",
127            "properties": {
128              "displayName": {
129                "description": "The display name to be shown on the terminating handset for outbound calls. The display name can be up to 32 characters.",
130                "maxLength": 32,
131                "minLength": 1,
132                "title": "Branded Calls Display Name",
133                "type": "string"
134              }
135            },
136            "required": [
137              "displayName"
138            ],
139            "type": "object"
140          },
141          "business": {
142            "additionalProperties": false,
143            "description": "General business information",
144            "properties": {
145              "employeeCount": {
146                "description": "The number of employees in the business.",
147                "minimum": 1,
148                "title": "Business Employee Count",
149                "type": "integer"
150              },
151              "entityType": {
152                "description": "Business type can be empty or one of Sole Proprietorship, Partnership, Co-operative, Limited Liability Corporation, Non-profit Corporation, Corporation",
153                "enum": [
154                  "Sole Proprietorship",
155                  "Partnership",
156                  "Limited Liability Corporation",
157                  "Co-operative",
158                  "Non-profit Corporation",
159                  "Corporation"
160                ],
161                "title": "Business Type",
162                "type": "string"
163              },
164              "identityType": {
165                "description": "Whether the company is an ISV (independent software vendor) or direct customer.",
166                "enum": [
167                  "direct_customer",
168                  "isv_reseller_or_partner"
169                ],
170                "title": "Business Identity (ISV vs. Direct)",
171                "type": "string"
172              },
173              "industry": {
174                "description": "Business industry should be one of 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",
175                "enum": [
176                  "AUTOMOTIVE",
177                  "AGRICULTURE",
178                  "BANKING",
179                  "CONSTRUCTION",
180                  "CONSUMER",
181                  "EDUCATION",
182                  "ENGINEERING",
183                  "ENERGY",
184                  "OIL_AND_GAS",
185                  "FAST_MOVING_CONSUMER_GOODS",
186                  "FINANCIAL",
187                  "FINTECH",
188                  "FOOD_AND_BEVERAGE",
189                  "GOVERNMENT",
190                  "HEALTHCARE",
191                  "HOSPITALITY",
192                  "INSURANCE",
193                  "LEGAL",
194                  "MANUFACTURING",
195                  "MEDIA",
196                  "ONLINE",
197                  "PROFESSIONAL_SERVICES",
198                  "RAW_MATERIALS",
199                  "REAL_ESTATE",
200                  "RELIGION",
201                  "RETAIL",
202                  "JEWELRY",
203                  "TECHNOLOGY",
204                  "TELECOMMUNICATIONS",
205                  "TRANSPORTATION",
206                  "TRAVEL",
207                  "ELECTRONICS",
208                  "NOT_FOR_PROFIT"
209                ],
210                "title": "Business Industry",
211                "type": "string"
212              },
213              "isSubassigned": {
214                "description": "Choose any one of the following values : [YES, NO]. A sub assigned phone number is where Independent Software Vendor (ISV) assigns the Twilio phone number to their end customer. If you are a direct customer, answer NO.",
215                "enum": [
216                  "YES",
217                  "NO"
218                ],
219                "title": "Will you subassign this number to your end customers?",
220                "type": "string"
221              },
222              "legalName": {
223                "description": "Name of the business entity",
224                "maxLength": 255,
225                "minLength": 1,
226                "title": "Business Name",
227                "type": "string"
228              },
229              "privacyNoticeUrl": {
230                "description": "The privacy notice/policy website that explains how the business collects, uses, and protects personal data.",
231                "format": "uri",
232                "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
233                "title": "Privacy Notice URL",
234                "type": [
235                  "string",
236                  "null"
237                ]
238              },
239              "registrationAuthority": {
240                "description": "The registrar the business is registered with: EIN(US), DUNS, CBN(CA), CCN(CA), CRN(UK), OTHER",
241                "enum": [
242                  "EIN",
243                  "DUNS",
244                  "CBN",
245                  "CCN",
246                  "CRN",
247                  "OTHER"
248                ],
249                "title": "Business Registration Identifier",
250                "type": "string"
251              },
252              "registrationNumber": {
253                "description": "The ID number of the business in the business registrar",
254                "maxLength": 21,
255                "minLength": 1,
256                "title": "Business Registration Number",
257                "type": "string"
258              },
259              "tradeName": {
260                "description": "The trade name or DBA name that the business uses to operate under that is different than the legal name.",
261                "maxLength": 255,
262                "minLength": 1,
263                "title": "Business Trade Name",
264                "type": [
265                  "string",
266                  "null"
267                ]
268              },
269              "websiteUrl": {
270                "description": "The URL of the business website",
271                "format": "uri",
272                "minLength": 1,
273                "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
274                "title": "Website URL",
275                "type": "string"
276              }
277            },
278            "required": [
279              "legalName",
280              "entityType",
281              "identityType",
282              "registrationNumber",
283              "registrationAuthority",
284              "industry",
285              "websiteUrl",
286              "isSubassigned",
287              "employeeCount"
288            ],
289            "type": "object"
290          },
291          "useCase": {
292            "additionalProperties": false,
293            "description": "What the branded calling products will be used for.",
294            "properties": {
295              "callVolumeDaily": {
296                "description": "The number of calls expected to be placed per day.",
297                "minimum": 1,
298                "title": "Call Volume Daily",
299                "type": "integer"
300              },
301              "category": {
302                "description": "The branded calling use case category.",
303                "enum": [
304                  "2FA",
305                  "ACCOUNT_NOTIFICATION",
306                  "AGENTS_FRANCHISES",
307                  "CARRIER_EXEMPT",
308                  "CHARITY",
309                  "CUSTOMER_CARE",
310                  "DELIVERY_NOTIFICATION",
311                  "EMERGENCY",
312                  "FRAUD_ALERT",
313                  "HIGHER_EDUCATION",
314                  "K12_EDUCATION",
315                  "LOW_VOLUME",
316                  "MARKETING",
317                  "MIXED",
318                  "POLITICAL",
319                  "POLLING_VOTING",
320                  "PROXY",
321                  "PUBLIC_SERVICE_ANNOUNCEMENT",
322                  "SECURITY_ALERT",
323                  "SOCIAL",
324                  "SOLE_PROPRIETOR",
325                  "SWEEPSTAKE"
326                ],
327                "title": "Use Case Category",
328                "type": "string"
329              },
330              "consentDescription": {
331                "description": "The branded calling consent use case description.",
332                "minLength": 1,
333                "title": "Use Case Consent Description",
334                "type": "string"
335              },
336              "description": {
337                "description": "The branded calling use case description.",
338                "minLength": 1,
339                "title": "Use Case Description",
340                "type": "string"
341              }
342            },
343            "required": [
344              "category",
345              "description",
346              "consentDescription",
347              "callVolumeDaily"
348            ],
349            "type": "object"
350          }
351        },
352        "required": [
353          "brandedCaller",
354          "authorizedRepresentative1",
355          "business",
356          "useCase",
357          "address"
358        ],
359        "title": "Branded Calling - UK",
360        "type": "object",
361        "x-acceptableDocuments": [
362          {
363            "description": "The letter to authorize Twilio to run voice traffic on a given set of Phone Numbers.",
364            "documents": [
365              {
366                "description": "Letter of Authorization containing Brand Name, Tax ID, Tax country, Legal Name, Address, Phone #",
367                "documentType": "letter_of_authorization",
368                "friendlyName": "Letter of Authorization"
369              }
370            ],
371            "friendlyName": "Letter of Authorization"
372          }
373        ]
374      },
375      "subType": "BRANDED_CALLS",
376      "type": "VOICE_TRUST",
377      "version": 4
378    },
379    {
380      "country": "US",
381      "endUserType": "BUSINESS",
382      "friendlyName": "Enhanced Branded Calling - US",
383      "id": "RNa0b74679be7511921f4d2e3094fa6d23",
384      "schema": {
385        "$schema": "http://json-schema.org/draft-07/schema#",
386        "additionalProperties": false,
387        "properties": {
388          "address": {
389            "additionalProperties": false,
390            "description": "Physical address of your business.",
391            "properties": {
392              "id": {
393                "description": "Must be a valid address",
394                "maxLength": 34,
395                "minLength": 34,
396                "pattern": "^AD[0-9a-fA-F]{32}$",
397                "title": "Address id",
398                "type": "string"
399              }
400            },
401            "required": [
402              "id"
403            ],
404            "type": "object"
405          },
406          "authorizedContact": {
407            "additionalProperties": false,
408            "description": "If you are an ISV registering for Branded Calling on behalf of an end user, please ensure the brand contact is an individual from the end user's company.",
409            "properties": {
410              "firstName": {
411                "description": "The first name of the authorized contact.",
412                "minLength": 1,
413                "title": "First Name",
414                "type": "string"
415              },
416              "lastName": {
417                "description": "The last name of the authorized contact.",
418                "minLength": 1,
419                "title": "Last Name",
420                "type": "string"
421              },
422              "mobilePhoneE164": {
423                "description": "The mobile phone number of the authorized contact.",
424                "pattern": "^\\+[1-9]\\d{1,14}$",
425                "title": "Mobile Phone Number",
426                "type": "string"
427              },
428              "verificationEmail": {
429                "description": "The verification email address of the authorized contact.",
430                "format": "email",
431                "minLength": 1,
432                "pattern": "^\\S+@\\S+\\.\\S+$",
433                "title": "Verification Email Address",
434                "type": "string"
435              }
436            },
437            "required": [
438              "firstName",
439              "lastName",
440              "verificationEmail",
441              "mobilePhoneE164"
442            ],
443            "type": "object"
444          },
445          "authorizedRepresentative1": {
446            "additionalProperties": false,
447            "description": "Authorized Representative #1",
448            "properties": {
449              "email": {
450                "description": "The email address of the authorized representative.",
451                "format": "email",
452                "minLength": 1,
453                "pattern": "^\\S+@\\S+\\.\\S+$",
454                "title": "Email Address",
455                "type": "string"
456              },
457              "firstName": {
458                "description": "The first name of the authorized representative.",
459                "minLength": 1,
460                "title": "First Name",
461                "type": "string"
462              },
463              "jobPosition": {
464                "description": "The job position of the authorized representative.",
465                "enum": [
466                  "Director",
467                  "GM",
468                  "VP",
469                  "CEO",
470                  "CFO",
471                  "General Counsel",
472                  "Other"
473                ],
474                "title": "Job Position",
475                "type": "string"
476              },
477              "lastName": {
478                "description": "The last name of the authorized representative.",
479                "minLength": 1,
480                "title": "Last Name",
481                "type": "string"
482              },
483              "phoneE164": {
484                "description": "The phone number of the authorized representative.",
485                "minLength": 1,
486                "pattern": "^\\+[1-9]\\d{1,14}$",
487                "title": "Phone Number",
488                "type": "string"
489              }
490            },
491            "required": [
492              "firstName",
493              "lastName",
494              "email",
495              "phoneE164",
496              "jobPosition"
497            ],
498            "type": "object"
499          },
500          "brandedCaller": {
501            "additionalProperties": false,
502            "description": "The information that will be shown on the terminating handset for outbound calls.",
503            "properties": {
504              "displayCallReason": {
505                "description": "The call reason to be shown on the terminating handset for outbound calls. Limit 64 characters.",
506                "maxLength": 64,
507                "minLength": 1,
508                "title": "Branded Calls Call Reason",
509                "type": [
510                  "string",
511                  "null"
512                ]
513              },
514              "displayLogoUrl": {
515                "description": "The URL of the logo to be shown on the terminating handset for outbound calls. Only bmp, png types are supported",
516                "format": "uri",
517                "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
518                "title": "Branded Calls Logo URL",
519                "type": [
520                  "string",
521                  "null"
522                ]
523              },
524              "displayName": {
525                "description": "The display name to be shown on the terminating handset for outbound calls. The display name can be up to 35 characters.",
526                "maxLength": 35,
527                "minLength": 1,
528                "title": "Branded Calls Display Name",
529                "type": "string"
530              }
531            },
532            "required": [
533              "displayName"
534            ],
535            "type": "object"
536          },
537          "business": {
538            "additionalProperties": false,
539            "description": "General business information",
540            "properties": {
541              "employeeCount": {
542                "description": "The number of employees in the business.",
543                "minimum": 1,
544                "title": "Business Employee Count",
545                "type": "integer"
546              },
547              "entityType": {
548                "description": "Business type can be empty or one of Sole Proprietorship, Partnership, Co-operative, Limited Liability Corporation, Non-profit Corporation, Corporation",
549                "enum": [
550                  "Sole Proprietorship",
551                  "Partnership",
552                  "Limited Liability Corporation",
553                  "Co-operative",
554                  "Non-profit Corporation",
555                  "Corporation"
556                ],
557                "title": "Business Type",
558                "type": "string"
559              },
560              "identityType": {
561                "description": "Whether the company is an ISV (independent software vendor) or direct customer.",
562                "enum": [
563                  "direct_customer",
564                  "isv_reseller_or_partner"
565                ],
566                "title": "Business Identity (ISV vs. Direct)",
567                "type": "string"
568              },
569              "industry": {
570                "description": "Business industry should be one of 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",
571                "enum": [
572                  "AUTOMOTIVE",
573                  "AGRICULTURE",
574                  "BANKING",
575                  "CONSTRUCTION",
576                  "CONSUMER",
577                  "EDUCATION",
578                  "ENGINEERING",
579                  "ENERGY",
580                  "OIL_AND_GAS",
581                  "FAST_MOVING_CONSUMER_GOODS",
582                  "FINANCIAL",
583                  "FINTECH",
584                  "FOOD_AND_BEVERAGE",
585                  "GOVERNMENT",
586                  "HEALTHCARE",
587                  "HOSPITALITY",
588                  "INSURANCE",
589                  "LEGAL",
590                  "MANUFACTURING",
591                  "MEDIA",
592                  "ONLINE",
593                  "PROFESSIONAL_SERVICES",
594                  "RAW_MATERIALS",
595                  "REAL_ESTATE",
596                  "RELIGION",
597                  "RETAIL",
598                  "JEWELRY",
599                  "TECHNOLOGY",
600                  "TELECOMMUNICATIONS",
601                  "TRANSPORTATION",
602                  "TRAVEL",
603                  "ELECTRONICS",
604                  "NOT_FOR_PROFIT"
605                ],
606                "title": "Business Industry",
607                "type": "string"
608              },
609              "isSubassigned": {
610                "description": "Choose any one of the following values : [YES, NO]. A sub assigned phone number is where Independent Software Vendor (ISV) assigns the Twilio phone number to their end customer. If you are a direct customer, answer NO.",
611                "enum": [
612                  "YES",
613                  "NO"
614                ],
615                "title": "Will you subassign this number to your end customers?",
616                "type": "string"
617              },
618              "legalName": {
619                "description": "Name of the business entity",
620                "maxLength": 255,
621                "minLength": 1,
622                "title": "Business Name",
623                "type": "string"
624              },
625              "privacyNoticeUrl": {
626                "description": "The privacy notice/policy website that explains how the business collects, uses, and protects personal data.",
627                "format": "uri",
628                "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
629                "title": "Privacy Notice URL",
630                "type": [
631                  "string",
632                  "null"
633                ]
634              },
635              "registrationAuthority": {
636                "description": "The registrar the business is registered with: EIN(US), DUNS",
637                "enum": [
638                  "EIN",
639                  "DUNS"
640                ],
641                "title": "Business Registration Identifier",
642                "type": "string"
643              },
644              "registrationNumber": {
645                "description": "The ID number of the business in the business registrar",
646                "maxLength": 21,
647                "minLength": 1,
648                "title": "Business Registration Number",
649                "type": "string"
650              },
651              "tradeName": {
652                "description": "The trade name or DBA name that the business uses to operate under that is different than the legal name.",
653                "maxLength": 255,
654                "minLength": 1,
655                "title": "Business Trade Name",
656                "type": [
657                  "string",
658                  "null"
659                ]
660              },
661              "websiteUrl": {
662                "description": "The URL of the business website",
663                "format": "uri",
664                "minLength": 1,
665                "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
666                "title": "Website URL",
667                "type": "string"
668              }
669            },
670            "required": [
671              "legalName",
672              "entityType",
673              "identityType",
674              "registrationNumber",
675              "registrationAuthority",
676              "industry",
677              "websiteUrl",
678              "isSubassigned",
679              "employeeCount"
680            ],
681            "type": "object"
682          },
683          "useCase": {
684            "additionalProperties": false,
685            "description": "What the branded calling products will be used for.",
686            "properties": {
687              "callVolumeDaily": {
688                "description": "The number of calls expected to be placed per day.",
689                "minimum": 1,
690                "title": "Call Volume Daily",
691                "type": "integer"
692              },
693              "category": {
694                "description": "The branded calling use case category.",
695                "enum": [
696                  "2FA",
697                  "ACCOUNT_NOTIFICATION",
698                  "AGENTS_FRANCHISES",
699                  "CARRIER_EXEMPT",
700                  "CHARITY",
701                  "CUSTOMER_CARE",
702                  "DELIVERY_NOTIFICATION",
703                  "EMERGENCY",
704                  "FRAUD_ALERT",
705                  "HIGHER_EDUCATION",
706                  "K12_EDUCATION",
707                  "LOW_VOLUME",
708                  "MARKETING",
709                  "MIXED",
710                  "POLITICAL",
711                  "POLLING_VOTING",
712                  "PROXY",
713                  "PUBLIC_SERVICE_ANNOUNCEMENT",
714                  "SECURITY_ALERT",
715                  "SOCIAL",
716                  "SOLE_PROPRIETOR",
717                  "SWEEPSTAKE"
718                ],
719                "title": "Use Case Category",
720                "type": "string"
721              },
722              "categoryApple": {
723                "description": "The branded calling Apple business connect use case category.",
724                "minLength": 1,
725                "title": "Apple Business Connect Use Case Category",
726                "type": [
727                  "string",
728                  "null"
729                ]
730              },
731              "consentDescription": {
732                "description": "The branded calling consent use case description.",
733                "minLength": 1,
734                "title": "Use Case Consent Description",
735                "type": "string"
736              },
737              "description": {
738                "description": "The branded calling use case description.",
739                "minLength": 1,
740                "title": "Use Case Description",
741                "type": "string"
742              }
743            },
744            "required": [
745              "category",
746              "description",
747              "consentDescription",
748              "callVolumeDaily"
749            ],
750            "type": "object"
751          }
752        },
753        "required": [
754          "brandedCaller",
755          "authorizedRepresentative1",
756          "business",
757          "useCase",
758          "address"
759        ],
760        "title": "Enhanced Branded Calling - US",
761        "type": "object",
762        "x-acceptableDocuments": [
763          {
764            "description": "The letter to authorize Twilio to run voice traffic on a given set of Phone Numbers.",
765            "documents": [
766              {
767                "description": "Letter of Authorization containing Brand Name, Tax ID, Tax country, Legal Name, Address, Phone #",
768                "documentType": "letter_of_authorization",
769                "friendlyName": "Letter of Authorization"
770              }
771            ],
772            "friendlyName": "Letter of Authorization"
773          }
774        ]
775      },
776      "subType": "BRANDED_CALLS",
777      "type": "VOICE_TRUST",
778      "version": 9
779    },
780    {
781      "country": "US",
782      "endUserType": "BUSINESS",
783      "friendlyName": "Basic Branded Calling - US",
784      "id": "RNca63d1066fbd5e44eac02d0b3cf6d019",
785      "schema": {
786        "$schema": "http://json-schema.org/draft-07/schema#",
787        "additionalProperties": false,
788        "properties": {
789          "brandedCaller": {
790            "additionalProperties": false,
791            "properties": {
792              "displayLongName": {
793                "description": "An optional longer display name for supported carriers. This should align with your primary display name. Limit 32 characters (including spaces), should always start with a letter and can only contain letters, numbers, periods, commas and spaces.",
794                "maxLength": 32,
795                "minLength": 1,
796                "pattern": "^[a-zA-Z][A-Za-z0-9,.\\s]{1,31}$",
797                "title": "Branded Calls Long Display Name",
798                "type": [
799                  "string",
800                  "null"
801                ]
802              },
803              "displayName": {
804                "description": "The display name to be shown on the terminating handset for outbound calls. The display name can be up to 15 characters (including spaces), should always start with a letter and can only contain letters, numbers, periods, commas and spaces.",
805                "maxLength": 15,
806                "minLength": 1,
807                "pattern": "^[a-zA-Z][A-Za-z0-9,.\\s]{1,14}$",
808                "title": "Branded Calls Display Name",
809                "type": "string"
810              },
811              "voiceIntegrityRegistrationId": {
812                "description": "The registration id of the associated voice integrity registration.",
813                "maxLength": 34,
814                "minLength": 34,
815                "pattern": "^BU[0-9a-fA-F]{32}$",
816                "title": "Voice Integrity Registration Id",
817                "type": "string"
818              }
819            },
820            "required": [
821              "displayName"
822            ],
823            "type": "object"
824          }
825        },
826        "required": [
827          "brandedCaller"
828        ],
829        "title": "Basic Branded Calling - US",
830        "type": "object",
831        "x-acceptableDocuments": [
832          {
833            "description": "The letter to authorize Twilio to run voice traffic on a given set of Phone Numbers.",
834            "documents": [
835              {
836                "description": "Letter of Authorization containing Brand Name, Tax ID, Tax country, Legal Name, Address, Phone #",
837                "documentType": "letter_of_authorization",
838                "friendlyName": "Letter of Authorization"
839              }
840            ],
841            "friendlyName": "Letter of Authorization"
842          }
843        ]
844      },
845      "subType": "BRANDED_CALLS",
846      "type": "VOICE_TRUST",
847      "version": 13
848    }
849  ],
850  "meta": {
851    "key": "items",
852    "nextToken": null,
853    "pageSize": 3,
854    "previousToken": null
855  }
856}

Retrieve a Compliance Regulation

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

Path parameters

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

Query parameters

Parameter	Type	Description
`version`	integer	The version of the Compliance Regulation.

Branded Calling Compliance Regulation IDs and versions

Branded Calling type	Country	Regulation ID	Latest version
US Basic	`US` (United States)	`RNca63d1066fbd5e44eac02d0b3cf6d019`	`13`
US Enhanced	`US` (United States)	`RNa0b74679be7511921f4d2e3094fa6d23`	`9`
Non-US	`GB` (United Kingdom)	`RN304faa2408f673b68867fe5cb65b7f50`	`4`
Non-US	`DE` (Germany)	`RN5db7f1c57f6157280b28428ede4db708`	`4`
Non-US	`CA` (Canada)	`RNa5150dedb5f110adba478ce9dde61d56`	`4`

US Basic Branded CallingUS Enhanced Branded CallingNon-US Branded Calling

US Basic Branded Calling: Retrieve the Compliance Regulation

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

Output

1{
2  "country": "US",
3  "endUserType": "BUSINESS",
4  "friendlyName": "Basic Branded Calling - US",
5  "id": "RNca63d1066fbd5e44eac02d0b3cf6d019",
6  "schema": {
7    "$schema": "http://json-schema.org/draft-07/schema#",
8    "additionalProperties": false,
9    "properties": {
10      "brandedCaller": {
11        "additionalProperties": false,
12        "properties": {
13          "displayLongName": {
14            "description": "An optional longer display name for supported carriers. This should align with your primary display name. Limit 32 characters (including spaces), should always start with a letter and can only contain letters, numbers, periods, commas and spaces.",
15            "maxLength": 32,
16            "minLength": 1,
17            "pattern": "^[a-zA-Z][A-Za-z0-9,.\\s]{1,31}$",
18            "title": "Branded Calls Long Display Name",
19            "type": [
20              "string",
21              "null"
22            ]
23          },
24          "displayName": {
25            "description": "The display name to be shown on the terminating handset for outbound calls. The display name can be up to 15 characters (including spaces), should always start with a letter and can only contain letters, numbers, periods, commas and spaces.",
26            "maxLength": 15,
27            "minLength": 1,
28            "pattern": "^[a-zA-Z][A-Za-z0-9,.\\s]{1,14}$",
29            "title": "Branded Calls Display Name",
30            "type": "string"
31          },
32          "voiceIntegrityRegistrationId": {
33            "description": "The registration id of the associated voice integrity registration.",
34            "maxLength": 34,
35            "minLength": 34,
36            "pattern": "^BU[0-9a-fA-F]{32}$",
37            "title": "Voice Integrity Registration Id",
38            "type": "string"
39          }
40        },
41        "required": [
42          "displayName"
43        ],
44        "type": "object"
45      }
46    },
47    "required": [
48      "brandedCaller"
49    ],
50    "title": "Basic Branded Calling - US",
51    "type": "object",
52    "x-acceptableDocuments": [
53      {
54        "description": "The letter to authorize Twilio to run voice traffic on a given set of Phone Numbers.",
55        "documents": [
56          {
57            "description": "Letter of Authorization containing Brand Name, Tax ID, Tax country, Legal Name, Address, Phone #",
58            "documentType": "letter_of_authorization",
59            "friendlyName": "Letter of Authorization"
60          }
61        ],
62        "friendlyName": "Letter of Authorization"
63      }
64    ]
65  },
66  "subType": "BRANDED_CALLS",
67  "type": "VOICE_TRUST",
68  "version": 13
69}

US Enhanced Branded Calling: Retrieve the Compliance Regulation

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

Output

1{
2  "country": "US",
3  "endUserType": "BUSINESS",
4  "friendlyName": "Enhanced Branded Calling - US",
5  "id": "RNa0b74679be7511921f4d2e3094fa6d23",
6  "schema": {
7    "$schema": "http://json-schema.org/draft-07/schema#",
8    "additionalProperties": false,
9    "properties": {
10      "address": {
11        "additionalProperties": false,
12        "description": "Physical address of your business.",
13        "properties": {
14          "id": {
15            "description": "Must be a valid address",
16            "maxLength": 34,
17            "minLength": 34,
18            "pattern": "^AD[0-9a-fA-F]{32}$",
19            "title": "Address id",
20            "type": "string"
21          }
22        },
23        "required": [
24          "id"
25        ],
26        "type": "object"
27      },
28      "authorizedContact": {
29        "additionalProperties": false,
30        "description": "If you are an ISV registering for Branded Calling on behalf of an end user, please ensure the brand contact is an individual from the end user's company.",
31        "properties": {
32          "firstName": {
33            "description": "The first name of the authorized contact.",
34            "minLength": 1,
35            "title": "First Name",
36            "type": "string"
37          },
38          "lastName": {
39            "description": "The last name of the authorized contact.",
40            "minLength": 1,
41            "title": "Last Name",
42            "type": "string"
43          },
44          "mobilePhoneE164": {
45            "description": "The mobile phone number of the authorized contact.",
46            "pattern": "^\\+[1-9]\\d{1,14}$",
47            "title": "Mobile Phone Number",
48            "type": "string"
49          },
50          "verificationEmail": {
51            "description": "The verification email address of the authorized contact.",
52            "format": "email",
53            "minLength": 1,
54            "pattern": "^\\S+@\\S+\\.\\S+$",
55            "title": "Verification Email Address",
56            "type": "string"
57          }
58        },
59        "required": [
60          "firstName",
61          "lastName",
62          "verificationEmail",
63          "mobilePhoneE164"
64        ],
65        "type": "object"
66      },
67      "authorizedRepresentative1": {
68        "additionalProperties": false,
69        "description": "Authorized Representative #1",
70        "properties": {
71          "email": {
72            "description": "The email address of the authorized representative.",
73            "format": "email",
74            "minLength": 1,
75            "pattern": "^\\S+@\\S+\\.\\S+$",
76            "title": "Email Address",
77            "type": "string"
78          },
79          "firstName": {
80            "description": "The first name of the authorized representative.",
81            "minLength": 1,
82            "title": "First Name",
83            "type": "string"
84          },
85          "jobPosition": {
86            "description": "The job position of the authorized representative.",
87            "enum": [
88              "Director",
89              "GM",
90              "VP",
91              "CEO",
92              "CFO",
93              "General Counsel",
94              "Other"
95            ],
96            "title": "Job Position",
97            "type": "string"
98          },
99          "lastName": {
100            "description": "The last name of the authorized representative.",
101            "minLength": 1,
102            "title": "Last Name",
103            "type": "string"
104          },
105          "phoneE164": {
106            "description": "The phone number of the authorized representative.",
107            "minLength": 1,
108            "pattern": "^\\+[1-9]\\d{1,14}$",
109            "title": "Phone Number",
110            "type": "string"
111          }
112        },
113        "required": [
114          "firstName",
115          "lastName",
116          "email",
117          "phoneE164",
118          "jobPosition"
119        ],
120        "type": "object"
121      },
122      "brandedCaller": {
123        "additionalProperties": false,
124        "description": "The information that will be shown on the terminating handset for outbound calls.",
125        "properties": {
126          "displayCallReason": {
127            "description": "The call reason to be shown on the terminating handset for outbound calls. Limit 64 characters.",
128            "maxLength": 64,
129            "minLength": 1,
130            "title": "Branded Calls Call Reason",
131            "type": [
132              "string",
133              "null"
134            ]
135          },
136          "displayLogoUrl": {
137            "description": "The URL of the logo to be shown on the terminating handset for outbound calls. Only bmp, png types are supported",
138            "format": "uri",
139            "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
140            "title": "Branded Calls Logo URL",
141            "type": [
142              "string",
143              "null"
144            ]
145          },
146          "displayName": {
147            "description": "The display name to be shown on the terminating handset for outbound calls. The display name can be up to 35 characters.",
148            "maxLength": 35,
149            "minLength": 1,
150            "title": "Branded Calls Display Name",
151            "type": "string"
152          }
153        },
154        "required": [
155          "displayName"
156        ],
157        "type": "object"
158      },
159      "business": {
160        "additionalProperties": false,
161        "description": "General business information",
162        "properties": {
163          "employeeCount": {
164            "description": "The number of employees in the business.",
165            "minimum": 1,
166            "title": "Business Employee Count",
167            "type": "integer"
168          },
169          "entityType": {
170            "description": "Business type can be empty or one of Sole Proprietorship, Partnership, Co-operative, Limited Liability Corporation, Non-profit Corporation, Corporation",
171            "enum": [
172              "Sole Proprietorship",
173              "Partnership",
174              "Limited Liability Corporation",
175              "Co-operative",
176              "Non-profit Corporation",
177              "Corporation"
178            ],
179            "title": "Business Type",
180            "type": "string"
181          },
182          "identityType": {
183            "description": "Whether the company is an ISV (independent software vendor) or direct customer.",
184            "enum": [
185              "direct_customer",
186              "isv_reseller_or_partner"
187            ],
188            "title": "Business Identity (ISV vs. Direct)",
189            "type": "string"
190          },
191          "industry": {
192            "description": "Business industry should be one of 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",
193            "enum": [
194              "AUTOMOTIVE",
195              "AGRICULTURE",
196              "BANKING",
197              "CONSTRUCTION",
198              "CONSUMER",
199              "EDUCATION",
200              "ENGINEERING",
201              "ENERGY",
202              "OIL_AND_GAS",
203              "FAST_MOVING_CONSUMER_GOODS",
204              "FINANCIAL",
205              "FINTECH",
206              "FOOD_AND_BEVERAGE",
207              "GOVERNMENT",
208              "HEALTHCARE",
209              "HOSPITALITY",
210              "INSURANCE",
211              "LEGAL",
212              "MANUFACTURING",
213              "MEDIA",
214              "ONLINE",
215              "PROFESSIONAL_SERVICES",
216              "RAW_MATERIALS",
217              "REAL_ESTATE",
218              "RELIGION",
219              "RETAIL",
220              "JEWELRY",
221              "TECHNOLOGY",
222              "TELECOMMUNICATIONS",
223              "TRANSPORTATION",
224              "TRAVEL",
225              "ELECTRONICS",
226              "NOT_FOR_PROFIT"
227            ],
228            "title": "Business Industry",
229            "type": "string"
230          },
231          "isSubassigned": {
232            "description": "Choose any one of the following values : [YES, NO]. A sub assigned phone number is where Independent Software Vendor (ISV) assigns the Twilio phone number to their end customer. If you are a direct customer, answer NO.",
233            "enum": [
234              "YES",
235              "NO"
236            ],
237            "title": "Will you subassign this number to your end customers?",
238            "type": "string"
239          },
240          "legalName": {
241            "description": "Name of the business entity",
242            "maxLength": 255,
243            "minLength": 1,
244            "title": "Business Name",
245            "type": "string"
246          },
247          "privacyNoticeUrl": {
248            "description": "The privacy notice/policy website that explains how the business collects, uses, and protects personal data.",
249            "format": "uri",
250            "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
251            "title": "Privacy Notice URL",
252            "type": [
253              "string",
254              "null"
255            ]
256          },
257          "registrationAuthority": {
258            "description": "The registrar the business is registered with: EIN(US), DUNS",
259            "enum": [
260              "EIN",
261              "DUNS"
262            ],
263            "title": "Business Registration Identifier",
264            "type": "string"
265          },
266          "registrationNumber": {
267            "description": "The ID number of the business in the business registrar",
268            "maxLength": 21,
269            "minLength": 1,
270            "title": "Business Registration Number",
271            "type": "string"
272          },
273          "tradeName": {
274            "description": "The trade name or DBA name that the business uses to operate under that is different than the legal name.",
275            "maxLength": 255,
276            "minLength": 1,
277            "title": "Business Trade Name",
278            "type": [
279              "string",
280              "null"
281            ]
282          },
283          "websiteUrl": {
284            "description": "The URL of the business website",
285            "format": "uri",
286            "minLength": 1,
287            "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
288            "title": "Website URL",
289            "type": "string"
290          }
291        },
292        "required": [
293          "legalName",
294          "entityType",
295          "identityType",
296          "registrationNumber",
297          "registrationAuthority",
298          "industry",
299          "websiteUrl",
300          "isSubassigned",
301          "employeeCount"
302        ],
303        "type": "object"
304      },
305      "useCase": {
306        "additionalProperties": false,
307        "description": "What the branded calling products will be used for.",
308        "properties": {
309          "callVolumeDaily": {
310            "description": "The number of calls expected to be placed per day.",
311            "minimum": 1,
312            "title": "Call Volume Daily",
313            "type": "integer"
314          },
315          "category": {
316            "description": "The branded calling use case category.",
317            "enum": [
318              "2FA",
319              "ACCOUNT_NOTIFICATION",
320              "AGENTS_FRANCHISES",
321              "CARRIER_EXEMPT",
322              "CHARITY",
323              "CUSTOMER_CARE",
324              "DELIVERY_NOTIFICATION",
325              "EMERGENCY",
326              "FRAUD_ALERT",
327              "HIGHER_EDUCATION",
328              "K12_EDUCATION",
329              "LOW_VOLUME",
330              "MARKETING",
331              "MIXED",
332              "POLITICAL",
333              "POLLING_VOTING",
334              "PROXY",
335              "PUBLIC_SERVICE_ANNOUNCEMENT",
336              "SECURITY_ALERT",
337              "SOCIAL",
338              "SOLE_PROPRIETOR",
339              "SWEEPSTAKE"
340            ],
341            "title": "Use Case Category",
342            "type": "string"
343          },
344          "categoryApple": {
345            "description": "The branded calling Apple business connect use case category.",
346            "minLength": 1,
347            "title": "Apple Business Connect Use Case Category",
348            "type": [
349              "string",
350              "null"
351            ]
352          },
353          "consentDescription": {
354            "description": "The branded calling consent use case description.",
355            "minLength": 1,
356            "title": "Use Case Consent Description",
357            "type": "string"
358          },
359          "description": {
360            "description": "The branded calling use case description.",
361            "minLength": 1,
362            "title": "Use Case Description",
363            "type": "string"
364          }
365        },
366        "required": [
367          "category",
368          "description",
369          "consentDescription",
370          "callVolumeDaily"
371        ],
372        "type": "object"
373      }
374    },
375    "required": [
376      "brandedCaller",
377      "authorizedRepresentative1",
378      "business",
379      "useCase",
380      "address"
381    ],
382    "title": "Enhanced Branded Calling - US",
383    "type": "object",
384    "x-acceptableDocuments": [
385      {
386        "description": "The letter to authorize Twilio to run voice traffic on a given set of Phone Numbers.",
387        "documents": [
388          {
389            "description": "Letter of Authorization containing Brand Name, Tax ID, Tax country, Legal Name, Address, Phone #",
390            "documentType": "letter_of_authorization",
391            "friendlyName": "Letter of Authorization"
392          }
393        ],
394        "friendlyName": "Letter of Authorization"
395      }
396    ]
397  },
398  "subType": "BRANDED_CALLS",
399  "type": "VOICE_TRUST",
400  "version": 9
401}

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

Non-US Branded Calling (UK): Retrieve the Compliance Regulation

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

Output

1{
2  "country": "GB",
3  "endUserType": "BUSINESS",
4  "friendlyName": "Branded Calling - UK",
5  "id": "RN304faa2408f673b68867fe5cb65b7f50",
6  "schema": {
7    "$schema": "http://json-schema.org/draft-07/schema#",
8    "additionalProperties": false,
9    "properties": {
10      "address": {
11        "additionalProperties": false,
12        "description": "Physical address of your business.",
13        "properties": {
14          "id": {
15            "description": "Must be a valid address",
16            "maxLength": 34,
17            "minLength": 34,
18            "pattern": "^AD[0-9a-fA-F]{32}$",
19            "title": "Address id",
20            "type": "string"
21          }
22        },
23        "required": [
24          "id"
25        ],
26        "type": "object"
27      },
28      "authorizedContact": {
29        "additionalProperties": false,
30        "description": "If you are an ISV registering for Branded Calling on behalf of an end user, please ensure the brand contact is an individual from the end user's company.",
31        "properties": {
32          "firstName": {
33            "description": "The first name of the authorized contact.",
34            "minLength": 1,
35            "title": "First Name",
36            "type": "string"
37          },
38          "lastName": {
39            "description": "The last name of the authorized contact.",
40            "minLength": 1,
41            "title": "Last Name",
42            "type": "string"
43          },
44          "mobilePhoneE164": {
45            "description": "The mobile phone number of the authorized contact.",
46            "pattern": "^\\+[1-9]\\d{1,14}$",
47            "title": "Mobile Phone Number",
48            "type": "string"
49          },
50          "verificationEmail": {
51            "description": "The verification email address of the authorized contact.",
52            "format": "email",
53            "minLength": 1,
54            "pattern": "^\\S+@\\S+\\.\\S+$",
55            "title": "Verification Email Address",
56            "type": "string"
57          }
58        },
59        "required": [
60          "firstName",
61          "lastName",
62          "verificationEmail",
63          "mobilePhoneE164"
64        ],
65        "type": "object"
66      },
67      "authorizedRepresentative1": {
68        "additionalProperties": false,
69        "description": "Authorized Representative #1",
70        "properties": {
71          "email": {
72            "description": "The email address of the authorized representative.",
73            "format": "email",
74            "minLength": 1,
75            "pattern": "^\\S+@\\S+\\.\\S+$",
76            "title": "Email Address",
77            "type": "string"
78          },
79          "firstName": {
80            "description": "The first name of the authorized representative.",
81            "minLength": 1,
82            "title": "First Name",
83            "type": "string"
84          },
85          "jobPosition": {
86            "description": "The job position of the authorized representative.",
87            "enum": [
88              "Director",
89              "GM",
90              "VP",
91              "CEO",
92              "CFO",
93              "General Counsel",
94              "Other"
95            ],
96            "title": "Job Position",
97            "type": "string"
98          },
99          "lastName": {
100            "description": "The last name of the authorized representative.",
101            "minLength": 1,
102            "title": "Last Name",
103            "type": "string"
104          },
105          "phoneE164": {
106            "description": "The phone number of the authorized representative.",
107            "minLength": 1,
108            "pattern": "^\\+[1-9]\\d{1,14}$",
109            "title": "Phone Number",
110            "type": "string"
111          }
112        },
113        "required": [
114          "firstName",
115          "lastName",
116          "email",
117          "phoneE164",
118          "jobPosition"
119        ],
120        "type": "object"
121      },
122      "brandedCaller": {
123        "additionalProperties": false,
124        "description": "The information that will be shown on the terminating handset for outbound calls.",
125        "properties": {
126          "displayName": {
127            "description": "The display name to be shown on the terminating handset for outbound calls. The display name can be up to 32 characters.",
128            "maxLength": 32,
129            "minLength": 1,
130            "title": "Branded Calls Display Name",
131            "type": "string"
132          }
133        },
134        "required": [
135          "displayName"
136        ],
137        "type": "object"
138      },
139      "business": {
140        "additionalProperties": false,
141        "description": "General business information",
142        "properties": {
143          "employeeCount": {
144            "description": "The number of employees in the business.",
145            "minimum": 1,
146            "title": "Business Employee Count",
147            "type": "integer"
148          },
149          "entityType": {
150            "description": "Business type can be empty or one of Sole Proprietorship, Partnership, Co-operative, Limited Liability Corporation, Non-profit Corporation, Corporation",
151            "enum": [
152              "Sole Proprietorship",
153              "Partnership",
154              "Limited Liability Corporation",
155              "Co-operative",
156              "Non-profit Corporation",
157              "Corporation"
158            ],
159            "title": "Business Type",
160            "type": "string"
161          },
162          "identityType": {
163            "description": "Whether the company is an ISV (independent software vendor) or direct customer.",
164            "enum": [
165              "direct_customer",
166              "isv_reseller_or_partner"
167            ],
168            "title": "Business Identity (ISV vs. Direct)",
169            "type": "string"
170          },
171          "industry": {
172            "description": "Business industry should be one of 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",
173            "enum": [
174              "AUTOMOTIVE",
175              "AGRICULTURE",
176              "BANKING",
177              "CONSTRUCTION",
178              "CONSUMER",
179              "EDUCATION",
180              "ENGINEERING",
181              "ENERGY",
182              "OIL_AND_GAS",
183              "FAST_MOVING_CONSUMER_GOODS",
184              "FINANCIAL",
185              "FINTECH",
186              "FOOD_AND_BEVERAGE",
187              "GOVERNMENT",
188              "HEALTHCARE",
189              "HOSPITALITY",
190              "INSURANCE",
191              "LEGAL",
192              "MANUFACTURING",
193              "MEDIA",
194              "ONLINE",
195              "PROFESSIONAL_SERVICES",
196              "RAW_MATERIALS",
197              "REAL_ESTATE",
198              "RELIGION",
199              "RETAIL",
200              "JEWELRY",
201              "TECHNOLOGY",
202              "TELECOMMUNICATIONS",
203              "TRANSPORTATION",
204              "TRAVEL",
205              "ELECTRONICS",
206              "NOT_FOR_PROFIT"
207            ],
208            "title": "Business Industry",
209            "type": "string"
210          },
211          "isSubassigned": {
212            "description": "Choose any one of the following values : [YES, NO]. A sub assigned phone number is where Independent Software Vendor (ISV) assigns the Twilio phone number to their end customer. If you are a direct customer, answer NO.",
213            "enum": [
214              "YES",
215              "NO"
216            ],
217            "title": "Will you subassign this number to your end customers?",
218            "type": "string"
219          },
220          "legalName": {
221            "description": "Name of the business entity",
222            "maxLength": 255,
223            "minLength": 1,
224            "title": "Business Name",
225            "type": "string"
226          },
227          "privacyNoticeUrl": {
228            "description": "The privacy notice/policy website that explains how the business collects, uses, and protects personal data.",
229            "format": "uri",
230            "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
231            "title": "Privacy Notice URL",
232            "type": [
233              "string",
234              "null"
235            ]
236          },
237          "registrationAuthority": {
238            "description": "The registrar the business is registered with: EIN(US), DUNS, CBN(CA), CCN(CA), CRN(UK), OTHER",
239            "enum": [
240              "EIN",
241              "DUNS",
242              "CBN",
243              "CCN",
244              "CRN",
245              "OTHER"
246            ],
247            "title": "Business Registration Identifier",
248            "type": "string"
249          },
250          "registrationNumber": {
251            "description": "The ID number of the business in the business registrar",
252            "maxLength": 21,
253            "minLength": 1,
254            "title": "Business Registration Number",
255            "type": "string"
256          },
257          "tradeName": {
258            "description": "The trade name or DBA name that the business uses to operate under that is different than the legal name.",
259            "maxLength": 255,
260            "minLength": 1,
261            "title": "Business Trade Name",
262            "type": [
263              "string",
264              "null"
265            ]
266          },
267          "websiteUrl": {
268            "description": "The URL of the business website",
269            "format": "uri",
270            "minLength": 1,
271            "pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\/\/(?:[Ww]{3}\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&/=]*)$",
272            "title": "Website URL",
273            "type": "string"
274          }
275        },
276        "required": [
277          "legalName",
278          "entityType",
279          "identityType",
280          "registrationNumber",
281          "registrationAuthority",
282          "industry",
283          "websiteUrl",
284          "isSubassigned",
285          "employeeCount"
286        ],
287        "type": "object"
288      },
289      "useCase": {
290        "additionalProperties": false,
291        "description": "What the branded calling products will be used for.",
292        "properties": {
293          "callVolumeDaily": {
294            "description": "The number of calls expected to be placed per day.",
295            "minimum": 1,
296            "title": "Call Volume Daily",
297            "type": "integer"
298          },
299          "category": {
300            "description": "The branded calling use case category.",
301            "enum": [
302              "2FA",
303              "ACCOUNT_NOTIFICATION",
304              "AGENTS_FRANCHISES",
305              "CARRIER_EXEMPT",
306              "CHARITY",
307              "CUSTOMER_CARE",
308              "DELIVERY_NOTIFICATION",
309              "EMERGENCY",
310              "FRAUD_ALERT",
311              "HIGHER_EDUCATION",
312              "K12_EDUCATION",
313              "LOW_VOLUME",
314              "MARKETING",
315              "MIXED",
316              "POLITICAL",
317              "POLLING_VOTING",
318              "PROXY",
319              "PUBLIC_SERVICE_ANNOUNCEMENT",
320              "SECURITY_ALERT",
321              "SOCIAL",
322              "SOLE_PROPRIETOR",
323              "SWEEPSTAKE"
324            ],
325            "title": "Use Case Category",
326            "type": "string"
327          },
328          "consentDescription": {
329            "description": "The branded calling consent use case description.",
330            "minLength": 1,
331            "title": "Use Case Consent Description",
332            "type": "string"
333          },
334          "description": {
335            "description": "The branded calling use case description.",
336            "minLength": 1,
337            "title": "Use Case Description",
338            "type": "string"
339          }
340        },
341        "required": [
342          "category",
343          "description",
344          "consentDescription",
345          "callVolumeDaily"
346        ],
347        "type": "object"
348      }
349    },
350    "required": [
351      "brandedCaller",
352      "authorizedRepresentative1",
353      "business",
354      "useCase",
355      "address"
356    ],
357    "title": "Branded Calling - UK",
358    "type": "object",
359    "x-acceptableDocuments": [
360      {
361        "description": "The letter to authorize Twilio to run voice traffic on a given set of Phone Numbers.",
362        "documents": [
363          {
364            "description": "Letter of Authorization containing Brand Name, Tax ID, Tax country, Legal Name, Address, Phone #",
365            "documentType": "letter_of_authorization",
366            "friendlyName": "Letter of Authorization"
367          }
368        ],
369        "friendlyName": "Letter of Authorization"
370      }
371    ]
372  },
373  "subType": "BRANDED_CALLS",
374  "type": "VOICE_TRUST",
375  "version": 4
376}