PDF mixed documents

A mixed PDF document is a single-page PDF or multi-page pdf containing different form types which you prefer Ocrolus to classify.

Upload PDF mixed documents to Ocrolus

The steps involved are:

1. Generate your API credentials as described in the Authentication section.
2. Create a new Book to upload all the Document. Save the book_uuid or book pk for later use.
3. Upload the input file to the Book using the Upload mixed document PDF endpoint. Use the book_uuid or book pk from the create Book response while invoking the upload call to ensure that the files are organized within the appropriate Book.
4. Retrieve the document Classify results using the book or mixed-document classification summary endpoint.
5. To know the uploaded mixed document's status, call the Retrieve mixed document statusendpoint. We recommend registering for webhook notifications, which lets you know exactly when a document has completed processing.

📘

Check for completion

While you can request results at any point, you will only receive data from documents with VERIFICATION_COMPLETE status.

Extract results from Book

The results from the classification will be retrieved by calling classification summary endpoint. The classification results will break down the documents per type and unit.

Forms

• Once processed, forms produce JSON results comprising Form Data (Pay stub, ISO App, W-2, 1040, SBA PPP application, etc.).

• To extract the results from a book, download form data (pay stub, ISO App, W-2, 1040, SBA PPP application etc.) in JSON format.

Bank Statements

Once processed, bank statements produce the below two results:

• Transaction listing
• Analytics (JSON)

To extract the results from a book:

• Download Transaction listing
• Download Analytics (JSON) or Analytics (Excel)