Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

PDF Mixed Documents

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:

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:

To extract the results from a Book:

Once processed, Bank Statements produce two results:

To extract the results from a Book:

Updated 2 months ago


PDF Mixed Documents


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.