Supporting Document Types Resource Warning 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(link takes you to an external page)
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 .
Property name Type PII Description
The unique string that identifies the Supporting Document Type resource.
Pattern: ^OY[0-9a-fA-F]{32}$Min length: 34Max length: 34
A 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}Property name Type Required PII Description
The unique string that identifies the Supporting Document Type resource.
_19 // Download the helper library from https://www.twilio.com/docs/node/install
_19 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19 // Find your Account SID and Auth Token at twilio.com/console
_19 // and set the environment variables. See http://twil.io/secure
_19 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19 const authToken = process.env.TWILIO_AUTH_TOKEN;
_19 const client = twilio(accountSid, authToken);
_19 async function listSupportingDocumentType() {
_19 const supportingDocumentTypes =
_19 await client.numbers.v2.regulatoryCompliance.supportingDocumentTypes.list({
_19 supportingDocumentTypes.forEach((s) => console.log(s.sid));
_19 listSupportingDocumentType();
_12 "supporting_document_types": [],
_12 "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0",
_12 "previous_page_url": null,
_12 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0",
_12 "next_page_url": null,
_12 "key": "supporting_document_types"
GET https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypesProperty name Type Required PII Description
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_18 // Download the helper library from https://www.twilio.com/docs/node/install
_18 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18 // Find your Account SID and Auth Token at twilio.com/console
_18 // and set the environment variables. See http://twil.io/secure
_18 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18 const authToken = process.env.TWILIO_AUTH_TOKEN;
_18 const client = twilio(accountSid, authToken);
_18 async function fetchSupportingDocumentType() {
_18 const supportingDocumentType = await client.numbers.v2.regulatoryCompliance
_18 .supportingDocumentTypes("Sid")
_18 console.log(supportingDocumentType.sid);
_18 fetchSupportingDocumentType();
_13 "friendly_name": "Passport",
_13 "machine_name": "passport",
_13 "friendly_name": "Last Name",
_13 "machine_name": "last_name",
_13 "constraint": "String"
_13 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"