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

API: Create a Starter Profile

(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.

Prerequisites

prerequisites page anchor

For a successful evaluation of the starter 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.

Creation Flow

creation-flow page anchor
starter-profile.

Steps to create a compliant Starter Profile

steps-to-create-a-compliant-starter-profile page anchor

Note: This regulation SID is necessary for distinguishing between a Secondary Customer Profile and a Starter Profile.

Step 1

step-1 page anchor

Note: the correct regulation SID for Starter Profiles in production is:

RN806dd6cd175f314e1f96a9727ee271f4

Step 2

step-2 page anchor

Note: This step creates an empty starter profile bundle that we will then fill with the correct business information.

Create an empty Starter Profile BundleLink to code sample: Create an empty Starter Profile Bundle
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createCustomerProfile() {

11
  const customerProfile = await client.trusthub.v1.customerProfiles.create({

12
    email: "email",

13
    friendlyName: "friendly_name",

14
    policySid: "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
    statusCallback: "http://www.example.com",

16
  });

17


18
  console.log(customerProfile.accountSid);

19
}

20


21
createCustomerProfile();

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/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

13
  "links": {

14
    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",

15
    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",

16
    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"

17
  },

18
  "errors": null

19
}

Request body parameters

request-body-parameters page anchor
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 Customer-Profile resource changes status.

PolicySidSID<RN>required
Not PII

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>

Optional

Not PII

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

Step 3

step-3 page anchor

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

Attribute (* = Required):Accepted Values
First name (*)Freeform string Ex: 'John'
Last Name (*)Freeform string Ex: 'Smith'
Phone Number (*)Provide a valid phone number Ex: +12132383712
Email Address (*)Provide a valid email address Ex: 'johnsmith@example.com'
Create EndUser of type: starter_customer_profile_informationLink to code sample: Create EndUser of type: starter_customer_profile_information
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createEndUser() {

11
  const endUser = await client.trusthub.v1.endUsers.create({

12
    attributes: {

13
      last_name: "Smith",

14
      phone_number: "+12132388713",

15
      first_name: "John",

16
      email: "johnsmith@example.com",

17
    },

18
    friendlyName: "friendly_name",

19
    type: "starter_customer_profile_information",

20
  });

21


22
  console.log(endUser.sid);

23
}

24


25
createEndUser();

Output

1
{

2
  "date_updated": "2021-02-16T20:40:57Z",

3
  "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "friendly_name",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-16T20:40:57Z",

8
  "attributes": {

9
    "phone_number": "+11234567890",

10
    "job_position": "CEO",

11
    "first_name": "rep1",

12
    "last_name": "test",

13
    "business_title": "ceo",

14
    "email": "foobar@test.com"

15
  },

16
  "type": "starter_customer_profile_information"

17
}

Request body parameters

request-body-parameters-1 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
FriendlyNamestringrequired
Not PII

The string that you assigned to describe the resource.

Typestringrequired
Not PII

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

Attributesobject

Optional

PII MTL: 30 days

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

[Optional] Step 4

optional-step-4 page anchor

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

Skip this step if you already have an address sid.

Attribute (* = Required):Accepted Values
Address Friendly NameFreeform String
CountryEx: 'US' or 'United States'
Street AddressEx: 1234 Fake St
CityEx: San Francisco
State/Province/RegionEx: CA
Postal CodeEx: 94016
Create an addressLink to code sample: Create an address
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createAddress() {

11
  const address = await client.addresses.create({

12
    city: "Any City",

13
    customerName: "name",

14
    isoCountry: "US",

15
    postalCode: "12345",

16
    region: "Any Region",

17
    street: "555 AnyStreet",

18
  });

19


20
  console.log(address.sid);

21
}

22


23
createAddress();

Output

1
{

2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "city": "Any City",

4
  "customer_name": "name",

5
  "date_created": "Tue, 18 Aug 2015 17:07:30 +0000",

6
  "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",

7
  "emergency_enabled": false,

8
  "friendly_name": null,

9
  "iso_country": "US",

10
  "postal_code": "12345",

11
  "region": "Any Region",

12
  "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

13
  "street": "555 AnyStreet",

14
  "street_secondary": null,

15
  "validated": false,

16
  "verified": false,

17
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"

18
}

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

The SID of the Account that will be responsible for the new Address resource.

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

Request body parameters

request-body-parameters-2 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
CustomerNamestringrequired
PII MTL: 30 days

The name to associate with the new address.

Streetstringrequired
PII MTL: 30 days

The number and street address of the new address.

Citystringrequired
Not PII

The city of the new address.

Regionstringrequired
Not PII

The state or region of the new address.

PostalCodestringrequired
PII MTL: 30 days

The postal code of the new address.

IsoCountrystring<iso-country-code>required
Not PII

The ISO country code of the new address.

FriendlyNamestring

Optional

PII MTL: 30 days

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

EmergencyEnabledboolean

Optional

Not PII

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

AutoCorrectAddressboolean

Optional

Not PII

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

Optional

PII MTL: 30 days

The additional number and street address of the address.

Step 5

step-5 page anchor

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

Create Supporting DocumentLink to code sample: Create Supporting Document
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createSupportingDocument() {

11
  const supportingDocument =

12
    await client.trusthub.v1.supportingDocuments.create({

13
      attributes: {

14
        address_sids: "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
      },

16
      friendlyName: "address",

17
      type: "customer_profile_address",

18
    });

19


20
  console.log(supportingDocument.sid);

21
}

22


23
createSupportingDocument();

Output

1
{

2
  "status": "draft",

3
  "date_updated": "2021-02-11T17:23:00Z",

4
  "friendly_name": "address",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-11T17:23:00Z",

8
  "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

9
  "attributes": {

10
    "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
  },

12
  "type": "customer_profile_address",

13
  "mime_type": null

14
}

Request body parameters

request-body-parameters-3 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
FriendlyNamestringrequired
Not PII

The string that you assigned to describe the resource.

Typestringrequired
Not PII

The type of the Supporting Document.

Attributesobject

Optional

PII MTL: 30 days

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

Step 6

step-6 page anchor

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

Assign Starter Customer Profile InformationLink to code sample: Assign Starter Customer Profile Information
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createCustomerProfileEntityAssignment() {

11
  const customerProfilesEntityAssignment = await client.trusthub.v1

12
    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .customerProfilesEntityAssignments.create({

14
      objectSid: "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
    });

16


17
  console.log(customerProfilesEntityAssignment.sid);

18
}

19


20
createCustomerProfileEntityAssignment();

Output

1
{

2
  "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "object_sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "date_created": "2019-07-31T02:34:41Z",

7
  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

8
}

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
CustomerProfileSidSID<BU>required
Not PII

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

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

Request body parameters

request-body-parameters-4 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ObjectSidSIDrequired
Not PII

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

Step 7

step-7 page anchor

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 same/parent account.

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

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

Assign a Primary Customer ProfileLink to code sample: Assign a Primary Customer Profile
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createCustomerProfileEntityAssignment() {

11
  const customerProfilesEntityAssignment = await client.trusthub.v1

12
    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .customerProfilesEntityAssignments.create({

14
      objectSid: "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
    });

16


17
  console.log(customerProfilesEntityAssignment.sid);

18
}

19


20
createCustomerProfileEntityAssignment();

Output

1
{

2
  "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "object_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "date_created": "2019-07-31T02:34:41Z",

7
  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

8
}

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
CustomerProfileSidSID<BU>required
Not PII

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

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

Request body parameters

request-body-parameters-5 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ObjectSidSIDrequired
Not PII

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

Step 8

step-8 page anchor
Assign a Supporting DocumentLink to code sample: Assign a Supporting Document
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createCustomerProfileEntityAssignment() {

11
  const customerProfilesEntityAssignment = await client.trusthub.v1

12
    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .customerProfilesEntityAssignments.create({

14
      objectSid: "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

15
    });

16


17
  console.log(customerProfilesEntityAssignment.sid);

18
}

19


20
createCustomerProfileEntityAssignment();

Output

1
{

2
  "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "object_sid": "RDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

6
  "date_created": "2019-07-31T02:34:41Z",

7
  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

8
}

Path parameters

path-parameters-3 page anchor
Property nameTypeRequiredPIIDescription
CustomerProfileSidSID<BU>required
Not PII

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

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

Request body parameters

request-body-parameters-6 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ObjectSidSIDrequired
Not PII

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

Step 9

step-9 page anchor

Note: This step submits the bundle to the evaluation service to be reviewed.

Run an evaluationLink to code sample: Run an evaluation
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createCustomerProfileEvaluation() {

11
  const customerProfilesEvaluation = await client.trusthub.v1

12
    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .customerProfilesEvaluations.create({

14
      policySid: "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
    });

16


17
  console.log(customerProfilesEvaluation.sid);

18
}

19


20
createCustomerProfileEvaluation();

Output

1
{

2
  "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "status": "noncompliant",

7
  "date_created": "2020-04-28T18:14:01Z",

8
  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

9
  "results": [

10
    {

11
      "friendly_name": "Business",

12
      "object_type": "business",

13
      "passed": false,

14
      "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.",

15
      "error_code": 22214,

16
      "valid": [],

17
      "invalid": [

18
        {

19
          "friendly_name": "Business Name",

20
          "object_field": "business_name",

21
          "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.",

22
          "error_code": 22215

23
        },

24
        {

25
          "friendly_name": "Business Registration Number",

26
          "object_field": "business_registration_number",

27
          "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.",

28
          "error_code": 22215

29
        },

30
        {

31
          "friendly_name": "First Name",

32
          "object_field": "first_name",

33
          "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.",

34
          "error_code": 22215

35
        },

36
        {

37
          "friendly_name": "Last Name",

38
          "object_field": "last_name",

39
          "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.",

40
          "error_code": 22215

41
        }

42
      ],

43
      "requirement_friendly_name": "Business",

44
      "requirement_name": "business_info"

45
    },

46
    {

47
      "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative",

48
      "object_type": "commercial_registrar_excerpt",

49
      "passed": false,

50
      "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.",

51
      "error_code": 22216,

52
      "valid": [],

53
      "invalid": [

54
        {

55
          "friendly_name": "Business Name",

56
          "object_field": "business_name",

57
          "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.",

58
          "error_code": 22217

59
        }

60
      ],

61
      "requirement_friendly_name": "Business Name",

62
      "requirement_name": "business_name_info"

63
    },

64
    {

65
      "friendly_name": "Excerpt from the commercial register showing French address",

66
      "object_type": "commercial_registrar_excerpt",

67
      "passed": false,

68
      "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.",

69
      "error_code": 22216,

70
      "valid": [],

71
      "invalid": [

72
        {

73
          "friendly_name": "Address sid(s)",

74
          "object_field": "address_sids",

75
          "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.",

76
          "error_code": 22219

77
        }

78
      ],

79
      "requirement_friendly_name": "Business Address (Proof of Address)",

80
      "requirement_name": "business_address_proof_info"

81
    },

82
    {

83
      "friendly_name": "Excerpt from the commercial register (Extrait K-bis)",

84
      "object_type": "commercial_registrar_excerpt",

85
      "passed": false,

86
      "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.",

87
      "error_code": 22216,

88
      "valid": [],

89
      "invalid": [

90
        {

91
          "friendly_name": "Document Number",

92
          "object_field": "document_number",

93
          "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).",

94
          "error_code": 22217

95
        }

96
      ],

97
      "requirement_friendly_name": "Business Registration Number",

98
      "requirement_name": "business_reg_no_info"

99
    },

100
    {

101
      "friendly_name": "Government-issued ID",

102
      "object_type": "government_issued_document",

103
      "passed": false,

104
      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",

105
      "error_code": 22216,

106
      "valid": [],

107
      "invalid": [

108
        {

109
          "friendly_name": "First Name",

110
          "object_field": "first_name",

111
          "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.",

112
          "error_code": 22217

113
        },

114
        {

115
          "friendly_name": "Last Name",

116
          "object_field": "last_name",

117
          "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.",

118
          "error_code": 22217

119
        }

120
      ],

121
      "requirement_friendly_name": "Name of Authorized Representative",

122
      "requirement_name": "name_of_auth_rep_info"

123
    },

124
    {

125
      "friendly_name": "Executed Copy of Power of Attorney",

126
      "object_type": "power_of_attorney",

127
      "passed": false,

128
      "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.",

129
      "error_code": 22216,

130
      "valid": [],

131
      "invalid": [],

132
      "requirement_friendly_name": "Power of Attorney",

133
      "requirement_name": "power_of_attorney_info"

134
    },

135
    {

136
      "friendly_name": "Government-issued ID",

137
      "object_type": "government_issued_document",

138
      "passed": false,

139
      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",

140
      "error_code": 22216,

141
      "valid": [],

142
      "invalid": [

143
        {

144
          "friendly_name": "First Name",

145
          "object_field": "first_name",

146
          "failure_reason": "The First Name is missing on the Governnment-Issued ID.",

147
          "error_code": 22217

148
        },

149
        {

150
          "friendly_name": "Last Name",

151
          "object_field": "last_name",

152
          "failure_reason": "The Last Name is missing on the Government-issued ID",

153
          "error_code": 22217

154
        }

155
      ],

156
      "requirement_friendly_name": "Name of Person granted the Power of Attorney",

157
      "requirement_name": "name_in_power_of_attorney_info"

158
    }

159
  ]

160
}

Path parameters

path-parameters-4 page anchor
Property nameTypeRequiredPIIDescription
CustomerProfileSidSID<BU>required
Not PII

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

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

Request body parameters

request-body-parameters-7 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
PolicySidSID<RN>required
Not PII

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

Step 10

step-10 page anchor
Submit for reviewLink to code sample: Submit for review
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function updateCustomerProfile() {

11
  const customerProfile = await client.trusthub.v1

12
    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .update({ status: "pending-review" });

14


15
  console.log(customerProfile.sid);

16
}

17


18
updateCustomerProfile();

Output

1
{

2
  "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "friendly_name": "friendly_name",

6
  "status": "pending-review",

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/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

13
  "links": {

14
    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",

15
    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",

16
    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"

17
  },

18
  "errors": null

19
}

Path parameters

path-parameters-5 page anchor
Property nameTypeRequiredPIIDescription
SidSID<BU>required
Not PII

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

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

Request body parameters

request-body-parameters-8 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
Statusenum<string>

Optional

Not PII

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>

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 Customer-Profile resource changes status.

Once you submit a compliant Starter 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.