Supporting Document Types Resource
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.
Supporting Document Types Response Properties
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.
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that identifies the Supporting Document Type resource. |
friendly_name
|
A human-readable description of the Supporting Document Type resource. |
machine_name
|
The machine-readable description of the Supporting Document Type resource. |
fields
|
The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals. |
url
|
The absolute URL of the Supporting Document Type resource. |
Retrieve a list of Supporting Document Types
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The unique string that identifies the Supporting Document Type resource. |
Example 1
Read a Supporting Document Type resource instance
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
