API Documentation

Integrate OTP sending directly into your application using your account API key.

POST /api/v1/otp/send

Send an OTP you generated to a mobile number. Requires x-api-key header.

curl -X POST /api/v1/otp/send \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile": "9876543210",
    "otp": "4821"
  }'

Your application generates the OTP and passes it in the request — the platform never generates it for you. Each successful call validates your mobile number and OTP, checks that your OTP balance is greater than 0, substitutes {{otp}} in the active provider's message template with the value you sent, delivers it, and deducts one credit. If your balance is 0, the API returns Insufficient OTP Balance. The active SMS provider, sender ID, and route are configured by the platform.

GET /api/v1/wallet/balance

Fetch your current OTP credit balance.

curl -H "x-api-key: YOUR_API_KEY" /api/v1/wallet/balance

GET /api/v1/otp/logs

Retrieve your paginated OTP delivery history. Supports ?page= and ?limit=.

curl -H "x-api-key: YOUR_API_KEY" /api/v1/otp/logs?page=1