Split and process a W-2

POST 
/api/v8/partner/w2s-set

Veryfi's W-2 Splitter allows you to split a multi page PDF with different W-2s 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

Body

file_url

multipart/form-data

Body

file_url

Responses

202

The unique identifier of a document set.

application/json

Schema

Schema

id integerrequired

The unique identifier of the W-2 set.

document_ids integer[]

The ID of documents created from the set.

status stringrequired

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

Example (from schema)

{
  "id": 0,
  "document_ids": [
    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]

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)

{}

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 150 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

OperationStatus

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

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

Loading...