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

Policies Resource

Policies Properties

policies-properties page anchor
Resource properties
sidtype: SID<RN>Not PII

The unique string that identifies the Policy resource.

friendly_nametype: stringNot PII

A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy

requirementstype: objectNot PII

The SID of an object that holds the policy information

urltype: string<URI>Not PII

The absolute URL of the Policy resource.

Fetch specific Policy Instance.

fetch-specific-policy-instance page anchor
GET https://trusthub.twilio.com/v1/Policies/{Sid}

Parameters

fetch-parameters page anchor
URI parameters
Sidtype: SID<RN>Not PII
Path Parameter

The unique string that identifies the Policy resource.

Fetch a Policies

fetch-a-policies page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.policies('RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(policies => console.log(policies.friendlyName));

Output

_76
{
_76
"url": "https://trusthub.twilio.com/v1/Policies/RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_76
"requirements": {
_76
"end_user": [
_76
{
_76
"url": "/EndUserTypes/customer_profile_business_information",
_76
"fields": [
_76
"business_type",
_76
"business_registration_number",
_76
"business_name",
_76
"business_registration_identifier",
_76
"business_identity",
_76
"business_industry",
_76
"website_url",
_76
"business_regions_of_operation",
_76
"social_media_profile_urls"
_76
],
_76
"type": "customer_profile_business_information",
_76
"name": "Business Information",
_76
"requirement_name": "customer_profile_business_information"
_76
},
_76
{
_76
"url": "/EndUserTypes/authorized_representative_1",
_76
"fields": [
_76
"first_name",
_76
"last_name",
_76
"email",
_76
"phone_number",
_76
"business_title",
_76
"job_position"
_76
],
_76
"type": "authorized_representative_1",
_76
"name": "Authorized Representative 1",
_76
"requirement_name": "authorized_representative_1"
_76
},
_76
{
_76
"url": "/EndUserTypes/authorized_representative_2",
_76
"fields": [
_76
"first_name",
_76
"last_name",
_76
"email",
_76
"phone_number",
_76
"business_title",
_76
"job_position"
_76
],
_76
"type": "authorized_representative_2",
_76
"name": "Authorized Representative 2",
_76
"requirement_name": "authorized_representative_2"
_76
}
_76
],
_76
"supporting_trust_products": [],
_76
"supporting_document": [
_76
[
_76
{
_76
"description": "Customer Profile HQ Physical Address",
_76
"type": "document",
_76
"name": "Physical Business Address",
_76
"accepted_documents": [
_76
{
_76
"url": "/SupportingDocumentTypes/customer_profile_address",
_76
"fields": [
_76
"address_sids"
_76
],
_76
"type": "customer_profile_address",
_76
"name": "Physical Business Address"
_76
}
_76
],
_76
"requirement_name": "customer_profile_address"
_76
}
_76
]
_76
],
_76
"supporting_customer_profiles": []
_76
},
_76
"friendly_name": "Primary Customer Profile of type Business",
_76
"sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_76
}

Retrieve a list of all Policys.

retrieve-a-list-of-all-policys page anchor
GET https://trusthub.twilio.com/v1/Policies

Parameters

list-parameters page anchor
URI parameters
PageSizetype: integerNot PII
Query Parameter

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

Pagetype: integerNot PII
Query Parameter

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

PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple Policiess

list-multiple-policiess page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.policies
_10
.list({limit: 20})
_10
.then(policies => policies.forEach(p => console.log(p.sid)));

Output

_89
{
_89
"meta": {
_89
"page": 0,
_89
"page_size": 50,
_89
"first_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0",
_89
"previous_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0",
_89
"url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0",
_89
"next_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=1",
_89
"key": "results"
_89
},
_89
"results": [
_89
{
_89
"url": "https://trusthub.twilio.com/v1/Policies/RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_89
"requirements": {
_89
"end_user": [
_89
{
_89
"url": "/EndUserTypes/customer_profile_business_information",
_89
"fields": [
_89
"business_type",
_89
"business_registration_number",
_89
"business_name",
_89
"business_registration_identifier",
_89
"business_identity",
_89
"business_industry",
_89
"website_url",
_89
"business_regions_of_operation",
_89
"social_media_profile_urls"
_89
],
_89
"type": "customer_profile_business_information",
_89
"name": "Business Information",
_89
"requirement_name": "customer_profile_business_information"
_89
},
_89
{
_89
"url": "/EndUserTypes/authorized_representative_1",
_89
"fields": [
_89
"first_name",
_89
"last_name",
_89
"email",
_89
"phone_number",
_89
"business_title",
_89
"job_position"
_89
],
_89
"type": "authorized_representative_1",
_89
"name": "Authorized Representative 1",
_89
"requirement_name": "authorized_representative_1"
_89
},
_89
{
_89
"url": "/EndUserTypes/authorized_representative_2",
_89
"fields": [
_89
"first_name",
_89
"last_name",
_89
"email",
_89
"phone_number",
_89
"business_title",
_89
"job_position"
_89
],
_89
"type": "authorized_representative_2",
_89
"name": "Authorized Representative 2",
_89
"requirement_name": "authorized_representative_2"
_89
}
_89
],
_89
"supporting_trust_products": [],
_89
"supporting_document": [
_89
[
_89
{
_89
"description": "Customer Profile HQ Physical Address",
_89
"type": "document",
_89
"name": "Physical Business Address",
_89
"accepted_documents": [
_89
{
_89
"url": "/SupportingDocumentTypes/customer_profile_address",
_89
"fields": [
_89
"address_sids"
_89
],
_89
"type": "customer_profile_address",
_89
"name": "Physical Business Address"
_89
}
_89
],
_89
"requirement_name": "customer_profile_address"
_89
}
_89
]
_89
],
_89
"supporting_customer_profiles": []
_89
},
_89
"friendly_name": "Primary Customer Profile of type Business",
_89
"sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_89
}
_89
]
_89
}

Rate this page: