curl -X POST 'https://verification.didit.me/v3/businesses/aml-monitoring/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"is_enabled": true, "vendor_data_list": ["company-123", "company-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.set_aml_monitoring(
is_enabled=True,
estimate_only=True,
vendor_data_list=["company-123", "company-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.setAmlMonitoring({
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.SetAMLMonitoring(ctx, didit.BusinessesSetAMLMonitoringParams{
IsEnabled: true,
EstimateOnly: didit.Bool(true),
VendorDataList: didit.Some([]string{"company-123", "company-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BusinessesSetAmlMonitoringParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().setAmlMonitoring(BusinessesSetAmlMonitoringParams.builder()
.isEnabled(true)
.estimateOnly(true)
.vendorDataList(List.of("company-123", "company-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->setAmlMonitoring([
'is_enabled' => true,
'estimate_only' => true,
'vendor_data_list' => ['company-123', 'company-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.set_aml_monitoring(
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-456"]
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Businesses.SetAmlMonitoringAsync(new BusinessesSetAmlMonitoringParams
{
IsEnabled = true,
EstimateOnly = true,
VendorDataList = new string[] { "company-123", "company-456" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true,
"unmatched": [
"<string>"
]
}{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"is_enabled": true,
"target_type": "user",
"total": 123,
"processed": 123,
"outcomes": {
"enabled": 123,
"screened_and_enabled": 123,
"already_enabled": 123,
"disabled": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"skipped_sandbox": 123,
"failed_provider": 123,
"failed_insufficient_balance": 123
},
"results": [
{
"didit_internal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_data": "<string>",
"outcome": "enabled"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
},
"unmatched": [
"<string>"
]
}{
"error": "<string>",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
}
}AML-Überwachung für Unternehmen umschalten (Didit API)
Schalten Sie die laufende AML-Überwachung für viele Unternehmen per Aufruf ein oder aus – mit Kostenschätzung, abfragbarem Job und Ergebnis je Unternehmen.
curl -X POST 'https://verification.didit.me/v3/businesses/aml-monitoring/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"is_enabled": true, "vendor_data_list": ["company-123", "company-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.set_aml_monitoring(
is_enabled=True,
estimate_only=True,
vendor_data_list=["company-123", "company-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.setAmlMonitoring({
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.SetAMLMonitoring(ctx, didit.BusinessesSetAMLMonitoringParams{
IsEnabled: true,
EstimateOnly: didit.Bool(true),
VendorDataList: didit.Some([]string{"company-123", "company-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BusinessesSetAmlMonitoringParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().setAmlMonitoring(BusinessesSetAmlMonitoringParams.builder()
.isEnabled(true)
.estimateOnly(true)
.vendorDataList(List.of("company-123", "company-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->setAmlMonitoring([
'is_enabled' => true,
'estimate_only' => true,
'vendor_data_list' => ['company-123', 'company-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.set_aml_monitoring(
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-456"]
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Businesses.SetAmlMonitoringAsync(new BusinessesSetAmlMonitoringParams
{
IsEnabled = true,
EstimateOnly = true,
VendorDataList = new string[] { "company-123", "company-456" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true,
"unmatched": [
"<string>"
]
}{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"is_enabled": true,
"target_type": "user",
"total": 123,
"processed": 123,
"outcomes": {
"enabled": 123,
"screened_and_enabled": 123,
"already_enabled": 123,
"disabled": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"skipped_sandbox": 123,
"failed_provider": 123,
"failed_insufficient_balance": 123
},
"results": [
{
"didit_internal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_data": "<string>",
"outcome": "enabled"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
},
"unmatched": [
"<string>"
]
}{
"error": "<string>",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
}
}Überblick
Aktiviert oder deaktiviert die laufende AML-Überwachung für die ausgewählten Unternehmen, genau wie die Aktion Laufende AML-Überwachung in der Business Console. Die Console und dieser Endpoint führen denselben zugrunde liegenden Vorgang aus, daher sind die Regeln, die Abrechnung und die Ergebnisse identisch. Senden Sie zuerstestimate_only: true, um zu sehen, wie viele Unternehmen ausgewählt sind, wie viele ein neues AML-Screening benötigen, die einmalige Screening-Gebühr und die jährlichen Überwachungskosten. Ein Testlauf (Dry-Run) schreibt nichts. Die Schätzung verwendet dieselben Feldnamen wie der Users-Endpoint, daher ist users_total die Anzahl der ausgewählten Unternehmen.
So wird eine Auswahl verarbeitet
- Ein überwachtes Screening pro Unternehmen. Ein Unternehmen, das sich mehrfach verifiziert hat, wird nur einmal überwacht und einmal abgerechnet. Die Deaktivierung schaltet die Überwachung für alle Screenings dieses Unternehmens ab.
- Unternehmen ohne AML-Screening werden zuerst gescreent. Didit erstellt für sie eine neue AML-Verifizierung (sichtbar im Tab Verifizierungen des Unternehmens), die wie ein reguläres AML-Screening abgerechnet wird, und aktiviert darauf die Überwachung. Das Screening verwendet den rechtlichen Namen (oder den Anzeigenamen) und das Land des Unternehmens. Ein Unternehmen ganz ohne Namen wird als
skipped_no_identity_datagemeldet und nicht stillschweigend verworfen. - Sandbox-Anwendungen erstellen nie Screenings (
skipped_sandbox). - Das Guthaben wird vorab geprüft. Die Aktivierung wird mit
403abgelehnt, wenn Ihr Guthaben die Schätzung nicht deckt. Die Antwort enthält die Schätzung, damit Sie wissen, wie viel Sie aufladen müssen. - Jährliche Verlängerung. Ein neu überwachtes Unternehmen wird zum Preis für die jährliche Überwachung am nächsten Verlängerungsdatum abgerechnet, also zu dem Datum, das die Console in der Spalte Laufende Überwachung anzeigt. Die Deaktivierung stoppt die Verlängerung, erstattet aber keinen bereits abgerechneten Zeitraum.
Auswahl und Batch-Größe
Wählen Sie Unternehmen übervendor_data_list, didit_internal_id_list oder beide aus. Die beiden Listen werden mit ODER verknüpft. Eine Anfrage akzeptiert insgesamt höchstens 1000 Identifikatoren über beide Listen. Identifikatoren, die keinem Unternehmen in Ihrer Anwendung entsprechen, werden unverändert unter unmatched zurückgegeben und lassen die Anfrage nie fehlschlagen. Eine Auswahl ohne Treffer wird als leerer Job abgeschlossen (total: 0), wobei alle Identifikatoren aufgelistet werden, wie bei den Batch-Lösch-Endpoints.
Inline oder im Hintergrund
Auswahlen mit höchstens 20 Unternehmen werden inline verarbeitet, und der Aufruf gibt200 mit dem abgeschlossenen Job zurück. Größere Auswahlen geben 202 mit einem Job im Status PENDING zurück. Fragen Sie AML-Monitoring-Job abrufen ab, bis status COMPLETED oder FAILED ist. In beiden Fällen enthält der Job pro Unternehmen einen Eintrag in results mit dessen outcome.
outcome | Bedeutung |
|---|---|
enabled | Überwachung wurde für ein bestehendes AML-Screening aktiviert. |
screened_and_enabled | Ein neues AML-Screening wurde erstellt (abgerechnet) und die Überwachung darauf aktiviert. |
already_enabled | Die Überwachung war bereits aktiv. Nichts wurde geändert und nichts abgerechnet. |
disabled | Die Überwachung wurde für alle Screenings des Unternehmens deaktiviert. |
skipped_no_identity_data | Das Unternehmen hat keinen rechtlichen Namen oder Anzeigenamen, der gescreent werden könnte. |
skipped_sandbox | Sandbox-Anwendung. Es wird kein Screening erstellt. |
failed_provider | Das Screening konnte nicht abgeschlossen werden. Versuchen Sie es später erneut. |
failed_insufficient_balance | Das Guthaben ist während der Ausführung des Jobs aufgebraucht. |
Webhooks
Das Umschalten der Überwachung sendet keinen eigenen Webhook. Sobald die Überwachung aktiv ist, lösen erneute Screenings weiterhin die üblichen Ereignissestatus.updated und data.updated aus, die unter Laufende AML-Überwachung beschrieben sind.
Berechtigungen
Jeder aktive API-Schlüssel der Anwendung kann diesen Endpoint aufrufen. Didit-API-Schlüssel sind anwendungsbezogen, nicht rollenbezogen. Die Rollen und Berechtigungen der Console legen fest, was eine Person in der Console tun darf, und werden für Datenverkehr der Management API nicht ausgewertet.Verwandte Themen
- AML-Monitoring-Job abrufen
- AML-Überwachung für Benutzer umschalten
- Laufende AML-Überwachung
- AML-Screening für Unternehmen
- Unternehmen auflisten
Autorisierungen
Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.
Body
Wählen Sie Unternehmen mit vendor_data_list, didit_internal_id_list oder beiden aus (die beiden Listen werden ODER-verknüpft). Maximal 1000 IDs pro Anfrage über beide Listen hinweg.
true, um die Überwachung zu aktivieren, false, um sie zu deaktivieren.
Wenn true, wird die Kostenschätzung zurückgegeben und es werden keine Schreibvorgänge ausgeführt – kein Screening, keine Abrechnung, kein Job.
Ihre eigenen Kennungen der umzuschaltenden Unternehmen, exakt so abgeglichen wie übermittelt.
Interne Didit-IDs der umzuschaltenden Unternehmen – die von den Create-, Get- und List-Endpoints zurückgegebene didit_internal_id.
Antwort
Die Schätzung (wenn estimate_only true ist) oder der abgeschlossene Job für eine inline verarbeitete Auswahl.
- Option 1
- Option 2
Kostenvorschau. Wird direkt zurückgegeben, wenn estimate_only wahr ist (es wird nichts geschrieben).
Profile, die der Auswahl entsprechen.
Profile, die bereits überwacht werden (beim Aktivieren ist nichts zu tun; diese werden beim Deaktivieren abgeschaltet).
Profile, deren bestehendes AML-Screening auf überwacht umgestellt wird (kein neues Screening).
Profile ohne bisheriges AML-Screening, die zuerst gescreent werden (abgerechnet als reguläres AML-Screening).
Profile, die nicht gescreent werden können, da Identitätsdaten fehlen.
Gesperrte Benutzer, die übersprungen werden (bei Unternehmen immer 0).
Einmalige Kosten für die neuen Screenings.
0.2
Jährliche Überwachungskosten für die Profile, die künftig überwacht werden.
0.07
Gibt an, ob das Guthaben der Organisation das Screening plus das erste Jahr der Überwachung abdeckt.
Kennungen der Anfrage, die mit keinem Profil in dieser Anwendung übereinstimmten, exakt wie gesendet.