Latest Legacy

Create a new toll-free verification request

It is required to create a Plivo profile before you can start the toll-free verification process via API.

POST https://api.plivo.com/v1/Account/{auth_id}/TollfreeVerification/


ParamDescription
profile_uuid stringRequired

The unique identifier of an existing Plivo profile.

usecase stringRequired

The messaging use case(s) for which the toll-free number will be used. This should be set as one or more of the following options:

  • 2FA
  • ACCOUNT_NOTIFICATION
  • CUSTOMER_CARE
  • DELIVERY_NOTIFICATION
  • FRAUD_ALERT
  • HIGHER_EDUCATION
  • MARKETING
  • POLLING_VOTING
  • PUBLIC_SERVICE_ANNOUNCEMENT
  • SECURITY_ALERT

One use case is mandatory. Multiple use cases can be added as a string.

Example
"2FA, CUSTOMER_CARE"

usecase_summary stringRequired

The explanation of how messaging will be used on this toll-free phone number by your business. To enter multiple summaries, follow one of these best practices:

Example 1
"1. We send 2FA codes to customers when they sign up. 2. We send notifications to customers when they have signed up successfully.."

Example 2 "TWO_FACTOR_AUTHENTICATION - We send 2FA codes to customers when they sign up. ACCOUNT_NOTIFICATIONS - We send notifications to customers when they have signed up successfully."
Max character limit = 500.

message_sample stringRequired

Sample message(s) that you will send to the end user/mobile device. To enter multiple samples, follow one of these best practices:

Example 1
"1. Your Plivo verification code is xxxx. 2. Dear <customer name>, you have signed up on Plivo successfully."

Example 2 "Sample1 - Your Plivo verification code is xxxx. Sample2 - Dear <customer name>, you have signed up on Plivo successfully."
Max character limit = 1000.

optin_image_url stringRequired

A valid URL where you submit images demonstrating the opt-in process for the end user. Multiple URLs are allowed as a string.

Example
"https://www.url1.com, https://www.url2.com"

optin_type stringRequired

Describes how a user opts into text messages. One of the following exact values should be provided:

  • VERBAL
  • WEB_FORM
  • PAPER_FORM
  • VIA_TEXT
  • MOBILE_QR_CODE

-VERBAL must include the sample verbal consent collection and examples in a document linked in the optin_image_url parameter.
-WEB_FORM must include the link to the form in the optin_image_url parameter.
-PAPER_FORM must include a link to the form in the optin_image_url parameter. It can be a scanned image.
-VIA_TEXT must describe the keyword campaign in a document linked in the optin_image_url parameter.
-MOBILE_QR_CODE must include the QR code in a document linked in the optin_image_url parameter.
The sample submitted in the opt-in_image_url parameter should match the opt-in type selection.

volume stringRequired

An estimate of the monthly volume of messages you will send from the toll-free number. One of the following exact values should be provided:

  • 1,000
  • 10,000
  • 100,000
  • 250,000
  • 500,000
  • 750,000
  • 1,000,000
  • 5,000,000
  • 10,000,000+

If your monthly volumes are expected to increase, it is advisable to provide a value that accommodates the projected growth and remains suitable for the next six to eight months.

additional_information string

Any additional information related to your website, such as a link to the terms of service page or privacy policy that can clarify the verification request.

Example: “Refer to our privacy policy page here: https://www.plivo.com/legal/privacy/. Under the section "privacy" we clearly explain how we collect, store, and process the customer's personal data including their phone number. Under the sub-section ‘Rights over your personal data’, we also explain in detail the rights a customer has over the collected data and how they can exercise those rights.”
Max character limit = 500.

extra_data string

Any additional information that you would like to pass for your internal references.

Example: Internal ticket reference number - 121111
Max character limit = 100.

number stringRequired

The toll-free number in e.164 format for which verification is being initiated. Only US and Canadian toll-free numbers will be accepted.

Only one toll-free number can be provided.

callback_urlstring

A valid URL where verification-related callbacks will be sent.

Response

HTTP Response code - 201

{
   "api_id": "ffe33a14-81fc-11ee-b92a-0242ac110005",
   "message": "created",
   "uuid": "4a59de5e-204a-47e8-6973-e713f9a1e0ce"
}