A new version of the OTP API is available. This version includes email and WhatsApp as channels. Please consider upgrading. A subscription is required for this version. Please contact your account manager or our sales team.
{
"recipient": "0031601234567",
"sender": "My company"
}
Parameters
Property
Type
Required
Description
recipient
string
Yes
Phone number in international format. e.g. 0031601234567.
sender
string
Yes
The name or phone number of the sender. Please note that alphanumeric sender is not supported in all countries. If allowVoice is true, sender must be a phone number. For alphanumeric senders, the length should be between 3 and 11 characters.
length
integer
No
length of the code (min 4, max 10). default: 5.
expiry
integer
No
expiry in seconds (min 10, max 3600). default: 60 seconds.
allowPush
boolean
No
Allow code to be send via push notification. default: false.
appKey
string
No
The app key GUID.
allowVoice
boolean
No
Send the code via a voice call.
voiceLanguage
string
No
Change the language of the voice call. Supported values: de, en, es, fr, it, nl. Default: en
message
string
No
Set a custom message. You can use the placeholder {code} which will be replaced by the actual code. e.g. Your code is: {code}.
📘
When allowPush is set to true, a valid app key is required
