Latest Legacy

Toll-free Verification Object

The Toll-free Verification Object contains the following fields.

uuid string

The unique identifier for the verification request.

profile_uuidstring

The unique identifier of an existing Plivo profile.

numberstring

The toll-free number for which verification is being initiated.

usecaselist

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 list of strings.

usecase_summary string

The explanation of how messaging will be used on the toll-free phone number(s) by your business.

message_sample string

Sample message(s) that your business will send to the end-user/mobile device. Multiple sample messages are allowed.

optin_image_urllist

A valid URL where you submit images explaining details of the opt-in process for the end user. Multiple URLs are allowed as a list of strings.

Note: This URL should align with the details added to the optin_type.

optin_typestring

Describes how a user opts into receiving 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 string

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 the website, such as a link to the terms of service (TOS) page or privacy policy, that can help clarify the verification request.

extra_data string

Any additional information that you would like to include for your own internal reference.

status string

The status of the toll-free verification request.

rejection_reason string

The reason for toll-free verification rejection.

callback_url string

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

created datetime

The date when the verification request was created.

last_modified datetime

The date when the verification request was last modified.