API Documentation

Bank Book Example (SCB)

Bank Book OCR

POST https://api.iapp.co.th/book-bank-ocr/lineman/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

{
    "account_name": "นาง บุญยัง โลเปช",
    "account_number": "1234567890",
    "bank_branch": "0752 ธาตุพนม",
    "bank_name": "ไทยพาณิชย์ (SCB) - 014",
    "confidence": "77.84",
    "file_name_bookbank": "test",
    "final_reason_codes": {
        "final_code": 0,
        "message": "manuel_check",
        "reason_codes": {
            "reason_code_bookbank": 1,
            "reason_code_bookbank_signature": 0'
            "reason_codename_bookbank_signature": "No signature found"
        }
    },
    "inference_time(s)": "0.177",
    "message": "Success",
    "signature": "",
    "status": 200
}

Sample Requests

curl --location --request POST 'https://api.iapp.co.th/book-bank-ocr/lineman/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

file-name-bookbank

string

Name of the input file

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

signature

string

signature on the bank book

final-reason-codes

dict

Reason for detection failures

confidence

float

Average confidence of the OCR

inference

float

Time taken to process bank book

final-reason-codes (dict)

FieldsTypeDescription

final_code

int

0 (manual check) or 1(pass)

message

string

pass or manual check

reason_codes

dict

reason codes f bank book fields and signature

reason_codes (dict)

FieldsTypeDescription

reason_code_bookbank

int

0 or 1

reason_code_bookbank_signature

int

0 or 1

reason_codename_bookbank_signature

string

Reason if signature not found

Last updated