PDF mixed documents

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

Upload PDF mixed documents to Ocrolus

To upload the mixed PDF document using Ocrolus API, perform the following steps:

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 response of create Book API while invoking the upload call to ensure the documents are added within the intended Book.
4. Retrieve the document's classification results using the Book classification summary or mixed-document classification summary endpoint.
5. To know the uploaded mixed document's status, call the Retrieve mixed document status endpoint.

Check for completion

To receive the complete results for a case, poll for completion for the Book. Alternatively, we recommend registering for webhook notifications, which lets you know exactly when a document has completed processing.

📘

Note

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 be broken down into documents by type and unit.

Forms

Once processed, the forms generate JSON results that include form data (pay stub, ISO application, W-2, 1040, SBA PPP application, etc.). To retrieve the results from a book, download the form data (pay stub, ISO application, W-2, 1040, SBA PPP application, etc.) in JSON format.

Bank Statements

After the documents have been processed, you can retrieve their results through the following two endpoints:

• Transactions
• Book summary