This hefty penalty …
", "source_link": "https://www.example.com/news/274534" } ] } } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } }, "/v1/media/checkIndividual": { "get": { "summary": "Screen an individual against adverse media", "description": "The checkIndividual API method searches for individuals that match certain criteria. All categories are returned, even if they contain 0 hits.", "operationId": "checkMediaIndividual", "tags": [ "media_screening" ], "parameters": [ { "description": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "example": "Boris Johnson", "name": "search_all", "in": "query", "schema": { "type": "string" } }, { "description": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "name": "names", "in": "query", "schema": { "type": "string" } }, { "description": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "name": "start_date", "in": "query", "schema": { "$ref": "#/components/schemas/LocalDate" } }, { "description": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "name": "publication_country", "in": "query", "schema": { "type": "string" } }, { "description": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "name": "fetch_articles", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckMediaResponse" }, "examples": { "Categories only": { "summary": "With fetch_articles=false (default)", "value": { "timestamp": "2024-12-20T14:17:16.843Z", "total_hits": 3508683, "news_exposures": { "violent_crime": { "category": "violent_crime", "hits": 28466 }, "terrorism": { "category": "terrorism", "hits": 796691 }, "regulatory": { "category": "regulatory", "hits": 984492 }, "financial_crime": { "category": "financial_crime", "hits": 26088 }, "political": { "category": "political", "hits": 1649400 }, "organized_crime": { "category": "organized_crime", "hits": 23546 } } } }, "With articles": { "summary": "With fetch_articles=true", "value": { "timestamp": "2024-11-11T14:22:07.447Z", "total_hits": 801, "news_exposures": { "terrorism": { "category": "terrorism", "hits": 801, "articles": [ { "timestamp": "2024-11-06T08:02:35Z", "id": "274534:2871", "language": "en", "headline": "Boris Johnson ‘fired' …", "body": "Channel 4 ‘fired' …
", "source_link": "https://www.example.com/news/79685542" } ] } } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } }, "/v1/media/search": { "get": { "summary": "Search adverse media articles", "description": "The search API method returns the matching articles themselves instead of a category breakdown. It is the endpoint to use when you need every article that matches your query, because the results can be paged through with the `cursor` parameter.\n\nIn contrast to `checkIndividual` and `checkEntity`, the articles are returned as a flat `articles` array without the `news_exposures` category breakdown.", "operationId": "searchMedia", "tags": [ "media_screening" ], "parameters": [ { "description": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "example": "Example Holding", "name": "search_all", "in": "query", "schema": { "type": "string" } }, { "description": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "name": "names", "in": "query", "schema": { "type": "string" } }, { "description": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "example": "fraud,money laundering", "name": "term_filter", "in": "query", "schema": { "type": "string" } }, { "description": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "name": "start_date", "in": "query", "schema": { "$ref": "#/components/schemas/LocalDate" } }, { "description": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "name": "publication_country", "in": "query", "schema": { "type": "string" } }, { "description": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "description": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "name": "category", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleSearchResponse" }, "examples": { "Last page": { "summary": "The last page has no next_cursor", "value": { "timestamp": "2026-08-21T08:52:27.399Z", "total_hits": 1, "articles": [ { "timestamp": "2026-06-27T19:44:50Z", "id": "219938:26776", "language": "en", "headline": "Regulator fines Example Holding over money laundering controls", "body": "The financial regulator has imposed a fine on Example Holding following an investigation into the company's anti-money laundering controls.
According to the regulator, the company failed to monitor a number of high-risk client relationships over a period of three years, and suspicious transaction reports were not escalated in time.
Example Holding stated that it has since strengthened its compliance function and will not appeal the decision. Two former board members are subject to separate proceedings on suspicion of fraud.
", "source_link": "https://www.example.com/regulator-fines-example-holding" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } }, "/v1/registerEntity": { "get": { "summary": "Register an entity for monitoring", "description": "The registerEntity endpoint allows clients to register an entity's name to be monitored against dilisense's database, and receive notifications if any matches are found from that point in time onwards.\n\nRegistration does not perform an initial screening, and matches that already exist at the time of registration will not trigger a webhook. Therefore, first register the search profile and screen the name with checkEntity afterwards.", "operationId": "registerEntity", "tags": [ "om_profiles" ], "parameters": [ { "description": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "example": "abcdefg-1234", "name": "profile_id", "in": "query", "schema": { "type": "string" } }, { "description": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "name": "search_all", "in": "query", "schema": { "type": "string" } }, { "description": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "example": "REYCO GMBH GERMANY", "name": "names", "in": "query", "schema": { "type": "string" } }, { "description": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "name": "fuzzy_search", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" }, "examples": { "Success": { "summary": "Success", "value": { "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } }, "/v1/registerIndividual": { "get": { "summary": "Register an individual for monitoring", "description": "The registerIndividual endpoint allows clients to register an individual's name to be monitored against dilisense's database, and receive notifications if any matches are found from that point in time onwards.\n\nRegistration does not perform an initial screening, and matches that already exist at the time of registration will not trigger a webhook. Therefore, first register the search profile and screen the name with checkIndividual afterwards.", "operationId": "registerIndividual", "tags": [ "om_profiles" ], "parameters": [ { "description": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "example": "abcdefg-1234", "name": "profile_id", "in": "query", "schema": { "type": "string" } }, { "description": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "name": "search_all", "in": "query", "schema": { "type": "string" } }, { "description": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "example": "Boris Johnson", "name": "names", "in": "query", "schema": { "type": "string" } }, { "description": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "example": 1, "name": "fuzzy_search", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "description": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "example": "19/06/1964", "name": "dob", "in": "query", "schema": { "type": "string" } }, { "description": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "example": "male", "name": "gender", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" }, "examples": { "Success": { "summary": "Success", "value": { "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } }, "/v1/removeSearchProfile": { "get": { "summary": "Remove a search profile", "description": "The removeSearchProfile endpoint allows clients to remove a search profile that was previously registered with the Ongoing Monitoring API, based on the profile_id provided in the request parameters.\n\nThe endpoint is idempotent. Removing a profile_id that is unknown or that has already been removed also succeeds, so that a request can safely be retried if a previous response did not reach your system.", "operationId": "removeSearchProfile", "tags": [ "om_profiles" ], "parameters": [ { "description": "The unique identifier of the profile to be removed.", "example": "abcdefg-1234", "name": "profile_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" }, "examples": { "Success": { "summary": "Success", "value": { "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } }, "/v1/testWebhookDelivery": { "get": { "summary": "Send a test webhook notification", "description": "Once the webhook is configured, you can trigger a test notification to your configured webhook URL at any time in order to verify your integration. A sample ADD notification with the given profile_id is sent.\n\nA separate sandbox environment is not required. If you would like us to verify the integration together with you, please send us your webhook URL and we will send a test notification from our side.", "operationId": "testWebhookDelivery", "tags": [ "om_profiles" ], "parameters": [ { "description": "The profile_id that is set in the test notification. It does not have to be registered.", "example": "abcdefg-1234", "name": "profile_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" }, "examples": { "Success": { "summary": "Success", "value": { "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } }, "/v1/usage": { "get": { "summary": "Get the usage of your API key", "description": "The usage endpoint returns how many API calls your API key made in a month, broken down by endpoint and day, together with your quotas and the number of registered Ongoing Monitoring search profiles. Use it to track your consumption against your quota, to reconcile your invoice or to reconcile the search profiles tracked in your own system. The endpoint is available for every API key and covers all dilisense APIs.\n\nThe call is free of charge and does not count towards your billed requests. Calls are counted almost in real time, a call shows up in the usage after a few seconds. The quotas themselves are described in [Quotas](https://developers.dilisense.com/using-the-api/quotas).", "operationId": "getUsage", "tags": [ "utils" ], "parameters": [ { "description": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "example": "2026-09", "name": "month", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Usage" }, "examples": { "September 2026": { "summary": "With month=2026-09", "value": { "month": "2026-09", "timezone": "UTC", "summary": { "billed_requests_monthly_used": 132, "billed_requests_quota": 10000, "ongoing_monitoring_profiles_registered": 250, "ongoing_monitoring_profiles_quota": 1000 }, "endpoints": [ { "path": "/v1/checkIndividual", "monthly_used": 120, "daily": [ { "date": "2026-09-01", "used": 45 }, { "date": "2026-09-02", "used": 75 } ] }, { "path": "/v1/media/checkEntity", "monthly_used": 12, "daily": [ { "date": "2026-09-02", "used": 12 } ] }, { "path": "/v1/getSourceList", "monthly_used": 3, "daily": [ { "date": "2026-09-01", "used": 3 } ] }, { "path": "/v1/usage", "monthly_used": 2, "daily": [ { "date": "2026-09-02", "used": 2 } ] } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "x-api-key": [] } ] } } }, "webhooks": { "matchNotification": { "post": { "operationId": "matchNotification", "summary": "Receive a match notification", "description": "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.\n\nYour 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](https://developers.dilisense.com/using-the-api/signature-verification).\n\nNotifications 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).\n\nIf 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.", "tags": [ "om_webhook" ], "parameters": [ { "name": "x-api-key", "in": "header", "description": "Your API key, so that you can verify that the notification originates from dilisense.", "schema": { "type": "string" } }, { "name": "x-dilisense-signature", "in": "header", "description": "The payload signature, which proves that the body originates from dilisense and was not altered, see [Signature Verification](https://developers.dilisense.com/using-the-api/signature-verification).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookNotification" }, "examples": { "ADD notification": { "summary": "A new match for a registered individual", "value": { "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" ] } } } } } } }, "responses": { "2XX": { "description": "Acknowledges the notification. Respond within 30 seconds, the response body is ignored." }, "default": { "description": "The notification is not acknowledged." } } } } }, "servers": [ { "url": "https://api.dilisense.com" } ] }