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!

Webhooks

Register a Webhook Endpoint

In some scenarios, you must 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 the analytics for the Book. To check if verification is complete, you'll need to poll the Book Status Endpoint.

Receive notifications about completion events

Use Webhooks are they are more reliable than Polling specific Status Query Endpoints.

We currently limit each account to one Webhook Endpoint. To set up or update the Endpoint for your API account , use the Configure Webhook Endpoint.

The invocation requires two parameters:

  1. URL of Your Endpoint
    This parameter is the URL of Your Endpoint must be publicly accessible so that the API can submit notifications.
    For Endpoint protection strategies, view Securing Webhook URLs.
  2. Events that Trip Notifications
    This parameter indicates all the significant lifecycle events that trigger notifications for your endpoint, including:

Event Name

Description

BOOK_VERIFIED

Receive a notification when verification of all the Documents in 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. is complete.

DOC_VERIFIED

Receive a notification when a 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. within a Book completes or fails verification.

IMAGE_GROUP_VERIFIED

Receive a notification when an Image Group completes verification.

ANALYTICS_COMPLETED

Receive a notification when an Asynchronous Analytics Request completes generation of result data.

MIDDESK_VERIFIED

Receive the results of the POST Business API call (Middesk integration) once the results are available.

Updated about a month ago



Webhooks


Register a Webhook Endpoint

Suggested Edits are limited on API Reference Pages

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