{ "openapi": "3.0.2", "info": { "title": "Document Extraction Gateway", "description": "\n## Document Extraction API Documentation\n\nWelcome to the comprehensive documentation for the Document Extraction API. This API empowers you to extract valuable information from bank statement ePDFs, Utilitybill ePDFs and any files for OCR process.\n\n### Bank Statement Extraction\n\n#### Option 1: Asynchronous Approach\n\n1. Upload Document: Begin by uploading your statement using the \"Upload Bank Statement\" endpoint.\n2. Check Status: Utilize the \"Get Bank Statement\" endpoint by provided id from the initial step, to monitor the processing status. If the process completes.\n - If the process is ongoing, the \"message\" will indicate \"Pending\". Repeat this step until \"message\" is \"Success\" The extraction outcome, except for \"transactions\" will be included in the response.\n3. Transaction Details: To view the transactions within the statement, invoke the \"Get Bank Statement Transaction\" endpoint.\n4. Flagging and Summary Features (Optional): If required, you can utilize the following optional features:\n - Call \"Flag Batch Bank Statement\" by providing the batch_id from the \"Get Bank Statement\" response. Subsequently, call \"Get Bank Statement Transaction\" again to access flagged transactions.\n - Obtain the statement summary result by calling \"Get Batch Bank Statement Summary\" using the batch_id from the \"Get Bank Statement\" response.\n\n#### Option 2: Synchronous Approach\n\n1. Direct Extraction: Directly upload the statement through the \"Direct Extract Bank Statement\" endpoint.\n2. Await Processing: Wait for processing to conclude; the response will encompass the result, including flagged transactions.\n\n### Utility Bill Extraction\n\n#### Option 1: Asynchronous Approach\n\n1. Upload Document: Initiate the process by uploading your document using the \"Upload Utility Bill\" endpoint.\n2. Check Status: Use the \"Get Utility Bill\" endpoint by providing id from the initial step, to track the processing status. When the process completes.\n - If the process is ongoing, the \"message\" will indicate \"Pending\". Continue checking until \"Success\" appears in the \"message\" The extraction outcome will be present in the response.\n\n#### Option 2: Synchronous Approach\n\n1. Direct Extraction: Upload the utility bills directly using the \"Direct Extract Utility Bill\" endpoint.\n2. Await Processing: Wait for processing to finalize; the response will encompass the extraction result.\n\n### OCR Extraction\n\n#### Option 1: Asynchronous Approach Without Webhook\n\n1. Upload Document: Initiate the process by uploading your documents using the \"Upload Ocr\" endpoint.\n2. Check Status: Use the \"Get Ocr\" endpoint by providing id from the initial step, to track the processing status. When the process completes.\n - If the process is ongoing, the \"message\" will indicate \"Pending\". Continue checking until \"Success\" appears in the \"message\" The extraction outcome will be present in the response.\n\n#### Option 2: Synchronous Approach\n\n1. Direct Extraction: Upload the files directly using the \"Direct Extract Ocr\" endpoint.\n2. Await Processing: Wait for processing to finalize; the response will encompass the extraction result.\n\n#### Option 3: Asynchronous Approach With Webhook\n1. Webhook Registration: If the user has not yet registered a webhook, you must do so through the \"Register Webhook\" endpoint. This is a one-time process, unless you need to change the webhook URL.\n2. Upload Document: Initiate the process by uploading your documents using the \"Upload Ocr\" endpoint.\n3. Await Processing: Wait for processing to finalize; the response will be sent though the Webhook url with request_id for tracking.\n4. [Optional] Check Status: Use the \"Get Ocr\" endpoint by providing id from the initial step, to track the processing status. When the process completes.\n - If the process is ongoing, the \"message\" will indicate \"Pending\". Continue checking until \"Success\" appears in the \"message\" The extraction outcome will be present in the response.\n\n\nThank you for choosing our Document Extraction API. If you have any inquiries or require assistance, feel free to reach out to our support team.\n", "version": "1.15.0" }, "paths": { "/bank_statement": { "get": { "tags": [ "bank_statement" ], "summary": "Get Bank Statement", "description": "

Get Bank Statement

Get bank statement extraction result.

To get bank statement detail, request_id needs to be passed.\nRequest_id can be obtained from the response of \"Upload Bank Statement\".

\n\n

Response Data Dictionary:

Key

Type

Description

Note

result

dict

result of bank statement API

numberic

document identify

example: 5740261556617216

request_id

string

general purpose request identifier

example: 2023-05-11-06-06-50-300aee38-f4bd-4841-8780-a19e03721a7c

user_id

numberic

identify a user who process the service

example: 5634161670881280

batch_id

numberic

unique identifier assigned to a specific group

example: 5740372756004864

slug

string

UpPass form slug

example: \"2hdrmSMT\"; null if it was not used through the Uppass form.

expired_at

string (datetime)

document expiry date

example: \"2023-05-11T05:19:03.842304+00:00\"

created_at

string (datetime)

document created date

example: \"2023-05-11T05:18:03.842304+00:00\"

updated_at

string (datetime)

document updated date

example: \"2023-05-11T05:18:04.290689+00:00\"

extracted_at

string (datetime)

date/time of starting the process

example: \"2023-05-11T05:18:04.290689+00:00\"

bank_code

string

bank code of this statement

password

string

password

example: \"05071985\"; it will be null if the file does not have a password set.

detail

string

detail of bank statement

always null

status

string

processing status

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Status	Description
created	The process has been created.
failed Upload	The file upload has failed.
uploaded	The file has finished uploading.
failed analysis	There was a failure during file analysis.
failed validation	The bank statement did not pass one or more validation rules.
validated	The bank statement has passed all validation checks.
flagged	The document has been marked for further review.
excluded	The document has been excluded from the summary for this batch.

file_name

string

bank statement file name

example: \"scb_1.pdf\"

file_pk

string

unique file id

\"empty\" if version is 3

account_name

string

bank statement account name

example: \"John Does\"

account_number

string

bank statement account number

example: \"XXX-1-23041-X\"

account_type

string

bank statement account type

\"savings account\",\"fixed deposit account\", \"current account\"

address

string

account owner address

null if statement does not contain

applicant_id

string

unique identifier assigned to an individual who has applied the file

null if version is 3

branch_name

string

branch

example: \"SING BURI BRANCH\"; null if statement does not contain

ocr_created_at

string (datetime)

date/time of starting the process

example: \"2023-05-11T05:18:04.290689+00:00\"

statement_period_from

string (datetime)

start date of the statement

example: \"2022-10-19T00:00:00+07:00\"

statement_period_to

string (datetime)

end date of the statement

example: \"2023-04-18T00:00:00+07:00\"

request_date

string (datetime)

bank statement request date

only have for \"th-ktb\" statement

currency

string

currency of statement

example \"THB\", \"IDR\"

external_tracking_id

string

external tracking id for OCR process

template

string

statement's template name

example \"bay_detail_en\", \"bay_condense_th\", \"kbank_th\"

request_expired_at

string (datetime)

request id expired date

always null

checksum

boolean

file integrity

always null

version

numberic

extraction engine development version

page_count

numberic

numbers of the pdf pages

validation_name_match

boolean

is the input name not match with document

true, false

validation_address

boolean

Indicates whether the applicant's provided address is within the\n specified distance limit (address_validation_distance_limit) compare to address in the document.

true, false, null (if the address doesn't exist)

file_modified

boolean

is the information in the document has been modified

true, false

file_url

string

URL that contain the bank statement file

message

string

response status message

", "operationId": "get_bank_statement_bank_statement_get", "parameters": [ { "description": "general purpose request identifier. Example: 2023-03-27-12-14-44-a68c06b2-d79e-402e-a8a1-be3cb10ddadf", "required": true, "schema": { "title": "Request Id", "type": "string", "description": "general purpose request identifier. Example: 2023-03-27-12-14-44-a68c06b2-d79e-402e-a8a1-be3cb10ddadf" }, "name": "request_id", "in": "query" } ], "responses": { "200": { "description": "Success/Pending", "content": { "application/json": { "schema": {}, "examples": { "Success": { "value": { "result": { "id": 5748776287338496, "request_id": "2023-08-17-05-00-40-83f941d8-b9c0-451c-bd98-86287018ffe2", "user_id": 5634161670881280, "batch_id": 5726056312995840, "slug": "credit-ok-f7ff5279-e16d-43f7-98bd-d01842ae05d8", "expired_at": "None", "created_at": "2023-08-17T05:00:55.362122+00:00", "updated_at": "2023-08-17T05:00:56.047735+00:00", "bank_code": "th-bay", "password": "********", "detail": "None", "status": "failed_validation", "file_name": "BAY_992309_11021997.pdf", "file_pk": "empty", "account_name": "John Dose", "account_number": "XXX-1-14208-X", "account_type": "savings account", "address": "None", "applicant_id": "None", "branch_name": "สาขานครปฐม", "ocr_created_at": "2023-08-17T05:00:55.353160+00:00", "statement_period_from": "2022-08-02T00:00:00+00:00", "statement_period_to": "2023-02-01T00:00:00+00:00", "transaction_date_from": "2022-08-02T00:00:00+00:00", "transaction_date_to": "2023-02-01T00:00:00+00:00", "request_date": "None", "request_expired_at": "None", "checksum": "None", "version": 3, "page_count": 89, "currency": "THB", "template": "bay_condense_th", "validation_name_match": true, "validation_address": true, "file_modified": false, "file_url": "https://xxx.xxx" }, "message": "Success" } }, "Pending": { "value": { "result": "None", "message": "Pending" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "error": { "status_code": 404, "detail": "Not Found" } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "unavailable_template": { "value": { "error": { "message": "unavailable_template", "detail": "This document template is currently undergoing maintenance and will be back to normal soon.", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "status_code": 500, "message": "failure", "detail": "failure" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "bank_statement" ], "summary": "Upload Bank Statement", "description": "

Upload Bank Statement

Upload a bank statement file for processing.

This endpoint allows users to upload a bank statement file for processing.\nIt will return a request_id that can be used to retrieve the result through the \"Get Bank Statement\" route.

\n\n

List of Thai banks supported:

Bank Name	Bank Code	Supported Templates
Bangkok Bank	th-bbl	bbl_th, bbl_en
Bangkok Bank (Corporate Statement)	th-bbl-business	bbl_en
Krung Thai Bank	th-ktb	ktb_th, ktb_en
Government Savings Bank	th-gsb	gsb_th, gsb_en
Kasikorn Bank (Corporate and Personal Statement)	th-kbank	kbank_th, kbank_en
TMB Thanachart Bank	th-ttb	ttb_detail_th, ttb_detail_en, ttb_condense_th, ttb_condense_en
TMB Thanachart Bank (Corporate Statement)	th-ttb-business	ttb_en
Siam Commercial Bank	th-scb	scb_without_note_th, scb_with_note_th
Siam Commercial Bank (Corporate Statement)	th-scb-business	scb_horizontal_th, scb_vertical_th
Bank of Ayudhya (Krungsri)	th-bay	bay_detail_th, bay_detail_en, bay_condense_th
Bank for Agriculture and Agricultural Cooperatives	th-baac	baac_th, baac_en
United Overseas Bank	th-uob	uob_th
Land and House Bank	th-lh	lh_th
Kiatnakin Phatra Bank	th-kkp	kkp_th

\n\n

List of Indonesia banks supported:

To extract Indonesia bank statement, the country:\"ID\" must be provided in the form data.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Bank Name	Bank Code
Bank Central Asia	BCA_PERSONAL
Bank Rakyat Indonesia	BRI_PERSONA
Bank Mandiri	MANDIRI_PERSONAL
Bank Negara Indonesia	BNI_PERSONAL

\n\n

List of Philippine banks supported:

To extract Philippine bank statement, the country:\"PH\" must be provided in the form data.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Bank Name	Bank Code
Banco De Oro Unibank	BDO_PERSONAL
Metrobank	METROBANK_PERSONAL
Land Bank of the Philippines	LANDBANK_PERSONAL
BPI Family Savings Bank	BPI_PERSONAL
The Union Bank of the Philippines	UNIONBANK_PERSONAL
Rizal Commercial Banking Corporation	RCBC_PERSONAL

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
request_id	string	general purpose request identifier
nonce	string	unique number
message	string	response status message

", "operationId": "upload_bank_statement_bank_statement_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "title": "Body", "allOf": [ { "$ref": "#/components/schemas/Body_upload_bank_statement_bank_statement_post" } ], "include_in_schema": true } } }, "required": true }, "responses": { "200": { "description": "Upload Success", "content": { "application/json": { "schema": {}, "example": { "request_id": "2023-05-11-06-06-50-300aee38-f4bd-4841-8780-a19e03721a7", "nonce": "dab27a0f-72ef-4fdd-804b-e94527295aa6", "message": "Upload Success" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "examples": { "file_exceeds_1000_page": { "value": { "error": { "message": "file_exceeds_1000_page", "detail": "File exceeds 1,000 page", "status_code": 413 } } }, "uploaded_file_size_exceeds_16_MB": { "value": { "error": { "message": "uploaded_file_size_exceeds_16_MB", "detail": "File size exceeds 16 MB", "status_code": 413 } } } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "incorrect_password": { "value": { "error": { "message": "incorrect_password", "detail": "Incorrect Password", "status_code": 422 } } }, "unprocessable_country_code": { "value": { "error": { "status_code": 422, "detail": "Cannot process this country code." } } }, "unavailable_template": { "value": { "error": { "message": "unavailable_template", "detail": "This document template is currently undergoing maintenance and will be back to normal soon.", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/bank_statement/{id}/transaction": { "get": { "tags": [ "bank_statement" ], "summary": "Get Bank Statement Transaction", "description": "

Get Bank Statement Transaction

Get bank statement transaction result.

To retrieve bank statement transactions, provide the id parameter.\nThe id can be obtained from the response of \"Get Bank Statement\" endpoint.

\n\n

Response Data Dictionary:

Key

Type

Description

Note

message

string

response status message

\n \n \n \n \n \n \n \n \n \n \n \n \n \n

Status	Description
Success	The transaction has been successfully retrieved.
Failure	There was an error processing your request on our server.

results

list

result of bank statement transaction

numberic

order of transactions

example: 1

file_pk

string

unique file id for the document

\"empty\" for version 3

transaction_id

string

unique identifier for each transaction

example: \"f22cf516-e3a4-499f-96a3-a12318e867f4\"

transaction_date

string (datetime)

the date of this transaction

example: \"2022-10-26\"

transaction_type

string

type of transaction

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Types	Description
Credit	TA transaction with incoming amount.
Dedit	A transaction with outgoing amount.
Abnormal	A transaction where the amount is zero for both incoming and outgoing.

chq

string

description to identify the transaction

\"example: \"Transfer Deposit\", \"Payment\"

particular

string

destination of the transaction eg. bank name, bank account, company name

example: \"Paid for Ref X5538 KBank Card\", \"To PromptPay X6703 John-Lennon++\"

channel

string

transaction channel

\"example: \"MOBILE\", \"KBANK\"

deposit

numberic

deposit amont of each transaction

withdrawal

numberic

withdrawal amont of each transaction

balance

numberic

balance amont of each transaction

Get Bank Statement Support List

Get list and status of banks that API support in each country.

This API endpoint provides information about the supported banks in different countries, including their\n status. Users can utilize this endpoint to obtain a list of banks that are supported by the API in a\n specific country.

\n\n

To use this endpoint, you need to provide the following:

\n\n

country: Specify the desired country as a parameter.
Accept-Language: Include the preferred language for instruction in the request header.

\n\n

The API will respond by providing a list of banks supported in the specified country, along with instructions in\n the user's chosen language.

\n\n

List of countries with language supported:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Country	Language Supported
TH (Thai Banks)	\n \n TH (Thai) \n EN (English) :default \n \n
ID (Indonesia Banks)	EN (English)
PH (Philippine Banks)	EN (English)

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
label	string	bank name
sub_title	string	additional information of the bank
logo	string	URL for retrived bank logo
logo_disable	string	URL for retrived bank logo in black and white
value	string	bank code of the bank
is_enable	bool	if this bank are available
is_hidden	bool	if this bank should be hidden (but it still processable)
instructions	list	list of step to retrive statement PDF
is_corporate_statement	bool	if this bank are corporate statements
is_personal_statement	bool	if this bank are personal statements

", "operationId": "get_bank_statement_support_list_bank_statement_support_list_get", "parameters": [ { "description": "Country code for identify what is nationality of bank statement", "required": false, "schema": { "title": "Country", "type": "string", "description": "Country code for identify what is nationality of bank statement", "default": "TH" }, "name": "country", "in": "query" }, { "description": "Whether to return supported for corporate bank statements", "required": false, "schema": { "title": "Is Corporate Statement", "type": "boolean", "description": "Whether to return supported for corporate bank statements", "default": true }, "name": "is_corporate_statement", "in": "query" }, { "description": "Whether to return supported for personal bank statements", "required": false, "schema": { "title": "Is Personal Statement", "type": "boolean", "description": "Whether to return supported for personal bank statements", "default": true }, "name": "is_personal_statement", "in": "query" }, { "description": "Language of returned response", "required": false, "schema": { "title": "Accept-Language", "type": "string", "description": "Language of returned response", "default": "EN" }, "name": "accept-language", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": [ { "label": "Bank of Ayudhya", "sub_title": "", "logo": "https://cdn.uppass.io/logos/banks/circle/BAY/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/BAY/BW.png", "value": "th-bay", "is_enable": true, "is_hidden": false, "instructions": [ "Open the KMA application", "Select the \"Personal Accounts\" menu", "Go to the account for which you want to request a statement", "Press the \"Request Statement\" button", "Select the desired time range or date you want", "Select the language you prefer", "Enter the email details for receiving the statement", "Press the \"Submit Request\" button", "On the \"Request Statement Successful\" page, click the \"Finish\" button", "Go to the email used to request the statement and download the file" ], "is_personal_statement": true, "is_corporate_statement": false }, { "label": "Kasikornbank", "sub_title": "", "logo": "https://cdn.uppass.io/logos/banks/circle/KBANK/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/KBANK/BW.png", "value": "th-kbank", "is_enable": true, "is_hidden": false, "instructions": [ "Open the K Plus application", "Select the \"Transactions\" menu", "Enter the password to log in", "Select the \"Statement\" menu", "Choose the desired language, select the document delivery method, and select the month for which you want the statement", "Press the \"Submit Request\" button", "Go to the email used to request the statement and download the file" ], "is_personal_statement": true, "is_corporate_statement": false }, { "label": "Kasikornbank", "sub_title": "(Corporate statement)", "logo": "https://cdn.uppass.io/logos/banks/circle/KBANK/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/KBANK/BW.png", "value": "th-kbank", "is_enable": true, "is_hidden": false, "instructions": [ "Visit the KBANK Corporate Online Banking website", "Enter your username and password to log in", "Select the account for which you want to request a statement", "Click the \"Account Information\" menu", "Click the \"Request Statement\" button", "Select the period of time for which you want to request a statement", "Click the \"Request\" button", "Click the \"Download\" button to download the statement file" ], "is_personal_statement": false, "is_corporate_statement": true }, { "label": "Krung Thai Bank Public Co. Ltd.", "sub_title": "", "logo": "https://cdn.uppass.io/logos/banks/circle/KTB/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/KTB/BW.png", "value": "th-ktb", "is_enable": true, "is_hidden": false, "instructions": [ "Open the Krungthai Next application", "Go to \"Account\"", "Press the \"Other Menu\" button", "Select \"Statement\"", "Specify the desired time period for requesting the statement and select the preferred language", "Click on the \"Send Statement\" button", "The information will be sent to the specified email address", "Go to the email used to request the statement and download the file" ], "is_personal_statement": true, "is_corporate_statement": false }, { "label": "Siam Commercial Bank", "sub_title": "", "logo": "https://cdn.uppass.io/logos/banks/circle/SCB/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/SCB/BW.png", "value": "th-scb", "is_enable": true, "is_hidden": false, "instructions": [ "Open the SCB Easy application", "Select the \"My Transactions\" menu.", "Select the \"Consolidation page\" menu.", "Select the account you want to request a statement for", "Select \"Other Services\"", "Select \"Request Account Statement\"", "Select the desired time period", "Click \"Request\"", "Go to the email used to request the statement and download the file" ], "is_personal_statement": true, "is_corporate_statement": false }, { "label": "Siam Commercial Bank", "sub_title": "(Corporate statement)", "logo": "https://cdn.uppass.io/logos/banks/circle/SCB/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/SCB/BW.png", "value": "th-scb-business", "is_enable": true, "is_hidden": false, "instructions": [ "Visit the SCB Corporate Online Banking website", "Enter the username and password to log in", "Select the account for which you want to request a statement", "Click the \"Account Information\" menu", "Click the \"Request Statement\" button", "Select the period of time that you would like to request a statement", "Click the \"Request\" button", "Click the \"Download\" button to download the statement file" ], "is_personal_statement": false, "is_corporate_statement": true }, { "label": "TMB Thanachart Bank Public Company Limited", "sub_title": "(Condensed statement are not supported)", "logo": "https://cdn.uppass.io/logos/banks/circle/TTB/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/TTB/BW.png", "value": "th-ttb", "is_enable": true, "is_hidden": false, "instructions": [ "Launch the TTB touch application", "Enter the password to log in", "Select the account for which you want to request information", "Press the \"Other\" button", "Select the \"Request statement\" menu", "Select \"Language\"", "Choose \"Detailed statement\"", "Select the period of time that you would like to request a statement", "Press the \"Issue document\" button", "Press the \"Save file\" button" ], "is_personal_statement": true, "is_corporate_statement": false }, { "label": "TMB Thanachart Bank Public Company Limited", "sub_title": "(Corporate statement)", "logo": "https://cdn.uppass.io/logos/banks/circle/TTB/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/TTB/BW.png", "value": "th-ttb-business", "is_enable": true, "is_hidden": false, "instructions": [ "Visit the TTB Corporate Online Banking website", "Enter the username and password to log in", "Select the account for which you want to request a statement", "Click the \"Account Information\" menu", "Click the \"Request Statement\" button", "Select the period of time that you would like to request a statement", "Click the \"Request\" button", "Click the \"Download\" button to download the statement file" ], "is_personal_statement": false, "is_corporate_statement": true }, { "label": "Bangkok Bank", "sub_title": "", "logo": "https://cdn.uppass.io/logos/banks/circle/BBK/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/BBK/BW.png", "value": "th-bbl", "is_enable": true, "is_hidden": false, "instructions": [ "Go to BualuangM Banking app", "Go to \"Account\"", "Enter the password to login", "Select the account you wish", "Select the 3 dots in the upper right corner", "Select Request statement", "Choose the desired time frame and language, then submit the request", "Go to the email used to request the statement and download the file" ], "is_personal_statement": true, "is_corporate_statement": false }, { "label": "Bangkok Bank", "sub_title": "(Corporate statement)", "logo": "https://cdn.uppass.io/logos/banks/circle/BBK/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/BBK/BW.png", "value": "th-bbl-business", "is_enable": true, "is_hidden": false, "instructions": [ "Visit the BBL e-Corporate Banking website", "Enter the username and password to log in", "Select the account for which you want to request a statement", "Click the \"Account Information\" menu", "Click the \"Request Statement\" button", "Select the period of time that you would like to request a statement", "Click the \"Request\" button", "Click the \"Download\" button to download the statement file" ], "is_personal_statement": false, "is_corporate_statement": true }, { "label": "Government Savings Bank", "sub_title": "", "logo": "https://cdn.uppass.io/logos/banks/circle/GSB/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/GSB/BW.png", "value": "`th-gsb`", "is_enable": true, "is_hidden": false, "instructions": [ "Open the MyMo application by GSB", "Select the menu \"Account\"", "Select the account for which you want to request a transaction statement", "Select \"Statement\"", "Select the desired time frame and language", "Press the \"Submit Request\" button", "On the success page, click the \"Finish\" button", "Go to the email used to request the statement and download the file" ], "is_personal_statement": true, "is_corporate_statement": false }, { "label": "Bank for Agriculture and Agricultural Cooperative", "sub_title": "", "logo": "https://cdn.uppass.io/logos/banks/circle/BAAC/Color.png", "logo_disable": "https://cdn.uppass.io/logos/banks/circle/BAAC/BW.png", "value": "th-baac", "is_enable": true, "is_hidden": false, "instructions": [ "Open the BAAC Mobile Banking application", "Enter the password to log in", "Select the account for which you want to request information", "Tap the \"More\" button", "Select the \"Request statement\" menu", "Select the period of time that you would like to request a statement", "Tap the \"Request\" button", "Tap the \"Save file\" button" ], "is_personal_statement": true, "is_corporate_statement": false } ] } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_country_code": { "value": { "error": { "status_code": 422, "detail": "Cannot process this country code." } } }, "unprocessable_language": { "value": { "error": { "status_code": 422, "detail": "Cannot process on this language." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/batch_bank_statement/{id}/summary": { "get": { "tags": [ "batch_bank_statement" ], "summary": "Batch Bank Statement Summary", "description": "

Get Batch Bank Statement Summary

\n\n

Get statistical information about the batch statement.

\n\n

To retrieve the summary, provide the batch_id parameter.\nThe batch_id can be obtained from the response of \"Get Bank Statement\" endpoint.

\n\n

Note: You need to complete the \"Flag Batch Bank Statement\" before retrieving the summary.

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Field	Description
account_name	Name of the account owner
account_type	Account type
account_number	Account number
persona	\"Salaryman\", \"Non-Salaryman\"
number_of_transactions	Number of transactions
number_of_deposits	Number of deposit transactions
number_of_withdrawal	Number of withdrawal transactions
number_of_unique_channel	Number of unique transaction channels
number_of_unique_withdrawal_channel	Number of unique withdrawal transaction channels
number_of_unique_deposit_channel	Number of unique deposit transaction channels
total_amount_of_withdrawals	Total amount of withdrawals
total_amount_of_deposits	Total amount of deposits
average_deposit_amount	Average deposit amount
average_withdrawal_amount	Average withdrawal amount
median_deposit_amount	Median deposit amount
median_withdrawal_amount	Median withdrawal amount
max_deposit	Maximum deposit amount
min_deposit	Minimum deposit amount
max_withdrawal	Maximum withdrawal amount
min_withdrawal	Minimum withdrawal amount
max_balance	Maximum balance amount
min_balance	Minimum balance amount
initial_balance	Initial balance amount
final_balance	Final balance amount
avg_balance_per_day	Average daily account balance
avg_transactions_per_day	Average number of transactions per day
avg_max_deposit_per_day	Average maximum daily deposit amount
avg_min_deposit_per_day	Average minimum daily deposit amount
avg_max_withdrawal_per_day	Average maximum daily withdrawal amount
avg_min_withdrawal_per_day	Average minimum daily withdrawal amount
avg_num_deposits_per_day	Average number of daily deposit transactions
avg_num_withdrawals_per_day	Average number of daily withdrawal transactions
day_with_the_highest_deposit	Day with the highest deposit amount
day_with_the_highest_withdrawal	Day with the highest withdrawal amount
longest_time_between_transaction	Longest time interval between transactions
shortest_time_between_transaction	Shortest time interval between transactions
avg_time_between_transactions	Average time interval between transactions
top_3_max_deposits_transaction	Top 3 maximum deposit transactions
top_3_min_deposits_transaction	Top 3 minimum deposit transactions
top_3_max_withdrawal_transaction	Top 3 maximum withdrawal transactions
top_3_min_withdrawal_transaction	Top 3 minimum withdrawal transactions
number_of_days_with_deposit	frequency (days) of deposits
number_of_days_with_withdrawal	Frequency (days) of withdrawals
max_transaction_date	Transaction date in statement begins
min_transaction_date	Transaction date in statement ends
has_salary_transaction_last_1_month	Has Salary transactions in the last 1 month
has_salary_transaction_last_3_month	Has Salary transactions in the last 3 month
has_salary_transaction_last_6_month	Has Salary transactions in the last 6 month
own_deposit_count	Numbers of owners deposits
has_own_deposit_last_1_month	Has own deposits in the last 1 month
has_own_deposit_last_3_month	Has own deposits in the last 3 month
has_own_deposit_last_6_month	Has own deposits in the last 6 month
debt_to_income_last_1_month	Loan Repayment divide by Deposit in the last 1 month
debt_to_income_last_3_month	Loan Repayment divide by Deposit in the last 3 month
debt_to_income_last_6_month	Loan Repayment divide by Deposit in the last 6 month
avg_debt_to_income_last_3_month	Average Loan Repayment divide by Deposit in the last 3 month
avg_debt_to_income_last_6_month	Average Loan Repayment divide by Deposit in the last 6 month
loan_institution_count_last_1_month	Number of loan institution in Loan Repayment found in the last 1 month
loan_institution_count_last_3_month	Number of loan institution in Loan Repayment found in the last 3 month
loan_institution_count_last_6_month	Number of loan institution in Loan Repayment found in the last 6 month
sum_loan_repayment_last_1_month	Sum of loan repayment in the last 1 month
sum_loan_repayment_last_3_month	Sum of loan repayment in the last 3 month
sum_loan_repayment_last_6_month	Sum of loan repayment in the last 6 month
sum_deposit_last_1_month	Sum of deposit in the last 1 month
sum_deposit_last_3_month	Sum of deposit in the last 3 month
sum_deposit_last_6_month	Sum of deposit in the last 6 month
sum_withdrawal_last_1_month	Sum of withdrawal in the last 1 month
sum_withdrawal_last_3_month	Sum of withdrawal in the last 3 month
sum_withdrawal_last_6_month	Sum of withdrawal in the last 6 month
sum_deposit_net_passing_last_1_month	Sum of deposit - passing transactions in the last 1 month
sum_deposit_net_passing_last_3_month	Sum of deposit - passing transactions in the last 3 month
sum_deposit_net_passing_last_6_month	Sum of deposit - passing transactions in the last 6 month
days_balance_below_thb1000_last_1_month	Number of days balance below THB 1000 in the last 1 month
days_balance_below_thb1000_last_3_month	Number of days balance below THB 1000 in the last 3 month
days_balance_below_thb1000_last_6_month	Number of days balance below THB 1000 in the last 6 month
has_negative_balance_last_1_month	Has negative balance in the last 1 month
has_negative_balance_last_3_month	Has negative balance in the last 3 month
has_negative_balance_last_6_month	Has negative balance in the last 6 month
inactive_periods_days_last_1_month	Number of days bank statement is inactive in the last 1 month
zero_negative_balance_days_last_1_month	Number of days with zero or negative balance in the last 1 month
diff_30d_60d_rolling_deposit	Deposit in the most recent 30 days of transactions - Deposit in the 31-60 days of transactions
ratio_30d_60d_rolling_deposit	Ratio of the most recent 30 days of transactions / Deposit in the 31-60 days of transactions
diff_30d_60d_std_withdrawal	Standard Deviation of withdrawal in the most recent 30 days of transactions\n - Standard Deviation of withdrawal in the most recent 30 days of transactions
has_negative_net_income_last_1_month	Has negative net income in the last 1 month
has_negative_net_income_last_3_month	Has negative net income in the last 3 month
has_negative_net_income_last_6_month	Has negative net income in the last 6 month
net_income_in_1_month	Net Income in the last 1 month
avg_net_income_in_3_month	Average Net Income in the last 3 month
avg_net_income_in_6_month	Average Net Income in the last 6 month
has_large_tran_last_1_month	Has transactions that are greater than 3 standard deviation of deposit in the last 1 month
has_large_tran_last_3_month	Has transactions that are greater than 3 standard deviation of deposit in the last 3 month
has_large_tran_last_6_month	Has transactions that are greater than 3 standard deviation of deposit in the last 6 month
large_tran_count_last_1_month	Number of deposit > 3 sd deposit in the last 1 month
large_tran_count_last_3_month	Number of deposit > 3 sd deposit in the last 3 month
large_tran_count_last_6_month	Number of deposit > 3 sd deposit in the last 6 month
passing_deposit_count_last_1_month	Number of passing deposit (transfer in and out in the same amount, same day) in the last 1 month
passing_deposit_count_last_3_month	Number of passing deposit (transfer in and out in the same amount, same day) in the last 3 month
passing_deposit_count_last_6_month	Number of passing deposit (transfer in and out in the same amount, same day) in the last 6 month
avg_income_last_6_month	Average income within last 6 months
loan_institution_count	Number of loan instituition the user has transaction with

", "operationId": "batch_bank_statement_summary_batch_bank_statement__id__summary_get", "parameters": [ { "description": "Unique identifier assigned to a specific group. Example: 5726056312995840", "required": true, "schema": { "title": "Batch ID", "type": "integer", "description": "Unique identifier assigned to a specific group. Example: 5726056312995840" }, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "id": 5737844588937216, "user_id": 5634161670881280, "slug": "uppass-71d62960-3ae7-432d-9554-8aee3399f4ac", "created_at": "2023-10-10T04:14:18.551353+00:00", "updated_at": "2023-10-10T11:15:30.423076+00:00", "flagged_at": "2023-10-10T11:15:07.734590+00:00", "applicant_note": { "address_validation_distance_limit": 25.0, "applicant_last_name": "Dose", "applicant_first_name": "John", "applicant_full_name": "จอน โดส" }, "statement_summary": { "number_of_bank_accounts": 1, "persona": "Non-Salaryman", "overall": { "start_date": "2023-07-01", "end_date": "2023-10-31", "number_of_transactions": 81, "number_of_deposits": 25, "number_of_withdrawal": 56, "number_of_unique_channel": 5, "number_of_unique_withdrawal_channel": 3, "number_of_unique_deposit_channel": 4, "total_amount_of_withdrawals": 89688.62, "total_amount_of_deposits": 40269.33, "average_deposit_amount": 1610.77, "average_withdrawal_amount": 1601.58, "median_deposit_amount": 500.0, "median_withdrawal_amount": 460.0, "max_deposit": 10000.0, "min_deposit": 4.0, "max_withdrawal": 18000.0, "min_withdrawal": 19.0, "max_balance": 48839.39, "min_balance": 0.0, "initial_balance": 337.62, "final_balance": 27.05, "avg_balance_per_day": 5172.24, "avg_transactions_per_day": 2.61, "avg_max_deposit_per_day": 2021.95, "avg_min_deposit_per_day": 1803.65, "avg_max_withdrawal_per_day": 2694.22, "avg_min_withdrawal_per_day": 893.87, "avg_num_deposits_per_day": 1.32, "avg_num_withdrawals_per_day": 2.15, "day_with_the_highest_deposit": "2023-07-22", "day_with_the_highest_withdrawal": "2023-07-21", "longest_time_between_transaction": 456.0, "shortest_time_between_transaction": 0.0, "avg_time_between_transactions": 25.5, "number_of_days_with_deposit": 19, "number_of_days_with_withdrawal": 26, "max_transaction_date": "2023-09-29", "min_transaction_date": "2023-07-06", "has_salary_transaction_last_1_month": false, "has_salary_transaction_last_3_month": false, "has_salary_transaction_last_6_month": false, "own_deposit_count": 0, "has_own_deposit_last_1_month": false, "has_own_deposit_last_3_month": false, "has_own_deposit_last_6_month": false, "loan_institution_count_last_1_month": 0, "loan_institution_count_last_3_month": 0, "loan_institution_count_last_6_month": 0, "sum_loan_repayment_last_1_month": 0.0, "sum_loan_repayment_last_3_month": 0.0, "sum_loan_repayment_last_6_month": 0.0, "sum_deposit_last_1_month": 3598.0, "sum_deposit_last_3_month": 40269.33, "sum_deposit_last_6_month": 40269.33, "sum_withdrawal_last_1_month": 4059.0, "sum_withdrawal_last_3_month": 89688.62, "sum_withdrawal_last_6_month": 89688.62, "days_balance_below_thb1000_last_1_month": 7, "days_balance_below_thb1000_last_3_month": 24, "days_balance_below_thb1000_last_6_month": 24, "has_negative_balance_last_1_month": false, "has_negative_balance_last_3_month": false, "has_negative_balance_last_6_month": false, "inactive_periods_days_last_1_month": 25, "zero_negative_balance_days_last_1_month": 0, "sum_deposit_net_passing_last_1_month": 16000.0, "sum_deposit_net_passing_last_3_month": 140929.98, "sum_deposit_net_passing_last_6_month": 140929.98, "diff_30d_60d_rolling_deposit": -13944.33, "ratio_30d_60d_rolling_deposit": 0.14, "diff_30d_60d_std_withdrawal": -1412.76, "has_negative_net_income_last_1_month": true, "has_negative_net_income_last_3_month": true, "has_negative_net_income_last_6_month": true, "net_income_in_1_month": 719.6, "avg_net_income_in_3_month": -20391.69, "avg_net_income_in_6_month": -11652.39, "has_large_tran_last_1_month": true, "has_large_tran_last_3_month": true, "has_large_tran_last_6_month": true, "large_tran_count_last_1_month": 2, "large_tran_count_last_3_month": 2, "large_tran_count_last_6_month": 2, "passing_deposit_count_last_1_month": 12, "passing_deposit_count_last_3_month": 26, "passing_deposit_count_last_6_month": 26, "loan_institution_count": 1, "avg_income_last_6_month": 1342.31, "top_3_max_deposits_transaction": [ { "transaction_id": 60, "type": "deposit", "date": "2023-07-22", "amount": 10000.0 }, { "transaction_id": 95, "type": "deposit", "date": "2023-08-24", "amount": 9600.0 }, { "transaction_id": 21, "type": "deposit", "date": "2023-07-11", "amount": 4800.0 } ], "top_3_min_deposits_transaction": [ { "transaction_id": 75, "type": "deposit", "date": "2023-08-04", "amount": 4.0 }, { "transaction_id": 68, "type": "deposit", "date": "2023-07-25", "amount": 20.0 }, { "transaction_id": 89, "type": "deposit", "date": "2023-08-17", "amount": 33.33 } ], "top_3_max_withdrawal_transaction": [ { "transaction_id": 57, "type": "withdrawal", "date": "2023-07-21", "amount": 18000.0 }, { "transaction_id": 50, "type": "withdrawal", "date": "2023-07-20", "amount": 15000.0 }, { "transaction_id": 67, "type": "withdrawal", "date": "2023-07-24", "amount": 10821.0 } ], "top_3_min_withdrawal_transaction": [ { "transaction_id": 142, "type": "withdrawal", "date": "2023-09-29", "amount": 19.0 }, { "transaction_id": 24, "type": "withdrawal", "date": "2023-07-12", "amount": 19.0 }, { "transaction_id": 12, "type": "withdrawal", "date": "2023-07-09", "amount": 20.0 } ] }, "monthly": [ { "start_date": "2023-10-01", "end_date": "2023-10-31" }, { "start_date": "2023-09-01", "end_date": "2023-09-30", "number_of_transactions": 9, "number_of_deposits": 2, "number_of_withdrawal": 7, "number_of_unique_channel": 4, "number_of_unique_withdrawal_channel": 3, "number_of_unique_deposit_channel": 2, "total_amount_of_withdrawals": 2359.0, "total_amount_of_deposits": 1760.0, "average_deposit_amount": 880.0, "average_withdrawal_amount": 337.0, "median_deposit_amount": 880.0, "median_withdrawal_amount": 260.0, "max_deposit": 1000.0, "min_deposit": 760.0, "max_withdrawal": 800.0, "min_withdrawal": 19.0, "max_balance": 1006.05, "min_balance": 6.05, "initial_balance": 89.31, "final_balance": 27.05, "avg_balance_per_day": 338.11, "avg_transactions_per_day": 2.25, "avg_max_deposit_per_day": 880.0, "avg_min_deposit_per_day": 880.0, "avg_max_withdrawal_per_day": 515.0, "avg_min_withdrawal_per_day": 349.75, "avg_num_deposits_per_day": 1.0, "avg_num_withdrawals_per_day": 1.75, "day_with_the_highest_deposit": "2023-09-28", "day_with_the_highest_withdrawal": "2023-09-20", "longest_time_between_transaction": 456.0, "shortest_time_between_transaction": 0.0, "avg_time_between_transactions": 84.0 }, { "start_date": "2023-08-01", "end_date": "2023-08-31", "number_of_transactions": 23, "number_of_deposits": 10, "number_of_withdrawal": 13, "number_of_unique_channel": 3, "number_of_unique_withdrawal_channel": 2, "number_of_unique_deposit_channel": 3, "total_amount_of_withdrawals": 16348.0, "total_amount_of_deposits": 16780.33, "average_deposit_amount": 1678.03, "average_withdrawal_amount": 1257.54, "median_deposit_amount": 536.0, "median_withdrawal_amount": 600.0, "max_deposit": 9600.0, "min_deposit": 4.0, "max_withdrawal": 5000.0, "min_withdrawal": 100.0, "max_balance": 10068.31, "min_balance": 0.28, "initial_balance": 9.39, "final_balance": 589.31, "avg_balance_per_day": 1517.16, "avg_transactions_per_day": 1.92, "avg_max_deposit_per_day": 2084.5, "avg_min_deposit_per_day": 1960.04, "avg_max_withdrawal_per_day": 1818.5, "avg_min_withdrawal_per_day": 878.88, "avg_num_deposits_per_day": 1.25, "avg_num_withdrawals_per_day": 1.62, "day_with_the_highest_deposit": "2023-08-24", "day_with_the_highest_withdrawal": "2023-08-24", "longest_time_between_transaction": 264.0, "shortest_time_between_transaction": 0.0, "avg_time_between_transactions": 29.45 }, { "start_date": "2023-07-01", "end_date": "2023-07-31", "number_of_transactions": 49, "number_of_deposits": 13, "number_of_withdrawal": 36, "number_of_unique_channel": 5, "number_of_unique_withdrawal_channel": 3, "number_of_unique_deposit_channel": 4, "total_amount_of_withdrawals": 70981.62, "total_amount_of_deposits": 21729.0, "average_deposit_amount": 1671.46, "average_withdrawal_amount": 1971.71, "median_deposit_amount": 353.0, "median_withdrawal_amount": 410.0, "max_deposit": 10000.0, "min_deposit": 20.0, "max_withdrawal": 18000.0, "min_withdrawal": 19.0, "max_balance": 48839.39, "min_balance": 0.0, "initial_balance": 337.62, "final_balance": 5.39, "avg_balance_per_day": 7775.79, "avg_transactions_per_day": 3.27, "avg_max_deposit_per_day": 2220.11, "avg_min_deposit_per_day": 1869.89, "avg_max_withdrawal_per_day": 3817.26, "avg_min_withdrawal_per_day": 1057.9, "avg_num_deposits_per_day": 1.44, "avg_num_withdrawals_per_day": 2.57, "day_with_the_highest_deposit": "2023-07-22", "day_with_the_highest_withdrawal": "2023-07-21", "longest_time_between_transaction": 72.0, "shortest_time_between_transaction": 0.0, "avg_time_between_transactions": 9.5 }, { "start_date": "2023-06-01", "end_date": "2023-06-30" }, { "start_date": "2023-05-01", "end_date": "2023-05-31" } ] }, "statement_summary_features": { "avg_income_last_6_month": 1342.31, "avg_debt_to_income_last_6_month": 19.0, "loan_institution_count": 1 }, "source_from": "uppass" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "error": { "status_code": 404, "detail": "Not Found" } } } } }, "422": { "description": "No Calculable Statement", "content": { "application/json": { "example": { "error": { "message": "no_calculable_statement", "detail": "There are no flagged statements in this batch", "status_code": 422 } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/batch_bank_statement/{id}/flag": { "get": { "tags": [ "batch_bank_statement" ], "summary": "Flag Batch", "description": "

Flag Batch Bank Statement

Flag transaction category and exclusion reason.

\n\n

To process flagging, provide the batch_id parameter.\nThe batch_id can be obtained from the response of \"Get Bank Statement\" endpoint.

\n\n

To see the updated result, you need to call the \"Get Bank Statement Transaction\" endpoint again,\nand the category and exclusion reason will be updated accordingly.

", "operationId": "flag_batch_batch_bank_statement__id__flag_get", "parameters": [ { "description": "Unique identifier assigned to a specific group. Example: 5726056312995840", "required": true, "schema": { "title": "Batch ID", "type": "integer", "description": "Unique identifier assigned to a specific group. Example: 5726056312995840" }, "name": "id", "in": "path" }, { "description": "Flag to use machine learning models in salary transactions flagging", "required": false, "schema": { "title": "Use Ml Flagging", "type": "boolean", "description": "Flag to use machine learning models in salary transactions flagging", "default": false }, "name": "use_ml_flagging", "in": "query" } ], "responses": { "200": { "description": "Success/Failure", "content": { "application/json": { "schema": {}, "examples": { "Success": { "value": { "result": "Success", "message": "flag bank statement complete" } }, "Failure": { "value": { "result": "Failure", "message": "no bank statement to flag" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "error": { "status_code": 404, "detail": "Not Found" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/utility_bill": { "get": { "tags": [ "utility_bill" ], "summary": "Get Utility Bill", "description": "

Get Utility Bill

Get utility bill extraction result.

To get utility bill detail, request_id needs to be passed.\nRequest_id can be obtained from the response of \"Upload Utility Bill\".

\n\n

Response Data Dictionary:

Key

Type

Description

Note

result

dict

result of utility bill API

numberic

document id

example: 5708800317194240

request_id

string

general purpose request identifier

example:\"2023-05-11-05-21-43-b8f96414-dddf-4a8d-a480-96645b5f5206\"

user_id

numberic

identify a user who process the service

example: 5634161670881280

batch_id

numberic

unique identifier assigned to a specific group

example: 5124005757452288

slug

string

UpPass form slug

example: \"2hdrmSMT\"

expired_at

string (datetime)

document expiry date

always null

created_at

string (datetime)

document created date

example: \"2023-08-31T07:30:49.485645+00:00\"

updated_at

string (datetime)

document updated date

example: \"2023-08-31T07:30:49.804214+00:00\"

utility_bill_type

string

type of utility bill

example: \"th-ais\"

password

string

password of file

It will be null if the file does not have a password set.

detail

string

detail of utility bill

always null

status

string

processing status

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Status	Description
created	The process has been created.
failed Upload	The file upload has failed.
uploaded	The file has finished uploading.

file_name

string

utility bill file name

example: \"ais_123456.pdf\"

invoice_date

string (datetime)

invoice date in document

example: \"2023-01-07T00:00:00+07:00\"

name

string

name of utility bill

example: \"John Does\"

address

string

address of utility bill

example: \"64 Pan Rd., Silom, Bangrak, Bangkok, 10500; Thailand\"

package_details

list

details of package and number

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
description	string	package description.
type	string	type of package (\"main\", \"other\").
price	numberic	price of the package.
expiry_date	string	package expiry date.

\n (See the example demonstrated in the 'Example Response' section)\n

usage

numberic

number of billing units

example: 123.4; null if bill does not contain

usage_details

list

details of usage

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Description
voice	Usage details for calls, separated by \"minutes\" and \"seconds\"
data	Usage details for data, separated by \"gigabytes (GB)\", \"megabytes (MB)\", and \"kilobytes (KB)\"
sms	Number of sent SMS messages
mms	Number of sent MMS messages
unit	Unit of measurement for user's usage

\n (See the example demonstrated in the 'Example Response' section)\n

amount

numberic

total amount to be paid

example: 999.99

due_date

string (datetime)

last period date of bill payment

example: \"2023-01-23T00:00:00+07:00\"

bill_overdue

numberic

the total number of the bill that has not been paid by the due date

example: 1.0; null if bill does not contain

overdue_amount

numberic

the amount of money that has not been paid by the due date

example: 555.5

branch

string

branch name

example: \"Bangrak\"; null if bill does not contain.

bill_cycle

string

period bill date

example: \"2022-12\"

registered_id

string

id of user

example: \"020020979366\"; null if bill does not contain.

phone_number

string

main phone number

example: \"0123456789\"; null if bill does not contain.

registration_numbers

list

collection of all the numbers present in the bill

(See the example demonstrated in the 'Example Response' section)

current_amount

numberic

the amount of money in the current month

example: 868.16; null if bill does not contain

printed_at

string (datetime)

date/time of document printing

example: \"2023-01-07T10:02:14+07:00\"; null if bill does not contain.

registered_name

string

name of the user who is enrolling for the service

example: \"John Lennon\"

advance_amount

numberic

overpaid amount

example: 456.0; null if bill does not contain

invoice_number

string

invoice number

example: \"W-IN-18-6512-0166224\"; null if bill does not contain.

history_usage

list

usage history

(See the example demonstrated in the 'Example Response' section)

payment_method

string

method of payment for the invoice

example: \"credit_card\"; null if bill does not contain

extracted_at

string (datetime)

date/time of starting the process

example: \"2023-08-31T07:30:49.559252+00:00\"

checksum

boolean

file integrity

always null

version

numberic

ocr development version

file_modified

boolean

is the information in the document has been modified

true, false

page_count

numeric

number page of document

validation_name_match

boolean

Is the input name not match with document

true, false

validation_address

boolean

Indicates whether the applicant's provided address is within the\n specified distance limit (address_validation_distance_limit) compare to address in the document.

true, false, null (if the address doesn't exist)

file_url

string

URL that contain the utility bill file

https://storage.googleapis.com/...

message

string

response status message

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Message	Description
Success	The utility bill has been successfully extracted.
Pending	The utility bill extraction is currently pending. Please request the bank statement again after a moment.
Failure	There was an error processing your request on our server.

", "operationId": "get_utility_bill_utility_bill_get", "parameters": [ { "description": "general purpose request identifier. Example: 2023-03-27-12-14-44-a68c06b2-d79e-402e-a8a1-be3cb10ddadf", "required": true, "schema": { "title": "Request Id", "type": "string", "description": "general purpose request identifier. Example: 2023-03-27-12-14-44-a68c06b2-d79e-402e-a8a1-be3cb10ddadf" }, "name": "request_id", "in": "query" } ], "responses": { "200": { "description": "Success/Pending", "content": { "application/json": { "schema": {}, "examples": { "Success": { "value": { "result": { "id": 5752179444940800, "request_id": "2023-08-31-07-30-47-420a8e46-12d6-4875-9304-3bc40c3fde34", "user_id": 5634161670881280, "batch_id": 5736536905613312, "slug": "uppass-182280d1-7267-4eae-9dad-80d0850c21fb", "created_at": "2023-08-31T07:30:49.485645+00:00", "updated_at": "2023-08-31T07:30:49.804214+00:00", "utility_bill_type": "th-ais", "status": "validated", "file_name": "AIS_12345.pdf", "invoice_date": "2023-01-07T00:00:00+07:00", "name": "John Lennon", "address": "999 หมู่ 99 ตำบลแม่แรง อำเภอป่าซาง ลำพูน 51120", "package_details": { "0810000000": [ { "description": "สิทธิ์ฟรีอินเทอร์เน็ตสำหรับดูทีวีดูหนังผ่านแอป AIS PLAY นาน 6 รอบบิล", "type": "other", "price": 0.0, "expiry_date": "2023-04-30" }, { "description": "Net Max Speed 499บ. โทร 200นาทีเน็ตจำนวน 10GB จากนั้นความเร็ว 384Kbps, AIS SUPER WiFi", "type": "main", "price": 499.0, "expiry_date": "2023-10-31" }, { "description": "แพ็กเกจรายปีDisney plus Hotstar 499 บาท", "type": "other", "price": 499.0, "expiry_date": "2023-10-29" }, { "description": "Birthday Bonus โทรฟรีในเครือข่าย AIS พร้อมส่ง SMS,MMS, Internet ความเร็วสูงสุดจำนวน2GB", "type": "other", "price": 0.0, "expiry_date": "2022-12-12" } ] }, "usage_details": { "0810000000": { "voice": { "second": 0, "minute": 23 }, "data": { "mb": 211, "gb": 10, "kb": 437 } } }, "amount": 2834.86, "due_date": "2023-01-23T00:00:00+07:00", "bill_overdue": 1, "overdue_amount": 951.93, "bill_cycle": "2022-12", "registered_id": "31700015650143", "phone_number": "0810000000", "registration_numbers": [ "0810000000" ], "current_amount": 1882.93, "registered_name": "John Does", "advance_amount": 0.0, "invoice_number": "W-IN-18-6512-0166224", "payment_method": "credit_card", "extracted_at": "2023-08-31T07:30:49.559252+00:00", "version": 1, "page_count": 2, "validation_name_match": true, "validation_address": true, "file_modified": false, "file_url": "https://www.example.com" }, "message": "Success" } }, "Pending": { "value": { "result": "None", "message": "Pending" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "error": { "status_code": 404, "detail": "Not Found" } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "example": { "error": { "status_code": 422, "detail": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "status_code": 500, "message": "failure", "detail": "failure" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "utility_bill" ], "summary": "Upload Utility Bill", "description": "

Upload Utility Bill

Upload a utility bill file for processing.

This endpoint allows users to upload a utility bill file for processing.\nIt will return a request_id that can be used to retrieve the result through the \"Get Utility Bill\" route.

\n\n

List of types supported:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Operator	Types
AIS	th-ais
DTAC	th-dtac
True	th-true
PEA (Provincial Electricity Authority)	th-epb
MEA (Metropolitan Electricity Authority)	th-emb
WMB (Metropolitan Waterworks Authority)	th-wmb

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
request_id	string	general purpose request identifier
nonce	string	unique number
message	string	response status message

", "operationId": "upload_utility_bill_utility_bill_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "title": "Body", "allOf": [ { "$ref": "#/components/schemas/Body_upload_utility_bill_utility_bill_post" } ], "include_in_schema": true } } }, "required": true }, "responses": { "200": { "description": "Upload Success", "content": { "application/json": { "schema": {}, "example": { "request_id": "2023-05-11-06-06-50-300aee38-f4bd-4841-8780-a19e03721a7", "nonce": "dab27a0f-72ef-4fdd-804b-e94527295aa6", "message": "Upload Success" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "examples": { "file_exceeds_1000_page": { "value": { "error": { "message": "file_exceeds_1000_page", "detail": "File exceeds 1,000 page", "status_code": 413 } } }, "uploaded_file_size_exceeds_16_MB": { "value": { "error": { "message": "uploaded_file_size_exceeds_16_MB", "detail": "File size exceeds 16 MB", "status_code": 413 } } } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "incorrect_password": { "value": { "error": { "message": "incorrect_password", "detail": "Incorrect Password", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/utility_bill/support_list": { "get": { "tags": [ "utility_bill" ], "summary": "Get Utility Bill Support List", "description": "

Get Utility Bill Support List

Get list and status of types that API support in each country.

This API endpoint provides information about the supported types in different countries, including their\n status. Users can utilize this endpoint to obtain a list of types that are supported by the API in a\n specific country.

\n\n

To use this endpoint, you need to provide the following:

\n\n

country: Specify the desired country as a parameter.
Accept-Language: Include the preferred language for instruction in the request header.

\n\n

The API will respond by providing a list of types supported in the specified country, along with instructions in\n the user's chosen language.

\n\n

List of countries with language supported:

\n\n \n \n \n \n \n \n \n \n

Country	Language Supported
TH (Thai Bills)	\n \n TH (Thai) \n EN (English) :default \n \n

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
label	string	utility bill type name
sub_title	string	additional information of the type
logo	string	URL for retrived bill logo
logo_disable	string	URL for retrived bill logo in black and white
value	string	type of the bill
is_enable	bool	if this type are available
is_hidden	bool	if this type should be hidden (but it still processable)
instructions	list	list of step to retrive utility bill PDF

", "operationId": "get_utility_bill_support_list_utility_bill_support_list_get", "parameters": [ { "description": "Country code for identify what is nationality of bank statement", "required": false, "schema": { "title": "Country", "type": "string", "description": "Country code for identify what is nationality of bank statement", "default": "TH" }, "name": "country", "in": "query" }, { "description": "Language of returned response", "required": false, "schema": { "title": "Accept-Language", "type": "string", "description": "Language of returned response", "default": "EN" }, "name": "accept-language", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": [ { "label": "Metropolitan Electricity Authority (MEA)", "sub_title": "", "logo": "https://cdn.uppass.io/logos/bill-providers/mea.png", "logo_disable": "", "value": "th-emb", "is_enable": true, "is_hidden": false, "instructions": [ "Open the MEA SmartLife application", "Log in with your account number and meter ID", "Tap the three dots icon and select the \"Electronic Documents\" menu", "Select the card for the meter ID that matches your name", "Select the latest billing cycle", "Select \"Electricity bill\" and enter your email address", "Send the email and download the file from your email" ] }, { "label": "Provincial Electricity Authority (PEA)", "sub_title": "", "logo": "https://cdn.uppass.io/logos/bill-providers/pea.png", "logo_disable": "", "value": "th-epb", "is_enable": true, "is_hidden": false, "instructions": [ "Open the PEA Smart Plus application", "Select the electricity account you want to request a bill for", "Select the billing cycle you want to request a bill for", "Tap the \"Download electricity bill\" button", "Tap the download button in the bottom right corner of the screen", "On the download page, tap SAVE" ] }, { "label": "Metropolitan Waterworks Authority (MWA)", "sub_title": "", "logo": "https://cdn.uppass.io/logos/bill-providers/mwa.png", "logo_disable": "", "value": "th-wmb", "is_enable": true, "is_hidden": false, "instructions": [ "Open the MWA onMobile application", "Select the \"Water User Data\" menu", "Add a water user registration", "Enter the water registration number and tap \"Add water user registration\" or \"Add via QR Code\"", "Select the water usage statistics and water bill", "Tap the PDF icon under the latest water bill" ] }, { "label": "AIS", "sub_title": "", "logo": "https://cdn.uppass.io/logos/bill-providers/ais.png", "logo_disable": "", "value": "th-ais", "is_enable": true, "is_hidden": false, "instructions": [ "Open the my AIS application and log in > Select the \"More\" menu from the three dots bar below", "Select the \"AIS\" bar", "Select the \"Bills\" menu (the screen will show the payment history \"for the past 3 billing cycles\")", "Select \"View bill (PDF)\" for the desired cycle", "Tap \"Request OTP\". The system will send an OTP to view the eBill", "When you enter the OTP correctly, the screen will show the bill information" ] }, { "label": "DTAC", "sub_title": "", "logo": "https://cdn.uppass.io/logos/bill-providers/dtac.png", "logo_disable": "", "value": "th-dtac", "is_enable": true, "is_hidden": false, "instructions": [ "Open the Dtac application", "Log in with your phone number", "Select the \"Others\" menu", "Select \"Receipts & Bills\"", "Select \"Bills\"", "Tap the download icon to download the file" ] }, { "label": "TrueMove H", "sub_title": "", "logo": "https://cdn.uppass.io/logos/bill-providers/true.png", "logo_disable": "", "value": "th-true", "is_enable": true, "is_hidden": false, "instructions": [ "Open the True iService application", "Log in with your phone number", "Select the \"Bills & Usage\" menu", "Select \"Previous billing cycles\"", "View details", "Tap the \"Share\" icon in the top right corner and then tap \"Save\"", "Check that the name is the same as the user" ] } ] } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_country_code": { "value": { "error": { "status_code": 422, "detail": "Cannot process this country code." } } }, "unprocessable_language": { "value": { "error": { "status_code": 422, "detail": "Cannot process on this language." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/extract/bank_statement": { "post": { "tags": [ "extract" ], "summary": "Direct Extract Bank Statement", "description": "

Direct Extract Bank Statement

Extract bank statement results synchronously.

This endpoint allows you to upload a bank statement file and wait for the process to finish.\nThe result will be returned as a response with transactions already flagged.

\n\n

List of Thai banks supported:

Bank Name	Bank Code	Supported Templates
Bangkok Bank	th-bbl	bbl_th, bbl_en
Bangkok Bank (Corporate Statement)	th-bbl-business	bbl_en
Krung Thai Bank	th-ktb	ktb_th, ktb_en
Government Savings Bank	th-gsb	gsb_th, gsb_en
Kasikorn Bank (Corporate and Personal Statement)	th-kbank	kbank_th, kbank_en
TMB Thanachart Bank	th-ttb	ttb_detail_th, ttb_detail_en, ttb_condense_th, ttb_condense_en
TMB Thanachart Bank (Corporate Statement)	th-ttb-business	ttb_en
Siam Commercial Bank	th-scb	scb_without_note_th, scb_with_note_th
Siam Commercial Bank (Corporate Statement)	th-scb-business	scb_horizontal_th, scb_vertical_th
Bank of Ayudhya (Krungsri)	th-bay	bay_detail_th, bay_detail_en, bay_condense_th
Bank for Agriculture and Agricultural Cooperatives	th-baac	baac_th, baac_en
United Overseas Bank	th-uob	uob_th
Land and House Bank	th-lh	lh_th
Kiatnakin Phatra Bank	th-kkp	kkp_th

\n\n

List of Indonesia banks supported:

To extract Indonesia bank statement, the country:\"ID\" must be provided in the form data.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Bank Name	Bank Code
Bank Central Asia	BCA_PERSONAL
Bank Rakyat Indonesia	BRI_PERSONA
Bank Mandiri	MANDIRI_PERSONAL
Bank Negara Indonesia	BNI_PERSONAL

\n\n

List of Philippine banks supported:

To extract Philippine bank statement, the country:\"PH\" must be provided in the form data.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Bank Name	Bank Code
Banco De Oro Unibank	BDO_PERSONAL
Metrobank	METROBANK_PERSONAL
Land Bank of the Philippines	LANDBANK_PERSONAL
BPI Family Savings Bank	BPI_PERSONAL
The Union Bank of the Philippines	UNIONBANK_PERSONAL
Rizal Commercial Banking Corporation	RCBC_PERSONAL

\n\n

Response Data Dictionary:

Key

Type

Description

Note

result

dict

result of bank statement API

created_at

string (datetime)

document created date

example: \"2023-05-11T05:18:03.842304+00:00\"

bank_code

string

detail

string

detail of bank statement

always null

page_count

numeric

number page of document

account_number

string

bank statement account number

example: \"XXX-1-23041-X\"

account_name

string

bank statement account name

example: \"John Does\"

account_type

string

bank statement account type

\"savings account\",\"fixed deposit account\", \"current account\"

branch_name

string

branch

example: \"SING BURI BRANCH\"; null if statement does not contain

address

string

account owner address

null if statement does not contain

statement_period_from

string

start date of the statement

example: \"2022-10-19\"

statement_period_to

string

end date of the statement

example: \"2023-04-18\"

transaction_date_from

string

date of the first transactoion

example: \"2022-10-20\"

transaction_date_to

string

date of the last transactoion

example: \"2023-04-15\"

request_date

string

bank statement request date

example: \"2023-04-20\"

currency

string

currency of statement

example \"THB\", \"IDR\"

template

string

statement's template name

example \"bay_detail_en\", \"bay_condense_th\", \"kbank_th\"

version

numberic

extraction engine development version

page_count

numberic

numbers of the pdf pages

ocr_created_at

string (datetime)

date/time of starting the process

example: \"2023-05-11T05:18:04.290689+00:00\"

extracted_at

string (datetime)

date/time of starting the process

example: \"2023-05-11T05:18:04.290689+00:00\"

validation_name_match

boolean

is the input name match with document

true, false

validation_address

boolean

Indicates whether the applicant's provided address is within the\n specified distance limit (address_validation_distance_limit) compare to address in the document.

true, false, null (if the address doesn't exist)

file_modified

boolean

is the information in the document has been modified

true, false

status

string

processing status

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Status	Description
created	The process has been created.
failed Upload	The file upload has failed.
uploaded	The file has finished uploading.
failed analysis	There was a failure during file analysis.
failed validation	The bank statement did not pass one or more validation rules.
validated	The bank statement has passed all validation checks.

transactions

list

statement transactions

Key

Type

Description

Note

numberic

order of transactions

example: 1

transaction_date

string (datetime)

the date of this transaction

example: \"2022-10-26\"

transaction_type

string

type of transaction

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Types	Description
Credit	TA transaction with incoming amount.
Dedit	A transaction with outgoing amount.
Abnormal	A transaction where the amount is zero for both incoming and outgoing.

chq

string

description to identify the transaction

\"example: \"Transfer Deposit\", \"Payment\"

particular

string

destination of the transaction eg. bank name, bank account, company name

example: \"Paid for Ref X5538 KBank Card\", \"To PromptPay X6703 John-Lennon++\"

channel

string

transaction channel

\"example: \"MOBILE\", \"KBANK\"

deposit

numberic

deposit amont of each transaction

withdrawal

numberic

withdrawal amont of each transaction

balance

numberic

balance amont of each transaction

Direct Extract Utility Bill

Extract utility bill results synchronously.

This endpoint allows you to upload a utility bill file and wait for the process to finish.\nThe result will be returned as a response.

\n\n

List of types supported:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Operator	Types
AIS	th-ais
DTAC	th-dtac
True	th-true
PEA (Provincial Electricity Authority)	th-epb
MEA (Metropolitan Electricity Authority)	th-emb
WMB (Metropolitan Waterworks Authority)	th-wmb

\n\n

Response Data Dictionary:

Key

Type

Description

Note

result

dict

result of utility bill API

created_at

string (datetime)

document created date

example: \"2023-08-31T07:30:49.485645+00:00\"

utility_bill_type

string

type of utility bill

example: \"th-ais\"

detail

string

detail of utility bill

always null

page_count

numeric

number page of document

status

string

processing status

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Status	Description
created	The process has been created.
failed Upload	The file upload has failed.
uploaded	The file has finished uploading.

file_name

string

utility bill file name

example: \"ais_123456.pdf\"

invoice_date

string (datetime)

invoice date in document

example: \"2023-01-07T00:00:00+07:00\"

name

string

name of utility bill

example: \"John Does\"

address

string

address of utility bill

example: \"64 Pan Rd., Silom, Bangrak, Bangkok, 10500; Thailand\"

package_details

list

details of package and number

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
description	string	package description.
type	string	type of package (\"main\", \"other\").
price	numberic	price of the package.
expiry_date	string	package expiry date.

\n (See the example demonstrated in the 'Example Response' section)\n

usage

numberic

number of billing units

example: 123.4; null if bill does not contain

usage_details

list

details of usage

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Description
voice	Usage details for calls, separated by \"minutes\" and \"seconds\"
data	Usage details for data, separated by \"gigabytes (GB)\", \"megabytes (MB)\", and \"kilobytes (KB)\"
sms	Number of sent SMS messages
mms	Number of sent MMS messages
unit	Unit of measurement for user's usage

\n (See the example demonstrated in the 'Example Response' section)\n

amount

numberic

total amount to be paid

example: 999.99

bill_overdue

numberic

the total number of the bill that has not been paid by the due date

example: 1.0; null if bill does not contain

due_date

string (datetime)

last period date of bill payment

example: \"2023-01-23T00:00:00+07:00\"

overdue_amount

numberic

the amount of money that has not been paid by the due date

example: 555.5

branch

string

branch name

example: \"Bangrak\"; null if bill does not contain.

bill_cycle

string

period bill date

example: \"2022-12\"

registered_id

string

id of user

example: \"020020979366\"; null if bill does not contain.

phone_number

string

main phone number

example: \"0123456789\"; null if bill does not contain.

registration_numbers

list

collection of all the numbers present in the bill

(See the example demonstrated in the 'Example Response' section)

current_amount

numberic

the amount of money in the current month

example: 868.16; null if bill does not contain

printed_at

string (datetime)

date/time of document printing

example: \"2023-01-07T10:02:14+07:00\"; null if bill does not contain.

registered_name

string

name of the user who is enrolling for the service

example: \"John Lennon\"

advance_amount

numberic

overpaid amount

example: 456.0; null if bill does not contain

invoice_number

string

invoice number

example: \"W-IN-18-6512-0166224\"; null if bill does not contain.

history_usage

list

usage history

(See the example demonstrated in the 'Example Response' section)

payment_method

string

method of payment for the invoice

example: \"credit_card\"; null if bill does not contain

extracted_at

string (datetime)

date/time of starting the process

example: \"2023-08-31T07:30:49.559252+00:00\"

checksum

boolean

file integrity

always null

version

numberic

ocr development version

validation_name_match

boolean

Is the input name not match with document

true, false

validation_address

boolean

Indicates whether the applicant's provided address is within the\n specified distance limit (address_validation_distance_limit) compare to address in the document.

true, false, null (if the address doesn't exist)

file_modified

boolean

is the information in the document has been modified

true, false

password

string

password of file

It will be null if the file does not have a password set.

message

string

response status message

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Message	Description
Success	The utility bill has been successfully extracted.
Pending	The utility bill extraction is currently pending. Please request the bank statement again after a moment.
Failure	There was an error processing your request on our server.

", "operationId": "direct_extract_utility_bill_extract_utility_bill_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "title": "Body", "allOf": [ { "$ref": "#/components/schemas/Body_direct_extract_utility_bill_extract_utility_bill_post" } ], "include_in_schema": true } } }, "required": true }, "responses": { "200": { "description": "Upload Success", "content": { "application/json": { "schema": {}, "example": { "result": { "created_at": "2023-08-31T09:34:12.326831+00:00", "utility_bill_type": "th-ais", "page_count": 2, "status": "validated", "file_name": "AIS_71941.pdf", "invoice_date": "2023-01-01T00:00:00+07:00", "name": "John Does", "address": "999 Pracha Uthit 999 Alley, Rat Burana, Bangkok 10140", "package_details": { "0810000000": [ { "description": "แพ็กเกจใช้งาน AR Premium ฟรีนาน 12 เดือน", "type": "other", "price": 0.0, "expiry_date": "2022-12-31" }, { "description": "แพ็กเกจใช้งาน VR Premium ฟรีนาน 12 เดือน", "type": "other", "price": 0.0, "expiry_date": "2022-12-31" }, { "description": "แพ็กเกจเสริม 5G ค่าบริการ 150บ. อินเทอร์เน็ต 9GB ใช้ได้15 วัน", "type": "other", "price": 150.0, "expiry_date": "2022-11-25" }, { "description": "แพ็กเกจเสริม 5G ค่าบริการ 150บ. อินเทอร์เน็ต 9GB ใช้ได้15 วัน", "type": "other", "price": 150.0, "expiry_date": "2022-12-05" }, { "description": "แพ็กเกจเสริม 5G ค่าบริการ 99บ. อินเทอร์เน็ต 4GB ใช้ได้7 วัน", "type": "other", "price": 99.0, "expiry_date": "2022-11-29" }, { "description": "แพ็กเกจเสริม 5G ค่าบริการ 79บาท อินเทอร์เน็ต 14GB นาน 24ชม.", "type": "other", "price": 79.0, "expiry_date": "2022-11-24" }, { "description": "แพ็กเกจ 5G Super Share 749บ. โทร 550 นาทีเน็ตเร็วสูงสุด 55 GB จากนั้นความเร็ว 384Kbps,WiFi", "type": "main", "price": 749.0, "expiry_date": "2023-11-23" }, { "description": "แพ็กเกจ 5G Super Share เน็ตความเร็วสูงสุดจำนวน 55 GB จากนั้นใช้ได้ต่อเนื่องที่ความเร็ว 384Kbps", "type": "other", "price": 0.0, "expiry_date": "2023-11-23" } ] }, "usage_details": { "0810000000": { "voice": { "minute": 34, "second": 0 }, "data": { "gb": 39, "mb": 861, "kb": 73 } } }, "amount": 801.43, "due_date": "2023-01-15T00:00:00+07:00", "overdue_amount": 0.0, "bill_cycle": "2022-12", "registered_id": "31300001111111", "phone_number": "0810000000", "registration_numbers": [ "0810000000" ], "current_amount": 801.43, "registered_name": "John Does", "advance_amount": 0.0, "invoice_number": "W-IN-16-6512-0037331", "payment_method": "credit_card", "extracted_at": "2023-08-31T09:34:12.444918+00:00", "version": 1, "validation_name_match": true, "validation_address": true, "file_modified": false, "password": "123456" }, "message": "Success" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "examples": { "file_exceeds_1000_page": { "value": { "error": { "message": "file_exceeds_1000_page", "detail": "File exceeds 1,000 page", "status_code": 413 } } }, "uploaded_file_size_exceeds_16_MB": { "value": { "error": { "message": "uploaded_file_size_exceeds_16_MB", "detail": "File size exceeds 16 MB", "status_code": 413 } } } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "incorrect_password": { "value": { "error": { "message": "incorrect_password", "detail": "Incorrect Password", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/extract/ocr": { "post": { "tags": [ "extract" ], "summary": "Direct Extract Ocr", "description": "

Direct Extract OCR

Extract OCR results synchronously.

This endpoint allows you to upload a OCR file and wait for the process to finish.\nThe result will be returned as a response with transactions already flagged.

\n\n

List of type support

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Type Name	Type Code
Book bank	book-bank
Thai vehicle registration	th-vehicle-registration
Thai credit bureau	th-credit-bureau
bank statement	bank-statement

\n\n

List of template book bank support

To ocr book bank, the type:\"book-bank\" must be provided in the form data.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Bank Name	Supported Templates
Bangkok Bank	th_bbl_no_logo, th_bbl_with_logo
Krung Thai Bank	th_ktb_digital, th_ktb_physical
Government Savings Bank	th_gsb
Kasikorn Bank	th_kbank_digital, th_kbank_physical
TMB Thanachart Bank	th_ttb_digital, th_ttb_physical
Siam Commercial Bank	th_scb_digital, th_scb_physical
Bank of Ayudhya (Krungsri)	th_bay
Bank for Agriculture and Agricultural Cooperatives	th_baac_green, th_baac_orange
United Overseas Bank	th_uob_digital, th_uob_physical
Land and House Bank	th_lh

\n\n

Custom Fields Extraction Feature

This feature enables the extraction of information from the document based on user-defined criteria. By passing the parameter custom_fields, users can define the structure as follows:

\n\n

\n[\n    {\n        \"field_name\": \"field_1\",\n        \"field_description\": \"Description of field_1 (where it is in the document and what it represents)\",\n        \"field_type\": \"string/number\" (select only one type)\n    },\n    {\n        \"field_name\": \"field_2\",\n        \"field_description\": \"Description of field_2 (where it is in the document and what it represents)\",\n        \"field_type\": \"string/number\" (select only one type)\n    },\n    {\n        \"field_name\": \"table_1\",\n        \"field_description\": \"Description of table_1 (where it is in the document and what it represents)\",\n        \"field_type\": \"table\",\n        \"columns\": [\n            {\n                \"column_name\": \"column_1\",\n                \"column_type\": \"string/number\" (select only one type),\n                \"column_description\": \"Description of column_1 (where it is in the document and what it represents)\"\n            },\n            {\n                \"column_name\": \"column_2\",\n                \"column_type\": \"string/number\" (select only one type),\n                \"column_description\": \"Description of column_2 (where it is in the document and what it represents)\"\n            }\n        ]\n    }\n]\n

\n\n

Custom fields will receive a list of fields that users want to extract, offering the flexibility to include as many fields as desired.
Fields are categorized into three types:\n
- String: Represents textual data.
- Number: Represents numeric data.
- Table: Represents structured data organized into rows and columns.
\n
For non-table fields:\n
- Users need to provide a 'field_name' as the identifier for the field.
- A 'field_description' should be provided to describe the field's purpose and location within the document.
\n
For table fields:\n
- Users need to provide a list of columns, each with:\n
  - A 'column_name' as the identifier for the column.
  - A 'column_type' to specify whether the data in the column is string or number.
  - A 'column_description' to describe the content and purpose of the column.
  \n
\n

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description	Note
result	dict	result of ocr API
template	string	file's template name	example \"th_gsb\", \"th_baac_green\", \"th_lh\"
type	string	type of ocr	example \"book-bank\", \"bank-statement\"
fields	dict	extracted fields from ocr process
extracted_at	string (datetime)	date/time of starting the process	example: \"2023-08-31T07:30:49.804214+00:00\"
message	string	response status message

", "operationId": "direct_extract_ocr_extract_ocr_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "title": "Body", "allOf": [ { "$ref": "#/components/schemas/Body_direct_extract_ocr_extract_ocr_post" } ], "include_in_schema": true } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "examples": { "predefined_type": { "value": { "result": { "type": "book-bank", "fields": { "account_name": { "confidence": 0.94, "label": "Account Name", "type": "string", "value": "John Does" }, "account_number": { "confidence": 0.97, "label": "Account Number", "type": "string", "value": "123456789" }, "branch": { "confidence": 0.95, "label": "Branch", "type": "string", "value": "สาขาหนองคาย" }, "account_type": { "confidence": 0.83, "label": "Account Type", "type": "string", "value": "2001 - บัญชีเงินฝากออมทรัพย์ (ใช้สมุดคู่ฝาก)" } }, "extracted_at": "2024-05-09T05:22:35.004359+00:00" }, "message": "Success" } }, "custom_fields": { "value": { "result": { "fields": { "account_name": { "confidence": 1.0, "label": "account name", "type": "string", "value": "John Does" }, "account_number": { "confidence": 1.0, "label": "account number", "type": "string", "value": "XXX-X-XXXXX-X" }, "branch": { "confidence": 1.0, "label": "branch", "type": "string", "value": "ทีทีบี สาขาเซ็นทรัลพลาซ่า นครราชสีมา" }, "deposit_account_transaction": { "label": "Deposit Account Transaction", "type": "table", "value": [ { "page": 1, "columns": [ { "field": "date", "type": "string", "label": "date" }, { "field": "time", "type": "string", "label": "time" }, { "field": "descriptions", "type": "string", "label": "descriptions" }, { "field": "channel", "type": "string", "label": "channel" }, { "field": "amount", "type": "number", "label": "amount" }, { "field": "balance", "type": "number", "label": "balance" }, { "field": "details", "type": "string", "label": "details" } ], "rows": [ { "date": "31 ธ.ค. 66", "time": "15:18 น.", "descriptions": "จ่ายบิล/เติมเงิน", "channel": "Mobile", "amount": -500.0, "balance": 2050.0, "details": "True Money" }, { "date": "31 ธ.ค. 66", "time": "10:38 น.", "descriptions": "โอนเงินออกไปเบอร์มือถือ", "channel": "Mobile", "amount": -242.0, "balance": 2550.0, "details": "SCB X8095 ..." } ] } ] } }, "extracted_at": "2024-05-09T05:22:35.004359+00:00" }, "message": "Success" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "examples": { "file_exceeds_xxx_page": { "value": { "error": { "message": "file_exceeds_xxx_page", "detail": "File exceeds xxx page", "status_code": 413 } } }, "uploaded_file_size_exceeds_100_MB": { "value": { "error": { "message": "uploaded_file_size_exceeds_100_MB", "detail": "File size exceeds 100 MB", "status_code": 413 } } } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "unprocessable_custom_fields": { "value": { "error": { "message": "unprocessable_custom_fields", "detail": "The structure of the provided custom fields is incorrect.", "status_code": 422 } } }, "incorrect_password": { "value": { "error": { "message": "incorrect_password", "detail": "Incorrect Password", "status_code": 422 } } }, "unavailable_template": { "value": { "error": { "message": "unavailable_template", "detail": "This document template is currently undergoing maintenance and will be back to normal soon.", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/ocr": { "get": { "tags": [ "ocr" ], "summary": "Get Ocr", "description": "

Get Ocr

Get ocr extraction result.

To get ocr detail, request_id needs to be passed.\nRequest_id can be obtained from the response of \"Upload Ocr\".

\n\n

Response Data Dictionary:

Key

Type

Description

Note

result

dict

result of Ocr API

numberic

document id

example: 5708800317194240

request_id

string

general purpose request identifier

example:\"2023-05-11-05-21-43-b8f96414-dddf-4a8d-a480-96645b5f5206\"

user_id

numberic

identify a user who process the service

example: 5634161670881280

batch_id

numberic

unique identifier assigned to a specific group

example: 5124005757452288

slug

string

UpPass form slug

example: \"2hdrmSMT\"

expired_at

string (datetime)

document expiry date

always null

created_at

string (datetime)

document created date

example: \"2023-08-31T07:30:49.485645+00:00\"

updated_at

string (datetime)

document updated date

example: \"2023-08-31T07:30:49.804214+00:00\"

extracted_at

string (datetime)

date/time of starting the process

example: \"2023-08-31T07:30:49.804214+00:00\"

type

string

type of ocr

example: \"book-bank\"

template

string

file template name

example: \"th_scb_physical\"

status

string

processing status

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Status	Description
created	The process has been created.
failed Upload	The file upload has failed.
uploaded	The file has finished uploading.

password

string

password of file

It will be null if the file does not have a password set.

version

numberic

extraction engine development version

external_tracking_id

string

id for external tracking

example: \"22452562300\"

fields

dict

extracted fields from ocr process

file_url

string

URL that contain the files

https://storage.googleapis.com/...

message

string

response status message

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Message	Description
Success	The files has been successfully extracted.
Pending	The files extraction is currently pending. Please request \"get_ocr\" again after a moment.
Failure	There was an error processing your request on our server.

", "operationId": "get_ocr_ocr_get", "parameters": [ { "description": "general purpose request identifier. Example: 2023-03-27-12-14-44-a68c06b2-d79e-402e-a8a1-be3cb10ddadf", "required": true, "schema": { "title": "Request Id", "type": "string", "description": "general purpose request identifier. Example: 2023-03-27-12-14-44-a68c06b2-d79e-402e-a8a1-be3cb10ddadf" }, "name": "request_id", "in": "query" } ], "responses": { "200": { "description": "Upload Success", "content": { "application/json": { "schema": {}, "examples": { "response_from_get_api": { "value": { "result": { "id": 5655419414380544, "request_id": "2024-01-04-06-47-00-4f969f09-e4ed-468e-b24a-e0a6d43a369a", "user_id": 5634161670881280, "batch_id": 5755587514073088, "slug": "credit-ok-d890bc00-0b05-4c9f-850d-3281374ab707", "created_at": "2024-01-04T06:47:21.670449+00:00", "updated_at": "2024-01-04T06:47:21.747873+00:00", "extracted_at": "2024-01-04T06:47:21.747873+00:00", "type": "book-bank", "template": "th_baac_green", "status": "uploaded", "version": 1, "fields": { "account_name": { "confidence": 0.94, "label": "Account Name", "type": "string", "value": "John Does" }, "account_number": { "confidence": 0.97, "label": "Account Number", "type": "string", "value": "123456789" }, "branch": { "confidence": 0.95, "label": "Branch", "type": "string", "value": "สาขาหนองคาย" }, "account_type": { "confidence": 0.83, "label": "Account Type", "type": "string", "value": "2001 - บัญชีเงินฝากออมทรัพย์ (ใช้สมุดคู่ฝาก)" } }, "file_urls": [ "https://www.example.com" ] }, "message": "Success" } }, "response_custom_fields_from_get_api": { "value": { "result": { "id": 5747172490346496, "request_id": "2024-05-09-05-34-12-3465dda0-4b81-4fdb-9d28-798fdbfef3c2", "user_id": 5634161670881280, "batch_id": 5699685234769920, "slug": "credit-ok-e937a607-cc40-4954-9af4-fbe30fd356a0", "created_at": "2024-05-09T05:34:57.061181+00:00", "updated_at": "2024-05-09T05:34:57.153499+00:00", "extracted_at": "2024-05-09T05:34:57.153495+00:00", "status": "uploaded", "version": 1, "custom_fields_text_validation": { "type": "any", "keyword_list": [ "ธนาคาร", "ชื่อบัญชี" ], "match_level": 90.0 }, "custom_fields": [ { "field_name": "account name", "field_description": "ชื่อ นามสกุล", "field_type": "string" }, { "field_name": "account number", "field_description": "เลขบัญชี", "field_type": "string" }, { "field_name": "branch", "field_description": "สาขาที่เปิดบัญชี", "field_type": "string" }, { "field_name": "Deposit Account Transaction", "field_description": "รายละเอียดการเดินบัญชี", "field_type": "table", "columns": [ { "column_name": "date", "column_type": "string", "column_description": "วันที่มีการทำรายการ" }, { "column_name": "time", "column_type": "string", "column_description": "เวลาที่ทำรายการ" }, { "column_name": "descriptions", "column_type": "string", "column_description": "รายการ" }, { "column_name": "channel", "column_type": "string", "column_description": "ช่องทางการทำรายการ" }, { "column_name": "amount", "column_type": "number", "column_description": "จำนวนเงินทีทำรายการ" }, { "column_name": "balance", "column_type": "number", "column_description": "ยอดเงินคงเหลือ" }, { "column_name": "details", "column_type": "string", "column_description": "รายละเอียดในหารทำรายการ" } ] } ], "fields": { "account_name": { "confidence": 1.0, "label": "account name", "type": "string", "value": "John Does" }, "account_number": { "confidence": 1.0, "label": "account number", "type": "string", "value": "XXX-X-XXXXX-X" }, "branch": { "confidence": 1.0, "label": "branch", "type": "string", "value": "ทีทีบี สาขาเซ็นทรัลพลาซ่า นครราชสีมา" }, "deposit_account_transaction": { "label": "Deposit Account Transaction", "type": "table", "value": [ { "page": 1, "columns": [ { "field": "date", "type": "string", "label": "date" }, { "field": "time", "type": "string", "label": "time" }, { "field": "descriptions", "type": "string", "label": "descriptions" }, { "field": "channel", "type": "string", "label": "channel" }, { "field": "amount", "type": "number", "label": "amount" }, { "field": "balance", "type": "number", "label": "balance" }, { "field": "details", "type": "string", "label": "details" } ], "rows": [ { "date": "31 ธ.ค. 66", "time": "15:18 น.", "descriptions": "จ่ายบิล/เติมเงิน", "channel": "Mobile", "amount": -500.0, "balance": 2050.0, "details": "True Money" }, { "date": "31 ธ.ค. 66", "time": "10:38 น.", "descriptions": "โอนเงินออกไปเบอร์มือถือ", "channel": "Mobile", "amount": -242.0, "balance": 2550.0, "details": "SCB X8095 ..." } ] } ] } }, "file_urls": [ "https://www.example.com" ] }, "message": "Success" } }, "response_from_webhook": { "value": { "result": { "id": 5746815546687488, "request_id": "2024-01-05-15-43-39-91c08a6c-4c5a-49f9-ac9c-420ddc76714f", "user_id": 5634161670881280, "batch_id": 5694773864169472, "slug": "credit-ok-fe9480c9-2ffa-478b-8908-032a5e4df4f6", "created_at": "2024-01-05T15:43:43.827275+00:00", "updated_at": "2024-01-05T15:43:43.901707+00:00", "type": "book-bank", "template": "th_baac_green", "status": "uploaded", "version": 1, "fields": { "account_name": { "confidence": 0.94, "label": "Account Name", "type": "string", "value": "John Does" }, "account_number": { "confidence": 0.97, "label": "Account Number", "type": "string", "value": "123456" }, "branch": { "confidence": 0.95, "label": "Branch", "type": "string", "value": "สาขาหนองคาย" }, "account_type": { "confidence": 0.83, "label": "Account Type", "type": "string", "value": "2001 - บัญชีเงินฝากออมทรัพย์ (ใช้สมุดคู่ฝาก)" } }, "file_urls": [ "https://www.example.com" ] }, "message": "Success", "status_code": 200, "request_id": "2024-01-05-15-43-39-91c08a6c-4c5a-49f9-ac9c-420ddc76714f" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "examples": { "file_exceeds_1000_page": { "value": { "error": { "message": "file_exceeds_1000_page", "detail": "File exceeds 1,000 page", "status_code": 413 } } }, "uploaded_file_size_exceeds_16_MB": { "value": { "error": { "message": "uploaded_file_size_exceeds_16_MB", "detail": "File size exceeds 16 MB", "status_code": 413 } } } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "incorrect_password": { "value": { "error": { "message": "incorrect_password", "detail": "Incorrect Password", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "ocr" ], "summary": "Upload Ocr", "description": "

Upload OCR

Upload files for processing.

This endpoint allows users to upload any files for processing.\nIt will return a request_id that can be used to retrieve the result through the \"Get Ocr\" route.

\n\n

List of type support

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Type Name	Type Code
Book bank	book-bank
Thai vehicle registration	th-vehicle-registration
Thai credit bureau	th-credit-bureau
bank statement	bank-statement
taxation page	taxation-page
Company Certificate	company-certificate

\n\n

List of template book bank support

To ocr book bank, the type:\"book-bank\" must be provided in the form data.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Bank Name	Supported Templates
Bangkok Bank	th_bbl_no_logo, th_bbl_with_logo
Krung Thai Bank	th_ktb_digital, th_ktb_physical
Government Savings Bank	th_gsb
Kasikorn Bank	th_kbank_digital, th_kbank_physical
TMB Thanachart Bank	th_ttb_digital, th_ttb_physical
Siam Commercial Bank	th_scb_digital, th_scb_physical
Bank of Ayudhya (Krungsri)	th_bay
Bank for Agriculture and Agricultural Cooperatives	th_baac_green, th_baac_orange
United Overseas Bank	th_uob_digital, th_uob_physical
Land and House Bank	th_lh

\n\n

Custom Fields Extraction Feature

This feature enables the extraction of information from the document based on user-defined criteria. By passing the parameter custom_fields, users can define the structure as follows:

\n\n

\n[\n    {\n        \"field_name\": \"field_1\",\n        \"field_description\": \"Description of field_1 (where it is in the document and what it represents)\",\n        \"field_type\": \"string/number\" (select only one type)\n    },\n    {\n        \"field_name\": \"field_2\",\n        \"field_description\": \"Description of field_2 (where it is in the document and what it represents)\",\n        \"field_type\": \"string/number\" (select only one type)\n    },\n    {\n        \"field_name\": \"table_1\",\n        \"field_description\": \"Description of table_1 (where it is in the document and what it represents)\",\n        \"field_type\": \"table\",\n        \"columns\": [\n            {\n                \"column_name\": \"column_1\",\n                \"column_type\": \"string/number\" (select only one type),\n                \"column_description\": \"Description of column_1 (where it is in the document and what it represents)\"\n            },\n            {\n                \"column_name\": \"column_2\",\n                \"column_type\": \"string/number\" (select only one type),\n                \"column_description\": \"Description of column_2 (where it is in the document and what it represents)\"\n            }\n        ]\n    }\n]\n

\n\n

Custom fields will receive a list of fields that users want to extract, offering the flexibility to include as many fields as desired.
Fields are categorized into three types:\n
- String: Represents textual data.
- Number: Represents numeric data.
- Table: Represents structured data organized into rows and columns.
\n
For non-table fields:\n
- Users need to provide a 'field_name' as the identifier for the field.
- A 'field_description' should be provided to describe the field's purpose and location within the document.
\n
For table fields:\n
- Users need to provide a list of columns, each with:\n
  - A 'column_name' as the identifier for the column.
  - A 'column_type' to specify whether the data in the column is string or number.
  - A 'column_description' to describe the content and purpose of the column.
  \n
\n

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
request_id	string	general purpose request identifier
nonce	string	unique number
message	string	response status message

", "operationId": "upload_ocr_ocr_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "title": "Body", "allOf": [ { "$ref": "#/components/schemas/Body_upload_ocr_ocr_post" } ], "include_in_schema": true } } }, "required": true }, "responses": { "200": { "description": "Upload Success", "content": { "application/json": { "schema": {}, "example": { "request_id": "2023-05-11-06-06-50-300aee38-f4bd-4841-8780-a19e03721a7", "nonce": "dab27a0f-72ef-4fdd-804b-e94527295aa6", "message": "Upload Success" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "examples": { "file_exceeds_xxx_page": { "value": { "error": { "message": "file_exceeds_xxx_page", "detail": "File exceeds xxx page", "status_code": 413 } } }, "uploaded_file_size_exceeds_100_MB": { "value": { "error": { "message": "uploaded_file_size_exceeds_100_MB", "detail": "File size exceeds 100 MB", "status_code": 413 } } } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "unprocessable_custom_fields": { "value": { "error": { "message": "unprocessable_custom_fields", "detail": "The structure of the provided custom fields is incorrect.", "status_code": 422 } } }, "incorrect_password": { "value": { "error": { "message": "incorrect_password", "detail": "Incorrect Password", "status_code": 422 } } }, "unavailable_template": { "value": { "error": { "message": "unavailable_template", "detail": "This document template is currently undergoing maintenance and will be back to normal soon.", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/ocr/support_list": { "get": { "tags": [ "ocr" ], "summary": "Get Ocr Support List", "description": "

Get OCR Support List

Get list and status of types that API support in each country.

\n\n

To use this endpoint, you need to provide the following:

\n\n

country: Specify the desired country as a parameter.
Accept-Language: Include the preferred language for instruction in the request header.

\n\n

The API will respond by providing a list of types supported in the specified country, along with instructions in\n the user's chosen language.

\n\n

List of countries with language supported:

\n\n \n \n \n \n \n \n \n \n

Country	Language Supported
TH	\n \n TH (Thai) \n EN (English) :default \n \n

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
label	string	utility bill type name
sub_title	string	additional information of the type
logo	string	URL for retrived bill logo
logo_disable	string	URL for retrived bill logo in black and white
value	string	type of the bill
is_enable	bool	if this type are available
is_hidden	bool	if this type should be hidden (but it still processable)
instructions	list	list of step to retrive utility bill PDF
file_types_supported	list	list of file types supported by the system
pages_limit	numberic	total number of pages

", "operationId": "get_ocr_support_list_ocr_support_list_get", "parameters": [ { "description": "Country code for identify what is nationality of bank statement", "required": false, "schema": { "title": "Country", "type": "string", "description": "Country code for identify what is nationality of bank statement", "default": "TH" }, "name": "country", "in": "query" }, { "description": "Language of returned response", "required": false, "schema": { "title": "Accept-Language", "type": "string", "description": "Language of returned response", "default": "EN" }, "name": "accept-language", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": [ { "label": "Pass book", "sub_title": "", "logo": "", "logo_disable": "", "value": "book-bank", "is_enable": false, "is_hidden": false, "instructions": [ "Take a clear photo of your bank account book or capture a screenshot of the online book.", "Upload the image in either JPEG, PNG, or PDF format." ], "file_types_supported": [ "jpg", "jpeg", "png", "pdf" ], "pages_limit": 1, "fields": { "account_name": { "label": "Account Name", "type": "string" }, "account_number": { "label": "Account Number", "type": "string" }, "branch": { "label": "Branch", "type": "string" }, "account_type": { "label": "Account Type", "type": "string" } }, "sync_support": true }, { "label": "Vehicle Registration Book", "sub_title": "", "logo": "", "logo_disable": "", "value": "th-vehicle-registration", "is_enable": true, "is_hidden": false, "instructions": [ "Take a clear photo of your vehicle registration book.", "Upload the image in either JPEG, PNG, or PDF format." ], "file_types_supported": [ "jpg", "jpeg", "png", "pdf" ], "pages_limit": 1, "fields": { "registration_date": { "label": "Registration Date", "type": "string" }, "registration_number": { "label": "Registration Number", "type": "string" }, "province": { "label": "Province", "type": "string" }, "vehicle_type": { "label": "Vehicle Type", "type": "string" }, "vehicle_sub_type": { "label": "Vehicle Sub Type", "type": "string" }, "brand_name": { "label": "Brand Name", "type": "string" }, "vehicle_model": { "label": "Vehicle Model", "type": "string" }, "vehicle_model_year": { "label": "Vehicle Model Year", "type": "number" }, "vehicle_color": { "label": "Vehicle Color", "type": "string" }, "vin_number": { "label": "Vin Number", "type": "string" }, "vin_position": { "label": "Vin Position", "type": "string" }, "engine_brand": { "label": "Engine Brand", "type": "string" }, "engine_number": { "label": "Engine Number", "type": "string" }, "engine_number_position": { "label": "Engine Number Position", "type": "string" }, "fuel_type": { "label": "Fuel Type", "type": "string" }, "number_of_gas_tank": { "label": "Number of Gas Tank", "type": "string" }, "number_of_cylinders": { "label": "Number of Cylinders", "type": "number" }, "engine_capacity": { "label": "Engine Capacity", "type": "number" }, "horsepower": { "label": "Horsepower", "type": "number" }, "characteristic_drive": { "label": "Characteristic Drive", "type": "string" }, "vehicle_weight": { "label": "Vehicle Weight", "type": "number" }, "loading_weight": { "label": "Loading Weight", "type": "number" }, "vehicle_gross_weight": { "label": "Vehicle Gross Weight", "type": "number" }, "seat_capacity": { "label": "Seat Capacity", "type": "number" }, "rank_of_holder": { "label": "Rank of Holder", "type": "number" }, "date_of_possession": { "label": "Date of Possession", "type": "string" }, "owner_name": { "label": "Owner Name", "type": "string" }, "legal_owner_id_card": { "label": "Legal Owner Id Card", "type": "string" }, "legal_owner_date_of_birth": { "label": "Legal Owner Date of Birth", "type": "string" }, "owner_nationality": { "label": "Owner Nationality", "type": "string" }, "owner_address": { "label": "Owner Address", "type": "string" }, "holder_name": { "label": "Holder Name", "type": "string" }, "holder_id_card": { "label": "Holder Id Card", "type": "string" }, "holder_date_of_birth": { "label": "Holder Date of Birth", "type": "string" }, "holder_nationality": { "label": "Holder Nationality", "type": "string" }, "holder_address": { "label": "Holder Address", "type": "string" }, "contract_number": { "label": "Contract Number", "type": "string" }, "contract_date": { "label": "Contract Date", "type": "string" } }, "sync_support": true }, { "label": "Credit Bureau Report", "sub_title": "", "logo": "", "logo_disable": "", "value": "th-credit-bureau", "is_enable": true, "is_hidden": false, "instructions": [ "Take a clear photo of each page of the credit bureau report or use an electronic file.", "Upload the image in either JPEG, PNG, or PDF format." ], "file_types_supported": [ "jpg", "jpeg", "png", "pdf" ], "pages_limit": 50, "fields": { "number_of_pages": { "label": "Number of Pages", "type": "string" }, "report_number": { "label": "Report Number", "type": "string" }, "reference_number": { "label": "Reference Number", "type": "string" }, "report_date": { "label": "Report Date", "type": "date" }, "name": { "label": "Name", "type": "string" }, "id_card_number": { "label": "ID Card Number", "type": "string" }, "dob": { "label": "DOB", "type": "date" }, "nationality": { "label": "Nationality", "type": "string" }, "gender": { "label": "Gender", "type": "string" }, "marital_status": { "label": "Marital Status", "type": "string" }, "address": { "label": "Address", "type": "string" }, "total_number_of_accounts": { "label": "Total Number of Accounts", "type": "number" }, "number_of_accounts_under_update": { "label": "Number of Accounts Under Update", "type": "number" }, "account_details": { "label": "Account Details", "type": "table" }, "payment_history": { "label": "Payment History", "type": "table" }, "browsing_history": { "label": "Browsing History", "type": "table" } }, "sync_support": true }, { "label": "Bank Statement", "sub_title": "", "logo": "", "logo_disable": "", "value": "bank-statement", "is_enable": true, "is_hidden": false, "instructions": [ "Take a clear photo of each page of the bank statement or use an electronic file.", "Upload the image in either JPEG, PNG, or PDF format." ], "file_types_supported": [ "jpg", "jpeg", "png", "pdf" ], "pages_limit": 200, "fields": { "bank_name": { "label": "Bank Name", "type": "string" }, "account_number": { "label": "Account Number", "type": "string" }, "account_type": { "label": "Account Type", "type": "string" }, "account_holder_name": { "label": "Account Holder Name", "type": "string" }, "account_holder_address": { "label": "Account Holder Address", "type": "string" }, "statement_date": { "label": "Statement Date", "type": "string" }, "statement_period_from": { "label": "Statement Period - From", "type": "date" }, "statement_period_to": { "label": "Statement Period - To", "type": "date" }, "currency": { "label": "Currency", "type": "number" }, "opening_balance": { "label": "Opening Balance", "type": "number" }, "closing_balance": { "label": "Closing Balance", "type": "number" }, "total_deposits": { "label": "Total Deposits", "type": "number" }, "total_withdrawals": { "label": "Total Withdrawals", "type": "number" }, "total_no_of_deposit_transactions": { "label": "Total No. of Deposit Transactions", "type": "number" }, "total_no_of_withdrawal_transactions": { "label": "Total No. of Withdrawal Transactions", "type": "number" }, "transaction_details": { "label": "Transaction Details", "type": "table" } }, "sync_support": true }, { "label": "Taxation page", "sub_title": "", "logo": "", "logo_disable": "", "value": "taxation-page", "is_enable": true, "is_hidden": false, "instructions": [ "Take a clear photo of your taxation page", "Upload the image in either JPEG, PNG, or PDF format." ], "file_types_supported": [ "jpg", "jpeg", "png", "pdf" ], "pages_limit": 1, "fields": { "registration_number": { "label": "Registration number", "type": "string" }, "day_month_year": { "label": "day month year", "type": "string" }, "tax_data": { "label": "Tax Data", "type": "table" } }, "sync_support": false }, { "label": "Company Certificate", "sub_title": "", "logo": "", "logo_disable": "", "value": "company-certificate", "is_enable": true, "is_hidden": false, "instructions": [ "Take a clear photo of your company certificate", "Upload the image in either JPEG, PNG, or PDF format." ], "file_types_supported": [ "jpg", "jpeg", "png", "pdf" ], "pages_limit": 1, "fields": { "company_id": { "label": "Company ID", "type": "string" }, "director": { "label": "Director", "type": "string" }, "company_name": { "label": "Company Name", "type": "string" }, "empowerment": { "label": "Empowerment", "type": "string" } }, "sync_support": false } ] } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_country_code": { "value": { "error": { "status_code": 422, "detail": "Cannot process this country code." } } }, "unprocessable_language": { "value": { "error": { "status_code": 422, "detail": "Cannot process on this language." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/ocr/validate": { "post": { "tags": [ "ocr" ], "summary": "Ocr Validation", "description": "

OCR Validate

Upload files for OCR validation.

This endpoint allows users to upload pictures for processing.\nThe result will be returned as a response with validation result of Upload file.

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
pass_validation	bool	represent custom_fields_text_validation criteria with Upload file is pass
type	string	type of text validation
match_level	float	match_level criteria
keyword_list	list contain dictionary	represent keyword, matching score, is match of each keyword from user criteria

", "operationId": "ocr_validation_ocr_validate_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "title": "Body", "allOf": [ { "$ref": "#/components/schemas/Body_ocr_validation_ocr_validate_post" } ], "include_in_schema": true } } }, "required": true }, "responses": { "200": { "description": "Upload Success", "content": { "application/json": { "schema": {}, "example": { "pass_validation": true, "type": "any", "match_level": 50.0, "keyword_list": [ { "keyword": "text1", "founded_match_level": 75.25, "is_match": true }, { "keyword": "text2", "founded_match_level": 54.45, "is_match": true } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "examples": { "file_exceeds_xxx_page": { "value": { "error": { "message": "file_exceeds_xxx_page", "detail": "File exceeds xxx page", "status_code": 413 } } }, "uploaded_file_size_exceeds_100_MB": { "value": { "error": { "message": "uploaded_file_size_exceeds_100_MB", "detail": "File size exceeds 100 MB", "status_code": 413 } } } } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "examples": { "unprocessable_uploaded_file": { "value": { "error": { "message": "unprocessable_uploaded_file", "detail": "Unprocessable Content", "status_code": 422 } } }, "unprocessable_custom_fields": { "value": { "error": { "message": "unprocessable_custom_fields", "detail": "The structure of the provided custom fields is incorrect.", "status_code": 422 } } }, "incorrect_password": { "value": { "error": { "message": "incorrect_password", "detail": "Incorrect Password", "status_code": 422 } } }, "unavailable_template": { "value": { "error": { "message": "unavailable_template", "detail": "This document template is currently undergoing maintenance and will be back to normal soon.", "status_code": 422 } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/webhook/register": { "patch": { "tags": [ "webhook" ], "summary": "Register Webhook", "description": "

Register Webhook

This route is used to register a webhook URL for each user.\nYou can have only one webhook URL at a time, but you can register to change the webhook URL by recalling this route.

\n\n

Response Data Dictionary:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description	Note
status	string	processing status	example: \"success\"
user	dict	user's information
id	numberic	id of user	example: 5676797094002688
slug	string	UpPass form slug
company_name	string	company name	example: UpPass
role	string	role of user	example: \"user\"
created_at	string (datetime)	user created date	example: \"2023-05-11T05:18:03.842304+00:00\"
updated_at	string (datetime)	user updated date	example: \"2023-05-11T05:18:04.290689+00:00\"
webhook_url	string	URL that user registering	example: \"https://webhook.example\"
message	string	response status message	example: \"register webhook url successful\"

", "operationId": "register_webhook_webhook_register_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterWebhookSchema" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "status": "success", "message": "register webhook url successful", "user": { "id": 5676797094002688, "slug": "da3876e4-f455-4e00-b802-aec7e71f5ab2", "company_name": "UpPass", "role": "user", "created_at": "2023-12-20T03:59:33.509056+00:00", "updated_at": "2023-12-20T03:59:33.509060+00:00", "webhook_url": "https://webhook.example" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "error": { "status_code": 401, "detail": "Unauthorized" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "example": { "error": { "status_code": 500, "detail": "Internal Server Error" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } } }, "components": { "schemas": { "Body_direct_extract_bank_statement_extract_bank_statement_post": { "title": "Body_direct_extract_bank_statement_extract_bank_statement_post", "required": [ "bank_statement" ], "type": "object", "properties": { "bank_statement": { "title": "Bank Statement", "type": "string", "description": "A bank statement file from which you would like to extract information.", "format": "binary", "include_in_schema": true }, "bank_code": { "allOf": [ { "$ref": "#/components/schemas/Types" } ], "description": "\nThe bank statement's bank code.\nLeave empty or do not send a bank code will be automatically detected from a statement.", "include_in_schema": true }, "password": { "title": "Password", "type": "string", "description": "\nPassword required if the file is encrypted.\nLeave empty or do not send if the file is not encrypted.", "include_in_schema": true }, "applicant_first_name": { "title": "Applicant First Name", "type": "string", "description": "The first name of the owner of the bank statement, used for name match checking.", "include_in_schema": true }, "applicant_first_name_alt": { "title": "Applicant First Name Alt", "type": "string", "description": "\nAn alternative first name of the owner of the bank statement,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_last_name": { "title": "Applicant Last Name", "type": "string", "description": "The last name of the owner of the bank statement, used for name match checking.", "include_in_schema": true }, "applicant_last_name_alt": { "title": "Applicant Last Name Alt", "type": "string", "description": "\nAn alternative last name of the owner of the bank statement,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_full_name": { "title": "Applicant Full Name", "type": "string", "description": "\nA string field representing the name of the bank statement owner, \nused for name matching verification in the case of a non-personal statement", "include_in_schema": true }, "applicant_address": { "title": "Applicant Address", "type": "string", "description": "\nThe address of the owner of the bank statement.\nThis address is used for address validation based on the bank statement's address.", "include_in_schema": true }, "address_validation_distance_limit": { "title": "Address Validation Distance Limit", "type": "number", "description": "\nDistance limit for address validation in kilometers.\nIt will automatically convert to a positive number.", "default": 25.0, "include_in_schema": true }, "ignore_same_creation_mod_date": { "title": "Ignore Same Creation Mod Date", "type": "boolean", "description": "Flag to disregard checks for the same creation and modification date.", "default": false, "include_in_schema": true }, "ignore_name_match": { "title": "Ignore Name Match", "type": "boolean", "description": "Flag to disregard name match checks.", "default": false, "include_in_schema": true }, "ignore_has_transaction": { "title": "Ignore Has Transaction", "type": "boolean", "description": "Flag to skip checks for whether transactions are present.", "default": true, "include_in_schema": true }, "ignore_valid_account_number": { "title": "Ignore Valid Account Number", "type": "boolean", "description": "Flag to skip checks for valid account numbers.", "default": false, "include_in_schema": true }, "ignore_producer_check": { "title": "Ignore Producer Check", "type": "boolean", "description": "Flag to bypass checks for PDF producer information.", "default": false, "include_in_schema": true }, "ignore_validate_address": { "title": "Ignore Validate Address", "type": "boolean", "description": "Flag to skip address validation checks.", "default": false, "include_in_schema": true }, "ignore_trustable_pdf_producer": { "title": "Ignore Trustable Pdf Producer", "type": "boolean", "description": "Flag to skip pdf producer checks.", "default": false, "include_in_schema": true }, "country": { "title": "Country", "type": "string", "description": "Country code for identify what is nationality of bank statement", "default": "TH", "include_in_schema": true }, "use_ml_flagging": { "title": "Use Ml Flagging", "type": "boolean", "description": "Flag to use machine learning models in salary transactions flagging", "default": false, "include_in_schema": true } } }, "Body_direct_extract_ocr_extract_ocr_post": { "title": "Body_direct_extract_ocr_extract_ocr_post", "required": [ "ocr_files" ], "type": "object", "properties": { "ocr_files": { "title": "Ocr Files", "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Files from which you would like to extract information.", "include_in_schema": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/OcrTypes" } ], "description": "The OCR type.\nLeave empty or do not send a type will be automatically set to book-bank by default.\n ", "include_in_schema": true }, "password": { "title": "Password", "type": "string", "description": "\nPassword required if the file is encrypted.\nLeave empty or do not send if the file is not encrypted.", "include_in_schema": true }, "custom_fields": { "title": "Custom Fields", "type": "string", "description": "The json schema represents the desired response structure for extracting information from your images or documents.", "include_in_schema": true }, "custom_fields_text_validation": { "title": "Custom Fields Text Validation", "type": "string", "description": "The json schema represents The validation will be based on user-defined criteria such as keyword matching and match level threshold.", "include_in_schema": true } } }, "Body_direct_extract_utility_bill_extract_utility_bill_post": { "title": "Body_direct_extract_utility_bill_extract_utility_bill_post", "required": [ "utility_bill" ], "type": "object", "properties": { "utility_bill": { "title": "Utility Bill", "type": "string", "description": "A utility bill file from which you would like to extract information.", "format": "binary", "include_in_schema": true }, "utility_bill_type": { "allOf": [ { "$ref": "#/components/schemas/UtilityBillTypes" } ], "description": "\nThe utility bill type.\nLeave empty or do not send a type will be automatically detected from a bill.", "include_in_schema": true }, "password": { "title": "Password", "type": "string", "description": "\nPassword required if the file is encrypted.\nLeave empty or do not send if the file is not encrypted.", "include_in_schema": true }, "applicant_first_name": { "title": "Applicant First Name", "type": "string", "description": "The first name of the owner of the utility bill, used for name match checking.", "include_in_schema": true }, "applicant_first_name_alt": { "title": "Applicant First Name Alt", "type": "string", "description": "\nAn alternative first name of the owner of the utility bill,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_last_name": { "title": "Applicant Last Name", "type": "string", "description": "The last name of the owner of the utility bill, used for name match checking.", "include_in_schema": true }, "applicant_last_name_alt": { "title": "Applicant Last Name Alt", "type": "string", "description": "\nAn alternative last name of the owner of the utility bill,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_address": { "title": "Applicant Address", "type": "string", "description": "\nThe address of the owner of the utility bill.\nThis address is used for address validation based on the utility bill's address.", "include_in_schema": true }, "address_validation_distance_limit": { "title": "Address Validation Distance Limit", "type": "number", "description": "\nDistance limit for address validation in kilometers.\nIt will automatically convert to a positive number.", "default": 25.0, "include_in_schema": true }, "ignore_same_creation_mod_date": { "title": "Ignore Same Creation Mod Date", "type": "boolean", "description": "Flag to disregard checks for the same creation and modification date.", "default": false, "include_in_schema": true }, "ignore_name_match": { "title": "Ignore Name Match", "type": "boolean", "description": "Flag to disregard name match checks.", "default": false, "include_in_schema": true }, "ignore_producer_check": { "title": "Ignore Producer Check", "type": "boolean", "description": "Flag to bypass checks for PDF producer information.", "default": false, "include_in_schema": true }, "ignore_validate_address": { "title": "Ignore Validate Address", "type": "boolean", "description": "Flag to skip address validation checks.", "default": false, "include_in_schema": true } } }, "Body_ocr_validation_ocr_validate_post": { "title": "Body_ocr_validation_ocr_validate_post", "required": [ "ocr_files" ], "type": "object", "properties": { "ocr_files": { "title": "Ocr Files", "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Files from which you would like to extract information.", "include_in_schema": true }, "password": { "title": "Password", "type": "string", "description": "\nPassword required if the file is encrypted. Leave empty or do not send if the file is not encrypted.\n", "include_in_schema": true }, "custom_fields_text_validation": { "title": "Custom Fields Text Validation", "type": "string", "description": "The json schema represents The validation will be based on user-defined criteria such as keyword matching and match level threshold.", "include_in_schema": true } } }, "Body_upload_bank_statement_bank_statement_post": { "title": "Body_upload_bank_statement_bank_statement_post", "required": [ "bank_statement" ], "type": "object", "properties": { "bank_statement": { "title": "Bank Statement", "type": "string", "description": "A bank statement file from which you would like to extract information.", "format": "binary", "include_in_schema": true }, "bank_code": { "allOf": [ { "$ref": "#/components/schemas/Types" } ], "description": "\nThe bank statement's bank code.\nLeave empty or do not send a bank code will be automatically detected from a statement.", "include_in_schema": true }, "batch_id": { "title": "Batch Id", "type": "integer", "description": "\nID of the batch that you want to include this statement in. \nLeave empty or do not send the system will generate a new batch automatically.", "include_in_schema": true }, "nonce": { "title": "Nonce", "type": "string", "description": "A unique identifier to prevent duplicate requests", "include_in_schema": true }, "password": { "title": "Password", "type": "string", "description": "\nPassword required if the file is encrypted.\nLeave empty or do not send if the file is not encrypted.", "include_in_schema": true }, "slug": { "title": "Slug", "type": "string", "description": "\nA slug used for tracking between UpPass forms.\nLeave empty or do not send if you are not using UpPass integration.", "include_in_schema": true }, "applicant_first_name": { "title": "Applicant First Name", "type": "string", "description": "The first name of the owner of the bank statement, used for name match checking.", "include_in_schema": true }, "applicant_first_name_alt": { "title": "Applicant First Name Alt", "type": "string", "description": "\nAn alternative first name of the owner of the bank statement,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_last_name": { "title": "Applicant Last Name", "type": "string", "description": "The last name of the owner of the bank statement, used for name match checking.", "include_in_schema": true }, "applicant_last_name_alt": { "title": "Applicant Last Name Alt", "type": "string", "description": "\nAn alternative last name of the owner of the bank statement,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_full_name": { "title": "Applicant Full Name", "type": "string", "description": "\nA string field representing the name of the bank statement owner,\nused for name matching verification in the case of a non-personal statement", "include_in_schema": true }, "applicant_address": { "title": "Applicant Address", "type": "string", "description": "\nThe address of the owner of the bank statement.\nThis address is used for address validation based on the bank statement's address.", "include_in_schema": true }, "address_validation_distance_limit": { "title": "Address Validation Distance Limit", "type": "number", "description": "\nDistance limit for address validation in kilometers.\nIt will automatically convert to a positive number.", "default": 25.0, "include_in_schema": true }, "ignore_same_creation_mod_date": { "title": "Ignore Same Creation Mod Date", "type": "boolean", "description": "Flag to disregard checks for the same creation and modification date.", "default": false, "include_in_schema": true }, "ignore_name_match": { "title": "Ignore Name Match", "type": "boolean", "description": "Flag to disregard name match checks.", "default": false, "include_in_schema": true }, "ignore_has_transaction": { "title": "Ignore Has Transaction", "type": "boolean", "description": "Flag to skip checks for whether transactions are present.", "default": true, "include_in_schema": true }, "ignore_valid_account_number": { "title": "Ignore Valid Account Number", "type": "boolean", "description": "Flag to skip checks for valid account numbers.", "default": false, "include_in_schema": true }, "ignore_producer_check": { "title": "Ignore Producer Check", "type": "boolean", "description": "Flag to bypass checks for PDF producer information.", "default": false, "include_in_schema": true }, "ignore_validate_address": { "title": "Ignore Validate Address", "type": "boolean", "description": "Flag to skip address validation checks.", "default": false, "include_in_schema": true }, "ignore_trustable_pdf_producer": { "title": "Ignore Trustable Pdf Producer", "type": "boolean", "description": "Flag to skip pdf producer checks.", "default": false, "include_in_schema": true }, "country": { "title": "Country", "type": "string", "description": "Country code for identify what is nationality of bank statement", "default": "TH", "include_in_schema": true }, "use_ocr": { "title": "Use Ocr", "type": "boolean", "description": "Flag to use ocr extraction.", "default": false, "include_in_schema": true } } }, "Body_upload_ocr_ocr_post": { "title": "Body_upload_ocr_ocr_post", "required": [ "ocr_files" ], "type": "object", "properties": { "ocr_files": { "title": "Ocr Files", "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Files from which you would like to extract information.", "include_in_schema": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/OcrTypes" } ], "description": "\nThe ocr type.\nLeave empty or do not send a bank code will be automatically set to book-bank by default.\n", "include_in_schema": true }, "batch_id": { "title": "Batch Id", "type": "integer", "description": "\nID of the batch that you want to include this ocr in.\nLeave empty or do not send the system will generate a new batch automatically\n", "include_in_schema": true }, "nonce": { "title": "Nonce", "type": "string", "description": "A unique identifier to prevent duplicate requests", "include_in_schema": true }, "slug": { "title": "Slug", "type": "string", "description": "\nA slug used for tracking between UpPass forms.\nLeave empty or do not send if you are not using UpPass integration.", "include_in_schema": true }, "password": { "title": "Password", "type": "string", "description": "\nPassword required if the file is encrypted. Leave empty or do not send if the file is not encrypted.\n", "include_in_schema": true }, "webhook_enable": { "title": "Webhook Enable", "type": "boolean", "description": "\nAllow to send response to webhook url that user registered. \n", "default": false, "include_in_schema": true }, "custom_fields": { "title": "Custom Fields", "type": "string", "description": "The json schema represents the desired response structure for extracting information from your images or documents.", "include_in_schema": true }, "custom_fields_text_validation": { "title": "Custom Fields Text Validation", "type": "string", "description": "The json schema represents The validation will be based on user-defined criteria such as keyword matching and match level threshold.", "include_in_schema": true } } }, "Body_upload_utility_bill_utility_bill_post": { "title": "Body_upload_utility_bill_utility_bill_post", "required": [ "utility_bill" ], "type": "object", "properties": { "utility_bill": { "title": "Utility Bill", "type": "string", "description": "A utility bill file from which you would like to extract information.", "format": "binary", "include_in_schema": true }, "utility_bill_type": { "allOf": [ { "$ref": "#/components/schemas/UtilityBillTypes" } ], "description": "\nThe utility bill type.\nLeave empty or do not send a type will be automatically detected from a bill.", "include_in_schema": true }, "batch_id": { "title": "Batch Id", "type": "integer", "description": "\nID of the batch that you want to include this utility bill in.\nLeave empty or do not send the system will generate a new batch automatically.", "include_in_schema": true }, "nonce": { "title": "Nonce", "type": "string", "description": "A unique identifier to prevent duplicate requests", "include_in_schema": true }, "password": { "title": "Password", "type": "string", "description": "\nPassword required if the file is encrypted.\nLeave empty or do not send if the file is not encrypted.", "include_in_schema": true }, "slug": { "title": "Slug", "type": "string", "description": "\nA slug used for tracking between UpPass forms.\nLeave empty or do not send if you are not using UpPass integration.", "include_in_schema": true }, "applicant_first_name": { "title": "Applicant First Name", "type": "string", "description": "The first name of the owner of the utility bill, used for name match checking.", "include_in_schema": true }, "applicant_first_name_alt": { "title": "Applicant First Name Alt", "type": "string", "description": "\nAn alternative first name of the owner of the utility bill,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_last_name": { "title": "Applicant Last Name", "type": "string", "description": "The last name of the owner of the utility bill, used for name match checking.", "include_in_schema": true }, "applicant_last_name_alt": { "title": "Applicant Last Name Alt", "type": "string", "description": "\nAn alternative last name of the owner of the utility bill,\nused for name match checking. Leave empty or do not send if not available.", "include_in_schema": true }, "applicant_address": { "title": "Applicant Address", "type": "string", "description": "\nThe address of the owner of the utility bill.\nThis address is used for address validation based on the utility bill's address.", "include_in_schema": true }, "address_validation_distance_limit": { "title": "Address Validation Distance Limit", "type": "number", "description": "\nDistance limit for address validation in kilometers.\nIt will automatically convert to a positive number.", "default": 25.0, "include_in_schema": true }, "ignore_same_creation_mod_date": { "title": "Ignore Same Creation Mod Date", "type": "boolean", "description": "Flag to disregard checks for the same creation and modification date.", "default": false, "include_in_schema": true }, "ignore_name_match": { "title": "Ignore Name Match", "type": "boolean", "description": "Flag to disregard name match checks.", "default": false, "include_in_schema": true }, "ignore_valid_account_number": { "title": "Ignore Valid Account Number", "type": "boolean", "description": "Flag to skip checks for valid account numbers.", "default": false, "include_in_schema": true }, "ignore_producer_check": { "title": "Ignore Producer Check", "type": "boolean", "description": "Flag to bypass checks for PDF producer information.", "default": false, "include_in_schema": true }, "ignore_validate_address": { "title": "Ignore Validate Address", "type": "boolean", "description": "Flag to skip address validation checks.", "default": false, "include_in_schema": true } } }, "HTTPValidationError": { "title": "HTTPValidationError", "type": "object", "properties": { "detail": { "title": "Detail", "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "OcrTypes": { "title": "OcrTypes", "enum": [ "book-bank", "th-vehicle-registration", "th-credit-bureau", "bank-statement", "taxation-page", "company-certificate", "ocr-validation" ], "description": "An enumeration." }, "RegisterWebhookSchema": { "title": "RegisterWebhookSchema", "required": [ "webhook_url" ], "type": "object", "properties": { "webhook_url": { "title": "Webhook Url", "type": "string", "description": "url that need to callback ocr result." } } }, "Types": { "title": "Types", "enum": [ "th-kbank", "th-ktb", "th-gsb", "th-bbl", "th-bbl-business", "th-ttb", "th-ttb-business", "th-scb", "th-scb-business", "th-bay", "th-baac", "th-uob", "th-lh", "th-kkp", "th-generic-bank", "BCA_PERSONAL", "BNI_PERSONAL", "BRI_PERSONA", "MANDIRI_PERSONAL", "MANDIRI_CORPORATE", "BNI_CORPORATE", "BCA_CORPORATE", "PERMATA_CORPORATE", "GCASH_PERSONAL", "BDO_PERSONAL", "BPI_PERSONAL", "KOMO_PERSONAL", "LANDBANK_PERSONAL", "METROBANK_PERSONAL", "BRI_CORPORATE", "UNIONBANK_PERSONAL", "RCBC_PERSONAL" ], "description": "An enumeration." }, "UtilityBillTypes": { "title": "UtilityBillTypes", "enum": [ "th-ais", "th-dtac", "th-true", "th-epb", "th-emb", "th-wmb" ], "description": "An enumeration." }, "ValidationError": { "title": "ValidationError", "required": [ "loc", "msg", "type" ], "type": "object", "properties": { "loc": { "title": "Location", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } } } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }