Menu

Expand
Rate this page:

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
sid<OY> Not PII

The unique string that identifies the Supporting Document Type resource.

friendly_name
string Not PII

A human-readable description of the Supporting Document Type resource.

machine_name
string Not PII

The machine-readable description of the Supporting Document Type resource.

fields
object[] Not PII

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
url Not PII

The absolute URL of the Supporting Document Type resource.

Retrieve a list of Supporting Document Types

get
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}
Parameters
Parameters in REST API format
sid
Path
get sid_like<OY> Not PII

The unique string that identifies the Supporting Document Type resource.

Example 1
        
        
        
        

        Read a Supporting Document Type resource instance

        get
        https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes
        Example 1
              
              
              
              
              Rate this page:

              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 browsing the Twilio tag on Stack Overflow.

                    
                    
                    

                    Thank you for your feedback!

                    We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    Refer us and get $10 in 3 simple steps!

                    Step 1

                    Get link

                    Get a free personal referral link here

                    Step 2

                    Give $10

                    Your user signs up and upgrade using link

                    Step 3

                    Get $10

                    1,250 free SMSes
                    OR 1,000 free voice mins
                    OR 12,000 chats
                    OR more