Verify an OTP /api/sms/otp/verify

Developing

POST

/api/sms/otp/verify

Checks a submitted code against its reference. Bounded by attempts (default 5) and
expiry.

Body

Field	Type	Required	Notes
`reference`	string (uuid)	yes	The reference from `POST /sms/otp/send`.
`code`	string	yes	The code the user entered.

Success — 200 OK

{
  "success": true,
  "message": "Code verified.",
  "data": { "verified": true, "status": "verified", "message": "Code verified." }
}

An incorrect/expired/exhausted code returns 200 OK with verified: false and a status
of pending, expired, or failed.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

An incorrect/expired/exhausted code returns 200 OK with verified: false and a status
of pending, expired, or failed.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://prod.your-api-server.com/api/sms/otp/verify' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
    "code": "string"
}'

Response Example

{
  "success": true,
  "message": "Code verified.",
  "data": { "verified": true, "status": "verified", "message": "Code verified." }
}

Modified at 2026-06-23 14:21:27

Send an OTP /api/sms/otp/send

Delivery webhooks