Toll-Free Verification API Onboarding Guide
Introducing the Compliance Embeddable for Toll-Free Verification
The Compliance Embeddable is a new offering that allows independent software vendors (ISVs) to onboard their end customers without integrating with the Toll-Free Verification API. By integrating the Compliance Embeddable into your website as an iframe component, you can enable self-service Toll-Free verification. Read more in our blog post on Introducing the Compliance Embeddable for Toll-Free verification.
With the Messaging Compliance API you can submit your North America Toll-Free phone number for verification, so that you're sending compliant messaging traffic through Twilio.
This onboarding guide describes the step-by-step walkthrough of the various API calls you will make to register for Toll-Free Verification capabilities using Twilio APIs.
This guide will cover:
- Getting Started
- Submit a Toll-Free Verification Request
- List Toll-Free Verification Records (optional)
- Retrieve a single Toll-Free Verification Record (optional)
- Edit a rejected & resubmittable Toll-Free Verification Request
- Submission Statuses and Notifications
- Delete a Toll-Free Verification Request
- List of Toll-Free Verification Error Codes
The Toll-Free Verification process requires specific information to be submitted that will help to identify the end business and ensure that these businesses have the right measures in place to send compliant traffic.
Incomplete submissions can be rejected if the appropriate information is not supplied.
Rejected submissions because of incorrect information can be edited via the Resubmit API or the Twilio Console (coming soon).
Info
If you are an ISV, see our support article for guidance on Toll-Free verification for ISVs.
Toll-Free traffic verification is required for all North America Toll-Free phone numbers, including those needing high-throughput. High-Throughput Toll-Free SMS refers to increasing the MPS sending rate of your Toll-Free SMS number.
For details about how Twilio MPS and queueing works, see Toll-Free SMS and MMS messaging throughput (MPS).
Warning
Prior to submitting a Toll-Free Verification request with Twilio, you will need to create a TrustHub primary Customer Profile for your business. To do so, navigate to Account > TrustHub > Customer Profiles and click Create Primary Business Profile. For step-by-step guidance, see Create a Primary Customer Profile.
Before proceeding with Toll-Free verification for your customers as an ISV (Independent Software Vendor), your Primary Customer Profile must be in an APPROVED state. You can set up your customers with secondary profiles, if desired. Also note that the Primary Customer Profile needs to have ISV, Reseller or Partner value selected for Business Identity.
Primary Customer Profile and Primary Business Profile refer to the same resource in this context.
Info
Copy the Primary Customer Profile SID from your Profile Details (parent account) so it can be used in a later step. This will begin with BUXXXX.
TrustHub Customer profiles can be attached to a parent account or a subaccount, like shown in the graphic below.
Toll-Free verification supports both models, but the subaccount model is recommended, so that customers are separated. The Account SID used in the Messaging Compliance API is where the customer profile for the end business and Toll-Free verification record sits. The customer profile and toll-free phone number must be in the same account for toll-free verification.