Menu

Expand
Rate this page:

Thanks for rating this page!

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

End-User 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 Twilio End-User Type resource of Twilio's Regulatory Compliance API informs you which type of end-user you can create and what the values are. Once you know which end-user type you want to create and the required values, you will create using the End-User resource. Each End-User Type has a different set of values required to be compliant.

You will Assign Items to an End-User of a Regulatory Bundle with Supporting Documents. For applications that manage many End-Users, you will need to ensure that you assign the End-User instance to the correct Bundle instance to be in compliance with regulations.

End-User Types Response Properties

The output JSON response details the types and values of the `End-User Type` resource. 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 field of the End-User 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.

Names in REST API format
sid
sid<OY> Not PII

The unique string that identifies the End-User Type resource.

friendly_name
string Not PII

A human-readable description that is assigned to describe the End-User Type resource. Examples can include first name, last name, email, business name, etc

machine_name
string Not PII

A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc.

fields
object[] Not PII

The required information for creating an End-User. 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 End-User Type resource.

Fetch an End-User Type Instance

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

The unique string that identifies the End-User Type resource.

Example 1
        
        
        
        

        Retrieve a list of End-User Types

        get
        https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes
        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.