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!

Monitor Books

Polling For Completion

In some scenarios, it may be necessary to wait for a 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 reach a certain status before you can perform a certain action.

πŸ“˜

For instance, every DocumentDocument - A Document is a single sequence of Bank Statement pages. The sequence can contain pages from multiple Bank Statements, including different Bank Accounts and Account Holders. During data capture, Ocrolus attributes the Account Holder, Bank Account, and Period information to each processed Transaction therein. in a Book must achieve VERIFICATION_COMPLETE status before you can request analytics for the Book. To check if verification status is complete, poll the Book Status Endpoint.

Receive notification about document completion

Using Webhooks to receive document completion notification

Use Webhooks to receive reliable notifications about document completion.

Using Polling to query document completion notification

If setting up a publicly exposed endpoint is not an option, you can poll specific Status Query Endpoints.

Polling checks for an expected condition by calling a particular Query Endpoint in a loop.
Since the status of Endpoints does not change often, invoking the same Query Endpoint repeatedly is likely to give the same result for most invocations.

A more efficient approach is to poll in larger intervals, preferably with a back-off strategy for error conditions. To view more details about polling strategies, view Retry Strategies.

Updated about a month ago



Monitor Books


Polling For Completion

Suggested Edits are limited on API Reference Pages

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