On this page

TrustProduct Resource

TrustProduct Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<BU>

Optional

Not PII

The unique string that we created to identify the Trust Product resource.

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

account_sidSID<AC>

Optional

Not PII

The SID of the Account that created the Trust Product resource.

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

policy_sidSID<RN>

Optional

Not PII

The unique string of the policy that is associated with the Trust Product resource.

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

friendly_namestring

Optional

Not PII

The string that you assigned to describe the resource.

statusenum<string>

Optional

Not PII

The verification status of the Trust Product resource.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

valid_untilstring<date-time>

Optional

Not PII

The date and time in GMT in ISO 8601 format until which the resource will be valid.

emailstring

Optional

Not PII

The email address that will receive updates when the Trust Product resource changes status.

status_callbackstring<uri>

Optional

Not PII

The URL we call to inform your application of status changes.

date_createdstring<date-time>

Optional

Not PII

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

date_updatedstring<date-time>

Optional

Not PII

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

urlstring<uri>

Optional

Not PII

The absolute URL of the Trust Product resource.

linksobject<uri-map>

Optional

Not PII

The URLs of the Assigned Items of the Trust Product resource.

errorsarray

Optional

Not PII

The error codes associated with the rejection of the Trust Product.

Create a TrustProduct resource

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringrequired

Not PII

The string that you assigned to describe the resource.

Emailstringrequired

Not PII

The email address that will receive updates when the Trust Product resource changes status.

PolicySidSID<RN>required

Not PII

The unique string of a policy that is associated to the Trust Product resource.

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

StatusCallbackstring<uri>

Optional

Not PII

The URL we call to inform your application of status changes.

Create a TrustProduct

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createTrustProduct() {
11  const trustProduct = await client.trusthub.v1.trustProducts.create({
12    email: "Email",
13    friendlyName: "FriendlyName",
14    policySid: "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15  });
16
17  console.log(trustProduct.sid);
18}
19
20createTrustProduct();

Output

1{
2  "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "friendly_name": "FriendlyName",
6  "status": "draft",
7  "email": "Email",
8  "status_callback": "http://www.example.com",
9  "valid_until": null,
10  "date_created": "2019-07-30T22:29:24Z",
11  "date_updated": "2019-07-31T01:09:00Z",
12  "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",
15    "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",
16    "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"
17  },
18  "errors": null
19}

Fetch a TrustProduct resource

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

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<BU>required

Not PII

The unique string that we created to identify the Trust Product resource.

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

Fetch a TrustProduct

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchTrustProduct() {
11  const trustProduct = await client.trusthub.v1
12    .trustProducts("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(trustProduct.sid);
16}
17
18fetchTrustProduct();

Output

1{
2  "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "friendly_name": "friendly_name",
6  "status": "draft",
7  "valid_until": null,
8  "email": "email",
9  "status_callback": "http://www.example.com",
10  "date_created": "2019-07-30T22:29:24Z",
11  "date_updated": "2019-07-31T01:09:00Z",
12  "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",
15    "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",
16    "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"
17  },
18  "errors": [
19    {
20      "code": 18601
21    }
22  ]
23}

Read multiple TrustProduct resources

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

Query parameters

Property nameTypeRequiredPIIDescription

Statusenum<string>

Optional

Not PII

The verification status of the Trust Product resource.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

FriendlyNamestring

Optional

Not PII

The string that you assigned to describe the resource.

PolicySidSID<RN>

Optional

Not PII

The unique string of a policy that is associated to the Trust Product resource.

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

PageSizeinteger

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 TrustProducts

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listTrustProduct() {
11  const trustProducts = await client.trusthub.v1.trustProducts.list({
12    limit: 20,
13  });
14
15  trustProducts.forEach((t) => console.log(t.sid));
16}
17
18listTrustProduct();

Output

1{
2  "results": [],
3  "meta": {
4    "page": 0,
5    "page_size": 50,
6    "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0",
7    "previous_page_url": null,
8    "url": "https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0",
9    "next_page_url": null,
10    "key": "results"
11  }
12}

Update a TrustProduct resource

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

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<BU>required

Not PII

The unique string that we created to identify the Trust Product resource.

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

Statusenum<string>

Optional

Not PII

The verification status of the Trust Product resource. If the current verification status of the Trust Product is draft, you may set the verification status to pending-review to submit the TrustProduct for Twilio review. No other values for status are permissible when updating a resource via this API endpoint as the other states are maintained by Twilio.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

StatusCallbackstring<uri>

Optional

Not PII

The URL we call to inform your application of status changes.

FriendlyNamestring

Optional

Not PII

The string that you assigned to describe the resource.

Emailstring

Optional

Not PII

The email address that will receive updates when the Trust Product resource changes status.

Update a TrustProduct

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateTrustProduct() {
11  const trustProduct = await client.trusthub.v1
12    .trustProducts("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .update({ status: "draft" });
14
15  console.log(trustProduct.sid);
16}
17
18updateTrustProduct();

Output

1{
2  "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "friendly_name": "friendly_name",
6  "status": "draft",
7  "email": "email",
8  "status_callback": "http://www.example.com",
9  "valid_until": null,
10  "date_created": "2019-07-30T22:29:24Z",
11  "date_updated": "2019-07-31T01:09:00Z",
12  "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",
15    "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",
16    "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"
17  },
18  "errors": null
19}

Delete a TrustProduct resource

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

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<BU>required

Not PII

The unique string that we created to identify the Trust Product resource.

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

Delete a TrustProduct

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteTrustProduct() {
11  await client.trusthub.v1
12    .trustProducts("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .remove();
14}
15
16deleteTrustProduct();