Reading Regulations for the UK Bundle
This document previews the Phone Number regulation retrieval that will be possible for Twilio United Kingdom phone numbers as of Jan 29. You will make a LIST call to the regulations endpoint of the regulatory-compliance API, as shown in https://www.twilio.com/docs/phone-numbers/regulatory/getting-started/create-new-bundle-public-rest-apis#regulation-read, but you will use the input parameters specified below for each of the four UK use cases:
Parameters and Values:
iso_country:gbnumber_type:local(NOTE: this value could also benationaland would return identical regulation values)end_user_type:individual
Response json:
1{2"meta": {3"first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=local&PageSize=50&EndUserType=individual&Page=0",4"key": "results",5"next_page_url": null,6"page": 0,7"page_size": 50,8"previous_page_url": null,9"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=local&PageSize=50&EndUserType=individual&Page=0"10},11"results": [12{13"end_user_type": "individual",14"friendly_name": "United Kingdom: Local - Individual",15"iso_country": "GB",16"number_type": "local",17"requirements": {18"end_user": [19{20"constraint": null,21"detailed_fields": [22{23"constraint": null,24"description": "",25"friendly_name": "First Name",26"machine_name": "first_name"27},28{29"constraint": null,30"description": "",31"friendly_name": "Last Name",32"machine_name": "last_name"33},34{35"constraint": null,36"description": "",37"friendly_name": "Contact Email",38"machine_name": "email"39},40{41"constraint": null,42"description": "This must be a valid mobile number only where the customer can be reached. This cannot be a number which you've acquired from a CPaaS provider.",43"friendly_name": "Phone Number",44"machine_name": "phone_number"45},46{47"constraint": null,48"description": "This is an optional field which you can use to specify any additional information that might be useful for vetting your RC Bundle.",49"friendly_name": "Comments (Optional)",50"machine_name": "comments"51}52],53"fields": [54"first_name",55"last_name",56"email",57"phone_number",58"comments"59],60"name": "Individual",61"requirement_name": "individual_info",62"type": "individual",63"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/individual"64}65],66"supporting_document": [67[68{69"accepted_documents": [70{71"constraint": null,72"detailed_fields": [73{74"constraint": null,75"description": "The first name as seen in your government issued document. This must match the first name of the individual.",76"friendly_name": "First Name",77"machine_name": "first_name"78},79{80"constraint": null,81"description": "The last name as seen in your government issued document. This must match the last name of the individual.",82"friendly_name": "Last Name",83"machine_name": "last_name"84}85],86"fields": [87"first_name",88"last_name"89],90"name": "Government-issued ID",91"type": "government_issued_document",92"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/government_issued_document"93},94{95"constraint": null,96"detailed_fields": [97{98"constraint": null,99"description": "The first name as seen in your passport. This must match the first name of the individual.",100"friendly_name": "First Name",101"machine_name": "first_name"102},103{104"constraint": null,105"description": "The last name as seen in your government issued document. This must match the last name of the individual.",106"friendly_name": "Last Name",107"machine_name": "last_name"108}109],110"fields": [111"first_name",112"last_name"113],114"name": "Passport",115"type": "passport",116"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/passport"117}118],119"description": "Document must match the first and last name provided",120"name": "Proof of Identity",121"requirement_name": "proof_of_identity",122"type": "document"123},124{125"accepted_documents": [126{127"constraint": null,128"detailed_fields": [129{130"constraint": null,131"description": "Must be a valid United Kingdom address.",132"friendly_name": "Individual Address Sid",133"machine_name": "address_sids"134}135],136"fields": [137"address_sids"138],139"name": "Government-issued ID",140"type": "government_issued_document",141"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/government_issued_document"142},143{144"constraint": null,145"detailed_fields": [146{147"constraint": null,148"description": "Must be a valid United Kingdom address.",149"friendly_name": "Individual Address Sid",150"machine_name": "address_sids"151}152],153"fields": [154"address_sids"155],156"name": "Utility bill",157"type": "utility_bill",158"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/utility_bill"159},160{161"constraint": null,162"detailed_fields": [163{164"constraint": null,165"description": "Must be a valid United Kingdom address.",166"friendly_name": "Individual Address Sid",167"machine_name": "address_sids"168}169],170"fields": [171"address_sids"172],173"name": "Tax notice",174"type": "tax_document",175"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/tax_document"176},177{178"constraint": null,179"detailed_fields": [180{181"constraint": null,182"description": "Must be a valid United Kingdom address.",183"friendly_name": "Individual Address Sid",184"machine_name": "address_sids"185}186],187"fields": [188"address_sids"189],190"name": "Rent receipt",191"type": "rental_receipt",192"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/rental_receipt"193},194{195"constraint": null,196"detailed_fields": [197{198"constraint": null,199"description": "Must be a valid United Kingdom address.",200"friendly_name": "Individual Address Sid",201"machine_name": "address_sids"202}203],204"fields": [205"address_sids"206],207"name": "Title deed",208"type": "title_deed",209"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/title_deed"210}211],212"description": "Must be within United Kingdom; a PO Box is not acceptable. Supporting document must be issued in the last year.",213"name": "Proof of Address",214"requirement_name": "individual_address_info",215"type": "document"216}217]218]219},220"sid": "RNXXXXXXXXXXXXXXXXXXXX",221"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNXXXXXXXXXXXXXXXXXXXX"222}223]224}
Parameters and Values:
iso_country:gbnumber_type:mobile(NOTE: this value could also betoll_freeand would return identical regulation values)end_user_type:individual
Response json:
1{2"meta": {3"first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=mobile&PageSize=50&EndUserType=individual&Page=0",4"key": "results",5"next_page_url": null,6"page": 0,7"page_size": 50,8"previous_page_url": null,9"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=mobile&PageSize=50&EndUserType=individual&Page=0"10},11"results": [12{13"end_user_type": "individual",14"friendly_name": "United Kingdom: Mobile - Individual",15"iso_country": "GB",16"number_type": "mobile",17"requirements": {18"end_user": [19{20"constraint": null,21"detailed_fields": [22{23"constraint": null,24"description": "",25"friendly_name": "First Name",26"machine_name": "first_name"27},28{29"constraint": null,30"description": "",31"friendly_name": "Last Name",32"machine_name": "last_name"33},34{35"constraint": null,36"description": "",37"friendly_name": "Contact Email",38"machine_name": "email"39},40{41"constraint": null,42"description": "This must be a valid mobile number only where the customer can be reached. This cannot be a number which you've acquired from a CPaaS provider.",43"friendly_name": "Phone Number",44"machine_name": "phone_number"45},46{47"constraint": null,48"description": "This is an optional field which you can use to specify any additional information that might be useful for vetting your RC Bundle.",49"friendly_name": "Comments (Optional)",50"machine_name": "comments"51}52],53"fields": [54"first_name",55"last_name",56"email",57"phone_number",58"comments"59],60"name": "Individual",61"requirement_name": "individual_info",62"type": "individual",63"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/individual"64}65],66"supporting_document": [67[68{69"accepted_documents": [70{71"constraint": null,72"detailed_fields": [73{74"constraint": null,75"description": "The first name as seen in your government issued document. This must match the first name of the individual.",76"friendly_name": "First Name",77"machine_name": "first_name"78},79{80"constraint": null,81"description": "The last name as seen in your government issued document. This must match the last name of the individual.",82"friendly_name": "Last Name",83"machine_name": "last_name"84}85],86"fields": [87"first_name",88"last_name"89],90"name": "Government-issued ID",91"type": "government_issued_document",92"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/government_issued_document"93},94{95"constraint": null,96"detailed_fields": [97{98"constraint": null,99"description": "The first name as seen in your passport. This must match the first name of the individual.",100"friendly_name": "First Name",101"machine_name": "first_name"102},103{104"constraint": null,105"description": "The last name as seen in your government issued document. This must match the last name of the individual.",106"friendly_name": "Last Name",107"machine_name": "last_name"108}109],110"fields": [111"first_name",112"last_name"113],114"name": "Passport",115"type": "passport",116"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/passport"117}118],119"description": "Document must match the first and last name provided",120"name": "Proof of Identity",121"requirement_name": "proof_of_identity",122"type": "document"123},124{125"accepted_documents": [126{127"constraint": null,128"detailed_fields": [129{130"constraint": null,131"description": "Must be a valid address. May be anywhere in the world.",132"friendly_name": "Individual Address Sid",133"machine_name": "address_sids"134}135],136"fields": [137"address_sids"138],139"name": "Individual Address",140"type": "individual_address",141"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/individual_address"142}143],144"description": "May be anywhere in the world; a PO Box is not acceptable.",145"name": "Proof of Address",146"requirement_name": "individual_address_info",147"type": "document"148}149]150]151},152"sid": "RNXXXXXXXXXXXXXXXXX",153"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNXXXXXXXXXXXXXXXXX"154}155]156}
Parameters and Values:
iso_country:gbnumber_type:local(NOTE: this value could also benationaland would return identical regulation values)end_user_type:business
Response json:
1{2"meta": {3"first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=local&PageSize=50&EndUserType=business&Page=0",4"key": "results",5"next_page_url": null,6"page": 0,7"page_size": 50,8"previous_page_url": null,9"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=local&PageSize=50&EndUserType=business&Page=0"10},11"results": [12{13"end_user_type": "business",14"friendly_name": "United Kingdom: Local - Business",15"iso_country": "GB",16"number_type": "local",17"requirements": {18"end_user": [19{20"constraint": null,21"detailed_fields": [22{23"constraint": null,24"description": "",25"friendly_name": "Business Name",26"machine_name": "business_name"27},28{29"constraint": null,30"description": "Choose one of the following values: UK:CRN, US:EIN, CA:CBN, AU:ACN, OTHER ",31"friendly_name": "Registration Authority",32"machine_name": "business_registration_identifier"33},34{35"constraint": null,36"description": "Business registration number provided by the Registration Authority",37"friendly_name": "Business Registration Number",38"machine_name": "business_registration_number"39},40{41"constraint": null,42"description": "Public facing website or verified social media account",43"friendly_name": "Business Website",44"machine_name": "business_website"45},46{47"constraint": null,48"description": "",49"friendly_name": "Authorized Representative's First Name",50"machine_name": "first_name"51},52{53"constraint": null,54"description": "",55"friendly_name": "Authorized Representative's Last Name",56"machine_name": "last_name"57},58{59"constraint": null,60"description": "This must be a valid mobile number only where the customer can be reached. This cannot be a number which you've acquired from a CPaaS provider.",61"friendly_name": "Authorized Representative's Phone Number",62"machine_name": "phone_number"63},64{65"constraint": null,66"description": "Domain should match business name or website",67"friendly_name": "Authorized Representative's Work Email",68"machine_name": "email"69},70{71"constraint": null,72"description": "Choose any one of the following values: [DIRECT_CUSTOMER, INDEPENDENT_SOFTWARE_VENDOR]. Use 'DIRECT_CUSTOMER' if your business uses this phone number to communicate internally or with your customers. Use 'INDEPENDENT_SOFTWARE_VENDOR' if your business uses this phone number in a product that you sell to your customers.",73"friendly_name": "Business Classification",74"machine_name": "business_identity"75},76{77"constraint": null,78"description": "Choose any one of the following values : [YES, NO]. A sub assigned phone number is where Independent Software Vendor (ISV) assigns the phone number to their end customer. If you are a direct customer, answer NO.",79"friendly_name": "Is this number being assigned to the end customer ?",80"machine_name": "is_subassigned"81},82{83"constraint": null,84"description": "This is an optional field which you can use to specify any additional information that might be useful for vetting your RC Bundle.",85"friendly_name": "Comments (Optional)",86"machine_name": "comments"87}88],89"fields": [90"business_name",91"business_registration_identifier",92"business_registration_number",93"business_website",94"first_name",95"last_name",96"phone_number",97"email",98"business_identity",99"is_subassigned",100"comments"101],102"name": "Business",103"requirement_name": "business_info",104"type": "business",105"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/business"106}107],108"supporting_document": [109[110{111"accepted_documents": [112{113"constraint": null,114"detailed_fields": [115{116"constraint": null,117"description": "Must be a valid United Kingdom address.",118"friendly_name": "Business Address sid",119"machine_name": "address_sids"120}121],122"fields": [123"address_sids"124],125"name": "Business address",126"type": "business_address",127"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/business_address"128}129],130"description": "Must be within United Kingdom; a PO Box is not acceptable.",131"name": "Business Address (Proof of Address)",132"requirement_name": "business_address",133"type": "document"134}135]136]137},138"sid": "RNXXXXXXXXXXXX",139"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNXXXXXXXXXXXX"140}141]142}
Parameters and Values:
iso_country:gbnumber_type:mobile(NOTE: this value could also betoll_freeand would return identical regulation values)end_user_type:business
Response json:
1{2"meta": {3"first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=mobile&PageSize=50&EndUserType=business&Page=0",4"key": "results",5"next_page_url": null,6"page": 0,7"page_size": 50,8"previous_page_url": null,9"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=gb&NumberType=mobile&PageSize=50&EndUserType=business&Page=0"10},11"results": [12{13"end_user_type": "business",14"friendly_name": "United Kingdom: Mobile - Business",15"iso_country": "GB",16"number_type": "mobile",17"requirements": {18"end_user": [19{20"constraint": null,21"detailed_fields": [22{23"constraint": null,24"description": "",25"friendly_name": "Business Name",26"machine_name": "business_name"27},28{29"constraint": null,30"description": "Choose one of the following values: UK:CRN, US:EIN, CA:CBN, AU:ACN, OTHER ",31"friendly_name": "Registration Authority",32"machine_name": "business_registration_identifier"33},34{35"constraint": null,36"description": "Business registration number provided by the Registration Authority",37"friendly_name": "Business Registration Number",38"machine_name": "business_registration_number"39},40{41"constraint": null,42"description": "Public facing website or verified social media account",43"friendly_name": "Business Website",44"machine_name": "business_website"45},46{47"constraint": null,48"description": "",49"friendly_name": "Authorized Representative's First Name",50"machine_name": "first_name"51},52{53"constraint": null,54"description": "",55"friendly_name": "Authorized Representative's Last Name",56"machine_name": "last_name"57},58{59"constraint": null,60"description": "This must be a valid mobile number only where the customer can be reached. This cannot be a number which you've acquired from a CPaaS provider.",61"friendly_name": "Authorized Representative's Phone Number",62"machine_name": "phone_number"63},64{65"constraint": null,66"description": "Domain should match business name or website",67"friendly_name": "Authorized Representative's Work Email",68"machine_name": "email"69},70{71"constraint": null,72"description": "Choose any one of the following values: [DIRECT_CUSTOMER, INDEPENDENT_SOFTWARE_VENDOR]. Use 'DIRECT_CUSTOMER' if your business uses this phone number to communicate internally or with your customers. Use 'INDEPENDENT_SOFTWARE_VENDOR' if your business uses this phone number in a product that you sell to your customers.",73"friendly_name": "Business Classification",74"machine_name": "business_identity"75},76{77"constraint": null,78"description": "Choose any one of the following values : [YES, NO]. A sub assigned phone number is where Independent Software Vendor (ISV) assigns the phone number to their end customer. If you are a direct customer, answer NO.",79"friendly_name": "Is this number being assigned to the end customer ?",80"machine_name": "is_subassigned"81},82{83"constraint": null,84"description": "This is an optional field which you can use to specify any additional information that might be useful for vetting your RC Bundle.",85"friendly_name": "Comments (Optional)",86"machine_name": "comments"87}88],89"fields": [90"business_name",91"business_registration_identifier",92"business_registration_number",93"business_website",94"first_name",95"last_name",96"phone_number",97"email",98"business_identity",99"is_subassigned",100"comments"101],102"name": "Business",103"requirement_name": "business_info",104"type": "business",105"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/business"106}107],108"supporting_document": [109[110{111"accepted_documents": [112{113"constraint": null,114"detailed_fields": [115{116"constraint": null,117"description": "May be anywhere in the world; a PO Box is not acceptable.",118"friendly_name": "Business Address sid",119"machine_name": "address_sids"120}121],122"fields": [123"address_sids"124],125"name": "Business address",126"type": "business_address",127"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/business_address"128}129],130"description": "May be anywhere in the world; a PO Box is not acceptable.",131"name": "Proof of Address",132"requirement_name": "business_address",133"type": "document"134}135]136]137},138"sid": "RNXXXXXXXXXXXXXXXX",139"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNXXXXXXXXXXXXXXXX"140}141]142}