Supporting Documents 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 Supporting Documents resource of Twilio's Regulatory Compliance APIs allows you to create new Supporting Documents with metadata to fulfill Regulations. Each Supporting Document Type may need different information to be compliant, so be sure to pass all of the correct values when creating a new Supporting Document Type.
A collection of Supporting Documents Assigned as Items to a Regulatory Bundle along with an End-User satisfies a Regulation.
Supporting Documents Response Properties
The field of the Supporting Documents resource responds is in JSON. The type SID <RD> is a unique ID starting with letters RD that reference a unique Supporting Document instance. 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 Supporting Document resource. |
account_sid
|
The SID of the Account that created the Document resource. |
friendly_name
|
The string that you assigned to describe the resource. |
mime_type
|
The image type uploaded in the Supporting Document container. |
status
|
The verification status of the Supporting Document resource. |
failure_reason
|
The failure reason of the Supporting Document Resource. |
type
|
The type of the Supporting Document. |
attributes
|
The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document 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 Supporting Document resource. |
Supporting Document Statuses
The following statuses encompass the Bundle lifecycle.
| Status | Description |
| draft | The draft status of the Supporting Document allows users to edit the Supporting Document file and metadata. |
| pending-review | When the user has finished the draft and submits the Supporting Document for review, the status moves from draft to pending-review, awaiting Twilio's. |
| rejected | Twilio has reviewed the Supporting Document and has determined the Supporting Document does not comply with the regulations. |
| approved | Twilio has reviewed the Supporting Document and has determined the Supporting Document does not comply with the regulations. |
| expired | The document has expired and is no longer valid to provision phone numbers. An updated document must be created and added to a new or existing Bundle. |
Create a Supporting Document
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments
To provision or port in a phone number to Twilio, you will need to create one or many Supporting Documents that also may need an image as proof.
A Supporting Document is a container that holds metadata of a legal document. Each Supporting Document Type requires a different value during the create operation.
The Regulation may need the End-User to upload an image as proof for the Supporting Document. Formats accepted are JPEG, PNG, and PDF, with a file size limit of 5 MB.
Parameters
| Parameters in REST API format | |
|---|---|
friendly_name
Required
|
The string that you assigned to describe the resource. |
type
Required
|
The type of the Supporting Document. |
attributes
Optional
|
The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types. |
Example 1
Example 2
Fetch a Supporting Document instance
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The unique string created by Twilio to identify the Supporting Document resource. |
Example 1
Retrieve a list of Supporting Documents
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments
Example 1
Update a Supporting Document Instance
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The unique string created by Twilio to identify the Supporting Document 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 Supporting Document resource which are derived Supporting Document Types. |
Example 1
Delete a Supporting Document instance
https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/{Sid}
The DELETE operation is allowed for Supporting Documents with status of DRAFT, APPROVED, or REJECTED and have no active Long Code phone number assignments.
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The unique string created by Twilio to identify the Supporting Document 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.
