POST
/
otp
/
request_token

Authorizations

​
Authorization
string
headerrequired

An API key to authenticate requests

Body

application/json
​
recipient
string
required

Recipient of the OTP token

​
length
number
default: 4

Length of the OTP token

Required range: 4 < x < 8
​
expires_in
number
default: 15

Time in minutes before the OTP token expires

Required range: 1 < x < 60
​
token
string

The OTP token to send to the recipient, if not specified, a new token will be generated

Response

200 - application/json
​
id
string
required

ID of the OTP token

​
recipient
string
required

Recipient of the OTP token

​
status
number
required

Status of the OTP token

​
status_desc
string
required

Description of the status of the OTP token

​
created_datetime
string
required

Date and time the OTP token was created

​
updated_datetime
string

Date and time the OTP token was last updated, if any

Data ModelsVerify OTP