Enable or disable monitoring by entity and integration

curl --request PATCH \
  --url http://api.gu1.ai/entities/toggle-status-monitoring \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "<string>",
  "integrationCode": "<string>",
  "active": true,
  "riskMatrixId": {}
}
'

import requests

url = "http://api.gu1.ai/entities/toggle-status-monitoring"

payload = {
    "entityId": "<string>",
    "integrationCode": "<string>",
    "active": True,
    "riskMatrixId": {}
}
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({
    entityId: '<string>',
    integrationCode: '<string>',
    active: true,
    riskMatrixId: {}
  })
};

fetch('http://api.gu1.ai/entities/toggle-status-monitoring', 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 => "http://api.gu1.ai/entities/toggle-status-monitoring",
  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([
    'entityId' => '<string>',
    'integrationCode' => '<string>',
    'active' => true,
    'riskMatrixId' => [
        
    ]
  ]),
  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 := "http://api.gu1.ai/entities/toggle-status-monitoring"

	payload := strings.NewReader("{\n  \"entityId\": \"<string>\",\n  \"integrationCode\": \"<string>\",\n  \"active\": true,\n  \"riskMatrixId\": {}\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("http://api.gu1.ai/entities/toggle-status-monitoring")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityId\": \"<string>\",\n  \"integrationCode\": \"<string>\",\n  \"active\": true,\n  \"riskMatrixId\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.gu1.ai/entities/toggle-status-monitoring")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entityId\": \"<string>\",\n  \"integrationCode\": \"<string>\",\n  \"active\": true,\n  \"riskMatrixId\": {}\n}"

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

PATCH

entities

toggle-status-monitoring

Enable or disable monitoring by entity and integration

curl --request PATCH \
  --url http://api.gu1.ai/entities/toggle-status-monitoring \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "<string>",
  "integrationCode": "<string>",
  "active": true,
  "riskMatrixId": {}
}
'

import requests

url = "http://api.gu1.ai/entities/toggle-status-monitoring"

payload = {
    "entityId": "<string>",
    "integrationCode": "<string>",
    "active": True,
    "riskMatrixId": {}
}
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({
    entityId: '<string>',
    integrationCode: '<string>',
    active: true,
    riskMatrixId: {}
  })
};

fetch('http://api.gu1.ai/entities/toggle-status-monitoring', 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 => "http://api.gu1.ai/entities/toggle-status-monitoring",
  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([
    'entityId' => '<string>',
    'integrationCode' => '<string>',
    'active' => true,
    'riskMatrixId' => [
        
    ]
  ]),
  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 := "http://api.gu1.ai/entities/toggle-status-monitoring"

	payload := strings.NewReader("{\n  \"entityId\": \"<string>\",\n  \"integrationCode\": \"<string>\",\n  \"active\": true,\n  \"riskMatrixId\": {}\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("http://api.gu1.ai/entities/toggle-status-monitoring")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityId\": \"<string>\",\n  \"integrationCode\": \"<string>\",\n  \"active\": true,\n  \"riskMatrixId\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.gu1.ai/entities/toggle-status-monitoring")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entityId\": \"<string>\",\n  \"integrationCode\": \"<string>\",\n  \"active\": true,\n  \"riskMatrixId\": {}\n}"

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

PATCH http://api.gu1.ai/entities/toggle-status-monitoring

Generic endpoint to set whether an entity participates in continuous monitoring for a given integrationCode (server behavior depends on the code; today: Gu1 global sanctions).

Authentication

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Requires edit permission on the entity referenced by entityId.

JSON body

string

required

Entity UUID (must belong to your organization).

string

required

Integration / enrichment code. Supported today: global_gueno_sanctions_enrichment.
Other values return 400 UNSUPPORTED_MONITORING_INTEGRATION.

boolean

true — include in continuous monitoring when org and upstream allow (re-enable).
false — exclude (same as legacy monitoringOptOut: true). At least one of active or riskMatrixId must be sent.

string | null

Optional. Gu1 global sanctions only. UUID of a risk matrix in your org, or null to clear the per-subscription override (daily screening then uses the entity risk matrix again, same as before). When a UUID is set, only that matrix is used for rules triggered by monitoring (e.g. trigger_monitoring_completed after daily screening); the entity’s assigned matrix is not merged in for that run. Does not update entities.riskMatrixId.

Error Responses

HTTP	Code (example)	When
404	`ENTITY_NOT_FOUND`	Entity not in org.
400	`UNSUPPORTED_MONITORING_INTEGRATION`	No handler for `integrationCode`, or `riskMatrixId` on an unsupported code.
400	`INVALID_RISK_MATRIX`	Matrix missing, archived, or not in org.

Example — turn off Gu1 monitoring

curl -sS -X PATCH "http://api.gu1.ai/entities/toggle-status-monitoring" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "integrationCode": "global_gueno_sanctions_enrichment",
    "active": false
  }'

Deprecated route

PATCH /entities/{id}/gueno-sanctions-monitoring-opt-out with { "monitoringOptOut" } is deprecated; use this endpoint with active: !monitoringOptOut.

Getting Started

SDK

Use Cases

Webhooks

Workflows

Monitoring (entities)

Person

Messaging

Company

Transactions

Devices

Events

Know Your Customer (KYC)

Payment Methods

Rules

Custom lists

Risk Matrix

Alerts

Investigations

Data Ingestion

Bulk imports

Documents

Enrichment

AML Crypto

Services

Integrations

Interactive Tutorials

Enable or disable monitoring by entity and integration

Authentication

JSON body

Error Responses

Example — turn off Gu1 monitoring

Deprecated route

​Authentication

​JSON body

​Error Responses

​Example — turn off Gu1 monitoring

​Deprecated route

Authentication

JSON body

Error Responses

Example — turn off Gu1 monitoring

Deprecated route