Get Contracts

GET 
/api/v8/partner/contracts

Get Contracts

Request

Query Parameters

page integer

Default value: 1

The page number. The response is capped to maximum of 50 results per page.

page_size integer
Default value: 50
The number of Documents per page.
Example: 10

Responses

200

A list of previously processed Contracts.

application/json

Schema

Schema

anyOf
DetailedContracts
count integerrequired
The total number of results retrieved across all pages.
next stringrequired
The URL to the next page of results.
previous stringrequired
The URL to the previous page of results.
results object[]required
Array [
meta object
external_id string
Possible values: non-empty
A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.
pdf_url uri
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.
created_date date-timerequired
updated_date date-timerequired
text string
The text returned from converting the document into a machine-readable text format.
contract_name objectrequired
value stringrequired
begin integer
end integer
score number
date objectrequired
value daterequired
begin integer
end integer
score number
end_date objectrequired
value daterequired
begin integer
end integer
score number
start_date objectrequired
value daterequired
begin integer
end integer
score number
parties object[]required
Array [
value stringrequired
begin integer
end integer
score number
]
term objectrequired
value stringrequired
begin integer
end integer
score number
total objectrequired
value numberrequired
begin integer
end integer
score number
renewal_term objectrequired
value stringrequired
begin integer
end integer
score number
notice_period objectrequired
value stringrequired
begin integer
end integer
score number
termination_for_convenience_period objectrequired
value stringrequired
begin integer
end integer
score number
governing_law objectrequired
value stringrequired
begin integer
end integer
score number
vanity objectrequired
value stringrequired
begin integer
end integer
score number
termination_notice objectrequired
value stringrequired
begin integer
end integer
score number
]
DetailedBankStatements
count integerrequired
The total number of results retrieved across all pages.
next stringrequired
The URL to the next page of results.
previous stringrequired
The URL to the previous page of results.
results object[]required
A collection of previously processed Bank Statement objects.
Array [
external_id string
Possible values: non-empty
A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.
meta object
external_id string
Possible values: non-empty
A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.
fraud object
An object that contains additional information to identify fraud.
score number
Possible values: <= 1
Confidence of Fraud Detector in it's prediction
types string[]
Possible values: [LCD photo, not a document, duplicate, screenshot]
List of attributions which marked the document as fraud
duplicates object[]
An array of duplicate documents found in the system.
Array [
id integerrequired
The id of the duplicate document.
url urirequired
Possible values: non-empty and <= 2083 characters
The url of the duplicate document.
score numberrequired
Possible values: >= 0.7 and <= 1
The confidence score between 0 and 1.
]
pdf_url uri
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.
created_date date-timerequired
updated_date date-timerequired
img_thumbnail_url uri
Possible values: non-empty and <= 2083 characters
A signed URL to access the auto-generated thumbnail created for the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.
account_holder_address object
The address of the account holder.
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.
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
]
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
The name of the account holder.
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.
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
]
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
The account number associated with the bank statement.
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.
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
]
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_numbers object[]required
Array [
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.
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
]
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
The type of account associated with the bank statement.
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.
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
]
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_vat_number object
The unique identifier for businesses used for tax purposes
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.
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
]
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
The address of the bank.
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.
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
]
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
The name of the bank.
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.
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
]
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_vat_number object
The unique identifier assigned to a bank for tax purposes
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.
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
]
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
The URL for the website of the bank.
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.
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
]
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
The balance at the beginning of the statement period.
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.
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
]
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
currency_code object
The currency code associated with the bank statement.
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.
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
]
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.
due_date object
The date the payment is due in ISO 8601 format.
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.
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
]
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
The balance at the end of the statement period.
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.
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
]
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
iban_number object
The International Bank Account Number
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.
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
]
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.
minimum_due object
The minimum amount due for the statement period.
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.
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
]
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
The end date of the statement period in ISO 8601 format.
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.
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
]
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
The start date of the statement period in ISO 8601 format.
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.
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
]
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
The routing number associated with the bank statement.
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.
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
]
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.
routing_numbers object[]required
Array [
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.
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
]
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
The date of the statement in ISO 8601 format.
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.
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
]
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
The unique identifier associated with the bank statement.
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.
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
]
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.
swift object
The unique identifier for a bank used in international transactions
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.
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
]
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
The account number associated with the bank statement.
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.
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
]
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
The balance after any credit or debits have been applied from this transaction.
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.
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
]
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
A credit card number associated with this transaction.
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.
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
]
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
The amount credited from this transaction.
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.
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
]
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
The date of the transaction in ISO 8601 format.
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.
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
]
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
posted_date object
The date the transaction was posted in ISO 8601 format.
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.
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
]
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
The amount debited from this transaction.
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.
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
]
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
The description of the transaction.
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.
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
]
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
The unique identifier of the transaction.
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.
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
]
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
The OCR text extracted from the transaction.
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.
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
]
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.
]
summaries object[]required
Summary information
Array [
name object
The title or label that captures the main information
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.
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
]
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.
total object
The overall amount calculated from all transactions
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.
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
]
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
]
]

Example (from schema)

{}

Loading...