Skip to main content
POST
/
api
/
v3
/
extract
/
bankbooks
Extract Data
curl --request POST \
  --url https://api.dataspike.io/api/v3/extract/bankbooks \
  --header 'Content-Type: multipart/form-data' \
  --header 'ds-api-token: <api-key>' \
  --form file='@example-file' \
  --form issued_country=TH
{
  "id": "01827ed5-c228-7a3c-9a31-7ab7cc169d13",
  "account_name": "สมชาย แสนลี",
  "account_number": "123-4567-890",
  "account_name_en": "Samchai Leelie",
  "confidence_score": 0.985,
  "similarity_score": 0.985,
  "is_scan": true
}

Authorizations

​
ds-api-token
string
header
required

Body

multipart/form-data
​
file
file
required

The image of bankbook

Example:

"@bankbook.jpeg"

​
issued_country
string<ISO 3166-1 alpha-2>
required

Country issued document in ISO 3166-1 alpha-2 format.

Example:

"TH"

Response

Extracted fields

​
id
string<uuid>
required

The id of uploaded bankbook in the system

Example:

"01827ed5-c228-7a3c-9a31-7ab7cc169d13"

​
account_name
string
required

The account name extracted from document

Example:

"สมชาย แสนลี"

​
account_number
string
required

The account number extracted from document

Example:

"123-4567-890"

​
account_name_en
string | null

[Optional] The account name in English extracted from document

Example:

"Samchai Leelie"

​
confidence_score
number

Confidence score of extracted fields [0..1]. The higher the score, the more accurate the fields are.

Example:

0.985

​
similarity_score
number

Similarity score of the document [0..1]. The higher the score, the more likely the document is a bankbook.

Example:

0.985

​
is_scan
boolean

Whether the document is a scanned version or a screenshot of the bankbook

Example:

true