Webhooks

Register a Webhook Endpoint

Some operations on 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.s or Documents will take time to complete. 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 analytics are available for it.

We support two options for awaiting the result of a long-running operation:

  1. Regularly poll the Book Status endpoint until it delivers the desired response.
  2. Establish a webhook that Ocrolus will call upon an operation's completion.

Polling is simpler to implement and maintain, while webhooks are more reliable and precise.

We currently limit each account to one Webhook Endpoint. To configure the Endpoint for your API account, use the Configure Webhook Endpoint.

Doing so requires two parameters:

  1. URL of Your Endpoint: This parameter is the address of your webhook endpoint. It will likely exist within your own infrastructure, and must therefore be accessible to Ocrolus. We don't recommend exposing your webhook to the public Internet; for more information, see 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.


Did this page help you?