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

SupportingDocumentType Resource



SupportingDocumentType Properties

supportingdocumenttype-properties page anchor
Property nameTypePIIDescription
sidSID<OY>
Not PII

The unique string that identifies the Supporting Document Type resource.

Pattern: ^OY[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestring

A human-readable description of the Supporting Document Type resource.


machine_namestring

The machine-readable description of the Supporting Document Type resource.


fieldsarray

The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals.


urlstring<uri>

The absolute URL of the Supporting Document Type resource.


Fetch a specific Supporting Document Type Instance.

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

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
Sidstringrequired

The unique string that identifies the Supporting Document Type resource.

Fetch a SupportingDocumentType

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

_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
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.trusthub.v1
_11
.supportingDocumentTypes('OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.fetch()
_11
.then(supporting_document_type => console.log(supporting_document_type.friendlyName));

Output

_23
{
_23
"url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"fields": [
_23
{
_23
"machine_name": "first_name",
_23
"friendly_name": "First Name",
_23
"constraint": "String"
_23
},
_23
{
_23
"machine_name": "last_name",
_23
"friendly_name": "Last Name",
_23
"constraint": "String"
_23
},
_23
{
_23
"machine_name": "business_name",
_23
"friendly_name": "Business Name",
_23
"constraint": "String"
_23
}
_23
],
_23
"machine_name": "government_issued_proof_of_authorized_representative",
_23
"friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company",
_23
"sid": "OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_23
}


Retrieve a list of all Supporting Document Types.

retrieve-a-list-of-all-supporting-document-types page anchor
GET https://trusthub.twilio.com/v1/SupportingDocumentTypes

Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

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

Minimum: 1Maximum: 1000

PageintegerOptional

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

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

List multiple SupportingDocumentTypes

list-multiple-supportingdocumenttypes 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.supportingDocumentTypes
_10
.list({limit: 20})
_10
.then(supportingDocumentTypes => supportingDocumentTypes.forEach(s => console.log(s.sid)));

Output

_49
{
_49
"supporting_document_types": [
_49
{
_49
"url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_49
"fields": [
_49
{
_49
"machine_name": "address_sids",
_49
"friendly_name": "Address Sids",
_49
"constraint": "List"
_49
}
_49
],
_49
"machine_name": "customer_profile_address",
_49
"friendly_name": "Customer profile address",
_49
"sid": "OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_49
},
_49
{
_49
"url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_49
"fields": [
_49
{
_49
"machine_name": "first_name",
_49
"friendly_name": "First Name",
_49
"constraint": "String"
_49
},
_49
{
_49
"machine_name": "last_name",
_49
"friendly_name": "Last Name",
_49
"constraint": "String"
_49
},
_49
{
_49
"machine_name": "business_name",
_49
"friendly_name": "Business Name",
_49
"constraint": "String"
_49
}
_49
],
_49
"machine_name": "government_issued_proof_of_authorized_representative",
_49
"friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company",
_49
"sid": "OYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_49
}
_49
],
_49
"meta": {
_49
"page": 0,
_49
"page_size": 50,
_49
"first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
_49
"previous_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
_49
"url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
_49
"next_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=1",
_49
"key": "supporting_document_types"
_49
}
_49
}


Rate this page: