Latest Legacy

Update a verification request

You can update an existing toll-free verification request if the status of the existing toll-free verification request is listed as SUBMITTED or UPDATE_REQUIRED.

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


ParamDescription
profile_uuid

The unique identifier of an existing Plivo profile.

usecase

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 in comma-separated format.

usecase_summary

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

Example 1 "1. We send 2FA codes to customers when they sign up. 2. Dear <customer name>, you have signed up on Plivo 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

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

A valid URL where you submit images explaining details of the opt-in process for the end user.
Multiple URLs are allowed, separated by commas.

optin_type

Describes how a user opts into text messages. Provide one of the following exact values:

  • 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

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

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

Max character limit = 500.

extra_data

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

callback_url

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

Response

HTTP Response code - 202

{
   "api_id": "c74aa53a-8200-11ee-b92a-0242ac110005",
   "message": "Tollfree verification request for uuid 4bfde431-5317-43cc-644a-2b41e2af4e16 updated successfully."
}