Request Parameters
Authentication key generated for verification workflows.
Private secret that must accompany the access key.
Recipient phone number (e.g.
+1XXXXXXXXXX) that received the OTP. If a different number is provided the API returns 404 otp_not_found.Verification service identifier. Missing or invalid IDs return
404 service_not_found.The numeric OTP code the user received. Expired or incorrect codes return
400 otp_invalid.Successful Response
Error Scenarios
- 400 otp_invalid – incorrect or expired
otp - 404 otp_not_found – no pending OTP for the supplied
to+serviceId - 401 invalid credentials – authentication failure
- 410 otp_expired – OTP exists but
expiresInhas elapsed - 429 rate_limited – too many verification attempts; wait before retrying
Invalid OTP Example
Limit verification retries per user session to prevent brute-force attempts. Lock the service after repeated
otp_invalid responses.
