Feel free to reach techsupport@surepass.io for any technical support or guidance.
Authorization
header as Bearer TOKEN
.https://sandbox.surepass.io
https://kyc-api.surepass.io
Header | Required | Description |
---|---|---|
Authorization | Yes | Bearer token for authentication (JWT format) |
Content-Type | Yes | multipart/form-data for file uploads or application/json for base64/URL |
Parameter | Type | Required | Description |
---|---|---|---|
file | File | Yes | The cheque image file to be processed |
micr | Boolean | No | Whether to extract MICR code (default: true ) |
use_pdf | Boolean | No | Set to true if the uploaded file is a PDF |
Parameter | Type | Required | Description |
---|---|---|---|
base_64 | String | Yes | Cheque image encoded in Base64 format |
micr | Boolean | No | Whether to extract MICR code (default: true ) |
use_pdf | Boolean | No | Set to true if the encoded file is a PDF |
Parameter | Type | Required | Description |
---|---|---|---|
link | String | Yes | URL pointing to the cheque image |
micr | Boolean | No | Whether to extract MICR code (default: true ) |
use_pdf | Boolean | No | Set to true if the linked file is a PDF |
{
"link": "https://example.com/path/to/cheque-image.jpg",
"micr": true
}
Parameter | Type | Description |
---|---|---|
data | Object | Container for the extracted cheque information |
data.client_id | String | Unique identifier for the API request |
data.account_number | String | Account number retrieved from the cheque |
data.ifsc_code | String | IFSC code of the bank branch associated with the cheque |
data.amount | String | Amount mentioned on the cheque |
data.bank_name | String | Name of the bank issuing the cheque |
data.date_of_cheque_issued | String | Date the cheque was issued (YYYY-MM-DD format) |
data.receiver_name | String | Name of the receiver mentioned on the cheque |
data.micr_code | String | MICR code as extracted from the cheque |
status_code | Integer | HTTP status code indicating the result of the request |
success | Boolean | Indicates whether the request was successful |
message | String | Human-readable description of the result |
message_code | String | Machine-readable code for the result |
{
"data": {
"client_id": "ocr_cheque_v2_jRlmjcDAmutYqbSYioed",
"account_number": "151201234",
"ifsc_code": "SBIN0005566",
"amount": "6000",
"bank_name": "State Bank of India",
"date_of_cheque_issued": "2018-02-11",
"receiver_name": "MANISH KUMAR",
"micr_code": "029876 412342015⑆ 016991⑈ 11"
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}
{
"error": null,
"message": "Your token is invalid. Please ensure that correct token is being used.",
"status_code": 401,
"success": false,
"message_code": "invalid_token"
}
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ocr/cheque-v2' \
--form 'file=@""' \
--form 'micr="true"' \
--form 'use_pdf="false"'
{
"data": {
"client_id": "ocr_cheque_v2_jRlmjcDAmutYqbSYioed",
"account_number": "151201234",
"ifsc_code": "SBIN0005566",
"amount": "6000",
"bank_name": "State Bank of India",
"date_of_cheque_issued": "2018-02-11",
"receiver_name": "MANISH KUMAR",
"micr_code": "029876 412342015⑆ 016991⑈ 11"
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}