The v2 Regulatory Compliance APIs are currently in Public Beta. No breaking changes in the API contract will occur when the API moves from Public Beta to GA.
The Supporting Document Type resource of Twilio's Regulatory Compliance API informs you which type of document you create and what the values are. You will then create a new Supporting Document with the correct type and values.
Each Supporting Document Type may need different information to be compliant. Supporting Documents Assigned as Items to a Regulatory Bundle along with an End-User satisfy a Regulation.
The field of the Supporting Document Types resource response is in JSON. The type SID<OY> is a unique ID starting with letters OY. For more information about Twilio SIDs, please refer to Twilio's glossary on SIDs.
The unique string that identifies the Supporting Document Type resource.
^OY[0-9a-fA-F]{32}$Min length: 34Max length: 34A human-readable description of the Supporting Document Type resource.
The machine-readable description of the Supporting Document Type resource.
The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals.
The absolute URL of the Supporting Document Type resource.
GET https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}The unique string that identifies the Supporting Document Type resource.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listSupportingDocumentType() {11const supportingDocumentTypes =12await client.numbers.v2.regulatoryCompliance.supportingDocumentTypes.list({13limit: 20,14});1516supportingDocumentTypes.forEach((s) => console.log(s.sid));17}1819listSupportingDocumentType();
1{2"supporting_document_types": [],3"meta": {4"page": 0,5"page_size": 50,6"first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0",7"previous_page_url": null,8"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0",9"next_page_url": null,10"key": "supporting_document_types"11}12}
GET https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypesHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function fetchSupportingDocumentType() {11const supportingDocumentType = await client.numbers.v2.regulatoryCompliance12.supportingDocumentTypes("Sid")13.fetch();1415console.log(supportingDocumentType.sid);16}1718fetchSupportingDocumentType();
1{2"sid": "Sid",3"friendly_name": "Passport",4"machine_name": "passport",5"fields": [6{7"friendly_name": "Last Name",8"machine_name": "last_name",9"constraint": "String"10}11],12"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"13}