Split and process a PDF
POST/api/v8/partner/documents-set
Veryfi's PDF Splitter allows you to split a multi page PDF with different receipts and invoices inside into multiple Documents. This API supports .pdf,.zip. The max pdf file size is 50mb. When processing is finished, you should expect a request to your configured webhook.
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.
Default value: ``
The category chosen from a predefined list of categories found on the account. Learn how Veryfi's intelligent categorization, custom categorization, and model training work.
Default value: ``
A user-defined list of identifiers that help to categorize or flag particular types of documents.
Possible values: >= 1 and <= 100
Default value: 100
Limit processing to number of pages.
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.
Default value: ``
The category chosen from a predefined list of categories found on the account. Learn how Veryfi's intelligent categorization, custom categorization, and model training work.
Default value: ``
A user-defined list of identifiers that help to categorize or flag particular types of documents.
Possible values: >= 1 and <= 100
Default value: 100
Limit processing to number of pages.
Responses
- 202
- 400
- 404
- 429
- 499
- 503
- default
Returns the unique identifiers for the document currently being processed.
- application/json
- Schema
- Example (from schema)
Schema
The unique identifier of the collections of processed documents.
The unique identifiers of the documents created from processed PDF Splitter.
Possible values: [processed, in_progress, deleted, failed]
{
"id": 0,
"documents_id": [
0
],
"status": "processed"
}
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"
}