post https://business-api.test.equal.in/ie/transaction/journey/execute
The Aadhaar OCR Verification journey involves entering the Aadhaar front image and Aadhaar Back image in the Base 64 or URL format.
Businesses can configure these checks with our Aadhaar OCR Verification journey
Journey Input Data
{
"front_url": "<Image URL>",
"back_url":"<Image URL>"
"front_base64": "<Image Base64>",
"back_base64":"<Image Base64>"
}Journey Output Data
{
"transaction_id": "",
"journey_transaction_id": "",
"journey_id": "",
"status": "SUCCESS|FAILURE|IN_PROGRESS",
"status_code": "Refer to the table below",
"message": "Refer to the table below",
"decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
"checks": [],
"data": {
"keys": {
"aadhaar": [
{
"aadhaar_no": "XXXX",
"name": "XXXX XXX",
"source": "nsdl",
"issuer": "",
"decision": "",
"checks": []
}
]
}
}
}This journey does not include any pre-configured Ownership or Fraud Checks. To add these checks, please contact your Account Manager.
Status Codes
| Scenario | Http Status Code | status | status_code | message |
|---|---|---|---|---|
| When request is successful and Aadhaar details are available. | 200 | SUCCESS | success | Request successful |
| When aadhaar_no provided is not a valid Aadhaar format | 200 | FAILURE | invalid_aadhaar_no | aadhaar_no is Invalid |
| Invalid image | 200 | FAILURE | invalid_input | Invalid Image, please upload a valid image |
| When no details found at Source for given Aadhaar Number/ Aadhaar Image | 200 | FAILURE | document_not_found | Entity not found |
| When Input doesn't contain the aadhaar_no field. | 400 | FAILURE | invalid_request | aadhaar_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 |
Status (Journey Status)
| 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. |
Decision
| 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. |
Journey ID will be shared as part of Onboarding
Key Descriptions
| Key | Description |
|---|---|
| transaction_id | Unique identifier for the transaction. |
| journey_transaction_id | Unique identifier for the journey transaction. |
| journey_id | Unique identifier for the journey. |
| status | Current status of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS. |
| status_code | Code representing the specific status of the transaction. Refer to the documentation for possible values. |
| message | Detailed message about the transaction status. Refer to the documentation for specific messages. |
| decision | Final decision based on all checks. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. |
| checks | List of checks performed during the transaction. |
| aadhaar_no | Aadhaar number of the holder. |
| name | Name of the Aadhaar holder. |
| source | Source from which the data was extracted (e.g., nsdl). |
| issuer | Issuer of the Aadhaar (if available). |
| decision (specific key) | Decision for this specific key based on the checks performed. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. |
| checks (specific key) | List of checks performed on this specific key. |