PassbookAdmin Scope

# Passbook

Notes:

* Ensure you have installed the required package to use this SDK method.

* Catalyst does not store any of the files you upload in its systems. The documents you upload are used for one-time processing only. They are not used for ML model training purposes either. Catalyst components are fully compliant with all applicable data protection and privacy laws.

* Document Processing is only relevant to Indian users and is only available in the IN DC. This feature will not be available to users accessing from the EU, AU, US, JP, SA or CA data centers. Users outside of India from the other DCs can access the general OCR component to read and process textual content.

The PASSBOOK model is a part of the Document Processing feature that enables you to process Indian bank passbooks as financial or identity proof documents. This enables you to extract fields of data from a passbook using the OCR technology, and fetch the parameters from it in the response.

The Passbook model supports 11 Indian languages and an additional 8 International languages. You can check the list of languages and language codes from the API documentation.

You must provide the path to the image of the front page of the passbook. You must specify the model type as PASSBOOK using the key modelType.

Notes:

* English will be considered as the default language, if it isn’t specified.

* Identity Scanner will return the response only in English, irrespective of the languages present in the passbook.

**Allowed file formats**: .webp, .jpeg, .png, .bmp, .tiff, .pdf

**File size limit**: 15 MB

The zia reference used in the code snippets below is the component instance created to perform these operations. The promise returned here is resolved to a JSON object.

const fs = require('fs');
const result = await zia.extractOpticalCharacters(fs.createReadStream('/Users/amelia-421/Desktop/passbook.webp'), {language: 'tam', modelType: 'PASSBOOK'}); // Pass the input file with the model type and optional language
console.log(result);

#### Example of Expected Response

A sample response that you will receive is shown below. The response contains the bank details and account details recognized from the passbook such as the bank name, branch, address, account number. The extracted fields of information are assigned to their respective keys. The response also shows if RTGS, NEFT, and IMPS have been enabled for that account.

{
  "text": "{
    \"address\": \"No.20,Gandhi Road,M.G Lane\",
    \"city\": \"Chennai\",
    \"centre\": \"Chennai\",
    \"bankName\": \"ABX BANK LIMITED\",
    \"accountNumber\": \"002001001625859\",
    \"branch\": \"Anna Nagar\",
    \"dateOfOpening\": \"30/08/2012\",
    \"imps\": \"true\",
    \"neft\": \"true\",
    \"district\": \"Chennai\",
    \"contact\": \"801234567\",
    \"micr\": \"641021121\",
    \"name\": \"2312312\",
    \"state\": \"Tamil Nadu\",
    \"rtgs\": \"true\",
    \"ifsc\": \"ABX0000311\"
  }"
}

Notes:

Ensure you have installed the required package to use this SDK method.
Catalyst does not store any of the files you upload in its systems. The documents you upload are used for one-time processing only. They are not used for ML model training purposes either. Catalyst components are fully compliant with all applicable data protection and privacy laws.
Document Processing is only relevant to Indian users and is only available in the IN DC. This feature will not be available to users accessing from the EU, AU, US, JP, SA or CA data centers. Users outside of India from the other DCs can access the general OCR component to read and process textual content.

The Passbook model supports 11 Indian languages and an additional 8 International languages. You can check the list of languages and language codes from the API documentation.

You must provide the path to the image of the front page of the passbook. You must specify the model type as PASSBOOK using the key modelType.

Notes:

English will be considered as the default language, if it isn’t specified.
Identity Scanner will return the response only in English, irrespective of the languages present in the passbook.

Allowed file formats: .webp, .jpeg, .png, .bmp, .tiff, .pdf

File size limit: 15 MB

The zia reference used in the code snippets below is the component instance created to perform these operations. The promise returned here is resolved to a JSON object.

copy

         const fs = require('fs');
const result = await zia.extractOpticalCharacters(fs.createReadStream('/Users/amelia-421/Desktop/passbook.webp'), {language: 'tam', modelType: 'PASSBOOK'}); // Pass the input file with the model type and optional language
console.log(result);
    

Example of Expected Response

copy

         {
  "text": "{
    \"address\": \"No.20,Gandhi Road,M.G Lane\",
    \"city\": \"Chennai\",
    \"centre\": \"Chennai\",
    \"bankName\": \"ABX BANK LIMITED\",
    \"accountNumber\": \"002001001625859\",
    \"branch\": \"Anna Nagar\",
    \"dateOfOpening\": \"30/08/2012\",
    \"imps\": \"true\",
    \"neft\": \"true\",
    \"district\": \"Chennai\",
    \"contact\": \"801234567\",
    \"micr\": \"641021121\",
    \"name\": \"2312312\",
    \"state\": \"Tamil Nadu\",
    \"rtgs\": \"true\",
    \"ifsc\": \"ABX0000311\"
  }"
}
    

Last Updated 2026-07-02 14:51:41 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit

Catalyst Zia Services Java SDK Documentation NodeJS SDK Documentation Python SDK Documentation REST API Documentation

Modular JavaScript SDK

SDK Operations

PassbookAdmin Scope

Example of Expected Response