Menu

Expand
Rate this page:

SHAKEN/STIR Onboarding with the Trust Hub REST API (ISVs/Resellers using Subaccounts)

For general information on the Trust Hub API, go to the Trust Hub API Docs.

This page walks ISVs/Resellers using subaccounts through creating a SHAKEN/STIR Trust Product with the Trust Hub REST API.

Not an ISV/Reseller using subaccounts? Find the appropriate onboarding instructions below:

Overview:

There are three main sections in this guide:

  • Create Primary Business Profile in the Console
  • Create Secondary Business Profile under Customer Subaccount, Add Phone Numbers
    • Create Secondary Business Profile, Connect to Primary Business Profile
    • Create a Supporting Document, Connect to Secondary Business Profile
    • Create Business Information, Connect to Secondary Business Profile
    • Create Authorized Representative, Connect to Secondary Business Profile
    • Add Phone Numbers to Secondary Business Profile
    • Submit Secondary Business Profile for Vetting
  • Create Trust Product, Add Phone Numbers, and Submit for Vetting

SHAKEN STIR - ISV with subaccounts: Create Primary Business Profile, Create Secondary Business Profile under Subaccount for Customer, Add Phone Numbers from Subaccount to Secondary Business Profile, Create Trust Product, Add Phone numbers from Secondary Business Profile to Trust Product

Create a Primary Business Profile in your Parent Account in the Console's Trust Hub and submit for vetting.

Create Secondary Business Profile for Customer Subaccount

1. Create a Secondary Business Profile for your Customer's Subaccount

  • You will want to save the sid from the response. This is your Secondary Business Profile SID, and you will need it for the next step.
  • Do not change the PolicySID in the API call below. This is a static value that will be the same across all accounts.

        
        
        

        2. Connect the Secondary Business Profile to your Primary Business Profile

              
              
              

              3. Create a Supporting Document

              • You will need the Address SID for the Secondary Business.
              • This will return the SID for the Supporting Document. You will need this for the next step.
                • The Supporting Document SID will start with "RD"

                    
                    
                    

                    4. Connect the Supporting Document to your Secondary Business Profile

                    • You will need your Secondary Business Profile SID used earlier.
                    • You will need the Supporting Document SID, which was returned in the previous step.
                          
                          
                          

                          5. Create Business Information for the Secondary Business Profile

                          You will need the following information about your Secondary Business:

                          Parameter

                          Definition/Possible Values

                          business_name

                          required

                          Definition: Your Secondary Business' legal business name

                          Possible Values: [any string]

                          business_identity

                          required

                          Definition: Your Secondary Business' structure.

                          Possible Values:

                          direct_customer

                          isv_reseller_or_partner

                          unknown

                          business_type

                          required

                          Definition: Business type for your Secondary Business

                          Possible Values:

                          Sole Proprietorship

                          Partnership

                          Limited Liability Corporation

                          Corporation

                          Co-operative

                          Limited Liability Partnership

                          Non-profit

                          business_industry

                          required

                          Definition: Industry of Secondary Business

                          Possible 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

                          business_registration_identifier

                          required

                          Definition: The official method used to register the Secondary Business' identity.

                          Possible Values:

                          USA: DUNS Number (Dun & Bradstreet)

                          USA: Employer Identification Number (EIN)

                          business_registration_number

                          required

                          Definition: The number used to identify your Secondary Business of the type chosen for your business_registration_identifier

                          Possible Values: [numerical string for USA types]

                          business_regions_of_operation

                          required

                          Definiton: Regions your Secondary Business

                          AFRICA

                          ASIA

                          EUROPE

                          LATIN_AMERICA

                          USA_AND_CANADA

                          website_url

                          required

                          Definition: The URL for the Secondary Business' website

                          Possible Values: [any valid URL string]

                          social_media_profile_urls

                          optional

                          Definition: The URL(s) for the Secondary Business' social media accounts (i.e. LinkedIn, Facebook, Twitter)

                          Possible Values: [any valid URL string]

                          Do not change the Type value. It must be customer_profile_business_information in order to create the correct resource.

                          • You'll need the Business Information SID returned from this API call for the next step.

                                
                                
                                

                                6. Connect Business Information to Secondary Business Profile

                                • You will need the Customer Profile Business Information SID, which was returned in the last step.
                                • The Customer Profile Business Information SID will start with "IT".
                                • To find your Customer Profile Business Information SID via API, see the Read all End Users call in the Additional API Calls section.

                                      
                                      
                                      

                                      7. Create an Authorized Representative for your Secondary Business Profile

                                      • You must add one Authorized Representative as a contact for the Secondary Business.
                                      • A second Authorized Representative is optional.
                                        • To add a second representative repeat this step with the second Authorized Representative's information, but you will need to change the Type parameter to authorized_representative_2
                                      • Information you will need:
                                        • First Name
                                        • Last Name
                                        • Email
                                        • Phone Number
                                        • Business Title
                                        • Job Position
                                          • Possible Values: Director, GM, VP, CEO, CFO, General Counsel
                                      • This call will return the Authorized Representative's SID. You will need this for the next step.

                                            
                                            
                                            

                                            8. Connect Authorized Representative to Secondary Business Profile

                                            • You will need the Authorized Representative's SID, which was returned in the last API call.
                                            • To find the SID via API, see the Read all End Users call in the Additional API Calls section below.
                                            • If you added a second Authorized Representative, you will need to repeat this call with that Representative's SID.

                                                  
                                                  
                                                  

                                                  9. Add Phone Number(s) to Secondary Business Profile

                                                  • You will need your Secondary Business Profile SID.
                                                  • You'll also need your Phone Number SID(s)
                                                    • To find your Phone Number SIDs in the Console, go to your Dashboard for your Customer Subaccount. In the Project Info section, click on See all phone numbers, then click on a phone number to find the SID.
                                                    • To find your Phone Number SIDs via API, see the Additional API Calls section below.
                                                    • Phone Number SIDs begin with "PN".
                                                    • In the API Call below, don't change the ChannelEndpointType. It needs to be phone-number to add a phone number to your Business Profile.

                                                        
                                                        
                                                        

                                                        10. Submit Secondary Business Profile

                                                        • You will need your Secondary Business Profile SID.
                                                        • Do not change the value of the Status parameter. pending-review is needed to properly submit your Secondary Business Profile
                                                              
                                                              
                                                              

                                                              Create Trust Product, Add Phone Numbers, and Submit for Vetting

                                                              1. Create a SHAKEN/STIR Trust Product

                                                              • Note: Do not change the policy_sid from the example below. This is a static value that will stay the same across all accounts.
                                                              • The response will contain the SID for your Trust Product. You'll need this for the next step.
                                                                    
                                                                    
                                                                    

                                                                    2. Connect your SHAKEN/STIR Trust Product to your Secondary Business Profile

                                                                    • You'll need your Trust Product's SID. This was returned by the previous API call.
                                                                    • You'll need your Secondary Business Profile's SID.
                                                                    • To retrieve these SIDs via the API, see the Additional API Calls section below. You can also find them in the Console under Trust Hub.
                                                                          
                                                                          
                                                                          

                                                                          3. Assign phone numbers to your SHAKEN/STIR Trust Product

                                                                          • You'll need the Phone Number SID(s) you assigned to your Business Profile earlier. (Note: Only those phone numbers already assigned to your Secondary Business Profile are eligible)
                                                                          • You'll need your Secondary Buisness Profile SID. It starts with "BU".
                                                                          • Don't change the ChannelEndpointType
                                                                          • You can complete this step before or after submitting your SHAKEN/STIR Trust Product for vetting
                                                                          • To check your Secondary Business Profile's phone numbers via API, see the Additional API Calls section below.
                                                                                
                                                                                
                                                                                

                                                                                4. Submit your SHAKEN/STIR Trust Product for vetting

                                                                                • Once it reaches Twilio-Approved status, you will be able to sign outbound calls with “A” level attestation.
                                                                                      
                                                                                      
                                                                                      

                                                                                      Additional API Calls

                                                                                            
                                                                                            
                                                                                            
                                                                                                  
                                                                                                  
                                                                                                  
                                                                                                        
                                                                                                        
                                                                                                        
                                                                                                              
                                                                                                              
                                                                                                              
                                                                                                                    
                                                                                                                    
                                                                                                                    
                                                                                                                          
                                                                                                                          
                                                                                                                          
                                                                                                                                
                                                                                                                                
                                                                                                                                
                                                                                                                                Rate this page:

                                                                                                                                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 Community Forums or browsing the Twilio tag on Stack Overflow.

                                                                                                                                      
                                                                                                                                      
                                                                                                                                      

                                                                                                                                      Thank you for your feedback!

                                                                                                                                      We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                                                                                                                                      Sending your feedback...
                                                                                                                                      🎉 Thank you for your feedback!
                                                                                                                                      Something went wrong. Please try again.

                                                                                                                                      Thanks for your feedback!

                                                                                                                                      Refer us and get $10 in 3 simple steps!

                                                                                                                                      Step 1

                                                                                                                                      Get link

                                                                                                                                      Get a free personal referral link here

                                                                                                                                      Step 2

                                                                                                                                      Give $10

                                                                                                                                      Your user signs up and upgrade using link

                                                                                                                                      Step 3

                                                                                                                                      Get $10

                                                                                                                                      1,250 free SMSes
                                                                                                                                      OR 1,000 free voice mins
                                                                                                                                      OR 12,000 chats
                                                                                                                                      OR more