Update a monitoring alert

curl --request PATCH \
  --url https://api.synctera.com/v2/monitoring/alerts/{alert_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "metadata": {},
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "title": "Ireland Competition and Consumer Protection Commission Criminal Court Cases",
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}
'

import requests

url = "https://api.synctera.com/v2/monitoring/alerts/{alert_id}"

payload = {
    "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "metadata": {},
    "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "title": "Ireland Competition and Consumer Protection Commission Criminal Court Cases",
    "vendor_info": {
        "content_type": "application/json",
        "json": {},
        "vendor": "SOCURE"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    metadata: {},
    person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    title: 'Ireland Competition and Consumer Protection Commission Criminal Court Cases',
    vendor_info: {content_type: 'application/json', json: {}, vendor: 'SOCURE'}
  })
};

fetch('https://api.synctera.com/v2/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.synctera.com/v2/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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'metadata' => [
        
    ],
    'person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'title' => 'Ireland Competition and Consumer Protection Commission Criminal Court Cases',
    'vendor_info' => [
        'content_type' => 'application/json',
        'json' => [
                
        ],
        'vendor' => 'SOCURE'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.synctera.com/v2/monitoring/alerts/{alert_id}"

	payload := strings.NewReader("{\n  \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"title\": \"Ireland Competition and Consumer Protection Commission Criminal Court Cases\",\n  \"vendor_info\": {\n    \"content_type\": \"application/json\",\n    \"json\": {},\n    \"vendor\": \"SOCURE\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.synctera.com/v2/monitoring/alerts/{alert_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"title\": \"Ireland Competition and Consumer Protection Commission Criminal Court Cases\",\n  \"vendor_info\": {\n    \"content_type\": \"application/json\",\n    \"json\": {},\n    \"vendor\": \"SOCURE\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"title\": \"Ireland Competition and Consumer Protection Commission Criminal Court Cases\",\n  \"vendor_info\": {\n    \"content_type\": \"application/json\",\n    \"json\": {},\n    \"vendor\": \"SOCURE\"\n  }\n}"

response = http.request(request)
puts response.read_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"
}

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

PATCH

monitoring

alerts

{alert_id}

Update a monitoring alert

curl --request PATCH \
  --url https://api.synctera.com/v2/monitoring/alerts/{alert_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "metadata": {},
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "title": "Ireland Competition and Consumer Protection Commission Criminal Court Cases",
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}
'

import requests

url = "https://api.synctera.com/v2/monitoring/alerts/{alert_id}"

payload = {
    "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "metadata": {},
    "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "title": "Ireland Competition and Consumer Protection Commission Criminal Court Cases",
    "vendor_info": {
        "content_type": "application/json",
        "json": {},
        "vendor": "SOCURE"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    metadata: {},
    person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    title: 'Ireland Competition and Consumer Protection Commission Criminal Court Cases',
    vendor_info: {content_type: 'application/json', json: {}, vendor: 'SOCURE'}
  })
};

fetch('https://api.synctera.com/v2/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.synctera.com/v2/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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'metadata' => [
        
    ],
    'person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'title' => 'Ireland Competition and Consumer Protection Commission Criminal Court Cases',
    'vendor_info' => [
        'content_type' => 'application/json',
        'json' => [
                
        ],
        'vendor' => 'SOCURE'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.synctera.com/v2/monitoring/alerts/{alert_id}"

	payload := strings.NewReader("{\n  \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"title\": \"Ireland Competition and Consumer Protection Commission Criminal Court Cases\",\n  \"vendor_info\": {\n    \"content_type\": \"application/json\",\n    \"json\": {},\n    \"vendor\": \"SOCURE\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.synctera.com/v2/monitoring/alerts/{alert_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"title\": \"Ireland Competition and Consumer Protection Commission Criminal Court Cases\",\n  \"vendor_info\": {\n    \"content_type\": \"application/json\",\n    \"json\": {},\n    \"vendor\": \"SOCURE\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"title\": \"Ireland Competition and Consumer Protection Commission Criminal Court Cases\",\n  \"vendor_info\": {\n    \"content_type\": \"application/json\",\n    \"json\": {},\n    \"vendor\": \"SOCURE\"\n  }\n}"

response = http.request(request)
puts response.read_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"
}

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

Body

application/json

Monitoring alert to update.

business_id

string<uuid>

The unique identifier of a business

Example:

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

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"

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"

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

Response

Updated monitoring alert.

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Update a monitoring alert

Authorizations

Path Parameters

Body

Response