Send smart verify code

Use this action to send a one-time passcode (OTP) to your end user with the Telesign Smart Verify API. The service decides whether it is most effective to send the code in an SMS or in a voice message.

General requirements

  • Authentication: Basic (easiest to implement)
  • Encoding: Accepts only UTF-8 unicode characters as inputs.
  • Accepts: application/x-www-form-urlencoded
  • Responds with: application/json
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

The end user's phone number you want to send a message to, including the country code, as a string of digits without spaces or special characters, beginning with the country dialing code.

string

An abbreviation specifying a use case. Valid options are:

  • ATCK - for use in a 2FA situation like updating an account or logging in
  • BACF - for creating an account where the service may be vulnerable to bulk attacks and fraudsters
  • BACS - for creating an account where the service may be vulnerable to bulk attacks or individual spammers
  • CHBK - for use when someone is trying to buy something expensive or unusual and you want to verify it is really them
  • CLDR - calendar event
  • LEAD - for use in a situation where you require a person to enter personal information in order to obtain information about something like a loan or realty or school, and you want to check if the person is bogus or not
  • OTHR - if you have a situation not addressed by other tags
  • PWRT - for use in a situation where a passwor reset is required
  • RESV - for use when you have end users making reservations and not showing up, and you want to be able to include phone verification in the loop
  • RXPF - for use when you are trying to prevent prescription fraud
  • SHIP - for use when you are sending a shippingnotification
  • THEF - for use when you are trying to prevent an end user from deactivating or redirecting a phone number in order to take over someone else's identity
  • TRVF - for use when you are transferring moneyand you want to check to see if it is approved by sending a text message or phone call to your end user. This is similar to CHBK, but is specifically for a money transaction
  • UNKN - if you have a situation not addressed by other tags (same as OTHR).
string

If you choose to pass a custom message, you use this parameter to indicate what the custom message would be for text to speech (TTS). You MUST set the language parameter if you use this parameter. If a language is not supported, Telesign may choose a default for you. If you do not set the language tag, United States English is assumed. Make sure to use $$CODE$$ in your message string, as this will generate and insert a random string with appropriate length as part of your TTS message.

string

If you use the tts_message parameter you must set the language. Choose from the list of supported languages also used by the Telesign Voice Verify API.

string

If you choose to pass a custom message, you use this parameter to indicate what the custom message would be if an SMS is sent.

string
enum

Overrides the service's automatic method selection (SMS falling back on voice call), and attempts to force it to use your specified method. You can specify either Voice Verify (use call) or SMS Verify (use SMS) as the recommended method to attempt. Telesign uses the override method whenever possible. Telesign may ignore this specified method if the destination device does not support it.

Allowed:
boolean

Overrides the service's automatic method selection (SMS falling back on voice call), and attempts to force it to use your specified method. You can specify either Voice Verify (use call) or SMS Verify (use SMS) as the recommended method to attempt. Telesign uses the override method whenever possible. Telesign may ignore this specified method if the destination device does not support it.

Headers
string
required

application/x-www-form-urlencoded

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json