Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

SupportingDocument Resource



SupportingDocument Properties

supportingdocument-properties page anchor
Resource properties
sidtype: SID<RD>Not PII

The unique string created by Twilio to identify the Supporting Document resource.


friendly_nametype: stringNot PII

The string that you assigned to describe the resource.


mime_typetype: stringNot PII

The image type uploaded in the Supporting Document container.


statustype: enum<STRING>Not PII

The verification status of the Supporting Document resource.

Possible values:
draftpending-reviewrejectedapprovedexpiredprovisionally-approved

typetype: stringNot PII

The type of the Supporting Document.


attributestype: objectPII MTL: 30 days

The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.


date_createdtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.


date_updatedtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.


urltype: string<URI>Not PII

The absolute URL of the Supporting Document resource.


Create a new Supporting Document.

create-a-new-supporting-document page anchor
POST https://trusthub.twilio.com/v1/SupportingDocuments

Parameters

create-parameters page anchor
Request body parameters
FriendlyNametype: stringNot PII
Required

The string that you assigned to describe the resource.


Typetype: stringNot PII
Required

The type of the Supporting Document.


Attributestype: objectPII MTL: 30 days

The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.

Create a SupportingDocument

create-a-supportingdocument page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.supportingDocuments
_10
.create({friendlyName: 'friendly_name', type: 'type'})
_10
.then(supporting_document => console.log(supporting_document.sid));

Output

_14
{
_14
"status": "draft",
_14
"date_updated": "2021-02-11T17:23:00Z",
_14
"friendly_name": "Business-profile-physical-address",
_14
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"date_created": "2021-02-11T17:23:00Z",
_14
"sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"attributes": {
_14
"address_sids": "ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_14
},
_14
"type": "customer_profile_address",
_14
"mime_type": null
_14
}


Fetch specific Supporting Document Instance.

fetch-specific-supporting-document-instance page anchor
GET https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}

URI parameters
Sidtype: SID<RD>Not PII
Path Parameter

The unique string created by Twilio to identify the Supporting Document resource.

Fetch a SupportingDocument

fetch-a-supportingdocument page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.supportingDocuments('RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(supporting_document => console.log(supporting_document.friendlyName));

Output

_14
{
_14
"status": "draft",
_14
"date_updated": "2021-02-11T17:23:00Z",
_14
"friendly_name": "Business-profile-physical-address",
_14
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"date_created": "2021-02-11T17:23:00Z",
_14
"sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"attributes": {
_14
"address_sids": "ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_14
},
_14
"type": "customer_profile_address",
_14
"mime_type": null
_14
}


Retrieve a list of all Supporting Document for an account.

retrieve-a-list-of-all-supporting-document-for-an-account page anchor
GET https://trusthub.twilio.com/v1/SupportingDocuments

URI parameters
PageSizetype: integerNot PII
Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.


Pagetype: integerNot PII
Query Parameter

The page index. This value is simply for client state.


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple SupportingDocuments

list-multiple-supportingdocuments page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.supportingDocuments
_10
.list({limit: 20})
_10
.then(supportingDocuments => supportingDocuments.forEach(s => console.log(s.sid)));

Output

_27
{
_27
"results": [
_27
{
_27
"status": "draft",
_27
"date_updated": "2021-02-11T17:23:00Z",
_27
"friendly_name": "Business-profile-physical-address",
_27
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_27
"url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_27
"date_created": "2021-02-11T17:23:00Z",
_27
"sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_27
"attributes": {
_27
"address_sids": "ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_27
},
_27
"type": "customer_profile_address",
_27
"mime_type": null
_27
}
_27
],
_27
"meta": {
_27
"page": 0,
_27
"page_size": 50,
_27
"first_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0",
_27
"previous_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0",
_27
"url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0",
_27
"next_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=1",
_27
"key": "results"
_27
}
_27
}


Update an existing Supporting Document.

update-an-existing-supporting-document page anchor
POST https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}

URI parameters
Sidtype: SID<RD>Not PII
Path Parameter

The unique string created by Twilio to identify the Supporting Document resource.


Request body parameters
FriendlyNametype: stringNot PII

The string that you assigned to describe the resource.


Attributestype: objectPII MTL: 30 days

The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.

Update a SupportingDocument

update-a-supportingdocument page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.supportingDocuments('RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({friendlyName: 'friendly_name'})
_10
.then(supporting_document => console.log(supporting_document.friendlyName));

Output

_14
{
_14
"status": "draft",
_14
"date_updated": "2021-02-11T17:23:00Z",
_14
"friendly_name": "friendly_name",
_14
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"date_created": "2021-02-11T17:23:00Z",
_14
"sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"attributes": {
_14
"address_sids": "ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_14
},
_14
"type": "customer_profile_address",
_14
"mime_type": null
_14
}


Delete a specific Supporting Document.

delete-a-specific-supporting-document page anchor
DELETE https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}

URI parameters
Sidtype: SID<RD>Not PII
Path Parameter

The unique string created by Twilio to identify the Supporting Document resource.

Delete a SupportingDocument

delete-a-supportingdocument page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.supportingDocuments('RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.remove();


Rate this page: