Process Any Document
POST/api/v8/partner/any-documents
Veryfi's Process Any Document 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
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.
A URL to a publicly accessible document to be sent to Veryfi for processing.
An array of URLs to publicly accessible documents to be sent to Veryfi for processing.
A path to a file in an S3 bucket, e.g. 'some/receipt.jpg
An S3 bucket for 'package_path', e.g. 'documents'.
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.
The name of the extraction templates.
Body
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.
A URL to a publicly accessible document to be sent to Veryfi for processing.
An array of URLs to publicly accessible documents to be sent to Veryfi for processing.
A path to a file in an S3 bucket, e.g. 'some/receipt.jpg
An S3 bucket for 'package_path', e.g. 'documents'.
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.
The name of the extraction templates.
Responses
- 201
- 400
- 404
- 429
- 499
- 503
- 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.
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 unique number created to identify the Document.
The date and time the document was first submitted and processed in ISO 8601.
Possible values: non-empty
The template name which was used to extract the data.
{
"pdf_url": "string",
"img_thumbnail_url": "string",
"id": 0,
"created_date": "2024-05-08T13:03:23.154Z",
"template_name": "string"
}
User error
- application/json
- Schema
- Example (from schema)
Schema
- COULDNT_DOWNLOAD_FILE_FROM_PROVIDED_URL
- RECEIVED_EMPTY_OR_MISSING_DATA
Default value: fail
Default value: Couldn't download file from provided url.
Default value: [object Object]
Default value: fail
Default value: Received empty or missing data
{}
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
{}
OperationStatus
- application/json
- Schema
- Example (from schema)
Schema
Default value: fail
{
"error": "string",
"details": [
{}
],
"status": "fail"
}