API Documentation

Everything you need to integrate ExtremeVerify into your stack.

Authentication

ExtremeVerify uses API Keys to authenticate requests. You can find your sovereign API key on the Dashboard. Use this key in the apiKey field of your JSON request body.

Note: All verification OTPs generated by the system are valid for exactly 10 minutes. After this window, the OTP will be invalidated automatically.

Daily Usage Policy (Sandbox)

Free Tier accounts are limited to 50 OTPs per day. The usage counter resets automatically every day at 12:00 AM (Midnight).

Content-Type: application/json

Endpoints

POST
/api/send-otp

Dispatches a high-priority Verification OTP to a specified WhatsApp number.

Parameter Type Description
apiKey Required String Your unique API key.
number Required String Target phone number with country code (e.g., 91XXXXXXXXXX). No '+' or spaces. 
{
  "apiKey": "ev_xxxxxxxxxxxxxxxxxxxxxxxx",
  "number": "91XXXXXXXXXX"
}
POST
/api/verify-otp

Validates a user-provided OTP against the stored record for a specific number.

Parameter Type Description
number Required String Target phone number (e.g., 91XXXXXXXXXX).
otp Required String/Number The 6-digit OTP provided by the user. 
{
  "number": "91XXXXXXXXXX",
  "otp": "123456"
}
POST
/api/send-message

Sends a custom message or alert to a specified WhatsApp number.

Parameter Type Description
apiKey Required String Your unique API key.
number Required String Target phone number with country code.
message Required String The custom message content to deliver. 
{
  "apiKey": "ev_xxxxxxxxxxxxxxxxxxxxxxxx",
  "number": "91XXXXXXXXXX",
  "message": "Hello from ExtremeVerify! Your order #1234 has been shipped."
}

Success Response

{
  "success": true,
  "message": "OTP sent successfully",
  "logId": "-O83h..."
}

Error Responses

401 Unauthorized: Invalid or missing API key.

400 Bad Request: Missing number or message.

400 OTP Expired: The provided OTP is no longer valid (10-minute limit reached).

503 Service Unavailable: WhatsApp engine not connected or busy.

Daily Usage & Rate Limiting

To ensure platform stability, Sandbox accounts are limited to 50 successful OTPs/messages per day. Once this limit is reached, all subsequent API calls will fail until the daily reset.

Daily Reset Policy

Your quota automatically resets every day at 12:00 AM (Midnight). You can monitor your real-time usage on the Dashboard's "Daily Load" card.

Limit Exceeded Response (429)

When you reach your daily limit, the API will return a 429 Too Many Requests status code:

{
  "success": false,
  "error": "Daily limit reached",
  "message": "Quota exceeded. Resets at 12:00 AM (Midnight)."
}