For AI agents: visit https://developer.equal.in/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
| Scenario | Http Status Code | status | status_code | message |
|---|
| When request is successful and details are available. | 200 | SUCCESS | success | Request successful |
| When id_no provided is not a valid format | 200 | FAILURE | invalid_input | id_no is Invalid |
| Invalid image | 200 | FAILURE | invalid_input | Invalid Image, please upload a valid image |
| When no details found at Source for given Image | 200 | FAILURE | document_not_found | Entity not found |
| When Input doesn't contain the id_no field. | 400 | FAILURE | invalid_request | id_no is required |
| Invalid Client Credentials | 401 | FAILURE | invalid_credentials | Invalid Client Credentials |
| Any unhandled error from Equal end | 500 | FAILURE | internal_server_error | Something went wrong, please try again. |
| Too many requests | 429 | No object will be sent, throttling happens at the gateway level. | | |
| Service Unavailable | 503 | | | |
| Anything other request found than 2 base64 or 2 URLs | 400 | FAILURE | invalid_request | Invalid Request |
| Unsupported media types | 400 | FAILURE | invalid_request | Invalid file type, only PNG, JPG, and JPEG files are allowed |
| Image too large | 400 | FAILURE | invalid_request | File size exceeds the maximum limit of 2MB |
| Possible Values | Description |
|---|
| SUCCESS | Shows that the verification process was completed successfully. |
| FAILURE | Indicates that the verification process did not succeed. |
| IN_PROGRESS | Signifies that the verification process is currently underway and has not yet been completed. |
| Possible Values | Description |
|---|
| CLEAR | Indicates that the verification has been completed and the information is confirmed as accurate and legitimate. |
| MUST REVIEW | Signifies that further review is needed due to potential issues or inconsistencies in the verification results. |
| NEEDS REVIEW | Suggests that the verification has identified areas that require further investigation or clarification before a final determination can be made. |