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.
Property nameTypePIIDescription
The unique string that we created to identify the Item Assignment resource.
Pattern: ^BV[0-9a-fA-F]{32}$Min length: 34Max length: 34
The unique string that we created to identify the Bundle resource.
Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34
The SID of the Account that created the Item Assignment resource.
Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
The SID of an object bag that holds information of the different items.
Pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$Min length: 34Max length: 34
date_createdstring<date-time>
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.
Property nameTypeRequiredPIIDescription
The unique string that we created to identify the Bundle resource.
Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34
Property nameTypeRequiredPIIDescription
The SID of an object bag that holds information of the different items.
Pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$Min length: 34Max length: 34
_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20async function createItemAssignment() {
_20 const itemAssignment = await client.numbers.v2.regulatoryCompliance
_20 .bundles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_20 .itemAssignments.create({
_20 objectSid: "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 console.log(itemAssignment.sid);
_20createItemAssignment();
_10 "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "object_sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "2019-07-31T02:34:41Z",
_10 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
Property nameTypeRequiredPIIDescription
The unique string that we created to identify the Bundle resource.
Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34
The unique string that we created to identify the Identity resource.
Pattern: ^BV[0-9a-fA-F]{32}$Min length: 34Max length: 34
_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19async function fetchItemAssignment() {
_19 const itemAssignment = await client.numbers.v2.regulatoryCompliance
_19 .bundles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19 .itemAssignments("BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19 console.log(itemAssignment.sid);
_19fetchItemAssignment();
_10 "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10 "date_created": "2019-07-31T02:34:41Z",
_10 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
Property nameTypeRequiredPIIDescription
The unique string that we created to identify the Bundle resource.
Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34
Property nameTypeRequiredPIIDescription
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function listItemAssignment() {
_18 const itemAssignments = await client.numbers.v2.regulatoryCompliance
_18 .bundles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18 .itemAssignments.list({ limit: 20 });
_18 itemAssignments.forEach((i) => console.log(i.sid));
_12 "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0",
_12 "previous_page_url": null,
_12 "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0",
_12 "next_page_url": null,
DELETE https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
Property nameTypeRequiredPIIDescription
The unique string that we created to identify the Bundle resource.
Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34
The unique string that we created to identify the Identity resource.
Pattern: ^BV[0-9a-fA-F]{32}$Min length: 34Max length: 34
_17// Download the helper library from https://www.twilio.com/docs/node/install
_17const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17// Find your Account SID and Auth Token at twilio.com/console
_17// and set the environment variables. See http://twil.io/secure
_17const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17const authToken = process.env.TWILIO_AUTH_TOKEN;
_17const client = twilio(accountSid, authToken);
_17async function deleteItemAssignment() {
_17 await client.numbers.v2.regulatoryCompliance
_17 .bundles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17 .itemAssignments("BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17deleteItemAssignment();