Item Assignments Resource
Warning
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.
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
sid
type: SID<BV>
The unique string that we created to identify the Item Assignment resource.
bundle_sid
type: SID<BU>
The unique string that we created to identify the Bundle resource.
object_sid
type: SID
The SID of an object bag that holds information of the different items.
date_created
type: string<DATE TIME>
url
type: string<URI>
The absolute URL of the Identity resource.
POST 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.
URI parameters
BundleSid
type: SID<BU>
The unique string that we created to identify the Bundle resource.
Request body parameters
ObjectSid
type: SIDRequired
The SID of an object bag that holds information of the different items.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.numbers.v2.regulatoryCompliance
_12 .bundles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .create({objectSid: 'RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'})
_12 .then(item_assignment => console.log(item_assignment.sid));
_10 "sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "bundle_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "object_sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "2019-07-31T02:34:41Z",
_10 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ItemAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
URI parameters
BundleSid
type: SID<BU>
The unique string that we created to identify the Bundle resource.
Sid
type: SID<BV>
The unique string that we created to identify the Identity resource.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.numbers.v2.regulatoryCompliance
_12 .bundles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .itemAssignments('BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(item_assignment => console.log(item_assignment.sid));
_10 "sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "bundle_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "object_sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "2019-07-31T02:34:41Z",
_10 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ItemAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
URI parameters
BundleSid
type: SID<BU>
The unique string that we created to identify the Bundle resource.
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.numbers.v2.regulatoryCompliance
_12 .bundles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(itemAssignments => itemAssignments.forEach(i => console.log(i.sid)));
_21 "sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "bundle_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "object_sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "date_created": "2019-07-31T02:34:41Z",
_21 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ItemAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_21 "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ItemAssignments?PageSize=50&Page=0",
_21 "previous_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ItemAssignments?PageSize=50&Page=0",
_21 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ItemAssignments?PageSize=50&Page=0",
_21 "next_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ItemAssignments?PageSize=50&Page=1",
DELETE https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
URI parameters
BundleSid
type: SID<BU>
The unique string that we created to identify the Bundle resource.
Sid
type: SID<BV>
The unique string that we created to identify the Identity resource.
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.numbers.v2.regulatoryCompliance
_11 .bundles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .itemAssignments('BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')