In some scenarios, you may have 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 desired 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_COMPLETEstatus before you can request the analytics for the Book. To check if verification is complete, you'll need to poll the Book Status Endpoint.
Webhooks are a more reliable mechanism to be notified about completion events, as opposed to Polling specific Status Query Endpoints.
We currently limit each account to one Webhook Endpoint. You can set up or update the Endpoint associated with your API account by using the Configure Webhook Endpoint.
The invocation requires two parameters:
- URL of Your Endpoint
The URL of Your Endpoint must be publicly accessible so that the API can submit notifications. See our section on Securing Webhook URLs for strategies to protect your Endpoint. - Events that Trip Notifications
This indicates all the significant lifecycle events that trigger notifications for your endpoint, including:
Event Name | Description |
|---|---|
| Receive a notification when 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. have been processed. |
| 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 has Completed Verification or is Rejected |
| Receive a notification when an Image Group completes verification. |
| Receive a notification when an Asynchronous Analytics Request has completed generation of result data. |
Updated 9 months ago