Post
/otp/verify
Used to validate one-time passwords (OTPs) entered by users against previously generated and stored OTPs.
Body parameters
Verify an OTP
{
"apptoken": "YOUR_APPTOKEN",
"request_id": "",
"otp": ""
} object
apptoken
string Required
Your App token
service_id
string Required
Your OTP integration ID
otp_code
string Required
The OTP code entered by the user
id
string
User identifier. Required if send_by is set to id.
id_type
string
Type of identifier. Required if send_by is set to id.
send_by
string
Determines how the profile is identified. Options: id or contact.
mobile_number
string
Mobile number used to receive the OTP. Required if send_by is set to contact.
Responses
200
200
Success
{
"success": "True",
"code": "200",
"status": "success"
}Incorrect OTP
{
"success": "False",
"code": "200",
"status": "failure",
"error": "Incorrect OTP"
}Expired OTP
{
"success": "False",
"code": "200",
"status": "failure",
"error": "OTP expired"
}Verification Limit Exceeded
{
"success": "False",
"code": "200",
"status": "failure",
"error": "Verification attempts exceeded"
}object
success
boolean
Defaulttrue
ExampleTrue
code
integer
Default0
Example200
status
string
Examplesuccess
400
400