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. Min file size is 250bytes. The max pdf file size is 50mb. When processing is finished, you should expect a request to your configured webhook.

Request

application/json

Body

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.tags string[]

Possible values: non-empty

Default value: ``

Tags you want to associate with the document.

package_path string

Possible values: non-empty

A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

bucket string

Possible values: non-empty

An S3 bucket for 'package_path', e.g. 'documents'.

file_data string

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.

file_url string

Possible values: non-empty

A URL to a publicly accessible document to be sent to Veryfi for processing.

file_urls string[]

Possible values: non-empty

An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

file_name string

Possible values: non-empty

An optional filename. Useful to determine file type.

categories string[]

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.

tags string[]

Default value: ``

A user-defined list of identifiers that help to categorize or flag particular types of documents.

max_pages_to_process integer

Possible values: >= 1 and <= 100

Default value: 100

Limit processing to number of pages.

multipart/form-data

Body

meta.external_id string

Possible values: non-empty

External ID you want to associate with the document.

meta.tags string[]

Possible values: non-empty

Default value: ``

Tags you want to associate with the document.

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.

package_path string

Possible values: non-empty

A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

bucket string

Possible values: non-empty

An S3 bucket for 'package_path', e.g. 'documents'.

file_data string

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.

file_url string

Possible values: non-empty

A URL to a publicly accessible document to be sent to Veryfi for processing.

file_urls string[]

Possible values: non-empty

An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

file_name string

Possible values: non-empty

An optional filename. Useful to determine file type.

file binary

A binary file. Submitting zipped documents through this parameter is the fastest way to process any document.

categories string[]

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.

tags string[]

Default value: ``

A user-defined list of identifiers that help to categorize or flag particular types of documents.

max_pages_to_process integer

Possible values: >= 1 and <= 100

Default value: 100

Limit processing to number of pages.

Responses

202

Returns the unique identifiers for the document currently being processed.

application/json

Schema

Schema

id integerrequired

The unique identifier of the collections of processed documents.

documents_id integer[]

The unique identifiers of the documents created from processed PDF Splitter.

status stringrequired

Possible values: [processed, in_progress, deleted, failed]

Example (from schema)

{
  "id": 0,
  "documents_id": [
    0
  ],
  "status": "processed"
}

400

User error

application/json

Schema

Schema

oneOf

COULDNT_DOWNLOAD_FILE_FROM_PROVIDED_URL

status string

Default value: fail

error string

Default value: Couldn't download file from provided url.

details undefined[]

Default value: [object Object]

RECEIVED_EMPTY_OR_MISSING_DATA

status string

Default value: fail

error string

Default value: Received empty or missing data

NO_FILES_TO_PROCESS

status string

Default value: fail

error string

Default value: No files to process

FILE_IS_CORRUPTED

status string

Default value: fail

error string

Default value: File is corrupted

THE_FILE_IS_TOO_BIG

status string

Default value: fail

error string

Default value: The file is too big

IMAGE_DIMENSIONS_ARE_TOO_SMALL

status string

Default value: fail

error string

Default value: Image dimensions are too small

details undefined[]

Default value: [object Object]

FILE_IS_ENCRYPTED

status string

Default value: fail

error string

Default value: File is encrypted

Example (from schema)

{}

403

User error

application/json

Schema

Schema

oneOf

AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED

status string

Default value: fail

error string

Default value: Authentication credentials were not provided.

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

413

Request body too large

application/json

Schema

Schema

oneOf

REQUEST_BODY_TOO_LARGE

status string

Default value: fail

error string

Default value: Request body too large

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

500

Unexpected error

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporarily unavailable. Please try again later

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 100 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

General error response

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string",
  "details": [
    {}
  ]
}

Loading...