Bank Statement OCR

Reads a Thai bank statement and returns the account details and the whole transaction table.

POST/ocr/v3/bank-statement/fileTry it

Price1 ICper page
Served18.6Kcalls

v1.0
Active

Input

OutputPOST /ocr/v3/bank-statement/file

bank_name: ธนาคารกสิกรไทย
account_holder_name: น.ส. สมหญิง ตัวอย่าง
account_number: XXX-2-48512-X
account_type: เงินฝากออมทรัพย์
branch: สาขาซีคอนสแควร์ 2
period_from: 01-04-2018
period_to: 20-09-2018
total_withdrawal_amount: 101797.39
total_deposit_amount: 101780.19
transactions: date: 10-09-2018 description: ฝากเงินสด ไม่มีสมุดคู่ฝาก withdrawal: — deposit: 100 balance: 206.14 channel: 0929

Every field, under Response

Request

curl -X POST "https://api.iapp.co.th/ocr/v3/bank-statement/file" \
  -H "apikey: YOUR_API_KEY" \
  -F "file=@/path/to/document.pdf" \
  -F "target_lang=th" \
  -F "include_confidence=true"

Response

200OK. The fields are explained under Response.

{
    "docs": [
        {
            "message": "success",
            "raw": {},
            "processed": {
                        "bank_name": "ธนาคารกสิกรไทย",
                        "account_holder_name": "น.ส. สมหญิง ตัวอย่าง",
                        "account_number": "XXX-2-48512-X",
                        "account_type": "เงินฝากออมทรัพย์",
                        "branch": "สาขาซีคอนสแควร์ 2",
                        "period_from": "01-04-2018",
                        "period_to": "20-09-2018",
                        "total_withdrawal_amount": 101797.39,
                        "total_deposit_amount": 101780.19,
                        "transactions": [
                                    {
                                                "date": "10-09-2018",
                                                "description": "ฝากเงินสด ไม่มีสมุดคู่ฝาก",
                                                "withdrawal": null,
                                                "deposit": 100.0,
                                                "balance": 206.14,
                                                "channel": "0929"
                                    }
                        ]
            },
            "confidence": {
                        "bank_name": 0.95,
                        "account_holder_name": 0.95,
                        "account_number": 0.95,
                        "account_type": 0.95,
                        "branch": 0.95,
                        "period_from": 0.95
            },
            "process_ms": 4120
        }
    ],
    "docs_count": 1,
    "process_ms": 4300
}

Request

multipart/form-data only; there is no Base64 form. Every page of a PDF is read and billed.

Headers

apikeystringrequired

Your API key, created under API Keys in the control panel.

Body

filefilerequired

The statement. PDF, JPEG, PNG or WEBP, up to 50 MB. Repeatable: several documents in one request.

return_ocrboolean

true to include the raw OCR text.

target_langstring

The language of the extracted values: th, the default, or en.

include_confidenceboolean

Default true: a confidence from 0.00 to 1.00 per field.

/v3/store/ocr/bank-statement is the same endpoint under the store prefix.

Response

The iapp-input-pages header carries the number of pages billed.

docsarray

One entry per document read

docs.processedobject

The fields read from the document

docs.processed.bank_namestring

The bank

docs.processed.account_holder_namestring

The account holder

docs.processed.account_numberstring

As printed, masking X's included

docs.processed.account_typestring

For example เงินฝากออมทรัพย์

docs.processed.branchstring

The branch

docs.processed.period_fromdocs.processed.period_to

The statement period

docs.processed.total_withdrawal_amountdocs.processed.total_deposit_amount

Totals, THB

docs.processed.transactionsarray

One row per transaction

docs.messagestring

Status message

docs.rawobject

The OCR text, when requested

docs.confidenceobject

Confidence per field, 0 to 1

docs.process_msinteger

Processing time, in milliseconds

docs_countinteger

Number of documents read

process_msinteger

Processing time, in milliseconds

Status codes

Code	Meaning
400	Unsupported file extension, or a file over 50 MB
404	Unknown document type in the URL
422	No file attached
500	Processing error; the response carries a code to quote to support

Details

Measured

Field-level accuracy on an internal set of real Thai documents with labels re-verified by eye, including low-resolution photographs and bills partly covered by handwriting.

Measure	Result
Bank statement, 2 documents, 10 fields	100%
All six document types, 25 documents, 147 fields	98.6%

Limits

Only the fields above are extracted.
Degraded scans, glare and handwriting over printed values lower accuracy. Prefer the original PDF, a square-on photograph in even light, or a scan at 300 dpi or more, and route low-confidence fields to review.

Data handling

The service is GDPR and PDPA compliant.

Request​

Response​

Details​

Request

Response

Details