Cheque OCR API
Read a cheque image and get the account number, account holder name, IFSC and bank details back as structured fields for mandate and vendor onboarding.
Overview
Cheque OCR reads an uploaded cheque image and returns the banking details printed on the leaf as structured fields. In most business flows the cheque is a cancelled cheque, submitted as proof of a bank account. The process wants the account number, the account holder name and the IFSC from it. Typing those details by hand is where payouts break. One wrong digit comes back later as a returned credit or a rejected mandate, and you collect the same document again. Reading the leaf inside your onboarding or mandate flow removes that typing step. Available fields vary by image quality, the bank cheque layout and the data source. Collect the cheque image with consent and a stated purpose, because it carries account details, a name and a signature specimen. Pair the reading with an account verification check before the first payout.
- Category
- Document OCR APIs
- Coverage
- Cheque leaves from Indian banks; what can be read depends on the image and the bank layout
- Input
- A cheque image or scan, usually a cancelled cheque uploaded as proof of a bank account
- Output
- Structured banking fields read from the leaf, which may include account number, account holder name, IFSC, bank and branch, cheque number and the MICR band
- Typical users
- Lenders and NBFCs, insurers, payment platforms, marketplaces, logistics operators, staffing and gig platforms
- Coverage note
- Available fields vary by image quality, the bank cheque layout and the data source. A reading captures the document, and account verification is a separate step.
The overview and the sections after the reference are the FinSour API catalog’s own record for this service, rendered unaltered.
Endpoint URL and method
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Authentication
Send your API key in this header on every call, from your own server: a key sent from a browser is refused. A key starting fs_test_ calls the sandbox and one starting fs_live_ calls production, at the same address. Create keys in the FinSour console.
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Request parameters
Headers
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
Idempotency-Key | string | Required | A key you generate for each attempt. Sending the same key again returns the first answer instead of running the check twice; the same key with a different body is refused. | 8 to 255 characters. Matches ^[A-Za-z0-9._:-]+$ |
FinSour-Version | string | Required | Send 2026-11-01 on this call and on every poll to get the receipt and the result described on this page. A call without it is served under 2026-09-01, whose job has a different shape. | — |
Body
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
file | file | Required | The document to read. | — |
payload | string (JSON) | Required | A JSON string carrying the call's options. | — |
payload. | object | Required | Settings for this call. This API requires consent. | — |
payload. | string | Optional | Your own reference for this call. It comes back unchanged as meta.reference. | 1 to 128 characters |
payload. | object | Required | The person's consent to this check. | — |
payload. | boolean | Required | Send true once the person has agreed to the check. | Always true |
payload. | string (date-time) | Required | When the person gave consent. | — |
payload. | string | Required | What the check is for, for example kyc. | 1 to 64 characters |
Request samples
cURL
curl -X POST https://gateway.staging.finsour.io/v1/documents/cheque \
-H "X-Api-Key: $FINSOUR_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "FinSour-Version: 2026-11-01" \
-F "file=@<path-to-document>" \
-F 'payload={"options":{"consent":{"obtained":"<obtained>","at":"<at>","purpose":"<purpose>"}}}'Node.js
import { openAsBlob } from "node:fs";
const form = new FormData();
form.append("file", await openAsBlob("<path-to-document>"));
form.append("payload", JSON.stringify({
"options": {
"consent": {
"obtained": "<obtained>",
"at": "<at>",
"purpose": "<purpose>"
}
}
}));
const response = await fetch("https://gateway.staging.finsour.io/v1/documents/cheque", {
method: "POST",
headers: {
"X-Api-Key": process.env.FINSOUR_API_KEY,
"Idempotency-Key": crypto.randomUUID(),
"FinSour-Version": "2026-11-01",
},
body: form,
});
console.log(response.status, await response.json());Python
import os
import uuid
import json
import requests
response = requests.post(
"https://gateway.staging.finsour.io/v1/documents/cheque",
headers={
"X-Api-Key": os.environ["FINSOUR_API_KEY"],
"Idempotency-Key": str(uuid.uuid4()),
"FinSour-Version": "2026-11-01",
},
files={"file": open("<path-to-document>", "rb")},
data={"payload": json.dumps({
"options": {
"consent": {
"obtained": "<obtained>",
"at": "<at>",
"purpose": "<purpose>",
},
},
})},
timeout=30,
)
print(response.status_code, response.json())Generated from the fields above. Replace each value in angle brackets with your own; the key is read from FINSOUR_API_KEY.
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Response schema
| Name | Type | Present | Description | Constraints |
|---|---|---|---|---|
data | object | Always | The job that will read the document. | — |
data. | string | Always | The job's id. Poll GET /v1/jobs/{jobId} with it. | Matches ^[0-9A-HJKMNP-TV-Z]{26}$ |
data. | string | Always | Always queued: the job is accepted and has not started. | Always "queued" |
The result
Poll GET /v1/jobs/{jobId}. Once the job has finished, data holds these fields:
| Name | Type | Present | Description | Constraints |
|---|---|---|---|---|
jobId | string | Always | — | — |
status | string | Always | — | One of queued, processing, completed, needs_review, unreadable, failed, expired, cancelled |
documentType | string or null | Always | The kind of document found, once it has been read; null before that. | — |
confidence | number or null | Always | The document's confidence, 0 to 1, to two places; null until it has been read. | Minimum 0. Maximum 1 |
fields | object | Always | What was read. Every key is always present: null means the document does not carry it, or it could not be read with enough confidence. | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fields. | string or null | Always | — | — |
fieldsToReview | array of strings | Always | When status is needs_review, the fields a person should confirm; empty otherwise. | — |
failureReason | string | Sometimes | Present only when status is unreadable or failed. | One of UNREADABLE_IMAGE, LOW_CONFIDENCE, DOCUMENT_TYPE_MISMATCH, UNSUPPORTED_MEDIA_TYPE, FILE_TOO_LARGE, INPUT_CORRUPT, PAGE_LIMIT_EXCEEDED, TIMEOUT, PROCESSING_ERROR |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Error codes
| Code | Status | Meaning | Retrying |
|---|---|---|---|
API_VERSION_UNSUPPORTED | 400 | That API version is no longer supported. | Do not retry automatically |
IDEMPOTENCY_KEY_INVALID | 400 | That Idempotency-Key does not meet the required format. | Do not retry automatically |
IDEMPOTENCY_KEY_REQUIRED | 400 | An Idempotency-Key header is required for this request. | Do not retry automatically |
REQUEST_MALFORMED | 400 | The request could not be parsed. | Do not retry automatically |
AUTH_KEY_EXPIRED | 401 | The API key is not valid. | Do not retry automatically |
AUTH_KEY_INVALID | 401 | The API key is not valid. | Do not retry automatically |
AUTH_KEY_MISSING | 401 | No API key was presented. | Do not retry automatically |
AUTH_KEY_REVOKED | 401 | The API key is not valid. | Do not retry automatically |
INSUFFICIENT_BALANCE | 402 | The available balance is not enough for this request. | Do not retry automatically |
AUTH_IP_NOT_ALLOWED | 403 | This API key may not be used from this address. | Do not retry automatically |
ENTITLEMENT_MISSING | 403 | This organization is not entitled to that product in this environment. | Do not retry automatically |
ORGANIZATION_SUSPENDED | 403 | This organization is not active. | Do not retry automatically |
PRODUCT_NOT_AVAILABLE | 403 | That product is not available. | Do not retry automatically |
PRODUCT_RETIRED | 403 | That product has been withdrawn. | Do not retry automatically |
SCOPE_INSUFFICIENT | 403 | This API key does not carry the scope this product requires. | Do not retry automatically |
PRODUCT_NOT_FOUND | 404 | No such product. | Do not retry automatically |
IDEMPOTENCY_KEY_REUSED | 409 | That idempotency key was already used for a different request. | Do not retry automatically |
PRICE_UNAVAILABLE | 409 | No active price covers this product right now. | Safe to retry |
REQUEST_IN_PROGRESS | 409 | An earlier attempt with this key is still running. | Safe to retry |
SETTLEMENT_PENDING | 409 | This request is awaiting reconciliation by an operator. | Do not retry automatically |
API_VERSION_SUNSET | 410 | That API version passed its announced sunset date. | Do not retry automatically |
REQUEST_TOO_LARGE | 413 | The request body is too large. | Do not retry automatically |
OCR_UNSUPPORTED_MEDIA_TYPE | 415 | That document format is not accepted. | Do not retry automatically |
UNSUPPORTED_MEDIA_TYPE | 415 | That content type is not accepted on this route. | Do not retry automatically |
CONSENT_REQUIRED | 422 | This product requires an explicit consent flag. | Do not retry automatically |
SANDBOX_FIXTURE_MISSING | 422 | No sandbox fixture exists for this input. Use a different test value. | Do not retry automatically |
UPSTREAM_REJECTED | 422 | The upstream source rejected the input. | Do not retry automatically |
VALIDATION_FAILED | 422 | The request payload is invalid. | Do not retry automatically |
CONCURRENCY_LIMIT | 429 | Too many simultaneous requests. | Safe to retry |
OCR_QUEUE_SATURATED | 429 | The document queue is full. Retry shortly. | Safe to retry |
QUOTA_EXCEEDED | 429 | The allowance for this window is spent. | Do not retry automatically |
RATE_LIMITED | 429 | Too many requests. | Safe to retry |
INTERNAL_ERROR | 500 | An unexpected error occurred. | Safe to retry |
OUTCOME_UNCERTAIN | 502 | The outcome of this request is not yet known. Retry with the same Idempotency-Key. | Do not retry automatically |
UPSTREAM_UNAVAILABLE | 502 | The upstream source is unavailable. Retry shortly. | Safe to retry |
MAINTENANCE_MODE | 503 | The service is in a maintenance window. | Safe to retry |
NO_PROVIDER_AVAILABLE | 503 | No provider can serve this product right now. | Safe to retry |
OCR_UNAVAILABLE | 503 | Document reading is unavailable right now. Retry later. | Safe to retry |
SERVICE_OVERLOADED | 503 | The service is shedding load. Retry shortly. | Safe to retry |
UPSTREAM_TIMEOUT | 504 | The upstream source did not respond in time. | Safe to retry |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Rate limits
| Scope | Limit | Window | At the limit |
|---|---|---|---|
| Your API key, within your organisation's limit | The figure in X-RateLimit-Limit | Per minute | 429 RATE_LIMITED, with Retry-After in seconds. Every answer past authentication carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Use cases
- Lending and NBFCs: capture the disbursement account from a cancelled cheque at sanction
- Insurance: read the payout account on claim settlement and premium mandate forms
- Fintech and payment platforms: capture the settlement account during merchant onboarding
- Marketplaces: read seller payout account details sent at registration
- Logistics and fleet: capture transporter and driver-partner payout accounts at onboarding
- Staffing and gig platforms: read worker payout account details collected in bulk on a phone
What this service does
Built for the cancelled cheque
The common case is a cancelled cheque submitted as account proof, marked across the middle and photographed on a desk. The reading targets the fields that workflow needs: account number, account holder name and IFSC.
Reads the printed leaf and the bottom band
A reading may return the account number, the name as printed, the IFSC, bank and branch details, the cheque number and the MICR band. On a filled cheque it can also return date, payee and amount. Which fields you get varies with the data source, the bank layout and the image condition.
Catches payout errors at the point of capture
A transposed account digit or a wrong IFSC shows up days later as a returned credit and a support ticket. Reading the values from the document, then confirming them on screen, moves that failure to the moment the partner is still in the flow.
Sits inside mandate and onboarding journeys
The call runs inside merchant, vendor, seller or partner onboarding and inside mandate collection. You capture bank details in the same session. Nothing waits in a separate operations queue.
How a check runs
Ask for the whole cheque leaf
The vendor, seller, partner or customer uploads a photograph or scan of the cancelled cheque. The whole leaf, including the bottom band, has to sit inside the frame.
Post the cheque image to the API
Your onboarding or mandate flow sends the uploaded file in one request, without moving the case into a separate review queue.
Read back the account, name and IFSC
The response returns the account, name, IFSC and bank details it could read. The fields on offer depend on image quality, bank layout and data source.
Confirm and verify the account
Show the captured values for confirmation, then run an account verification check. The account is then known to be usable before any money moves.
File the details against the partner record
Write the confirmed account details to the vendor, merchant or customer record, and keep the source image alongside them for later reconciliation.
Questions
- What is a Cheque OCR API?
- An interface that accepts a cheque image and returns the banking details printed on it as structured fields. Your application captures the account number, account holder name and IFSC directly. Nobody reads the image and retypes it.
- Can Cheque OCR read a cancelled cheque?
- Yes, and that is the usual case. The reading targets the printed account number, name, IFSC and bank details on a cheque submitted as proof of a bank account. The cancellation mark across the leaf does not normally sit over those fields.
- Which fields do I get back from a cheque image?
- The response may carry the account number, the account holder name as printed and the IFSC. It can also return the bank and branch details, the cheque number, the MICR band, and the date, payee and amount on a filled cheque. Which fields you get varies with the data source, the bank layout and the image quality.
- Does Cheque OCR confirm the bank account is valid?
- No, OCR reports what is printed on the paper. Confirming that the account exists, and identifying the holder, is a separate account verification step. Most teams run the two together so the details are checked before the first payout.
- Why does my cheque upload fail to read?
- The frame is usually the problem. Photographs taken at an angle, folded leaves, shadow across the printed line and crops that cut off the bottom band are the common causes. A capture preview with guides and a clear retry message recovers most of these cases.
- What consent do I need before collecting a cheque image?
- Treat a cheque as personal and financial data, since it carries account details, a name and a signature specimen. Collect it for a stated, lawful purpose, with the account holder consenting to the collection and to any verification that follows. Restrict who can view it, and retain it only as long as your policy and applicable law require.
Catalog entry last updated .