Toll-Free Numbers Verification API
Last updated
Was this helpful?
Last updated
Was this helpful?
A toll-free number can be used to send messages in US & Canada once it passes an additional verification process. Users who don’t verify their toll-free numbers will be blocked from sending messages as of November 8, 2023.
A verified toll-free number ensures that the business owning the number is identified, and that the message's content has been reviewed and does not oppose the Disallowed Content Policy. This process ensures better deliverability and less filtration.
To set up a new channel to send SMS messages using a toll-free number the following steps are required.
The following API requests can only be made using a valid access key, and attached to an access role, with an access policy that at least specifies the permissions to the resources outlined in each section below. Learn more about API access.
If you do not already have a US or Canadian toll-free number available in your workspace you can find one to purchase.
use the search parameter types=toll-free to only search for Toll Free Numbers
Once you have found an available number you can purchase this by providing the numberStockItemIds matching the id your previous call returned
A successful request to this endpoint will start a recurring monthly subscription based on the monthly cost of the number.
Before you can use a toll-free number to send SMS messages, you must submit a toll-free number verification request and wait for it to be approved.
To reduce the likelihood of rejection, ensure you are familiar with TFN registration examples and best practices. Specifically
Check this article for tips on how to write an effective useCaseSummary
Check this article on how to write an effective optInWorkflowDescription
Most TFN rejections are caused by unclear or incomplete useCaseSummary and/or optInWorkflowDescription
You can submit one toll-free number per verification request.
You are not allowed to submit the same number twice, unless the previous submission was resolved with status Rejected or Verified.
To make this call, you must provide following parameters:
businessName
The name of the Business using Toll Free Number.
businessAddr1
The address of the Business using Toll Free Number.
businessAddr2 (optional field)
The address of the Business using Toll Free Number.
businessCity
The city of the Business using Toll Free Number.
businessState
The state of the Business using Toll Free Number.
businessZip
The zip/postal code of the Business using Toll Free Number.
businessCountry
Country of the Business using Toll Free Number.
corporateWebsite
The website of the Business using Toll Free Number.
businessContactFirstName
Business contact first name.
businessContactLastName
Business contact last name.
businessContactEmail
Business contact email address.
businessContactPhone
Business contact phone number.
messageVolume
Estimate monthly volume of messages from the Toll Free Number. See more details below.
phoneNumbers
IDs of Toll-Free numbers.
useCase
The Category of the use case. See below types of UseCases
useCaseSummary
Please provide a general idea of the use case and customer.
productionMessageContent
Example of message content.
optInWorkflowDescription
Description of the opt in workflow.
optInWorkflowImageUrLs
Images showing the opt in workflow.
additionalInformation (optional field)
Any additional information.
isvReseller (optional field)
ISV Name.
Message Volume can only be of this type:
Fields below are not required for the submission:
201: Created
422: Unprocessable Entity (Invalid verification submission)
400: Bad request
Once you submit your verification request, you must wait for it to be reviewed. You will be informed about the status of your submission in the portal, but you can also use the API to fetch your verification request status.
Submitted
Verification is submitted and waiting to be reviewed
InProgress
Verification is being reviewed by authority. Additional information may be requested. In case of API integration please inspect the `statusMessage` object for more information.
Verified
Verification submission has been approved, and the number is ready to be used.
Rejected
Verification submission has been rejected.
200 OK:
404 Not Found:
If verification is rejected, some information will be provided in the DeclineReasonDescription if is in Progress, and any additional details have been required by the reviewing authority, you can find details in the Message field
You can update verification submission with new information in two cases:
Authority has requested to add additional information. Your input is required.
Always check the ResubmissionAllow filed in the StatusMessage before using this method
Provide more accurate verification information without request of an authority.
200 OK:
404 Not Found:
422: Unprocessable Entity
A TFN may have multiple verifications (example the firs submission was rejected by the reviewing authority ) but only one of them can be active
The ID for the organization.
d0b85ccc-b63a-4e81-b698-c359d77d250eLimits the number of results to return per page. The default value is 10 and maximum is 99. If the nextPageToken is defined on response, you can use it to get remaining numbers. To know more, refer to the pagination section.
Pagination token that keeps of track of the current position in the list. Use it to query remaining results. If not provided, the first page is returned. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.
A 2-digit ISO 3166-1 country code array.
["US","NL"]The number type depending on its purpose. Local for regional use, national for countrywide use, mobile for mobile networks, or toll-free for caller-free charging.
["toll-free"]The number capabilities, which can be voice, SMS, and MMS for inbound, outbound, or two-way communication, plus WhatsApp.
["sms-outbound"]Used to filter numbers belonging to a specific local area-code. It MUST be used in conjunction with the countryCodes filter. Always provide prefixes in full international format.
+1212Assigns Long Code Numbers to the current workspace, charging the wallet for their subscription price. When creating LCNs as a User, all specified Number Stock Items should be reserved.
The ID for the workspace.
d386a801-ee8d-4aba-a7e4-78671bd3b11eThe unique identifiers of the numbers you want to buy. You can buy up to 25 numbers at a time. This operation will incur wallet charges for the numbers. Before buying the number, you must reserve it.
When set, only validates the request payload without mutating any data.