Skip to contentSkip to navigationSkip to topbar
Rate this Page:

TrustHub REST API


(warning)

Warning

This is an overview of the TrustHub REST API Resources. It is not intended to serve as an onboarding guide for any TrustHub functionality. Select a TrustHub feature below to view the onboarding guide:

The TrustHub REST API organizes the Know Your Customer (KYC) information into CustomerProfile Resources and TrustProduct Resources.

These resources are considered "bundles", and the information required to submit each bundle successfully is determined by a Policies Resource. A Policy may require specific EndUsers, SupportingDocuments, and CustomerProfiles to be attached to each bundle.

Keep reading to learn more about all of the resources available in the TrustHub REST API, or use the API Resources menu in the left navigation pane to see the API reference for a specific TrustHub API Resource.


CustomerProfile Resource

customerprofile-resource page anchor

A CustomerProfile Resource is used to establish the identity of someone using a channel endpoint, such as a Twilio phone number or SendGrid email address.

Currently, the CustomerProfiles you can create are:

CustomerProfileChannelEndpointAssignment Resource

customerprofilechannelendpointassignment-resource page anchor

The CustomerProfileChannelEndpointAssignment Resource is used to assign phone numbers to a CustomerProfile Resource.

CustomerProfileEntityAssignment Resource

customerprofileentityassignment-resource page anchor

The CustomerProfileEntityAssignment Resource is used to associate TrustHub Resources with a CustomerProfile Resource, as defined by a Policies Resource.

These TrustHub Resources may include:

  • EndUser Resources , such as business information or authorized representatives of a business
  • SupportingDocument Resources , such as a business addresses
  • An associated CustomerProfile Resource

CustomerProfileEvaluation Resource

customerprofileevaluation-resource page anchor

The CustomerProfileEvaluation Resource allows developers to understand what failed and why when a CustomerProfile Resource is submitted for evaluation against a Policies Resource.

The synchronous request will provide error codes and instant feedback to fix the given CustomerProfile Resource.


A TrustProduct Resource is used to enable features on your Twilio account(s) like SHAKEN/STIR authentication, Application-to-Person (A2P) messaging, and Caller ID Name (CNAM).

Currently, the TrustProduct Resources you can create are:

  • SHAKEN/STIR Trust Product
  • A2P Messaging: Local - Business Trust Product
  • Starter A2P Messaging: Local - Business Trust Product
  • CNAM Profile Trust Product

TrustProductChannelEndpointAssignment Resource

trustproductchannelendpointassignment-resource page anchor

The TrustProductChannelEndpointAssignment Resource is used to assign phone numbers to a TrustProduct Resource.

TrustProductEntityAssignment Resource

trustproductentityassignment-resource page anchor

The TrustProductEntityAssignment Resource is used for associating TrustHub Resources with a TrustProduct Resource, as defined by a Policies Resource. These TrustHub Resources may include:

  • EndUser Resources , such as US A2P Messaging Profile General Business information and CNAM Information
  • An associated CustomerProfile Resource

TrustProductEvaluation Resource

trustproductevaluation-resource page anchor

The TrustProductEvaluation Resource allows developers to understand what (if anything) failed and why when a TrustProduct Resource is submitted for evaluation against a Policies Resource.

The synchronous request will provide error codes and instant feedback to fix the given TrustProduct Resource.


EndUser Resource and EndUserType Resource

enduser-resource-and-endusertype-resource page anchor

An EndUser Resource is a representation of an individual or business using the Twilio Platform to communicate with their customers. The structure of an EndUser Resource is described by an EndUserType Resource.

The Policies Resource associated with a CustomerProfile Resource or a TrustProduct Resource will determine what EndUser Resources you'll need to create. See the Policies Resource section below for more information.

You can see the possible EndUserTypes and the structure of each EndUserType by using the Read multiple EndUserType resources endpoint.

Note: You will only need to create EndUser Resources that are specific to your use case. See the appropriate onboarding guide (listed at the top of this page) for more information.


SupportingDocument and SupportingDocumentType Resource

supportingdocument-and-supportingdocumenttype-resource page anchor

A SupportingDocument Resource is a collection of required information to ensure compliance with various TrustHub features. The structure of a SupportingDocument Resource is described by a SupportingDocumentType Resource.

The Policies Resource associated with a CustomerProfile Resource or a TrustProduct Resource will determine what SupportingDocument Resources you'll need to create. See the Policies Resource section below for more information.

You can see the possible SupportingDocumentTypes and the information required for each by using the Read multiple SupportingDocumentType resources endpoint.

Note: You will only need to create SupportingDocument Resources that are specific to your use case. See the appropriate onboarding guide (listed at the top of this page) for more information.


The information required for creating a CustomerProfile Resource or a TrustProduct Resource is defined by a Policies Resource. This required information can include:

  • EndUser Resources
  • SupportingDocument Resources
  • TrustProduct Resources
  • Customer Profile Resources

You can view all of the available Policies Resources by using the Read multiple Policies Resources endpoint.

(information)

Info

Policies can and do change. Please make sure not to hardcode any Policy SID within your application.

Use the Read multiple Policies Resources endpoint to see all available Policies Resources.

Use the Fetch a Policies Resource endpoint to see a specific Policies Resource.

Policies Resource Example

policies-resource-example page anchor

Let's examine the Policies Resource for creating a "Secondary Customer Profile of type Business" to see an example of what information is required when creating a CustomerProfile Resource.


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

The requirements object contains the list of required TrustHub Resources. For this particular Policy, we see the following requirements:

EndUsers:

  • Business Information
  • Authorized Representative #1
  • Authorized Representative #2

SupportingDocuments:

  • Physical Business Address

Supporting CustomerProfiles:

  • Primary Customer Profile

Now let's look at the first object in the requirements.end_user array:


_17
{
_17
"url": "/EndUserTypes/customer_profile_business_information",
_17
"fields": [
_17
"business_type",
_17
"business_registration_number",
_17
"business_name",
_17
"business_registration_identifier",
_17
"business_identity",
_17
"business_industry",
_17
"website_url",
_17
"business_regions_of_operation",
_17
"social_media_profile_urls"
_17
],
_17
"type": "customer_profile_business_information",
_17
"name": "Business Information",
_17
"requirement_name": "customer_profile_business_information"
_17
},

This indicates that one of the requirements is a "Business Information" EndUser with the EndUserType of customer_profile_business_information.

The fields (information) needed for this customer_profile_business_information EndUserType are listed in the "fields" array. These fields are the parameters you'll need to include when you create an EndUser Resource.

You can learn more about the structure of the customer_profile_business_information EndUserType by making a GET request to the endpoint listed in the "URL" field in the object above.

Similarly, you can examine the structure of other requirements defined by a Policies Resource for “supporting_document” “supporting_trust_products”, and “supporting_customer_profiles” by making a GET request to the "URL"s provided by the Policies Resource.


Create a CustomerProfile bundle

create-a-customerprofile-bundle page anchor
(warning)

Warning

This is just a general description of how to create a CustomerProfile Resource. Use the specific onboarding guide for the specific TrustHub functionality you're working on.

  1. Fetch all Policies Resources and find the SID for the Policies Resource related to the CustomerProfile Resource you want to create.
  2. Fetch the specific Policies Resource and examine the requirements you need for your CustomerProfile Resource . This could include EndUsers , SupportingDocuments , or CustomerProfiles .
  3. Create a new CustomerProfile Resource using the appropriate Policies Resource SID.

    • You can also pass in FriendlyName , Email , and StatusCallback parameters
  4. Create the necessary required TrustHub Resource and take note of the SID of the new resource:

  5. Use the SID of the newly-created resource to create a new CustomerProfileEntityAssignment Resource .
  6. Repeat steps 4 and 5 for other requirements listed in the Policies Resource .
  7. Add a phone number to the CustomerProfile Resource by creating a CustomerProfileChannelEndpointAssignment Resource.

    • The ChannelEndpointType parameter should be phone-number .
  8. Repeat step 7 for any other phone numbers you want to associate with this CustomerProfile Resource .
  9. Evaluate the CustomerProfile Resource .
  10. If necessary, fix any errors provided by the Evaluation Resource . Repeat step 9 to reevaluate the CustomerProfile Resource .
  11. Submit the CustomerProfile Resource by using the Update a CustomerProfile Resource endpoint and setting the Status parameter to pending-review .

Create a TrustProduct bundle

create-a-trustproduct-bundle page anchor
(warning)

Warning

This is just a general description of how to create a TrustProduct Resource. Use the specific onboarding guide for the specific TrustHub functionality you're working on.

  1. Fetch all Policies Resources and find the SID for the Policies Resource related to the TrustProduct Resource you want to create.
  2. Fetch the specific Policies Resource and examine the requirements you need for your TrustProduct Resource . This could include EndUsers or CustomerProfiles .
  3. Create a new TrustProduct Resource using the appropriate Policies Resource SID.

    • You can also pass in FriendlyName , Email , and StatusCallback parameters
  4. Create the necessary required TrustHub Resource and take note of the SID of the new resource:

  5. Use the SID of the newly-created resource to create a new TrustProductEntityAssignment Resource .
  6. Repeat steps 4 and 5 for other requirements listed in the Policies Resource .
  7. Add a phone number to the TrustProduct Resource by creating a TrustProductChannelEndpointAssignment Resource.

    • The ChannelEndpointType parameter should be phone-number .
    • Note: You need to add the phone number to any supporting CustomerProfile Resources first. See the previous section for more information.
  8. Repeat step 7 for any other phone numbers you want to associate with this TrustProduct Resource .
  9. Evaluate the TrustProduct Resource .
  10. If necessary, fix any errors provided by the Evaluation Resource . Repeat step 9 to reevaluate the TrustProduct Resource .
  11. Submit the TrustProduct Resource by using the Update a TrustProduct Resource endpoint and setting the Status parameter to pending-review .

Rate this Page: