File Uploads

Upload Pay stub PDF to Book

Upload a known <<glossary:Pay stub>> file directly to a specific <glossary: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 <glossary: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.

post/v2/book/{book_uuid}/document/paystub

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v2/book/{book_uuid}/document/paystub
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Path parameters

book_uuidstring required
Example:19aab921-25a5-4beb-a59e-ac72320061d6

The unique identifier of the <glossary:Book> where the uploaded file will be saved.

Request body multipart/form-data

uploadstring binary required

The PDF file to upload.

Example request

{
  "upload": "example-pay-stub.pdf"
}

Response

Success

OR
OR

Example response

{
  "status": 200,
  "message": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.