post
https://business-api.test.equal.in/ie/transaction/journey/execute
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This journey enables businesses to perform OCR on the cancelled bank cheque of the user to perform bank account verification.
Journey Input Data
{
"cheque_url":""
}Journey Output Data
{
"status": "SUCCESS",
"message": "Success",
"status_code": "success",
"transaction_id": "",
"journey_transaction_id": "",
"journey_id": "",
"data": {
"insights": null,
"keys": {
"cancelled_cheque_ocr": [
{
"account_number": "",
"ifsc_code": "",
"micr_code": "",
"cheque_leaflet_number": "",
"bank_name": ""
}
]
}
}
}
This journeys does not include any pre-configured Ownership or Fraud Checks. To add these checks, please contact your Account Manager.
Status Codes
Journey ID will be shared as part of Onboarding
| Scenario | Http Status Code | status | status_code | message |
|---|---|---|---|---|
| When request is successful. | 200 | SUCCESS | success | Request successful |
| Invalid image | 200 | FAILURE | invalid_input | Invalid Image, please upload a valid image |
| 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 |
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. |
| account_number | Bank Account Number present on the cheque. |
| ifsc_code | The IFSC code present on the cheque image. |
| micr | The micr present on the cheque image. |
| cheque_leaflet number | The cheque leaflet number present on the image. |
| bank_name | The name of the bank present on the image. |
| status | Status of the GSTIN number |
| 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. |