v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
File Uploads

Upload Pay stub PDF to Book

Upload a known <<glossary:Pay stub>> file directly to a specific <glossary:Book>.


You can upload a file to this endpoint as a multipart/form-data encoded payload. Visit our guide for more information.

If successful, the response will return the specific doc_uuid for the uploaded <glossary:Document>.

📘

  • This endpoint is limited to PDF's where the form type is expected to be a PAYSTUB.
  • The maximum file size allowed for upload is 200 MB.
post/v2/book/{book_uuid}/document/paystub

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.

Response

Success

OR
OR

Example response

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