post https://business-api.test.equal.in/ie/transaction/journey/execute
The businesses can configure these checks with our VoterID Digital Verification journey
Journey Input Data
{
"epic_no": "<VoterId Epic Number>"
}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": {
"voter_id": [
{
"epic_number": "<VoterId Epic Number>",
"full_name": "",
"dob": "",
"gender": "",
"address": "",
"age": "",
"family_member_name": "",
"family_member_relation": "",
"address_district": "",
"assembly_constituency": "",
"parliamentary_constituency": "",
"location_number": "",
"serial_number": "",
"polling_booth_address": "",
"location_name": "",
"last_date_of_update": "",
"lat_long_of_polling_booth": "",
"section_of_constituency": "",
"source": "",
"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 | HttpStatus | status | status_code | message |
|---|---|---|---|---|
| When request is successful and VoterID details are available. | 200 | SUCCESS | success | Request successful |
| When EPIC Number provided is not a valid EPIC format | 200 | FAILURE | invalid_epic_no | EPIC no is invalid |
| When no details found at Source for given EPIC Number | 200 | FAILURE | document_not_found | Entity not found |
| Multiple records found | 200 | FAILURE | multiple_records_found | Multiple records found |
| When Input doesn't contain the epic_number field. | 400 | FAILURE | invalid_input | epic_number 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. |
| 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. |
| voter_id | List of voter ID-related data points. |
| epic_number | Unique identifier for the voter ID (EPIC Number). |
| full_name | Full name of the voter. |
| dob | Date of birth of the voter. |
| gender | Gender of the voter. |
| address | Full address of the voter. |
| age | Age of the voter. |
| family_member_name | Name of a family member associated with the voter. |
| family_member_relation | Relationship of the family member to the voter. |
| address_district | District of the voter’s address. |
| assembly_constituency | Assembly constituency associated with the voter. |
| parliamentary_constituency | Parliamentary constituency associated with the voter. |
| location_number | Location number related to the voter’s address. |
| serial_number | Serial number associated with the voter ID. |
| polling_booth_address | Polling booth address where the voter is registered. |
| location_name | Name of the location of the polling booth. |
| last_date_of_update | Last date when the voter’s details were updated. |
| lat_long_of_polling_booth | Latitude and longitude of the polling booth location. |
| section_of_constituency | Specific section of the constituency where the voter is registered. |
| source | Source from which the data was extracted (e.g., nsdl). |
| issuer | Issuer of the voter ID. |
| 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. |