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 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.s will take time to complete. For instance, every Document in a Book must achieve BOOK_COMPLETE (Book Status API Status Code), also listed as VERIFICATION_COMPLETE (Dashboard UI) 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 API acc to one webhook endpoint. To configure the endpoint for your API account, use the configure webhook endpoint.

Creating a webhook 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 event parameter indicates all the significant lifecycle events that trigger notifications for your endpoint, including:

Event

Description

BOOK_VERIFIED

Verification of all Documents in a Book is complete. This corresponds with the BOOK_COMPLETE status code in the Book Status API.

DOC_VERIFIED

One Document within a Book completes or fails verification. This corresponds with the VERIFICATION_COMPLETE Document Status.

IMAGE_GROUP_VERIFIED

Image group completes verification.

ANALYTICS_COMPLETED

Asynchronous analytics request completes generation of result data.

MIDDESK_VERIFIED

Results are available for POST Business API call (Middesk integration).

SUSPICIOUS_ACTIVITY

Email-only notification

Instances of suspicious activity have been found in the book.


Did this page help you?