Process ∀Doc
POST/api/v8/partner/any-documents
Veryfi's Process ∀Doc endpoint allows you to submit and extract data from unstructured documents (such as Contracts, Articles of Incorporation and others) and turn them into valuable business insights.
Request
- application/json
- multipart/form-data
Body
Possible values: non-empty
Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls
or uploading zip files.
Possible values: non-empty
A URL to a publicly accessible document to be sent to Veryfi for processing.
Possible values: non-empty
An array of URLs to publicly accessible documents to be sent to Veryfi for processing.
Possible values: non-empty
A path to a file in an S3 bucket, e.g. 'some/receipt.jpg
Possible values: non-empty
An S3 bucket for 'package_path', e.g. 'documents'.
Possible values: non-empty
An optional filename. Useful to determine file type.
Possible values: >= 1
and <= 50
Default value: 20
The number of pages to process for the document. The limit is 50 pages per document.
Possible values: non-empty
The name of the extraction blueprints. Default blueprints include [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.
Body
Possible values: non-empty
Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls
or uploading zip files.
Possible values: non-empty
A URL to a publicly accessible document to be sent to Veryfi for processing.
Possible values: non-empty
An array of URLs to publicly accessible documents to be sent to Veryfi for processing.
Possible values: non-empty
A path to a file in an S3 bucket, e.g. 'some/receipt.jpg
Possible values: non-empty
An S3 bucket for 'package_path', e.g. 'documents'.
Possible values: non-empty
An optional filename. Useful to determine file type.
A binary file. Submitting zipped documents through this parameter is the fastest way to process any document.
Possible values: >= 1
and <= 50
Default value: 20
The number of pages to process for the document. The limit is 50 pages per document.
Possible values: non-empty
The name of the extraction blueprints. Default blueprints include [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.
Responses
- 201
- 400
- 403
- 404
- 429
- 499
- 503
- 504
- default
The processed document.
- application/json
- Schema
- Example (from schema)
Schema
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.
{
"pdf_url": "string",
"id": 0,
"external_id": "string",
"created_date": "2024-12-06T16:05:02.113Z",
"updated_date": "2024-12-06T16:05:02.113Z",
"img_thumbnail_url": "string",
"blueprint_name": "string"
}
User error
- application/json
- Schema
- Example (from schema)
Schema
- FAILED_TO_PROCESS_PACKAGE
- FAILED_TO_EXTRACT
Default value: fail
Default value: Failed to process package
Default value: fail
Default value: Failed to extract
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED
Default value: fail
Default value: Authentication credentials were not provided.
{}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- NOT_FOUND
- DOCUMENT_NOT_FOUND
Default value: fail
Default value: Not found.
Default value: fail
Default value: Document Not Found
{}
Rate limit
- application/json
- Schema
- Example (from schema)
Schema
- YOU_HAVE_BEEN_RATE_LIMITED
Default value: fail
Default value: You have been rate limited
Default value: [object Object]
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION
Default value: fail
Default value: Client closed request or lost connection
{}
Service is temporaly unavailable
- application/json
- Schema
- Example (from schema)
Schema
- SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER
Default value: fail
Default value: Service is temporaly unavailable. Please try again later
{}
Gateway timeout. Returned if request takes more than 150 seconds. The request might finish successfully later.
- application/json
- Schema
- Example (from schema)
Schema
- GATEWAY_TIMEOUT
Default value: fail
Default value: Gateway timeout
{}
OperationStatus
- application/json
- Schema
- Example (from schema)
Schema
Default value: fail
{
"status": "fail",
"error": "string",
"details": [
{}
]
}