Upload Pay stub PDF to Book

Upload a known Pay stub file directly to a specific Book. This endpoint is limited to PDF's where the form type is expected to be a pay stub.


You can upload a file to this endpoint as a multipart/form-data encoded payload. To learn more, see multipart/form-data guide.

If successful, the response will return the specific doc_uuid for the uploaded Document.

Direct upload via this endpoint requires the calling organization to have the Pay stub document type configured. If it is not configured, the upload is rejected.

This endpoint is not available for Books configured with the Classify-only processing type. Attempting to upload to such a Book returns an error indicating that direct document upload is not allowed for that Book type.

📘

Note

The maximum file size allowed for upload is 200 MB.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the Book where the uploaded file will be saved.

Body Params
file
required

The PDF file to upload.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json