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 Bundles REST API allows you to create empty Regulatory Bundle containers. The Regulatory Bundles are Item Assignments of End-Users and Supporting Documents for regulatory compliance.
The field of the Bundle resource response is in JSON. The type SID<BU> is a unique ID starting with letters BU. For more information about Twilio SIDs, please refer to Twilio's glossary on SIDs.
The URLs of the Assigned Items of the Bundle resource.
Bundle Statuses
The following statuses encompass the Bundle lifecycle.
Status
Description
draft
The user has created a new Bundle that can be edited with Supporting Documents and End-User objects assigned.
pending-review
When the user has finished the draft of the Bundle and submits to Twilio for review, the status moves from draft to pending-review.
in-review
Twilio has moved the Bundle from pending-review to in-review. Once Twilio has finished review, the Bundle will go either to twilio-approved or twilio-rejected.
twilio-rejected
Twilio has reviewed the Bundle and has determined the Bundle does not meet the regulations.
twilio-approved
Twilio has reviewed the Bundle and has determined the Bundles does meet the regulations.
Status Callback
The status callback configuration of the Regulatory Bundle will send a POST request to the URL specified. Every time the Regulatory Bundle changes status, Twilio will send a request to the status callback webhook.
Field
Description
Account SID
The SID of the Account that created the Bundle resource.
Bundle SID
The unique string that we created to identify the Bundle resource.
Status
The verification status of the Bundle resource. See Bundle Statuses for a list of possible values.
Failure Reason
The description(s) of what incorrect configuration the Regulatory Bundle currently has.
Create a Bundle
POST https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles
To provision or port a phone number to Twilio, you will need to create a new Bundle that will contain all the information required to follow local telco Regulations.
The Bundle is a container that references the required Regulatory Compliance information set forth by the regulating telecom body of the end-user who actually answers the phone call or receives the message.
When creating the Bundle, you will specify the following parameters IsoCountry, NumberType, and EndUserType so you can follow compliance for a Regulation.
GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles
If your application requires local inbound connectivity in many number types within a country or with many countries, you will have to create many Regulatory Bundle containers with all necessary information.
Date to filter Bundles having their valid_until_date before or after the specified date. Can be ValidUntilDate>= or ValidUntilDate<=. Both can be used in conjunction as well. ISO 8601 is the acceptable date format.
Date to filter Bundles having their valid_until_date before or after the specified date. Can be ValidUntilDate>= or ValidUntilDate<=. Both can be used in conjunction as well. ISO 8601 is the acceptable date format.
Date to filter Bundles having their valid_until_date before or after the specified date. Can be ValidUntilDate>= or ValidUntilDate<=. Both can be used in conjunction as well. ISO 8601 is the acceptable date format.
The DELETE operation is allowed for Regulatory Bundles with status of DRAFT, TWILIO_APPROVED, or TWILIO_REJECTED and have no active Long Code phone number assignments.