API Documentation

Bank Book Example (SCB)

Bank Book OCR

POST https://api.iapp.co.th/book-bank-ocr/file/

Headers

NameTypeDescription

apikey*

string

Your API Key to call this API

Request Body

NameTypeDescription

file*

file

The binary data of the image, uploaded via POST multipart/form-data

{
    "message": "success",
    "inference_time(s)": 0.784,
    "bank_name": "SCB",
    "account_number": "1234567890",
    "account_name": "นาง บุญยัง โลเปช",
    "branch_name': "0752 ธาตพนม (branch/สาขา)",
    "confidence": 0.883,
    "reason_codes": {
        "account_name": "Success",
        "account_number": "Success",
        "bank_branch": "Success",
        "bank_name": "Success",
    },
    "status": 200
}

Sample Requests

curl --location --request POST 'https://api.iapp.co.th/book-bank-ocr/file'
--header 'apikey: --- Your API Key ---'
--form 'file=@"/your/path/to/image.jpg"'

Parameters

Fields

Description

Bank Name

Name of the bank

Account Number

Account number on the bank book

Account Name

Account name on the bank book

Bank Branch

Name of the bank branch

Return Values

Fields

Type

Description

Message

string

OCR successful / unsuccessful

Status

int

API code

Bank Name

string

Name of the bank

Account Number

string

Account number on the bank book

Account Name

string

Account name on the bank book

Bank Branch

string

Name of the bank branch

Reason Codes

string

Reason for detection failures

Confidence Score

float

Average confidence of the OCR

Inference

float

Time taken to process bank book

Last updated