Skip to contentSkip to navigationSkip to topbar
Page tools
Useful for sharing or LLM
Accelerate development with AI
On this page
Looking for more inspiration?Visit the

SupportingDocument Resource

SupportingDocument Properties

supportingdocument-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
sidSID<RD>

Optional

Not PII

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

Pattern: ^RD[0-9a-fA-F]{32}$Min length: 34Max length: 34
accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the Document resource.

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

Optional

Not PII

The string that you assigned to describe the resource.

mimeTypestring

Optional

Not PII

The image type uploaded in the Supporting Document container.

statusenum<string>

Optional

Not PII

The verification status of the Supporting Document resource.

Possible values:
DRAFTPENDING_REVIEWREJECTEDAPPROVEDEXPIREDPROVISIONALLY_APPROVED
typestring

Optional

Not PII

The type of the Supporting Document.

attributes

Optional

PII MTL: 30 days

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

dateCreatedstring<date-time>

Optional

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.

dateUpdatedstring<date-time>

Optional

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.

urlstring<uri>

Optional

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

Request body parameters

request-body-parameters page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
friendlyNamestring
required
Not PII

The string that you assigned to describe the resource.

typestring
required
Not PII

The type of the Supporting Document.

attributes

Optional

PII MTL: 30 days

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

Create a new Supporting DocumentLink to code sample: Create a new Supporting Document
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

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

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function createSupportingDocument() {

14
  const supportingDocument =

15
    await client.trusthub.v1.supportingDocuments.create({

16
      friendlyName: "FriendlyName",

17
      type: "Type",

18
    });

19


20
  console.log(supportingDocument.sid);

21
}

22


23
createSupportingDocument();

Response

Note about this response
1
{

2
  "status": "DRAFT",

3
  "date_updated": "2021-02-11T17:23:00Z",

4
  "friendly_name": "FriendlyName",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-11T17:23:00Z",

8
  "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

9
  "attributes": {

10
    "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
  },

12
  "type": "Type",

13
  "mime_type": null

14
}

Fetch specific Supporting Document Instance

fetch-specific-supporting-document-instance page anchor

GET https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
sidSID<RD>
required
Not PII

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

Pattern: ^RD[0-9a-fA-F]{32}$Min length: 34Max length: 34
Fetch specific Supporting Document InstanceLink to code sample: Fetch specific Supporting Document Instance
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

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

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function fetchSupportingDocument() {

14
  const supportingDocument = await client.trusthub.v1

15
    .supportingDocuments("RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .fetch();

17


18
  console.log(supportingDocument.sid);

19
}

20


21
fetchSupportingDocument();

Response

Note about this response
1
{

2
  "status": "DRAFT",

3
  "date_updated": "2021-02-11T17:23:00Z",

4
  "friendly_name": "Business-profile-physical-address",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-11T17:23:00Z",

8
  "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

9
  "attributes": {

10
    "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
  },

12
  "type": "customer_profile_address",

13
  "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

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.

Retrieve a list of all Supporting Document for an accountLink to code sample: Retrieve a list of all Supporting Document for an account
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

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

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function listSupportingDocument() {

14
  const supportingDocuments = await client.trusthub.v1.supportingDocuments.list(

15
    { limit: 20 },

16
  );

17


18
  supportingDocuments.forEach((s) => console.log(s.sid));

19
}

20


21
listSupportingDocument();

Response

Note about this response
1
{

2
  "results": [],

3
  "meta": {

4
    "page": 0,

5
    "page_size": 50,

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

7
    "previous_page_url": null,

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

9
    "next_page_url": null,

10
    "key": "results"

11
  }

12
}

Update an existing Supporting Document

update-an-existing-supporting-document page anchor

POST https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
sidSID<RD>
required
Not PII

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

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

Request body parameters

request-body-parameters-1 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
friendlyNamestring

Optional

Not PII

The string that you assigned to describe the resource.

attributes

Optional

PII MTL: 30 days

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

Update an existing Supporting DocumentLink to code sample: Update an existing Supporting Document
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

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

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function updateSupportingDocument() {

14
  const supportingDocument = await client.trusthub.v1

15
    .supportingDocuments("RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .update({ friendlyName: "FriendlyName" });

17


18
  console.log(supportingDocument.sid);

19
}

20


21
updateSupportingDocument();

Response

Note about this response
1
{

2
  "status": "DRAFT",

3
  "date_updated": "2021-02-11T17:23:00Z",

4
  "friendly_name": "FriendlyName",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-11T17:23:00Z",

8
  "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

9
  "attributes": {

10
    "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
  },

12
  "type": "customer_profile_address",

13
  "mime_type": null

14
}

Delete a specific Supporting Document

delete-a-specific-supporting-document page anchor

DELETE https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
sidSID<RD>
required
Not PII

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

Pattern: ^RD[0-9a-fA-F]{32}$Min length: 34Max length: 34
Delete a specific Supporting DocumentLink to code sample: Delete a specific Supporting Document
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

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

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function deleteSupportingDocument() {

14
  await client.trusthub.v1

15
    .supportingDocuments("RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .remove();

17
}

18


19
deleteSupportingDocument();