post https://business-api.test.equal.in/ie/transaction/journey/execute
The businesses can configure these checks with our PAN Basic 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",
"decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
"checks": [],
"data": {
"keys": {
"pan": [
{
"pan_no": "XXXX",
"name": "XXXX XXX",
"dob": "18/05/1992",
"gender": "Male",
"source": "nsdl",
"issuer": "",
"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 |
| When no details found at Source for given PAN Number | 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 |
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, linking this transaction to a specific journey. |
| journey_id | Unique identifier for the journey that the transaction belongs to. |
| status | Indicates the current state of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS. |
| status_code | Code corresponding to the status of the transaction. Refer to the status code table. |
| message | Descriptive message providing details about the status. |
| decision | Outcome of the evaluation. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. |
| checks | List of checks performed during the transaction. |
| pan | Array containing details of PAN-related information. |
| pan_no | The Permanent Account Number (PAN) in masked format. |
| name | Name associated with the PAN as retrieved from the source. |
| dob | Date of birth associated with the PAN holder. |
| gender | Gender of the PAN holder. |
| source | The source from which the PAN data was fetched, e.g., NSDL. |
| issuer | Entity that issued the key, if applicable. |
| decision | Outcome of the evaluation for the key. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. |
| checks | List of checks performed specifically for this key. |