curl -X PATCH \
https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-hit-status/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"hit_id": "abc123",
"review_status": "False Positive"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id="hit_7c1e9a40b2d35f86e0a4c912",
review_status="False Positive",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.updateAmlHitStatus("11111111-2222-3333-4444-555555555555", {
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.UpdateAMLHitStatus(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsUpdateAMLHitStatusParams{
HitID: "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus: "False Positive",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SessionsUpdateAmlHitStatusParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().updateAmlHitStatus("11111111-2222-3333-4444-555555555555", SessionsUpdateAmlHitStatusParams.builder()
.hitId("hit_7c1e9a40b2d35f86e0a4c912")
.reviewStatus(SessionsUpdateAmlHitStatusParams.ReviewStatus.of("False Positive"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->updateAmlHitStatus('11111111-2222-3333-4444-555555555555', [
'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',
'review_status' => 'False Positive',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.UpdateAmlHitStatusAsync("11111111-2222-3333-4444-555555555555", new SessionsUpdateAmlHitStatusParams
{
HitId = "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus = "False Positive",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"message": "Hit status updated successfully",
"hit_id": "hit_7c1e9a40b2d35f86e0a4c912",
"review_status": "False Positive"
}AML-Treffer-Status per API aktualisieren | Didit
Mit der Didit API AML-Treffer als bestätigte Übereinstimmung, falsch positiv oder nicht eindeutig markieren – einzeln oder gesammelt.
curl -X PATCH \
https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-hit-status/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"hit_id": "abc123",
"review_status": "False Positive"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id="hit_7c1e9a40b2d35f86e0a4c912",
review_status="False Positive",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.updateAmlHitStatus("11111111-2222-3333-4444-555555555555", {
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.UpdateAMLHitStatus(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsUpdateAMLHitStatusParams{
HitID: "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus: "False Positive",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SessionsUpdateAmlHitStatusParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().updateAmlHitStatus("11111111-2222-3333-4444-555555555555", SessionsUpdateAmlHitStatusParams.builder()
.hitId("hit_7c1e9a40b2d35f86e0a4c912")
.reviewStatus(SessionsUpdateAmlHitStatusParams.ReviewStatus.of("False Positive"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->updateAmlHitStatus('11111111-2222-3333-4444-555555555555', [
'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',
'review_status' => 'False Positive',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.UpdateAmlHitStatusAsync("11111111-2222-3333-4444-555555555555", new SessionsUpdateAmlHitStatusParams
{
HitId = "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus = "False Positive",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"message": "Hit status updated successfully",
"hit_id": "hit_7c1e9a40b2d35f86e0a4c912",
"review_status": "False Positive"
}Was dieser Endpoint bewirkt
Das AML-Screening liefert eine Liste von Treffern, also möglichen Übereinstimmungen mit Sanktionslisten, PEP-Datenbanken, Beobachtungslisten und negativen Medienberichten. Jeder Treffer hat einreview_status (seine Bewertung), das je nach Übereinstimmungswert als Unreviewed oder False Positive beginnt. Über diesen Endpoint kann Ihr Team (oder Ihre Automatisierung) für jeden Treffer eine Entscheidung festhalten, ohne die Gesamtentscheidung der Sitzung zu ändern.
Die Treffer und ihre IDs finden Sie in der Sitzungsentscheidung, im Array hits der AML-Prüfung. Die id jedes Treffers ist die hit_id, die Sie hier übergeben.
Eine Treffer-id besteht aus hit_ gefolgt von 24 hexadezimalen Zeichen und bleibt bei einer erneuten Prüfung der Person bzw. Entität gleich. Eine Treffer-ID im früheren Format wird weiterhin akzeptiert. Die Antwort nennt den Treffer immer über seine aktuelle id.
Prüfstatus
review_status | Bedeutung |
|---|---|
Unreviewed | Standardwert für Treffer mit einem Übereinstimmungswert am oder über dem Schwellenwert, für die noch eine Entscheidung erforderlich ist. |
Confirmed Match | Eine echte Übereinstimmung mit der geprüften Person bzw. Entität. |
False Positive | Es handelt sich nicht um dieselbe Entität. Standardwert für Treffer unterhalb des Schwellenwerts. |
Inconclusive | Konnte nicht eindeutig bestimmt werden. |
False Positive markieren, behält diesen Status, wenn der Anbieter die Entität erneut prüft.Einen einzelnen Treffer aktualisieren
PATCH /v3/session/{sessionId}/update-aml-hit-status/
curl -X PATCH https://verification.didit.me/v3/session/4c5c7f3a-.../update-aml-hit-status/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"hit_id": "hit_7c1e9a40b2d35f86e0a4c912",
"review_status": "False Positive"
}'
?node_id=feature_aml_1 an die URL an oder fügen "node_id" in den Body ein, um eine bestimmte Prüfung anzusprechen.
Mehrere Treffer gleichzeitig aktualisieren
PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/
Übergeben Sie hit_updates, eine Liste von { hit_id, review_status }-Paaren. Der Vorgang folgt dem Alles-oder-nichts-Prinzip: Wenn eine hit_id nicht gefunden wird, gibt die Anfrage 404 zurück, und es wird kein Treffer geändert.
curl -X PATCH https://verification.didit.me/v3/session/4c5c7f3a-.../bulk-update-aml-hit-status/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"hit_updates": [
{ "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "Confirmed Match" },
{ "hit_id": "hit_3b8f20d6a91c4e75f0b2d6a8", "review_status": "False Positive" }
]
}'
data.updated-Webhook aus und erfasst einen einzigen Aktivitätseintrag, der alle Änderungen umfasst.
Was nach einer Aktualisierung passiert
- Webhook: Für die Sitzung wird ein Ereignis
data.updatedausgelöst. - Prüfpfad: Die Änderung wird im Prüfpfad der Sitzung zusammen mit dem Akteur (API-Schlüssel oder Benutzer) erfasst und ist in der Aktivitäts-Timeline der Konsole sichtbar.
- Der Gesamtstatus des AML-Schritts bleibt unverändert: Die Änderung der Bewertung eines Treffers ändert für sich genommen weder den Status des AML-Schritts noch die Entscheidung der Sitzung. Um den Status des AML-Schritts zu ändern (
Approved/Declined/In Review), verwenden Sie Feature-Status aktualisieren. Um die Entscheidung der Sitzung zu ändern, verwenden Sie Status aktualisieren.
Unterstützung für KYC und KYB
Der Endpoint funktioniert sowohl für Benutzerverifizierung (KYC) als auch für Unternehmensverifizierung (KYB). Didit löst diesessionId in beiden Fällen auf. Bei KYB läuft das AML-Screening für das Unternehmen und seine Schlüsselpersonen, und jede AML-Prüfung stellt ihre eigenen Treffer bereit.
Berechtigung
Erforderlich ist die Berechtigungwrite:sessions, und zwar entweder mit einem Client-API-Schlüssel (x-api-key) oder mit einem Autorisierungs-Header für Benutzer.
Fehler
| Status | Bedeutung |
|---|---|
400 | review_status ist kein gültiger Wert, hit_id ist leer oder hit_updates ist leer. |
403 | Anmeldedaten fehlen oder sind ungültig, oder dem Aufrufer fehlt write:sessions. |
404 | Sitzung nicht gefunden, die Sitzung hat keine AML-Prüfung, oder eine hit_id wurde nicht gefunden (bei Bulk-Aufrufen wird nichts geändert). |
Verwandte Seiten
- Feature-Status aktualisieren: den Status des AML-Schritts (oder eines anderen Schritts) ändern.
- Sitzungsstatus aktualisieren: die Gesamtentscheidung der Sitzung ändern.
- Sitzung abrufen: die AML-
hitsund ihre IDs lesen. - AML-Screening: wie Screening und Scoring funktionieren.
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.
Pfadparameter
UUID der Verifizierungssitzung. Akzeptiert sowohl Benutzer- (KYC) als auch Unternehmens- (KYB) Sitzungs-IDs — der Dienst löst die ID über beide Sitzungstypen hinweg auf.
"11111111-2222-3333-4444-555555555555"
Abfrageparameter
Workflow-Graph-Knoten-ID. Nur erforderlich, wenn die Sitzung mehrere AML-Prüfungen umfasst (eine pro Knoten); bei Sitzungen mit einer einzigen AML-Prüfung weglassen.
"feature_aml_1"
Body
Die id des Treffers im hits-Array der AML-Prüfung (hit_...). Eine Treffer-ID, die im früheren Format zurückgegeben wurde, wird weiterhin akzeptiert.
"hit_7c1e9a40b2d35f86e0a4c912"
Der neue Prüfstatus für den Treffer.
Unreviewed, Confirmed Match, False Positive, Inconclusive "False Positive"
Optionale Graph-Knoten-ID. Verwenden Sie diese (hier oder als Abfrageparameter), wenn die Sitzung mehrere AML-Prüfungen umfasst.
"feature_aml_1"
Antwort
Hit-Prüfstatus aktualisiert.
Immer Hit status updated successfully.
Die id des aktualisierten Treffers, wie von der Sitzungsentscheidung zurückgegeben, auch wenn die Anfrage den Treffer über eine ID im früheren Format benannt hat.
Der Prüfstatus, der jetzt für den Treffer gespeichert ist.
Unreviewed, Confirmed Match, False Positive, Inconclusive