Skip to contentSkip to navigationSkip to topbar
Twilio Docs
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
friendlyNamestring

Optional

Not PII

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

machineNamestring

Optional

Not PII

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

fieldsarray[object]

Optional

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

The unique string that identifies the Supporting Document Type resource.

Fetch a SupportingDocumentTypeLink to code sample: Fetch a SupportingDocumentType
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function fetchSupportingDocumentType() {

11
  const supportingDocumentType = await client.trusthub.v1

12
    .supportingDocumentTypes("Sid")

13
    .fetch();

14


15
  console.log(supportingDocumentType.sid);

16
}

17


18
fetchSupportingDocumentType();

Response

1
{

2
  "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "fields": [

4
    {

5
      "machine_name": "first_name",

6
      "friendly_name": "First Name",

7
      "constraint": "String"

8
    },

9
    {

10
      "machine_name": "last_name",

11
      "friendly_name": "Last Name",

12
      "constraint": "String"

13
    },

14
    {

15
      "machine_name": "business_name",

16
      "friendly_name": "Business Name",

17
      "constraint": "String"

18
    }

19
  ],

20
  "machine_name": "government_issued_proof_of_authorized_representative",

21
  "friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company",

22
  "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
pageSizeinteger<int64>

Optional

Not PII

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

Minimum: 1Maximum: 1000
pageinteger

Optional

Not PII

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

Minimum: 0
pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List multiple SupportingDocumentTypesLink to code sample: List multiple SupportingDocumentTypes
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function listSupportingDocumentType() {

11
  const supportingDocumentTypes =

12
    await client.trusthub.v1.supportingDocumentTypes.list({ limit: 20 });

13


14
  supportingDocumentTypes.forEach((s) => console.log(s.sid));

15
}

16


17
listSupportingDocumentType();

Response

1
{

2
  "supporting_document_types": [],

3
  "meta": {

4
    "page": 0,

5
    "page_size": 50,

6
    "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",

7
    "previous_page_url": null,

8
    "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",

9
    "next_page_url": null,

10
    "key": "supporting_document_types"

11
  }

12
}