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

SupportingDocumentType Resource

SupportingDocumentType Properties

supportingdocumenttype-properties page anchor
Property nameTypeRequiredDescriptionChild properties
sidSID<OY>Optional
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_namestringOptional
Not PII

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

machine_namestringOptional
Not PII

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

fieldsarrayOptional
Not PII

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>Optional
Not PII

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
Not PII

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

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function fetchSupportingDocumentType() {
_18
const supportingDocumentType = await client.trusthub.v1
_18
.supportingDocumentTypes("Sid")
_18
.fetch();
_18
_18
console.log(supportingDocumentType.sid);
_18
}
_18
_18
fetchSupportingDocumentType();

Output

_23
{
_23
"url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "Sid"
_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

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
PageSizeintegerOptional
Not PII

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

Minimum: 1Maximum: 1000
PageintegerOptional
Not PII

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

Minimum: 0
PageTokenstringOptional
Not PII

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

_17
// Download the helper library from https://www.twilio.com/docs/node/install
_17
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17
// Find your Account SID and Auth Token at twilio.com/console
_17
// and set the environment variables. See http://twil.io/secure
_17
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17
const authToken = process.env.TWILIO_AUTH_TOKEN;
_17
const client = twilio(accountSid, authToken);
_17
_17
async function listSupportingDocumentType() {
_17
const supportingDocumentTypes =
_17
await client.trusthub.v1.supportingDocumentTypes.list({ limit: 20 });
_17
_17
supportingDocumentTypes.forEach((s) => console.log(s.sid));
_17
}
_17
_17
listSupportingDocumentType();

Output

_12
{
_12
"supporting_document_types": [],
_12
"meta": {
_12
"page": 0,
_12
"page_size": 50,
_12
"first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
_12
"previous_page_url": null,
_12
"url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
_12
"next_page_url": null,
_12
"key": "supporting_document_types"
_12
}
_12
}

Rate this page: