Item Assignments 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 Item Assignments REST API allows you to assign End-Users and Supporting Documents to Regulatory Bundles.
The configuration of the Regulatory Bundle must pass a Regulation (e.g., Germany local phone numbers for a business). Different Regulations need Item Assignments combinations of End-User Types and Supporting Document Types.
With the correct items assigned to the Regulatory Bundle, you can submit the bundle by changing its status. After submission, the Twilio regulatory reviewers will review the Regulatory Bundle.
Item Assignments Response Properties
All the fields returned in the output JSON response compose what an Item Assignment is. The type SID <BV> is a unique ID of an Item Assignment and starts with letters BV. 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 we created to identify the Item Assignment resource. |
bundle_sid
|
The unique string that we created to identify the Bundle resource. |
account_sid
|
The SID of the Account that created the Item Assignment resource. |
object_sid
|
The SID of an object bag that holds information of the different items. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
url
|
The absolute URL of the Identity resource. |
Assign Items to a Regulatory Bundle
https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
To provision or port a phone number on or to Twilio, you will need to assign an End-User to a Regulatory Bundle. The Regulation may need one or more Supporting Documents assignments to a Regulatory Bundle. The Supporting Documents may need an image uploaded as proof.
The Item Assignments to a Regulatory Bundle associate a container with other objects that follows a Regulation
The Regulations are unique by the phone number's country, type, and end-user type.
Parameters
| Parameters in REST API format | |
|---|---|
bundle_sid
Path
|
The unique string that we created to identify the Bundle resource. |
object_sid
Required
|
The SID of an object bag that holds information of the different items. |
Example 1
Retrieve an Item Assignment instance
https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
bundle_sid
Path
|
The unique string that we created to identify the Bundle resource. |
sid
Path
|
The unique string that we created to identify the Identity resource. |
Example 1
List all Bundle Items
https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
Parameters
| Parameters in REST API format | |
|---|---|
bundle_sid
Path
|
The unique string that we created to identify the Bundle resource. |
Example 1
Delete an Item Assignment
https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
bundle_sid
Path
|
The unique string that we created to identify the Bundle resource. |
sid
Path
|
The unique string that we created to identify the Identity 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.
