Get ∀Docs

GET 
/api/v8/partner/any-documents

Get ∀Docs

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
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.

created_date__gt string
Return documents created after this date and time in ISO 8601 format.
Example: 2022-05-03 00:00:00
created_date__lt string
Return documents created before this date and time in ISO 8601 format.
Example: 2023-03-23 00:00:00
created_date__gte string
Return documents created beginning at this date and time in ISO 8601 format.
Example: 2022-04-24 00:00:00
created_date__lte string
Return documents created on and before this date and time in ISO 8601 format.
Example: 2020-10-15 00:00:00
updated_date__gt string
Return documents updated after this date and time in ISO 8601 format.
Example: 2023-07-25 00:00:00
updated_date__lt string
Return documents updated before this date and time in ISO 8601 format.
Example: 2019-03-18 00:00:00
updated_date__gte string
Return documents updated beginning at this date and time in ISO 8601 format.
Example: 2020-02-03 00:00:00
updated_date__lte string
Return documents updated on and before this date and time in ISO 8601 format.
Example: 2023-01-03 00:00:00
meta_tags array
Return documents containing these tags.
Example: a
blueprint_name string

The name of the extraction blueprints.

template_name string

The name of the extraction blueprints.

Responses

200

A list of previously processed ∀Docs.

application/json

Schema

Schema

anyOf
∀DocListResponseSchema
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
The collection of processed ∀Doc documents
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.
pages object[]
Array [
ocr_score number
Possible values: <= 1
The average OCR score of the page.
width integer
The width of the page.
height integer
The height of the page.
]
tags string[]
Possible values: non-empty
Default value: ``
Tags associated with the document.
ocr_score number
Possible values: <= 1
The average OCR score of the whole document.
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.
blueprint_name stringrequired
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"]
template_name stringdeprecated
Possible values: non-empty
The blueprint name which was used to extract the data. Same as blueprint_name.
]

Example (from schema)

{}

Loading...