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

Once processed, Bank Statements produce two results:

• Transaction Listing
• Analytics

To extract the results from a Book:

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