Get a Bank Statement

GET 
/api/v8/partner/bank-statements/:document_id

Veryfi's Get a Bank Statement endpoint allows you to retrieve a previously processed Bank Statement.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

Query Parameters

detailed boolean

This field was deprecated on 2023-08-20. Use bounding_boxes and confidence_details.

bounding_boxes boolean

A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

confidence_details boolean

A field used to determine whether or not to return the score and ocr_score fields in the Document response.

Responses

200

Veryfi's Get a Bank Statement endpoint allows you to retrieve a previously processed Bank Statement.

application/json

Schema

Schema

anyOf

BankStatement

pdf_url urirequired

Possible values: non-empty and <= 2083 characters

A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

id integerrequired

The unique number created to identify the document.

account_holder_address string

The address of the account holder.

account_holder_name string

The name of the account holder.

account_number string

The account number associated with the bank statement.

account_type string

The type of account associated with the bank statement.

bank_address string

The address of the bank.

bank_name string

The name of the bank.

bank_website string

The URL for the website of the bank.

beginning_balance number

The balance at the beginning of the statement period.

due_date date

The date the payment is due in ISO 8601 format.

ending_balance number

The balance at the end of the statement period.

minimum_due number

The minimum amount due for the statement period.

period_end_date date

The end date of the statement period in ISO 8601 format.

period_start_date date

The start date of the statement period in ISO 8601 format.

routing_number string

The routing number associated with the bank statement.

statement_date date

The date of the statement in ISO 8601 format.

statement_number string

The unique identifier associated with the bank statement.

transactions object[]required

A list of transactions associated with the bank statement.

Array [

order integerrequired

The value indicating the position of where the transaction appears on the bank statement.

account_number string

The account number associated with the bank statement.

balance number

The balance after any credit or debits have been applied from this transaction.

card_number string

A credit card number associated with this transaction.

credit_amount number

The amount credited from this transaction.

date date

The date of the transaction in ISO 8601 format.

debit_amount number

The amount debited from this transaction.

description string

The description of the transaction.

transaction_id string

The unique identifier of the transaction.

text stringrequired

The OCR text extracted from the transaction.

]

currency_code string

The currency code associated with the bank statement.

DetailedBankStatement

pdf_url urirequired

Possible values: non-empty and <= 2083 characters

A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

id integerrequired

The unique number created to identify the document.

account_holder_address object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

account_holder_name object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

account_number object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

account_type object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bank_address object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bank_name object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bank_website object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

beginning_balance object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value numberrequired

due_date object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value daterequired

ending_balance object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value numberrequired

minimum_due object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value numberrequired

period_end_date object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value daterequired

period_start_date object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value daterequired

routing_number object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

statement_date object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value daterequired

statement_number object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

transactions object[]required

A list of transactions associated with the bank statement.

Array [

order integerrequired

The value indicating the position of where the transaction appears on the bank statement.

account_number object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

balance object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value numberrequired

card_number object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

credit_amount object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value numberrequired

date object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value daterequired

debit_amount object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value numberrequired

description object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

transaction_id object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

text object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

]

currency_code object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

Example (from schema)

{}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

503

Service is temporaly unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporaly unavailable. Please try again later

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

status stringrequired

Possible values: [fail, ok]

error string
message stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string",
  "message": "string",
  "details": [
    {}
  ]
}

Loading...