v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Monitoring

List monitoring alerts

get/monitoring/alerts

Query parameters

idstring[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

sanctions_screening_idstring[]

Only return alerts related to the specified sanctions screening(s). Multiple IDs can be provided as a comma-separated list.

monitoring_event_idstring[]

Only return alerts produced by the specified monitoring event(s). Multiple IDs can be provided as a comma-separated list.

business_idstring[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

person_idstring[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

Response

List of alerts.

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "alerts": [
    {
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "title": "Ireland Competition and Consumer Protection Commission Criminal Court Cases",
      "urls": [
        "https://example.com/alert-document-1",
        "https://example.com/alert-document-2"
      ],
      "vendor_info": {
        "vendor": "SOCURE"
      }
    }
  ],
  "next_page_token": "a8937a0d"
}