On this page

SupportingDocument Resource

SupportingDocument Properties

Property nameTypePIIDescription

sidSID<RD>

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

account_sidSID<AC>

Not PII

The SID of the Account that created the Document resource.

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

friendly_namestring

Not PII

The string that you assigned to describe the resource.

mime_typestring

Not PII

The image type uploaded in the Supporting Document container.

statusenum<string>

Not PII

The verification status of the Supporting Document resource.

Possible values:

draftpending-reviewrejectedapprovedexpiredprovisionally-approved

typestring

Not PII

The type of the Supporting Document.

attributesobject

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.

date_createdstring<date-time>

Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring<date-time>

Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring<uri>

Not PII

The absolute URL of the Supporting Document resource.

Create a new Supporting Document.

POST https://trusthub.twilio.com/v1/SupportingDocuments

Request body parameters

Property nameTypeRequiredPIIDescription

FriendlyNamestringrequired

Not PII

The string that you assigned to describe the resource.

Typestringrequired

Not PII

The type of the Supporting Document.

AttributesobjectOptional

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 SupportingDocument

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20
_20async function createSupportingDocument() {
_20  const supportingDocument =
_20    await client.trusthub.v1.supportingDocuments.create({
_20      friendlyName: "FriendlyName",
_20      type: "Type",
_20    });
_20
_20  console.log(supportingDocument.sid);
_20}
_20
_20createSupportingDocument();

Output


_14{
_14  "status": "draft",
_14  "date_updated": "2021-02-11T17:23:00Z",
_14  "friendly_name": "FriendlyName",
_14  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14  "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14  "date_created": "2021-02-11T17:23:00Z",
_14  "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14  "attributes": {
_14    "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_14  },
_14  "type": "Type",
_14  "mime_type": null
_14}

Fetch specific Supporting Document Instance.

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

Path parameters

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 a SupportingDocument

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const 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
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function fetchSupportingDocument() {
_18  const supportingDocument = await client.trusthub.v1
_18    .supportingDocuments("RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .fetch();
_18
_18  console.log(supportingDocument.sid);
_18}
_18
_18fetchSupportingDocument();

Output


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

Retrieve a list of all Supporting Document for an account.

GET https://trusthub.twilio.com/v1/SupportingDocuments

Query parameters

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 SupportingDocuments

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const 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
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listSupportingDocument() {
_18  const supportingDocuments = await client.trusthub.v1.supportingDocuments.list(
_18    { limit: 20 }
_18  );
_18
_18  supportingDocuments.forEach((s) => console.log(s.sid));
_18}
_18
_18listSupportingDocument();

Output


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

Update an existing Supporting Document.

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

Path parameters

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

Property nameTypeRequiredPIIDescription

FriendlyNamestringOptional

Not PII

The string that you assigned to describe the resource.

AttributesobjectOptional

PII 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

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const 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
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function updateSupportingDocument() {
_18  const supportingDocument = await client.trusthub.v1
_18    .supportingDocuments("RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .update({ friendlyName: "FriendlyName" });
_18
_18  console.log(supportingDocument.sid);
_18}
_18
_18updateSupportingDocument();

Output


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

Delete a specific Supporting Document.

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

Path parameters

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 SupportingDocument

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function deleteSupportingDocument() {
_16  await client.trusthub.v1
_16    .supportingDocuments("RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_16    .remove();
_16}
_16
_16deleteSupportingDocument();