post https://business-api.test.equal.in/ie/transaction/journey/execute
The businesses can configure these checks with our Driving Licence Digital Verification journey:
Journey Input Data
{
"front_image": "<Image URL>",
"back_image": "<Image URL>",
"front_base64": "<Image Base 64>",
"back_base64":"<Image Base 64>"
}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": {
"dl": [
{
"dl_no": "<Driving Licence Number as Input>",
"name": "",
"dob": "",
"gender": "",
"swd": "",
"permanent_address": "",
"address": "",
"address_pincode": "",
"blood_group": "",
"authorized_to_drive": "",
"photo": "",
"source": "",
"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 | HttpStatus | status | status_code | message |
|---|---|---|---|---|
| When request is successful and DL details are available. | 200 | SUCCESS | success | Request successful |
| When DL Number provided is not a valid DL Number format | 200 | FAILURE | invalid_dl_no | DL no is invalid |
| When no details found at Source for given DL Number/ DL Image | 200 | FAILURE | document_not_found | Entity not found |
| Invalid Image | 200 | FAILURE | invalid_input | Invalid Image, please upload a valid image |
| Multiple records found | 200 | FAILURE | multiple_records_found | Multiple records found |
| When Input doesn't contain the dl_number field. | 400 | FAILURE | invalid_input | dl_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 | |||
| 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. |
| dl | List of driving license-related data points. |
| dl_no | Driving license number as input for verification. |
| name | Name of the driving license holder. |
| dob | Date of birth of the driving license holder. |
| gender | Gender of the driving license holder. |
| swd | Specially-abled status of the driving license holder (if applicable). |
| permanent_address | Permanent address of the driving license holder. |
| address | Current address of the driving license holder. |
| address_pincode | Pincode of the address of the driving license holder. |
| blood_group | Blood group of the driving license holder (if mentioned). |
| authorized_to_drive | Indicates whether the driving license holder is authorized to drive (Yes/No). |
| photo | Photo of the driving license holder. |
| source | Source from which the data was extracted (e.g., issuing authority). |
| issuer | Issuer of the driving license (e.g., RTO). |
| 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. |