Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
File Uploads

Upload PDF to Book

Upload a PDF file to a <glossary:Book> for processing.

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

📘

  • The maximum file size for upload is 200 MB.

For all Documents except bank statements, the optional form_type parameter can be used to specify the type of <glossary:Document>.

You can see form types we support in our forms directory. For more information, please contact your Account Executive or Customer Success Executive to discuss other options for your organization.

post/v1/book/upload

Response

200

OR

Example response

{
  "status": 200,
  "response": {
    "uploaded_docs": [
      {
        "pk": 1,
        "uuid": "8dc88eed-2b6f-414a-82f2-a99bd181cf6e",
        "name": "bank-statement.pdf",
        "page_count": 16,
        "checksum": "50a62f72f4b5b80b18f75fbed690dc47",
        "created_ts": "2018-06-20T19:47:12Z",
        "id": 1
      }
    ]
  },
  "message": "OK"
}