End-Users 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 REST API allows you to create End-Users to follow Regulations. The End-User is the entity that answers the phone call or receives the message of a phone number. An entity can be either an individual or a business. You can find more information about the possible End-Users by referencing End-User Type resource.
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 Response Properties
The fields of the End-User resource response is in JSON. The type SID <IT> is a unique ID starting with letters IT. For more information about Twilio SIDs, please refer to Twilio's glossary on SIDs.
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string created by Twilio to identify the End User resource. |
account_sid
|
The SID of the Account that created the End User resource. |
friendly_name
|
The string that you assigned to describe the resource. |
type
|
The type of end user of the Bundle resource - can be |
attributes
|
The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
url
|
The absolute URL of the End User resource. |
Create a new End-User
https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers
To provision or port a phone number to Twilio, you will need to create a new End-User of a phone number.
The End-User is the individual or business who answers the phone call or receives the message.
You will need to assign the End-User to a Regulatory Bundle and that Regulatory Bundle assigned to a Phone Number.
Parameters
| Parameters in REST API format | |
|---|---|
friendly_name
Required
|
The string that you assigned to describe the resource. |
type
Required
|
The type of end user of the Bundle resource - can be |
attributes
Optional
|
The set of parameters that are the attributes of the End User resource which are derived End User Types. |
Example 1
Note: the EndUserType must be either individual or business.
Fetch an End-User Instance
https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The unique string created by Twilio to identify the End User resource. |
Example 1
List all End-Users
https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers
Example 1
Update an End-User instance
https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The unique string created by Twilio to identify the End User resource. |
friendly_name
Optional
|
The string that you assigned to describe the resource. |
attributes
Optional
|
The set of parameters that are the attributes of the End User resource which are derived End User Types. |
Example 1
Delete an End-User instance
https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The unique string created by Twilio to identify the End User resource. |
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.
