Make an automated call to any valid phone number and playback a unique security code.
Use this API to verify personal details, help reduce fraud and in authentication systems for implementing multi-factor (MFA and 2FA) authentication.
Supply your own security code for use in TOTP systems (the most common standard for 2FA implementations) or let us auto generate a secure random code.
To then verify a delivered code you can either implement this on your side or use use the verify security code endpoint.
The telephony APIs can operate in two modes, you can place your calls using our VOIP service or your can provide your own SIP trunk.
Using your own SIP trunk allows you to use your own DIDs.
You can also setup voice mail and any other features your VOIP service provider might have.
The number of digits to use in the security code (between 4 and 12)
security-code
no
integer
Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code
playback-delay
no
integer
800
The delay in milliseconds between the playback of each security code
country-code
no
string
ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
language-code
no
string
en
The language to playback the verification code in, available languages are:
de - German
en - English
es - Spanish
fr - French
it - Italian
pt - Portuguese
ru - Russian
limit
no
integer
3
Limit the total number of calls allowed to the supplied phone number, if the limit is reached within the TTL then error code 14 will be returned
limit-ttl
no
integer
1
Set the TTL in number of days that the 'limit' option will remember a phone number (the default is 1 day and the maximum is 365 days)
API Response
Parameter
Type
Description
calling
boolean
True if the call is being made now
number-valid
boolean
True if this a valid phone number
security-code
string
The security code generated, you can save this code to perform your own verification or you can use the Verify Security Code API
API Performance
Characteristic
Value
Description
Avg Latency
20ms
Average RTT for requests within the same data center/region
Max Rate
2/second
Maximum inbound request rate. Exceeding this will result in request throttling
Max Concurrency
10
Maximum concurrent/simultaneous requests. Exceeding this will result in error code 06 [TOO MANY CONNECTIONS]