GET
/
monitoring
/
alerts
/
{alert_id}
Retrieve a monitoring alert
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id} \
  --header 'Authorization: Bearer <token>'
{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "status": "ACTIVE",
  "title": "Ireland Competition and Consumer Protection Commission Criminal Court Cases",
  "type": "BANKRUPTCY",
  "urls": [
    "https://example.com/alert-document-1",
    "https://example.com/alert-document-2"
  ],
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
alert_id
string<uuid>
required

Unique identifier for this monitoring alert.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

A single monitoring alert.

​
business_id
string<uuid>

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
creation_time
string<date-time>

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>

Unique identifier for this alert.

​
last_updated_time
string<date-time>

The date and time the resource was last update.

Example:

"2010-05-06T12:23:34.321Z"

​
metadata
object

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

​
person_id
string<uuid>

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
status
enum<string>

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.
Available options:
ACTIVE,
SUPPRESSED
​
title
string

A description of the monitoring alert.

Example:

"Ireland Competition and Consumer Protection Commission Criminal Court Cases"

​
type
enum<string>

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
Available options:
BANKRUPTCY,
LICENSE_VALIDITY,
NEGATIVE_NEWS,
WATCHLIST
​
urls
string[]

Where to get more information about this alert.

Example:
[
  "https://example.com/alert-document-1",
  "https://example.com/alert-document-2"
]
​
vendor_info
object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.