Retrieve a monitoring alert

curl --request GET \
  --url https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": {},
  "monitoring_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "source": "MONITORING_SUBSCRIPTION",
  "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"
  }
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

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>'

import requests

url = "https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/monitoring/alerts/{alert_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": {},
  "monitoring_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "source": "MONITORING_SUBSCRIPTION",
  "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"
  }
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

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>

read-only

The date and time the resource was created.

Example:

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

string<uuid>

read-only

Unique identifier for this alert.

last_updated_time

string<date-time>

read-only

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.

monitoring_event_id

string<uuid>

read-only

Unique identifier for the monitoring event that produced this alert.

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"

source

enum<string>

How the alert was produced. Any of the following:

MONITORING_SUBSCRIPTION – produced by an event from an ongoing monitoring subscription.
SANCTIONS_SCREENING – produced by a point-in-time sanctions screening.

Available options:

MONITORING_SUBSCRIPTION,

SANCTIONS_SCREENING

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>

read-only

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[]

read-only

Where to get more information about this alert.

Example:

[
  "https://example.com/alert-document-1",
  "https://example.com/alert-document-2"
]

vendor_info

Vendor Info · object

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

Vendor Info
Vendor Info

Show child attributes

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Deprecated

Retrieve a monitoring alert

Authorizations

Path Parameters

Response