This guide covers how to upload either a PDF file that contains more than one document, or a document that you prefer for Ocrolus to classify.

Upload PDF mixed documents to Ocrolus

The steps involved are:

Generate your API credentialsAPI credentials - API Credentials are the API Key and Secret used to authenticate all requests to the API. as described in the Authentication section.
Create a new BookBook - A Book is a container for all Documents in a Case or Loan Application. This container primarily serves as a boundary to correlate data. As such, objects in different Books can never be associated or correlated with each other. to upload all the bank statements for a given case.
Upload mixed document PDF to the Book. Reference the book_pk from the create Book response when invoking the upload call to ensure that the files are organized within the appropriate Book.

Check for completion

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

In order to receive results from a case, poll for completion for documents in a Book. In this scenario, poll for Mixed document status. Alternatively, configure a Webhook to be notified when a document or Book is complete.

Extract results from Book

The results of the classification will break down the documents per type and unit. Here are detailed steps to retrieve the results for forms and bank statements.

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.

Once processed, bank statements produce two results:

To extract the results from a Book:

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