Skip to main content

Receive a match notification

Webhook

The Ongoing Monitoring API provides a webhook-based notification system that enables clients to receive real-time alerts when a change in a search profile is found in any of the screening lists. The URL should be publicly accessible and capable of handling HTTP POST requests. We will ask you for the webhook URL during the onboarding process.

Your API key is sent with every webhook request, so that you can verify that the notification originates from dilisense. In addition every notification carries a payload signature in the x-dilisense-signature header, which proves that the body originates from dilisense and was not altered, see Signature Verification.

Notifications are driven by the updates of the dilisense database and are not sent on a fixed schedule. Each database update is compared against the previous state and the resulting changes are computed subsequently. If an update contains no relevant change for your registered search profiles, no webhook is sent. For each match a separate webhook is triggered, with ADD, UPDATE or DELETE as the match_type (e.g., there can be multiple matches in one list and across lists).

If the webhook URL receives a notification from the Ongoing Monitoring API, it should respond with an HTTP status code in the 2xx range within 30 seconds to indicate that the message has been received and acknowledged. The response body is ignored. To avoid timeouts or delays, any long-running processes should be written as code that can run asynchronously outside the webhook endpoint.

Request​

Responses​

Acknowledges the notification. Respond within 30 seconds, the response body is ignored.

Error responses are the same for all endpoints, see Errors.

Example​

Payload​

{
  "timestamp": "2024-03-24T19:16:00Z",
  "event_id": "3f6c2a9e-8d41-4b7a-9c5e-1a2b3c4d5e6f",
  "profile_id": "abcdefg-1234",
  "match_type": "ADD",
  "entity": {
    "id": "c438b18a93cd3c13",
    "source_id": "dilisense_pep",
    "source_type": "PEP",
    "pep_type": "POLITICIAN",
    "entity_type": "INDIVIDUAL",
    "name": "Boris Johnson",
    "given_names": [
      "Boris"
    ],
    "last_names": [
      "Johnson"
    ],
    "gender": "MALE",
    "date_of_birth": [
      "19/06/1964"
    ],
    "political_parties": [
      "Conservative Party"
    ],
    "description": [
      "Prime Minister of the United Kingdom"
    ],
    "occupations": [
      "journalist",
      "politician"
    ],
    "links": [
      "Facebook: borisjohnson"
    ],
    "citizenship": [
      "United Kingdom",
      "United States of America"
    ],
    "positions": [
      "2001-06-07 - 2005-04-11  Member of the 53rd Parliament of the United Kingdom",
      "2005-05-05 - 2008-06-04  Member of the 54th Parliament of the United Kingdom",
      "2008-05-04 - 2016-05-07  Mayor of London",
      "2015-05-07 - 2017-05-03  Member of the 56th Parliament of the United Kingdom",
      "2016-07-13 - 2018-07-09  Secretary of State for Foreign and Commonwealth Affairs",
      "2017-06-08 - 2019-11-06  Member of the 57th Parliament of the United Kingdom",
      "Since 2016-01-01  Member of the Privy Council of the United Kingdom",
      "Since 2019-07-23  Leader of the Conservative Party",
      "Since 2019-07-24  First Lord of the Treasury",
      "Since 2019-07-24  Minister for the Civil Service",
      "Since 2019-07-24  Prime Minister of the United Kingdom",
      "Since 2019-07-26  Minister for the Union",
      "Since 2019-12-12  Member of the 58th Parliament of the United Kingdom"
    ],
    "place_of_birth": [
      "New York City"
    ],
    "parents": [
      "Charlotte Johnson Wahl",
      "Stanley Johnson"
    ],
    "siblings": [
      "Jo Johnson",
      "Leo Johnson",
      "Rachel Johnson"
    ],
    "spouse": [
      "Allegra Mostyn-Owen",
      "Marina Wheeler"
    ],
    "children": [
      "Cassia Peaches Johnson",
      "Lara Lettice Johnson",
      "Milo Arthur Johnson",
      "Theodore Apollo Johnson",
      "Wilfred Johnson"
    ]
  }
}