Skip to main content

Split and process a W2

POST 
/api/v8/partner/w2s-set

Veryfi's W2 Splitter allows you to split a multi page PDF with different W2s inside into multiple Documents. This API supports .zip,.pdf. The max pdf file size is 50mb. When processing is finished, you should expect a request to your configured webhook.

Request​

Body

    file_data string

    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

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

    file_urls string[]

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

    package_path string

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

    bucket string

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

    file_name string

    An optional filename. Useful to determine file type.

    max_pages_to_process integer

    Possible values: >= 1 and <= 100

    Default value: 100

    Limit processing to number of pages. A page is a pdf page or an image

Responses​

The unique identifier of a document set.

Schema
    id integerrequired

    The unique identifier of the W2 set.

    document_ids integer[]

    The ID of documents created from the set.

    status stringrequired

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

Loading...