Get ∀Docs
GET/api/v8/partner/any-documents
Get ∀Docs
Request
Query Parameters
Default value: 1
The page number. The response is capped to maximum of 50 results per page.
Default value: 50
The number of Documents per page.
A field used to determine whether or not to return bounding_box and bounding_region
for extracted fields in the Document response.
A field used to determine whether or not to return the score
and ocr_score
fields in the Document response.
Return documents created after this date and time in ISO 8601 format.
Return documents created before this date and time in ISO 8601 format.
Return documents created beginning at this date and time in ISO 8601 format.
Return documents created on and before this date and time in ISO 8601 format.
Return documents updated after this date and time in ISO 8601 format.
Return documents updated before this date and time in ISO 8601 format.
Return documents updated beginning at this date and time in ISO 8601 format.
Return documents updated on and before this date and time in ISO 8601 format.
The name of the extraction blueprints.
The name of the extraction blueprints.
Responses
- 200
A list of previously processed ∀Docs.
- application/json
- Schema
- Example (from schema)
Schema
- AnyDocumentsResponse
- DetailedChecks
- Array [
- ]
- Array [
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- CheckFraudPage
- ]
- Array [
- ]
- Array [
- ]
- ]
The total number of results retrieved across all pages.
The URL to the next page of results.
The URL to the previous page of results.
results object[]required
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.
The unique number created to identify the document.
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.
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.
Possible values: non-empty
The blueprint name which was used to extract the data. Sample blueprints: [ "auto_insurance_card", "bill_of_lading", "flight_itinerary", "goods_received_note", "incorporation_document", "incorporation_document_latam", "indian_passport", "latam_passport", "prescription_medication_label", "product_nutrition_facts", "restaurant_menu", "shipping_label", "uk_drivers_license", "us_driver_license", "us_health_insurance_card", "us_passport", "vehicle_registration", "vendor_statement", "work_order"]
Possible values: non-empty
The blueprint name which was used to extract the data. Same as blueprint_name.
The total number of results retrieved across all pages.
The URL to the next page of results.
The URL to the previous page of results.
results object[]required
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.
The unique number created to identify the document.
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.
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.
The text returned from converting the document into a machine-readable text format.
amount objectrequired
The numeric value representing the amount found on the document.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
amount_text objectrequired
The value as a string representing the amount found on the document.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
bank_address objectrequired
The address of the bank.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
bank_name objectrequired
The name of the bank.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
fractional_routing_number object
The numbers appearing as the denominator of a fraction that is printed in the upper portion of a check.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
routing_from_fractional objectrequired
The routing number from the found in the fractional_routing_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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
check_number objectrequired
The check 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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
date objectrequired
The date in ISO 8601 format. Typically found on invoices.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
memo objectrequired
The description found in the memo line of the check.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
payer_address objectrequired
The address of the payer.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
payer_name objectrequired
The name of the payer.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
receiver_address objectrequired
The address of the receiver.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
receiver_name objectrequired
The name of the receiver.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
is_signed objectrequired
Presence of a signature on the check (front of check image)
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
is_endorsed objectdeprecated
deprecated and will be removed at 2024-11-10. Use endorsement.is_signed instead
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
endorsement object
An object containing the endorsement details
is_signed object
Presence of an endorsement signature (back of check image).
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
is_mobile_or_remote_deposit_only object
Presence of restricted endorsement text such as mobile or remote deposit only
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
micr object
An object containing the details for the Magnetic ink character recognition.
routing_number object
The bank routing 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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
account_number objectrequired
The bank account 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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
serial_number object
The serial number on checks.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
raw object
The text returned from converting the document into a machine-readable text format.
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.
number
integer
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
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.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
meta object
fraud object
An object that contains additional information to help check for fraud.
pages object[]
An array containing fraud info about each extracted page
is_lcd object
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. Returned with confidence_details: true
The extracted value.
Indicates that all four corners of the check are visible and within the boundaries of the image.
Possible values: <= 1
Confidence of Fraud Detector in it's prediction
Possible values: [other
, handwritten characters
, digital tampering
, generated document
, LCD photo
, screenshot
, not a document
, duplicate
, high velocity
, critical velocity
, similar documents
, multiple profiles or devices
, fraud history
, emulated device
, blocked device
]
List of attributions which marked the document as fraud
pages object[]
Pages meta details
Specifies whether the image represents the front side of the check.
duplicates object[]
An array of duplicate documents found in the system.
The id of the duplicate document.
Possible values: non-empty
and <= 2083 characters
The url of the duplicate document.
Possible values: >= 0.7
and <= 1
The confidence score between 0 and 1.
{}