Cheque Extraction
Introduction
The Cheque Extraction API is tailored to retrieve data from cheque images. By providing the URL of the cheque image, the API delivers structured and accurate data extracted from the cheque. This includes crucial information like the account holder's name, cheque number, account number, bank and branch details, MICR code, IFSC code, and other pertinent information.
Performance metrics:
Accuracy: 86% 95% of responses within 7.5 secs.
API details
Endpoint
POST https://api.signzy.app/api/v3/cheque/extractionsPOST https://api-preproduction.signzy.app/api/v3/cheque/extractionsRequest headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Request body parameters
Parameter | Data type | Description | Required |
|---|---|---|---|
files | Array of Strings | An array containing the URL of the files being extracted. Only one file URL can be extracted at once. | Mandatory |
{
"files": [
"https://preproduction-persist.signzy.tech/api/files/39733953/download/0000000.pdf"
]
}Code samples
curl --location 'https://api.signzy.app/api/v3/cheque/extractions' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Your access token>' \
--data '{
"files": [
"https://preproduction-persist.signzy.tech/api/files/39733953/download/0000000.pdf"
]
}'Response body parameters
Parameter | Data Type | Description |
|---|---|---|
files | Array of Strings | URL of files being extracted. |
id | Integer | Unique ID for the request. |
result | Object | Contains the result of extraction. |
result.address | String | Address as on the cheque. |
result.ifsc | String | IFSC code. |
result.pincode | String | Pincode. |
result.accountNumber | String | Bank account number. |
result.bankName | String | Name of the bank. |
result.chequeNumber | String | Cheque number. |
result.accountType | String | Type of bank account.If available. The possible values are: Savings or Current |
result.micrCode | String | MICR code. |
result.contact | String | Contact number, if available. |
result.branch | String | Branch name of the bank. |
result.name | String | Account holder name. |
result.splitAddress | Object | Contains the bank branch address in split format. |
result.splitAddress.district | Array of strings | District. |
result.splitAddress.state | Array of strings | State. |
result.splitAddress.city | Array of strings | City. |
result.splitAddress.pincode | String | Pincode. |
result.splitAddress.country | Array of Strings | Country. |
result.splitAddress.addressLine | String | Address line. |
result.summary | Object | Summary of extracted details. |
result.summary.number | String | Account number. |
result.summary.name | String | Account holder name. |
result.summary.dob | String | Date of birth, if available. In format DD/MM/YYYY. |
result.summary.address | String | Bank branch address. |
result.summary.splitAddress | Object | Contains the Bank branch address in split format. |
result.summary.splitAddress.district | Array of strings | District. |
result.summary.splitAddress.state | Array of strings | State. |
result.summary.splitAddress.city | Array of strings | City. |
result.summary.splitAddress.pincode | String | Pincode. |
result.summary.splitAddress.country | Array of Strings | Country. |
result.summary.splitAddress.addressLine | String | Address line. |
result.summary.gender | String | Gender of the individual, If available. Possible response could be: Male, Female. |
result.summary.guardianName | String | Guardian's name, if available. |
result.summary.issueDate | String | Issue date in format DD/MM/YYYY if available. |
result.summary.expiryDate | String | Expiry date in format DD/MM/YYYY if available. |
{
"files": [
"https://preproduction-persist.signzy.tech/api/files/39733953/download/000000.pdf"
],
"id": 101,
"result": {
"address": "Address",
"ifsc": "<IFSC code>",
"pincode": "000000",
"accountNumber": "<Account Number>",
"bankName": "AXIS BANK",
"chequeNumber": "",
"accountType": "",
"micrCode": "<MICR code>",
"contact": "Contact number",
"branch": "AGRA(UP)",
"name": "<Account holder name>",
"splitAddress": {
"district": [
"AGRA"
],
"state": [
[
"UTTAR PRADESH",
"UP"
]
],
"city": [
"AGRA"
],
"pincode": "000000",
"country": [
"IN",
"IND",
"INDIA"
],
"addressLine": "Address line"
},
"summary": {
"number": "<Account number>",
"name": "<Payer's name>",
"dob": "DD/MM/YYYY",
"address": "Address",
"splitAddress": {
"district": [
"AGRA"
],
"state": [
[
"UTTAR PRADESH",
"UP"
]
],
"city": [
"AGRA"
],
"pincode": "000000",
"country": [
"IN",
"IND",
"INDIA"
],
"addressLine": "Address line"
},
"gender": "",
"guardianName": "",
"issueDate": "",
"expiryDate": ""
}
}
}Document Related Constraints
The size of the document should not exceed 7 MB.
For best results, make sure the image you use fits tightly in the camera view and is horizontally aligned.
Supported document types:
- Image - JPEG, JPG, PNG and TIFF/TIF.
- Single page PDF
Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!