API: Create a Secondary Customer Profile
Prerequisites
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.
Creation Flow
Steps to create a compliant Secondary Customer Profile
Step 1
Note: This step will fetch the regulation SID necessary to use for Secondary Profile creation.
Step 2
Note: This step creates an empty bundle that will then be filled with the information submitted in the subsequent steps.
Parameters in REST API format | |
---|---|
friendly_name
Required
|
The string that you assigned to describe the resource. |
email
Required
|
The email address that will receive updates when the Customer-Profile resource changes status. |
policy_sid
Required
|
The unique string of a policy that is associated to the Customer-Profile resource. |
status_callback
Optional
|
The URL we call to inform your application of status changes. |
Step 3
Please note: 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.
Updates are coming to Twilio’s Starter Brand registration based on changes from The Campaign Registry (TCR) 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): | Accepted Values |
Business Identity (*) | 'direct_customer', 'isv_reseller_or_partner', 'unknown' |
Business Type (*) | 'Sole Proprietorship', 'Partnership', 'Limited Liability Corporation', 'Co-operative', 'Non-profit Corporation', 'Corporation' |
Business Industry (*) |
'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' |
Business Registration ID Type (*) | 'USA: Employer Identification Number (EIN)', 'USA: DUNS Number (Dun & Bradstreet)', 'Canada: Canadian Corporation Number (CCN)', 'Great Britain: Company Number', 'Australia: Company Number from ASIC (ACN)', 'India: Corporate Identity Number', 'Estonia: VAT Number', 'Romania: VAT Registration Number', 'Israel: Registration Number', 'Other' |
Name of Other Registration Type ( only applicable if 'Other' is used for Business Registration ID Type) (*) | Freeform string |
Business Registration Number (*) |
US EIN: [xx-xxxxxxx] (NUMERICAL) US DUNS: [xx-xxx-xxxx] (NUMERICAL) CA BIN: [xxxxxxxxx] (NUMERICAL) |
Business Regions of Operations (*) |
'AFRICA', 'ASIA', 'EUROPE', 'LATIN_AMERICA', 'USA_AND_CANADA' |
Website Url (*) |
URL |
Social Media Profile URL |
URL |
Parameters in REST API format | |
---|---|
friendly_name
Required
|
The string that you assigned to describe the resource. |
type
Required
|
The type of end user of the Bundle resource - can be |
attributes
Optional
|
The set of parameters that are the attributes of the End User resource which are derived End User Types. |
Step 4
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 Name | Ex: 'Smith' |
First Name | Ex: 'John' |
Ex: 'johnsmith@example.com' | |
Business Title | Ex: 'Head of Product Management' |
Job Position | 'Director', 'GM', 'VP', 'CEO', 'CFO', 'General Counsel', 'Other' |
Phone Number | Ex: '123-456-7890' |
Country Code | Ex: '+1' (US Country Code) |
Parameters in REST API format | |
---|---|
friendly_name
Required
|
The string that you assigned to describe the resource. |
type
Required
|
The type of end user of the Bundle resource - can be |
attributes
Optional
|
The set of parameters that are the attributes of the End User resource which are derived End User Types. |
Step 5
Parameters in REST API format | |
---|---|
friendly_name
Required
|
The string that you assigned to describe the resource. |
type
Required
|
The type of end user of the Bundle resource - can be |
attributes
Optional
|
The set of parameters that are the attributes of the End User resource which are derived End User Types. |
PO Boxes not accepted for address submission
[Optional] Step 6
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 2 | Ex: Apt B (if applicable) |
City * | Ex: San Francisco |
State/Province/Region * | Ex: CA |
Postal Code * | Ex: 94016 |
Parameters in REST API format | |
---|---|
account_sid
Path
|
The SID of the Account that will be responsible for the new Address resource. |
customer_name
Required
|
The name to associate with the new address. |
street
Required
|
The number and street address of the new address. |
city
Required
|
The city of the new address. |
region
Required
|
The state or region of the new address. |
postal_code
Required
|
The postal code of the new address. |
iso_country
Required
|
The ISO country code of the new address. |
friendly_name
Optional
|
A descriptive string that you create to describe the new address. It can be up to 64 characters long. |
emergency_enabled
Optional
|
Whether to enable emergency calling on the new address. Can be: |
auto_correct_address
Optional
|
Whether we should automatically correct the address. Can be: |
street_secondary
Optional
|
The additional number and street address of the address. |
Step 7
Note: This step creates the supporting doc that houses the address information which will then be associated with the bundle in Step 8.
Parameters in REST API format | |
---|---|
friendly_name
Required
|
The string that you assigned to describe the resource. |
type
Required
|
The type of the Supporting Document. |
attributes
Optional
|
The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types. |
Step 8
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.
Parameters in REST API format | |
---|---|
customer_profile_sid
Path
|
The unique string that we created to identify the CustomerProfile resource. |
object_sid
Required
|
The SID of an object bag that holds information of the different items. |
Step 9
Parameters in REST API format | |
---|---|
customer_profile_sid
Path
|
The unique string that we created to identify the CustomerProfile resource. |
object_sid
Required
|
The SID of an object bag that holds information of the different items. |
Step 10
Parameters in REST API format | |
---|---|
customer_profile_sid
Path
|
The unique string that we created to identify the CustomerProfile resource. |
object_sid
Required
|
The SID of an object bag that holds information of the different items. |
Step 11
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.
Parameters in REST API format | |
---|---|
customer_profile_sid
Path
|
The unique string that we created to identify the CustomerProfile resource. |
object_sid
Required
|
The SID of an object bag that holds information of the different items. |
Step 12
Parameters in REST API format | |
---|---|
customer_profile_sid
Path
|
The unique string that we created to identify the CustomerProfile resource. |
object_sid
Required
|
The SID of an object bag that holds information of the different items. |
[Optional] Step 13
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.
Parameters in REST API format | |
---|---|
customer_profile_sid
Path
|
The unique string that we created to identify the CustomerProfile resource. |
channel_endpoint_type
Required
|
The type of channel endpoint. eg: phone-number |
channel_endpoint_sid
Required
|
The SID of an channel endpoint |
Step 14
Parameters in REST API format | |
---|---|
customer_profile_sid
Path
|
The unique string that we created to identify the CustomerProfile resource. |
policy_sid
Required
|
The unique string of a policy that is associated to the customer_profile resource. |
Step 15
Parameters in REST API format | |
---|---|
sid
Path
|
The unique string that we created to identify the Customer-Profile resource. |
status
Optional
|
The verification status of the Customer-Profile resource. |
status_callback
Optional
|
The URL we call to inform your application of status changes. |
friendly_name
Optional
|
The string that you assigned to describe the resource. |
email
Optional
|
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 noncompliant, it will automatically be rejected with a twilio-rejected
status.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.