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

API: Create a Secondary Customer Profile



Prerequisites

prerequisites page anchor

For a successful evaluation of the secondary customer profile, please ensure that you've already created a Primary Customer Profile in the same account and it's in twilio-approved state.

if not, refer to Console: Create a Primary Customer Profile for a step-by-step walkthrough.


Secondary Customer Profiles Flow.

Steps to create a compliant Secondary Customer Profile

steps-to-create-a-compliant-secondary-customer-profile page anchor

Step 1

step-1 page anchor

Note: This step will fetch the regulation SID necessary to use for Secondary Profile creation.

Fetch Secondary Customer Profile Policy

fetch-secondary-customer-profile-policy 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
}

PageSizeinteger
Not PII

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

Minimum: 1Maximum: 1000

Pageinteger

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

Minimum: 0

PageTokenstring

The page token. This is provided by the API.

Note: This step creates an empty bundle that will then be filled with the information submitted in the subsequent steps.

Create an empty Secondary Customer Profile Bundle

create-an-empty-secondary-customer-profile-bundle page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_15
// Download the helper library from https://www.twilio.com/docs/node/install
_15
// Find your Account SID and Auth Token at twilio.com/console
_15
// and set the environment variables. See http://twil.io/secure
_15
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_15
const authToken = process.env.TWILIO_AUTH_TOKEN;
_15
const client = require('twilio')(accountSid, authToken);
_15
_15
client.trusthub.v1.customerProfiles
_15
.create({
_15
statusCallback: 'http://www.example.com',
_15
friendlyName: 'friendly_name',
_15
email: 'email',
_15
policySid: 'RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
_15
})
_15
.then(customer_profiles => console.log(customer_profiles.accountSid));

Output

_19
{
_19
"sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"policy_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"friendly_name": "friendly_name",
_19
"status": "draft",
_19
"email": "email",
_19
"status_callback": "http://www.example.com",
_19
"valid_until": null,
_19
"date_created": "2019-07-30T22:29:24Z",
_19
"date_updated": "2019-07-31T01:09:00Z",
_19
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"links": {
_19
"customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments",
_19
"customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Evaluations",
_19
"customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments"
_19
},
_19
"errors": null
_19
}

FriendlyNamestringrequired

The string that you assigned to describe the resource.


Emailstringrequired

The email address that will receive updates when the Customer-Profile resource changes status.


PolicySidSID<RN>required

The unique string of a policy that is associated to the Customer-Profile resource.

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

StatusCallbackstring<uri>

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

(error)

Danger

If you have a US entity or an International Tax ID, use EIN to register your business profile and to avoid brand registration failures. Do not use a DUNS number.

(error)

Danger

Updates are coming to Twilio's Starter Brand registration based on changes from The Campaign Registry (TCR)(link takes you to an external page) and mobile carriers. We will provide updates on how this change may impact US A2P 10DLC registration as soon as they are available. Brands with EINs will no longer be able to use Twilio's Starter Brand registration going forward.

In the meantime, if you are registering on behalf of an organization with an EIN/Tax ID, please complete a Standard registration.

Note: This step is used to gather the following business information that will then be added to the bundle in step 8:

Attribute (* = Required):: Business Identity (*)

Accepted Values:

'direct_customer', 'isv_reseller_or_partner', 'unknown'

Attribute (* = Required):: Business Type (*)

Accepted Values:

'Sole Proprietorship', 'Partnership', 'Limited Liability Corporation', 'Co-operative', 'Non-profit Corporation', 'Corporation'

Attribute (* = Required):: Business Industry (*)

Accepted Values:

'AUTOMOTIVE', 'AGRICULTURE', 'BANKING', 'CONSUMER', 'EDUCATION', 'ENGINEERING', 'ENERGY', 'OIL_AND_GAS', 'FAST_MOVING_CONSUMER_GOODS', 'FINANCIAL', 'FINTECH', 'FOOD_AND_BEVERAGE', 'GOVERNMENT', 'HEALTHCARE', 'HOSPITALITY', 'INSURANCE', 'LEGAL', 'MANUFACTURING', 'MEDIA', 'ONLINE', 'RAW_MATERIALS', 'REAL_ESTATE', 'RELIGION', 'RETAIL', 'JEWELRY', 'TECHNOLOGY', 'TELECOMMUNICATIONS', 'TRANSPORTATION', 'TRAVEL', 'ELECTRONICS', 'NOT_FOR_PROFIT'

Attribute (* = Required):: Business Registration ID Type (*)

Accepted Values:

  • EIN USA: Employer Identification Number (EIN)
  • DUNS USA: DUNS Number (Dun & Bradstreet)
  • CCN Canada: Canadian Corporation Number

    • NOTE : to register for A2P 10DLC, you must select CBN because CCN is no longer accepted.
  • CBN Canada: Canadian Business Number
  • CN Great Britain: Company Number
  • ACN Australia: Company Number from ASIC (ACN)
  • CIN India: Corporate Identity Number
  • VAT Estonia: VAT Number
  • VATRN Romania: VAT Registration Number
  • RN Israel: Registration Number
  • Other Other

Attribute (* = Required):: Name of Other Registration Type ( only applicable if 'Other' is used for Business Registration ID Type) (*)

Accepted Values:

Freeform string

Attribute (* = Required):: Business Registration Number (*)

Accepted Values:

Attribute (* = Required):: Business Regions of Operations (*)

Accepted Values:

'AFRICA', 'ASIA', 'EUROPE', 'LATIN_AMERICA', 'USA_AND_CANADA', 'AUSTRALIA'

Attribute (* = Required):: Website Url (*)

Accepted Values:

URL

Attribute (* = Required):: Social Media Profile URL

Accepted Values:

URL

Create EndUser of type: customer_profile_business_information

create-enduser-of-type-customer_profile_business_information page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_24
// Download the helper library from https://www.twilio.com/docs/node/install
_24
// Find your Account SID and Auth Token at twilio.com/console
_24
// and set the environment variables. See http://twil.io/secure
_24
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_24
const authToken = process.env.TWILIO_AUTH_TOKEN;
_24
const client = require('twilio')(accountSid, authToken);
_24
_24
client.trusthub.v1.endUsers
_24
.create({
_24
attributes: {
_24
business_name: 'acme business',
_24
social_media_profile_urls: '',
_24
website_url: 'test.com',
_24
business_regions_of_operation: 'USA_AND_CANADA',
_24
business_type: 'Partnership',
_24
business_registration_identifier: 'DUNS',
_24
business_identity: 'direct_customer',
_24
business_industry: 'EDUCATION',
_24
business_registration_number: '123456789'
_24
},
_24
friendlyName: 'friendly name',
_24
type: 'customer_profile_business_information'
_24
})
_24
.then(end_user => console.log(end_user.sid));

Output

_20
{
_20
"date_updated": "2021-02-16T20:40:57Z",
_20
"sid": "ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20
"friendly_name": "friendly name",
_20
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20
"url": "https://trusthub.twilio.com/v1/EndUsers/ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20
"date_created": "2021-02-16T20:40:57Z",
_20
"attributes": {
_20
"business_name": "acme business",
_20
"social_media_profile_urls": "",
_20
"website_url": "test.com",
_20
"business_regions_of_operation": "USA_AND_CANADA",
_20
"business_type": "Partnership",
_20
"business_registration_identifier": "DUNS",
_20
"business_identity": "direct_customer",
_20
"business_industry": "EDUCATION",
_20
"business_registration_number": "123456789"
_20
},
_20
"type": "customer_profile_business_information"
_20
}

FriendlyNamestringrequired

The string that you assigned to describe the resource.


Typestringrequired

The type of end user of the Bundle resource - can be individual or business.


Attributesobject
PII MTL: 30 days

The set of parameters that are the attributes of the End User resource which are derived End User Types.

Note: This step is used to gather the following authorized representative information to be associated with the bundle in step 8.

Attribute (* = Required):Accepted Values
Last NameEx: 'Smith'
First NameEx: 'John'
EmailEx: 'johnsmith@example.com'
Business TitleEx: 'Head of Product Management'
Job Position'Director', 'GM', 'VP', 'CEO', 'CFO', 'General Counsel', 'Other'
Phone NumberEx: '123-456-7890'
Country CodeEx: '+1' (US Country Code)

Create EndUser of type: authorized_representative_1

create-enduser-of-type-authorized_representative_1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_21
// Download the helper library from https://www.twilio.com/docs/node/install
_21
// Find your Account SID and Auth Token at twilio.com/console
_21
// and set the environment variables. See http://twil.io/secure
_21
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21
const authToken = process.env.TWILIO_AUTH_TOKEN;
_21
const client = require('twilio')(accountSid, authToken);
_21
_21
client.trusthub.v1.endUsers
_21
.create({
_21
attributes: {
_21
job_position: 'CEO',
_21
last_name: 'acme',
_21
phone_number: '+11234567890',
_21
first_name: 'rep1',
_21
email: 'rep1@acme.com',
_21
business_title: 'ceo'
_21
},
_21
friendlyName: 'auth_rep_1',
_21
type: 'authorized_representative_1'
_21
})
_21
.then(end_user => console.log(end_user.sid));

Output

_17
{
_17
"date_updated": "2021-02-16T20:40:57Z",
_17
"sid": "ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"friendly_name": "auth_rep_1",
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"url": "https://trusthub.twilio.com/v1/EndUsers/ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"date_created": "2021-02-16T20:40:57Z",
_17
"attributes": {
_17
"job_position": "CEO",
_17
"last_name": "acme",
_17
"phone_number": "+11234567890",
_17
"first_name": "rep1",
_17
"email": "rep1@acme.com",
_17
"business_title": "ceo"
_17
},
_17
"type": "authorized_representative_1"
_17
}

FriendlyNamestringrequired

The string that you assigned to describe the resource.


Typestringrequired

The type of end user of the Bundle resource - can be individual or business.


Attributesobject

The set of parameters that are the attributes of the End User resource which are derived End User Types.

Create EndUser of type: authorized_representative_2

create-enduser-of-type-authorized_representative_2 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_21
// Download the helper library from https://www.twilio.com/docs/node/install
_21
// Find your Account SID and Auth Token at twilio.com/console
_21
// and set the environment variables. See http://twil.io/secure
_21
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21
const authToken = process.env.TWILIO_AUTH_TOKEN;
_21
const client = require('twilio')(accountSid, authToken);
_21
_21
client.trusthub.v1.endUsers
_21
.create({
_21
attributes: {
_21
job_position: 'CFO',
_21
last_name: 'acme',
_21
phone_number: '+14345678900',
_21
first_name: 'rep2',
_21
email: 'rep2@acme.com',
_21
business_title: 'cfo'
_21
},
_21
friendlyName: 'auth_rep_2',
_21
type: 'authorized_representative_2'
_21
})
_21
.then(end_user => console.log(end_user.sid));

Output

_17
{
_17
"date_updated": "2021-02-16T20:40:57Z",
_17
"sid": "ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"friendly_name": "auth_rep_2",
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"url": "https://trusthub.twilio.com/v1/EndUsers/ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"date_created": "2021-02-16T20:40:57Z",
_17
"attributes": {
_17
"job_position": "CFO",
_17
"last_name": "acme",
_17
"phone_number": "+14345678900",
_17
"first_name": "rep2",
_17
"email": "rep2@acme.com",
_17
"business_title": "cfo"
_17
},
_17
"type": "authorized_representative_2"
_17
}

FriendlyNamestringrequired

The string that you assigned to describe the resource.


Typestringrequired

The type of end user of the Bundle resource - can be individual or business.


Attributesobject

The set of parameters that are the attributes of the End User resource which are derived End User Types.

(warning)

Warning

PO Boxes not accepted for address submission

Note: This step will gather the address info to be associated with the bundle in Step 8.

Skip this step if you already have an address sid.

Attribute (* = Required):Accepted Values
Address Friendly Name *Freeform String
Country *Ex: 'US' or 'United States'
Street Address 1 *Ex: 1234 Fake St
Street Address 2Ex: Apt B (if applicable)
City *Ex: San Francisco
State/Province/Region *Ex: CA
Postal Code *Ex: 94016
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_17
// Download the helper library from https://www.twilio.com/docs/node/install
_17
// Find your Account SID and Auth Token at twilio.com/console
_17
// and set the environment variables. See http://twil.io/secure
_17
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17
const authToken = process.env.TWILIO_AUTH_TOKEN;
_17
const client = require('twilio')(accountSid, authToken);
_17
_17
client.addresses
_17
.create({
_17
customerName: 'name',
_17
street: '555 AnyStreet',
_17
city: 'Any City',
_17
region: 'Any Region',
_17
postalCode: '12345',
_17
isoCountry: 'US'
_17
})
_17
.then(address => console.log(address.sid));

Output

_18
{
_18
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_18
"city": "Any City",
_18
"customer_name": "name",
_18
"date_created": "Tue, 18 Aug 2015 17:07:30 +0000",
_18
"date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",
_18
"emergency_enabled": false,
_18
"friendly_name": null,
_18
"iso_country": "US",
_18
"postal_code": "12345",
_18
"region": "Any Region",
_18
"sid": "ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_18
"street": "555 AnyStreet",
_18
"street_secondary": null,
_18
"validated": false,
_18
"verified": false,
_18
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Addresses/ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
_18
}

AccountSidSID<AC>required

The SID of the Account(link takes you to an external page) that will be responsible for the new Address resource.

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

The name to associate with the new address.


Streetstringrequired

The number and street address of the new address.


Citystringrequired

The city of the new address.


Regionstringrequired

The state or region of the new address.


PostalCodestringrequired

The postal code of the new address.


IsoCountrystring<iso-country-code>required

The ISO country code of the new address.


FriendlyNamestring

A descriptive string that you create to describe the new address. It can be up to 64 characters long.


EmergencyEnabledboolean

Whether to enable emergency calling on the new address. Can be: true or false.


AutoCorrectAddressboolean

Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.


StreetSecondarystring

The additional number and street address of the address.

Note: This step creates the supporting doc that houses the address information which will then be associated with the bundle in Step 8.

Create Supporting Document

create-supporting-document page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.trusthub.v1.supportingDocuments
_12
.create({attributes: {
_12
address_sids: 'ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
_12
}, friendlyName: 'address', type: 'customer_profile_address'})
_12
.then(supporting_document => console.log(supporting_document.sid));

Output

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

FriendlyNamestringrequired

The string that you assigned to describe the resource.


Typestringrequired

The type of the Supporting Document.


Attributesobject

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

Note: This step gathers up the previously entered information and associates it with the empty bundle. Each component (supporting document/address, customer profile information, authorized representative 1, authorized representative 2) will have its own object_sid to be assigned to the bundle.

Assign Customer Profile Business Information

assign-customer-profile-business-information page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.trusthub.v1.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_11
.customerProfilesEntityAssignments
_11
.create({objectSid: 'ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
_11
.then(customer_profiles_entity_assignments => console.log(customer_profiles_entity_assignments.sid));

Output

_10
{
_10
"sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"object_sid": "ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "2019-07-31T02:34:41Z",
_10
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}

CustomerProfileSidSID<BU>required

The unique string that we created to identify the CustomerProfile resource.

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

The SID of an object bag that holds information of the different items.

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

Assign Authorized Representative 1

assign-authorized-representative-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.trusthub.v1.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_11
.customerProfilesEntityAssignments
_11
.create({objectSid: 'ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
_11
.then(customer_profiles_entity_assignments => console.log(customer_profiles_entity_assignments.sid));

Output

_10
{
_10
"sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"object_sid": "ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "2019-07-31T02:34:41Z",
_10
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}

CustomerProfileSidSID<BU>required

The unique string that we created to identify the CustomerProfile resource.

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

The SID of an object bag that holds information of the different items.

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

Assign Authorized Representative 2

assign-authorized-representative-2 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.trusthub.v1.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_11
.customerProfilesEntityAssignments
_11
.create({objectSid: 'ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
_11
.then(customer_profiles_entity_assignments => console.log(customer_profiles_entity_assignments.sid));

Output

_10
{
_10
"sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"object_sid": "ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "2019-07-31T02:34:41Z",
_10
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}

CustomerProfileSidSID<BU>required

The unique string that we created to identify the CustomerProfile resource.

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

The SID of an object bag that holds information of the different items.

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

You can assign a Customer Profile as an entity to another Customer Profile. For the current use-case, you can do so by fetching the Primary Customer Profile Sid from the primary account.

Use it as the ObjectSid=primary-customer-profile-sid

Note: Currently ObjectSid accepts a Customer Profile Sid from the same account or from the primary account.

Assign a Primary Customer Profile

assign-a-primary-customer-profile page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.trusthub.v1.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_11
.customerProfilesEntityAssignments
_11
.create({objectSid: 'BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
_11
.then(customer_profiles_entity_assignments => console.log(customer_profiles_entity_assignments.sid));

Output

_10
{
_10
"sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"object_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "2019-07-31T02:34:41Z",
_10
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}

CustomerProfileSidSID<BU>required

The unique string that we created to identify the CustomerProfile resource.

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

The SID of an object bag that holds information of the different items.

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

Assign a Supporting Document

assign-a-supporting-document page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.trusthub.v1.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_11
.customerProfilesEntityAssignments
_11
.create({objectSid: 'RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'})
_11
.then(customer_profiles_entity_assignments => console.log(customer_profiles_entity_assignments.sid));

Output

_10
{
_10
"sid": "BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"object_sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "2019-07-31T02:34:41Z",
_10
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments/BVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}

CustomerProfileSidSID<BU>required

The unique string that we created to identify the CustomerProfile resource.

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

The SID of an object bag that holds information of the different items.

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

If you want to assign phone numbers to your Secondary Customer Profile, find your phone number SID from the Phone Numbers page in the Console(link takes you to an external page).

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_14
// Download the helper library from https://www.twilio.com/docs/node/install
_14
// Find your Account SID and Auth Token at twilio.com/console
_14
// and set the environment variables. See http://twil.io/secure
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = require('twilio')(accountSid, authToken);
_14
_14
client.trusthub.v1.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_14
.customerProfilesChannelEndpointAssignment
_14
.create({
_14
channelEndpointType: 'phone-number',
_14
channelEndpointSid: 'PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
_14
})
_14
.then(customer_profiles_channel_endpoint_assignment => console.log(customer_profiles_channel_endpoint_assignment.sid));

Output

_10
{
_10
"sid": "RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"channel_endpoint_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"channel_endpoint_type": "phone-number",
_10
"date_created": "2019-07-31T02:34:41Z",
_10
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments/RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}

CustomerProfileSidSID<BU>required

The unique string that we created to identify the CustomerProfile resource.

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

The type of channel endpoint. eg: phone-number


ChannelEndpointSidSIDrequired

The SID of an channel endpoint

Pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$Min length: 34Max length: 34
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.trusthub.v1.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_11
.customerProfilesEvaluations
_11
.create({policySid: 'RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
_11
.then(customer_profiles_evaluations => console.log(customer_profiles_evaluations.sid));

Output

_160
{
_160
"sid": "ELXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_160
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_160
"policy_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_160
"customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_160
"status": "noncompliant",
_160
"date_created": "2020-04-28T18:14:01Z",
_160
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Evaluations/ELXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_160
"results": [
_160
{
_160
"friendly_name": "Business",
_160
"object_type": "business",
_160
"passed": false,
_160
"failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.",
_160
"error_code": 22214,
_160
"valid": [],
_160
"invalid": [
_160
{
_160
"friendly_name": "Business Name",
_160
"object_field": "business_name",
_160
"failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.",
_160
"error_code": 22215
_160
},
_160
{
_160
"friendly_name": "Business Registration Number",
_160
"object_field": "business_registration_number",
_160
"failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.",
_160
"error_code": 22215
_160
},
_160
{
_160
"friendly_name": "First Name",
_160
"object_field": "first_name",
_160
"failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.",
_160
"error_code": 22215
_160
},
_160
{
_160
"friendly_name": "Last Name",
_160
"object_field": "last_name",
_160
"failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.",
_160
"error_code": 22215
_160
}
_160
],
_160
"requirement_friendly_name": "Business",
_160
"requirement_name": "business_info"
_160
},
_160
{
_160
"friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative",
_160
"object_type": "commercial_registrar_excerpt",
_160
"passed": false,
_160
"failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.",
_160
"error_code": 22216,
_160
"valid": [],
_160
"invalid": [
_160
{
_160
"friendly_name": "Business Name",
_160
"object_field": "business_name",
_160
"failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.",
_160
"error_code": 22217
_160
}
_160
],
_160
"requirement_friendly_name": "Business Name",
_160
"requirement_name": "business_name_info"
_160
},
_160
{
_160
"friendly_name": "Excerpt from the commercial register showing French address",
_160
"object_type": "commercial_registrar_excerpt",
_160
"passed": false,
_160
"failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.",
_160
"error_code": 22216,
_160
"valid": [],
_160
"invalid": [
_160
{
_160
"friendly_name": "Address sid(s)",
_160
"object_field": "address_sids",
_160
"failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.",
_160
"error_code": 22219
_160
}
_160
],
_160
"requirement_friendly_name": "Business Address (Proof of Address)",
_160
"requirement_name": "business_address_proof_info"
_160
},
_160
{
_160
"friendly_name": "Excerpt from the commercial register (Extrait K-bis)",
_160
"object_type": "commercial_registrar_excerpt",
_160
"passed": false,
_160
"failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.",
_160
"error_code": 22216,
_160
"valid": [],
_160
"invalid": [
_160
{
_160
"friendly_name": "Document Number",
_160
"object_field": "document_number",
_160
"failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).",
_160
"error_code": 22217
_160
}
_160
],
_160
"requirement_friendly_name": "Business Registration Number",
_160
"requirement_name": "business_reg_no_info"
_160
},
_160
{
_160
"friendly_name": "Government-issued ID",
_160
"object_type": "government_issued_document",
_160
"passed": false,
_160
"failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
_160
"error_code": 22216,
_160
"valid": [],
_160
"invalid": [
_160
{
_160
"friendly_name": "First Name",
_160
"object_field": "first_name",
_160
"failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.",
_160
"error_code": 22217
_160
},
_160
{
_160
"friendly_name": "Last Name",
_160
"object_field": "last_name",
_160
"failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.",
_160
"error_code": 22217
_160
}
_160
],
_160
"requirement_friendly_name": "Name of Authorized Representative",
_160
"requirement_name": "name_of_auth_rep_info"
_160
},
_160
{
_160
"friendly_name": "Executed Copy of Power of Attorney",
_160
"object_type": "power_of_attorney",
_160
"passed": false,
_160
"failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.",
_160
"error_code": 22216,
_160
"valid": [],
_160
"invalid": [],
_160
"requirement_friendly_name": "Power of Attorney",
_160
"requirement_name": "power_of_attorney_info"
_160
},
_160
{
_160
"friendly_name": "Government-issued ID",
_160
"object_type": "government_issued_document",
_160
"passed": false,
_160
"failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
_160
"error_code": 22216,
_160
"valid": [],
_160
"invalid": [
_160
{
_160
"friendly_name": "First Name",
_160
"object_field": "first_name",
_160
"failure_reason": "The First Name is missing on the Governnment-Issued ID.",
_160
"error_code": 22217
_160
},
_160
{
_160
"friendly_name": "Last Name",
_160
"object_field": "last_name",
_160
"failure_reason": "The Last Name is missing on the Government-issued ID",
_160
"error_code": 22217
_160
}
_160
],
_160
"requirement_friendly_name": "Name of Person granted the Power of Attorney",
_160
"requirement_name": "name_in_power_of_attorney_info"
_160
}
_160
]
_160
}

CustomerProfileSidSID<BU>required

The unique string that we created to identify the CustomerProfile resource.

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

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

Pattern: ^RN[0-9a-fA-F]{32}$Min length: 34Max length: 34
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.customerProfiles('BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_10
.update({status: 'pending-review'})
_10
.then(customer_profiles => console.log(customer_profiles.sid));

Output

_19
{
_19
"sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"policy_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"friendly_name": "friendly_name",
_19
"status": "pending-review",
_19
"email": "email",
_19
"status_callback": "http://www.example.com",
_19
"valid_until": null,
_19
"date_created": "2019-07-30T22:29:24Z",
_19
"date_updated": "2019-07-31T01:09:00Z",
_19
"url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19
"links": {
_19
"customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments",
_19
"customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Evaluations",
_19
"customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments"
_19
},
_19
"errors": null
_19
}

SidSID<BU>required

The unique string that we created to identify the Customer-Profile resource.

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

The verification status of the Customer-Profile resource. If the current verification status of the Customer-Profile is draft, you may set the verification status to pending-review to submit the Customer-Profile 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>

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


FriendlyNamestring

The string that you assigned to describe the resource.


Emailstring

The email address that will receive updates when the Customer-Profile resource changes status.

Once you submit a compliant Secondary Customer Profile for review, your profile will be under in-review status. If it's non-compliant, it will automatically be rejected with a twilio-rejected status.


Rate this page: