API Parameters

Create the experience that works best for your business - a simple request only containing the destination phone number or add up to 18 parameters to create a comprehensive mobile verification capability.

Destination - the phone number you’re sending to. It can be with or without the international prefix for the country of the phone number.

Channel - designates whether the mobile verification request should be sent via SMS text or a voice call

Country - the country code of the phone number you’re sending to if the destination is specified without an international prefix

Template - defines the message body template of the message if you choose to modify the standard template

Brand - the brand parameter can be inserted in the message body to show the company it’s coming from

Code length - the number of characters for the one-time passcode

Code validity - the time in seconds that the one-time passcode is valid for before it expires

Code type - the type of characters used for the code. Options include numeric, numeric with a dash, alphanumeric, all capital alphanumeric, and easy to read alphanumeric.

Language - the language of voice to read the text to the end-user when a voice call is specified as the channel

Source - the from address that is used when delivering an SMS text or the caller ID when delivering a voice call. It can be alphanumeric or numeric, depending on the country.

Voice Profile - designates the voice, gender, and accent to be used in the voice call

Speed - the speed at which the speech in the voice call is spoken

Repetition - the number of times to repeat the content in the voice call

Reset Session - if another code is requested during the validity period, this determines if the same code or a new code will be sent

Resending Interval - a time interval in seconds that is defined to avoid sending multiple codes to the same number in the given time interval

Encoding - the character set encoding to be used when sending an SMS text. The API can analyze the text message body and automatically choose the correct encoding, or GSM7 or UCS2 can be manually selected.

API Key - the specific API key from the portal that is to be used for the API request

Subaccount ID - the specific subaccount ID from the portal that is to be used for the API request