Set up a webhook for your account so your application can react to Ocrolus events.

You can find a list of supported event types in the Registering your Webhook Endpoint Guide.

Sample Notifications

The following webhook notifications showcase some common scenarios.

{
  "status": "VERIFICATION_COMPLETE", 
  "book_pk": 6777219, 
  "book_uuid":   "0d8bb103-643c-4620-ace9-e042ec2e93b8",
  "uploaded_doc_pk": 13027406,
  "uploaded_doc_uuid": "7491a1b5-4edd-4fa8-9ed5-9a7ab2744127", 
  "mixed_uploaded_doc_pk": null,
  "mixed_uploaded_doc_uuid": null, 
  "uploaded_image_group_pk": null, 
  "uploaded_image_group_uuid": null
}
{
  "status": "REJECTED", 
  "book_pk": 6622008,
  "book_uuid": "446ceb3b-8c2a-45c0-82a8-0b21640c86f6", 
  "uploaded_doc_pk": 12856201, 
  "uploaded_doc_uuid": "b0bf0eb7-c1fd-4473-aba3-ea93dd619a22",
  "mixed_uploaded_doc_pk": null, 
  "mixed_uploaded_doc_uuid": null, 
  "uploaded_image_group_pk": 2515686, 
  "uploaded_image_group_uuid": "37b53b86-3d83-4c1a-86aa-e22bd522720c"
}
{
  "status": "BOOK_COMPLETE",
  "book_pk": 11917,
  "book_uuid": "35ef4501-b93d-4ce2-b766-b670a057c0fb"
}
{
  "status": "COMPLETED", 
  "book_pk": 6638269, 
  "book_uuid": "6ed803d7-6cd2-485f-b8b1-088c03362df2",
  "uploaded_image_group_pk": 2512560, 
  "uploaded_image_group_uuid": "93850c56b69f-4f3b-a8ee-e9acac0a9bad"
}
{
  "event": "ANALYTICS_COMPLETED",
  "status": "COMPLETED",
  "book_pk": 11917,
  "analytics_request_id": "419bcd3f-dba5-43a1-88b0-9bf0adebd332"
}
{
  "event": "MIDDESK_VERIFIED",
  "business_uuid": "950335c1-1c55-432a-8be7-2961a03d0b5b",
  "book_uuid": "c383ac62-61b8-43eb-a71f-88c8037ad681",
  "middesk_response": {
    "object": "business",
    "id": "51c4b91e-f324-467b-86b5-9e0155bcc251",
    "name": "Middesk Inc.",
    "external_id": null,
    "created_at": "2019-01-30T02:31:26.276Z",
    "updated_at": "2019-01-30T02:31:26.276Z",
    "status": "approved",
    "addresses": [
      "string"
    ],
    "tin": {},
    "formation": {},
    "phone_numbers": [
      "string"
    ],
    "review": {},
    "website": {},
    "watchlist": {},
    "registrations": [
      "string"
    ],
    "people": [
      "string"
    ],
    "subscriptions": null
  }
}
Language
Authentication
OAuth2