Skip to main content
POST
/
v2
/
ocr
/
cheque
Extract data from cheque image
curl --request POST \
  --url https://bgv.konnectnxt.com/api/v2/ocr/cheque/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_url": "https://example.com/images/cheque-sample.jpg",
  "micr_details": true
}
'
{
  "status": "success",
  "code": 400,
  "message": "Invalid request parameters",
  "data": {
    "account_name": "John Doe",
    "account_no": "123456789012",
    "bank_name": "ICICI Bank",
    "bank_address": "Mumbai Branch, Maharashtra",
    "ifsc_code": "ICIC0001234",
    "date_of_issue": "2024-01-15",
    "is_scanned": false,
    "micr_cheque_number": "000123",
    "micr_code": "400240001"
  },
  "credits_used": 3,
  "credits_left": 4040
}
Image Requirements:
  • Clear, high-resolution image
  • Cheque should be flat and well-lit
  • All text should be clearly visible
  • Supported formats: JPG, JPEG, PNG

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
document_url
string<uri>
required

Publicly accessible URL of the cheque image to be processed.

Requirements:

  • Must be a valid HTTP/HTTPS URL
  • Image must be publicly accessible
  • Supported formats: JPG, JPEG, PNG
Example:

"https://example.com/images/cheque-front.jpg"

​
micr_details
boolean
default:true

Fetch MICR details

Example:

true

Response

Cheque data extracted successfully

​
status
enum<string>
required

Overall status of the API

Available options:
success,
error
​
code
integer
required

HTTP status code

Example:

400

​
message
string
required

Description of the response or error

Example:

"Invalid request parameters"

​
data
object
required

Extracted cheque information

​
credits_used
integer
required

Represents the total number of credits used in this request.

Example:

3

​
credits_left
integer
required

Represents the remaining credits available for use.

Example:

4040