Send an OTP /api/sms/otp/send

Developing

POST

/api/sms/otp/send

Generates a one-time passcode, sends it via the dedicated OTP channel
("Your OTP for {brand} is: 1234"), and returns a reference to verify against. The
code itself is never returned or stored in plain text. Billed like a single SMS.

Body

Field	Type	Required	Notes
`recipient`	string	yes	E.164 (e.g. `+2348012345678`).
`sender_id`	string (uuid)	no	Approved sender ID used as the OTP brand. Defaults to your approved/default sender ID.
`length`	integer	no	Digits in the code, 4–8 (default 4).
`expiry_minutes`	integer	no	Validity window, 1–30 (default 5).
`hash_string`	string	no	11-char app signature for Android SMS Retriever auto-fill.

Success — 200 OK

{
  "success": true,
  "message": "OTP sent successfully",
  "data": { "reference": "a3d5f0c1-…", "expires_at": "2026-06-23T10:05:00.000Z", "status": "sent" }
}

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://prod.your-api-server.com/api/sms/otp/send' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "recipient": "string",
    "sender_id": "3194e023-c19f-4a42-9172-9e18d68e3a3a",
    "length": 0,
    "expiry_minutes": 0,
    "hash_string": "string"
}'

Response Example

{
  "success": true,
  "message": "OTP sent successfully",
  "data": { "reference": "a3d5f0c1-…", "expires_at": "2026-06-23T10:05:00.000Z", "status": "sent" }
}

Modified at 2026-06-23 14:25:03

Check wallet balance /api/sms/balance

Verify an OTP /api/sms/otp/verify