Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Monitoring

Retrieve a monitoring alert

get/monitoring/alerts/{alert_id}

Path parameters

alert_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Unique identifier for this monitoring alert.

Response

A single monitoring alert.

business_idstring uuid

Unique ID for the business. Exactly one of business_id or person_id must be set.

creation_timestring date-time

The date and time the resource was created.

idstring uuid

Unique identifier for this alert.

last_updated_timestring date-time

The date and time the resource was last update.

metadataMetadata

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

monitoring_event_idstring uuid

Unique identifier for the monitoring event that produced this alert.

person_idstring uuid

Unique ID for the person. Exactly one of person_id or business_id must be set.

status'ACTIVE' | 'SUPPRESSED'

The status of the alert. Any of the following:

  • ACTIVE – alert has been issued and should be investigated.
  • SUPPRESSED – alert is a false positive, alert should be dismissed, or has been otherwise investigated.
titlestring

A description of the monitoring alert.

type'BANKRUPTCY' | 'LICENSE_VALIDITY' | 'NEGATIVE_NEWS' | 'WATCHLIST'

The type of customer alert. Any of the following:

  • WATCHLIST – the customer was added to a known watchlist.
  • BANKRUPTCY – the customer filed for bankruptcy.
  • NEGATIVE_NEWS – the customer was mentioned in negative news articles.
  • LICENSE_VALIDITY – the license is no longer valid. Exmaple of this would be if a license was suspended
urlsstring[]

Where to get more information about this alert.

Example response

{
  "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"
  }
}