/otp/verify
✅ Email as user_id
user_id
These are the possible response codes when you make an API call to the /otp/verify
endpoint using an email address as user_id
.
Warning
If the
/token
endpoint receives five (5) attempts (either successful or failed) within a minute, it will return a429 Too Many Requests
error response. This will block the user account for 5 minutes and will automatically be unblocked when the time has passed.
Response code | Error | Message | Scenario | Resolution |
---|---|---|---|---|
200 OK | Verify OTP successfully | |||
200 OK | Invalid | |||
200 OK | Missing | |||
200 OK | Remove | |||
200 OK | Missing | |||
200 OK | Remove | |||
400 Bad Request |
| "Invalid json format" | Empty payload | Add the payload. |
400 Bad Request |
| "Invalid json format" | Invalid JSON format used in the payload. | Use correct JSON format for the payload. |
403 Forbidden |
| "Forbidden" | Invalid | Enter a valid |
422 Unprocessable Entity | invalid_code' | "message": "Please enter a valid verification code." no error description | Enter an incorrect | Enter a valid |
422 Unprocessable Entity | invalid_code' | "message": "Please enter a valid verification code." no error description | Enter an invalid | Enter a valid |
422 Unprocessable Entity | invalid_code' | "code": "field required" | Removed | Add the |
422 Unprocessable Entity | invalid_parameters' | "client_id":{ no error description | Missing | Enter a valid |
422 Unprocessable Entity | invalid_parameters' | "client_id": "field required" | Removed | Add the |
422 Unprocessable Entity | invalid_parameters' | "user_id":{ no error description | Invalid | Enter a valid |
422 Unprocessable Entity | invalid_parameters' | "user_id":{ no error description | Missing | Enter a valid |
422 Unprocessable Entity | invalid_parameters' | "user_id": "field required" | Removed | Add a |
422 Unprocessable Entity | invalid_parameters' | "auth_type":{ no error description | Invalid | Enter a valid |
422 Unprocessable Entity | invalid_parameters' | "auth_type":{ no error description | Missing | Enter a valid |
422 Unprocessable Entity | invalid_parameters' | "auth_type":"field required" | Removed | Add the |
422 Unprocessable Entity | invalid_parameters' | "message":"Please enter a valid verification code." no error description | Expired OTP code | Use a fresh OTP code. |
429 Too Many Requests |
| "Too many requests" | Attempts rate limit exceeded ( 5 attempts in one minute) | |
502 Bad Gateway | Did not enter | Enter a valid | ||
502 Bad Gateway | Invalid | Enter a valid |
✅ Mobile phone number as user_id
user_id
These are the possible response codes when you make an API call to the /otp/verify
endpoint using a mobile phone number as user_id
.
Response code | Error | Message | Scenario | T |
---|---|---|---|---|
| "Could not send request" | Invalid environment ID | Enter a valid environment ID. | |
200 OK | Successfully verified OTP send from mobile number | |||
200 OK | Invalid | |||
200 OK | Invalid | |||
200 OK | Missing | |||
200 OK | Remove | |||
200 OK | Missing | |||
200 OK | Remove | |||
403 Forbidden |
| "Forbidden" | Invalid | Enter a valid |
422 Unprocessable Entity |
| "client_id": { no error description | Missing | Enter a valid |
422 Unprocessable Entity |
| "client_id": "field required" | Removed | Add the |
422 Unprocessable Entity |
| "message": "Please enter a valid verification code." no error description | Invalid | |
422 Unprocessable Entity |
| "message": "Please enter a valid verification code." no error description | Expired | Enter a valid |
422 Unprocessable Entity |
| "code": "field required" | Removed | Add the |
422 Unprocessable Entity |
| "user_id": { no error description | Invalid | Enter a valid |
422 Unprocessable Entity |
| "user_id": { no error description | Missing | Enter a valid |
422 Unprocessable Entity |
| "user_id": "field required" | Removed | Add the |
422 Unprocessable Entity |
| "auth_type": { no error description | Invalid | Enter a valid |
422 Unprocessable Entity |
| "auth_type": { no error description | Missing | Enter a valid |
422 Unprocessable Entity |
| "auth_type": "field required" | Removed | Add the |
429 Too Many Requests |
| "Too many requests" | Attempts rate limit exceeded ( 5 attempts in one minute) | Limit calls to the endpoint within the rate limit. |
502 Bad Gateway | Missing | Enter a valid | ||
502 Bad Gateway | Invalid | Enter a valid | ||
503 Service Temporarily Unavailable | "Backend action does not exist" | Invalid version Number | Enter a valid |