Process a ∀Doc
POST/api/v8/partner/any-documents
Veryfi's Process a ∀Doc endpoint allows you to submit and extract data from unstructured documents such as Contracts, Articles of Incorporation and any other documents and turn them into valuable business insights. The Process a ∀Doc endpoint enables you to submit the following image formats: .pdf,.jpg,.jpeg,.png,.tiff,.tif,.bmp,.gif and retrieve extracted data in JSON format. The max file size is 20mb, min file size is 1kb. Rate limit is 60 requests per second.
Request
- application/json
- multipart/form-data
Body
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
Default value: ``
Tags you want to associate with the document.
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
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
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
Deprecated.The blueprint name which was used to extract the data. Same as blueprint_name.
Body
Possible values: non-empty
External ID you want to associate with the document.
Possible values: non-empty
Default value: ``
Tags you want to associate with 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
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
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
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
Deprecated.The blueprint name which was used to extract the data. Same as blueprint_name.
Responses
- 201
- 400
- 403
- 404
- 413
- 429
- 499
- 500
- 503
- 504
- default
Returns a processed ∀Doc.
- application/json
- Schema
- Example (from schema)
Schema
- API_V8_PARTNER_ANYDOCUMENTS_ANYDOCUMENTRESPONSE
- Array [
- ]
- Array [
- CheckFraudPage
- Array [
- ]
- ]
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
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[]
Possible values: <= 1
The average OCR score of the page.
The width of the page.
The height of the page.
Possible values: non-empty
Default value: ``
Tags associated with the document.
Possible values: <= 1
The average OCR score of the whole document.
Possible values: non-empty
The version of the model used to process the document.
fraud object
An object that contains additional information to help check for fraud.
Possible values: <= 1
Confidence of Fraud Detector in it's prediction
Possible values: [LCD photo
, not a document
, duplicate
, screenshot
, generated document
, aspect ratio mismatch
]
List of attributions which marked the document as 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.
The extracted value.
flags object[]
List of flags which marked the document as fraud
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: non-empty
Indicates that all four corners of the check are visible and within the boundaries of the image.
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
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
Deprecated. The blueprint name which was used to extract the data. Same as blueprint_name.
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- FAILED_TO_PROCESS_DOCUMENTS
- FAILED_TO_EXTRACT
Default value: fail
Default value: Failed to process documents
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
{}
Request body too large
- application/json
- Schema
- Example (from schema)
Schema
- REQUEST_BODY_TOO_LARGE
Default value: fail
Default value: Request body too large
{}
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
{}
Unexpected error
Service is temporarily unavailable
- application/json
- Schema
- Example (from schema)
Schema
- SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER
Default value: fail
Default value: Service is temporarily unavailable. Please try again later
{}
Gateway timeout. Returned if request takes more than 100 seconds. The request might finish successfully later.
- application/json
- Schema
- Example (from schema)
Schema
- GATEWAY_TIMEOUT
Default value: fail
Default value: Gateway timeout
{}
General error response
- application/json
- Schema
- Example (from schema)
Schema
Default value: fail
{
"status": "fail",
"error": "string",
"details": [
{}
]
}