Menu

Expand
Rate this page:

SHAKEN/STIR Onboarding with the Trust Hub REST API (Direct Customers using Subaccounts)

The Trust Hub REST API is in Private Beta.

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

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

Not a Direct Customer using subaccounts? Find the appropriate onboarding instructions below:

Direct Customers using Subaccounts

SHAKEN STIR - Direct Customer using Subaccounts: Create a Primary Business Profile under your Parent Account. Add Phone Numbers from Subaccounts to the Primary Business Profile. Create Trust Product, add phone numbers from Primary Business Profile

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

2. Add Phone Number(s) from your Subaccount(s) to your Primary Business Profile

  • This is required before you can add a phone number to your SHAKEN/STIR Trust Product.
  • You'll need your Business Profile's SID
    • To find your Business Profile SID in the Console, navigate to Trust Hub --> Customer Profiles --> View Profile Details.
    • If you'd prefer to use the Trust Hub API to do this, see the Additional API Calls section.
    • Business Profile SIDs start with "BU".
  • You'll also need your Phone Number SID(s) from your subaccount(s).
    • To find your Phone Number SIDs in the Console, first navigate to your subaccount (Settings --> Subaccounts --> View Subaccount), then go to Phone Numbers, and click on the phone number.
    • To find your Phone Number SIDs via API (you'll need your Subaccount SID(s), which can be found in the Console or via API), see the Additional API Calls Section.
    • 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.
        
        
        

        3. Create a SHAKEN/STIR Trust Product

        • Note: Do not change the policy_sid from the example below.
        • The response will contain the SID for your Trust Product. You'll need this for the next step.
              
              
              

              4. Connect your SHAKEN/STIR Trust Product to your Business Profile

              • You'll need your Trust Product's SID. This was returned by the previous API call.
              • You'll need your 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.
                    
                    
                    

                    5. 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 Primary Business Profile are eligible)
                    • You'll need your Buisness Profile SID used earlier. 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 Business Profile's phone numbers via API, see the Additional API Calls section below.
                          
                          
                          

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

                                      
                                      
                                      
                                            
                                            
                                            
                                                  
                                                  
                                                  
                                                  Replace $TWILIO_ACCOUNT_SID in the URL with your Subaccount SID

                                                  Get Phone Number SIDs from Subaccount

                                                  Replace $TWILIO_ACCOUNT_SID in the URL with your Subaccount SID
                                                        
                                                        
                                                        
                                                              
                                                              
                                                              
                                                              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 our Twilio 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