post https://business-api.test.equal.in/ie/transaction/journey/execute
The Aadhaar Digilocker Verification journey enables businesses to verify user's Aadhaar using Digilocker. The verification process would involve 2 steps:
Step 1:
Hit the API to obtain digilocker URL.
{
}Step 2:
Pass the auth_code obtained from the URL to this step to obtain the Digilocker verification data.
Journey Input Data (Step 2)
{
"auth_code":"XXXXXXX"
}Journey Output Data
{
"status": "SUCCESS",
"message": "Success",
"status_code": "success",
"transaction_id": "4af854f3-ec46-4a4d-8e2f-64c48255a682",
"journey_transaction_id": "EQ.GT.8b66c606-727c-4073-8457-b8622b5f24e3#digilocker_pidg_v1#81462ef67e2a4ef791a2b713c98d1742",
"journey_id": "aadhaar_digilocker_dev_test_v1",
"data": {
"keys": {
"aadhaar": [
{
"name": "",
"dob": "",
"gender": "",
"photo": "",
"address": "",
"address_house": "",
"address_street": "",
"address_area": "",
"address_district": "",
"address_state": "",
"address_country": "",
"address_pincode": "",
"key_id": "",
"key_name": "",
"key_source": "",
"key_fetched_at": "",
"issuer_name": "UIDAI",
"co": "",
"uidai_verification_data": {}
}
]
}
}
}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 |
| When no details found at Source for given Aadhaar Number. | 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 |
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 |
|---|---|
| status | Current status of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS. |
| message | Detailed message about the transaction status. |
| status_code | Code representing the specific status of the transaction. Possible values: success, failure, etc. |
| transaction_id | Unique identifier for the transaction. |
| journey_transaction_id | Unique identifier for the journey transaction. |
| journey_id | Unique identifier for the journey. |
| name | Name of the Aadhaar holder. |
| dob | Date of birth of the Aadhaar holder. |
| gender | Gender of the Aadhaar holder. |
| photo | Photo of the Aadhaar holder. |
| address | Full address of the Aadhaar holder. |
| address_house | House number in the Aadhaar holder's address. |
| address_street | Street name in the Aadhaar holder's address. |
| address_area | Area in the Aadhaar holder's address. |
| address_district | District in the Aadhaar holder's address. |
| address_state | State in the Aadhaar holder's address. |
| address_country | Country in the Aadhaar holder's address. |
| address_pincode | Pincode of the Aadhaar holder's address. |
| key_id | Unique identifier for the key. |
| key_name | Name of the key being verified. |
| key_source | Source from which the key data was fetched. |
| key_fetched_at | Timestamp when the key data was fetched. |
| issuer_name | Issuer of the Aadhaar (e.g., UIDAI). |
| co | Care of (CO) address, if available. |
| uidai_verification_data | Additional verification data from UIDAI. |