post https://business-api.test.equal.in/ie/transaction/journey/execute
The businesses can configure these checks with our PAN Detailed Profile Verification journey
Journey Input Data
{
"pan_no": "<10 Char PAN Input>"
}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",
"data": {
"keys": {
"pan": [
{
"name": "xxxxxx",
"dob": "xxxxxx",
"gender": "xxxxxx",
"father's_name": "xxxxxxxxxx",
"issuer_name": "xxxxxx",
"pan_no": "xxxxxx",
"first_name": "xxxxxx",
"middle_name": "xxxxxx",
"last_name": "xxxxxx",
"masked_aadhaar": "xxxxxx",
"pan_aadhaar_link": "xxxxxx",
"is_director": "xxxxxx",
"pan_issue_date": "xxxxxx",
"pan_category": "xxxxxx",
"decision": "",
"checks": []
}
]
}
}
}These journeys do 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 PAN details are available. | 200 | SUCCESS | success | Request successful |
| When pan_no provided is not a valid PAN format | 200 | FAILURE | invalid_pan_no | pan_no is Invalid |
| Invalid image | 200 | FAILURE | invalid_input | Invalid Image, please upload a valid image |
| When no details found at Source for given PAN Number/ PAN Image | 200 | FAILURE | document_not_found | Entity not found |
| When Input doesn't contain the pan_no field. | 400 | FAILURE | invalid_request | pan_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 | |||
| Both formats(Base 64 and URL) are entered | 400 | FAILURE | invalid_request | Enter only one Base 64 or URL |
| None of the inputs (Base 64 or URL) provided | 400 | FAILURE | invalid_request | One of the inputs Base 64 or URL is required |
| 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 |
| Invalid Base 64 | 400 | FAILURE | invalid_request | Invalid base64 content |
| Invalid URL | 400 | FAILURE | invalid_request | Invalid URL |
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. |
| pan | List of PAN-related data points. |
| name | Name of the PAN holder. |
| dob | Date of birth of the PAN holder. |
| gender | Gender of the PAN holder. |
| father's_name | Father's name of the PAN holder. |
| issuer_name | Name of the PAN issuer. |
| pan_no | PAN number of the holder. |
| first_name | First name of the PAN holder. |
| middle_name | Middle name of the PAN holder. |
| last_name | Last name of the PAN holder. |
| masked_aadhaar | Masked Aadhaar number of the PAN holder. |
| pan_aadhaar_link | Indicates whether the PAN is linked to Aadhaar. |
| is_director | Indicates whether the PAN holder is a director in a company. |
| pan_issue_date | Date when the PAN was issued. |
| pan_category | Category of the PAN (e.g., Individual, Company). |
| decision | Overall decision based on the checks performed. |
| checks | List of checks performed on the PAN. |