Zum Hauptinhalt springen
POST
curl

Autorisierungen

x-api-key
string
header
erforderlich

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.

Header

Idempotency-Key
string

Optionaler Schlüssel zur Absicherung von Wiederholungsversuchen, bis zu 255 Zeichen. Die erneute Verwendung desselben Schlüssels mit demselben Request-Body gibt die ursprüngliche Antwort zurück, ohne ein zweites Screening durchzuführen oder abzurechnen. Die erneute Verwendung des Schlüssels mit einem anderen Body gibt 409 zurück.

Maximum string length: 255

Body

application/json
full_name
string
erforderlich

Vollständiger Name der zu überprüfenden Person oder des zu überprüfenden Unternehmens. Mindestens 2 Zeichen – die Mindestanforderung des Screening-Anbieters. Ein kürzerer oder leerer Name führt bei diesem Feld zu einem 400-Fehler, bevor ein Screening durchgeführt wird, sodass keine Kosten anfallen.

Minimum string length: 2
Beispiel:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
Standard:person

Art der zu screenenden Entität. Standardwert ist person.

Verfügbare Optionen:
person,
company
date_of_birth
string<date>

Geburtsdatum (Personen) oder Gründungsdatum (Unternehmen), YYYY-MM-DD. Verbessert die Übereinstimmungsgenauigkeit über die Gewichtung des Geburtsdatums.

Beispiel:

"1972-02-29"

nationality
string

ISO 3166-1-Alpha-2-Ländercode (z. B. ES). Ungültige Codes geben 400 zurück. Verbessert die Genauigkeit der Übereinstimmung über die Ländergewichtung.

Beispiel:

"ES"

document_number
string

Ausweisnummer. Nicht gewichtet – fungiert als eindeutiger Schlüssel: Eine exakte Übereinstimmung überschreibt den match_score des Treffers auf 100, eine harte Nichtübereinstimmung straft ihn ab. Wird nur dann als Suchfilter an den Screening-Anbieter gesendet, wenn sie 2-50 Zeichen lang ist; ein Wert außerhalb dieses Bereichs wird akzeptiert und gespeichert, und das Screening wird weiterhin ausgeführt und abgerechnet, jedoch nicht nach Ausweisnummer eingegrenzt.

aml_score_approve_threshold
number
Standard:80

Risiko-Score-Schwellenwert, bei oder unter dem das Ergebnis Approved ist. Muss ≤ aml_score_review_threshold sein (andernfalls 400).

Erforderlicher Bereich: 0 <= x <= 100
aml_score_review_threshold
number
Standard:100

Risiko-Score-Schwellenwert, über dem das Ergebnis Declined ist. Scores zwischen den beiden Schwellenwerten führen zu In Review.

Erforderlicher Bereich: 0 <= x <= 100
aml_name_weight
integer
Standard:60

Gewichtung der Namensähnlichkeit im Übereinstimmungswert pro Treffer. Die drei Gewichtungen müssen in der Summe genau 100 ergeben (andernfalls 400).

Erforderlicher Bereich: 0 <= x <= 100
aml_dob_weight
integer
Standard:25

Gewichtung des Geburtsdatums im Übereinstimmungswert pro Treffer.

Erforderlicher Bereich: 0 <= x <= 100
aml_country_weight
integer
Standard:15

Gewichtung von Land/Staatsangehörigkeit im Übereinstimmungswert pro Treffer.

Erforderlicher Bereich: 0 <= x <= 100
aml_match_score_threshold
integer
Standard:93

Schwellenwert pro Treffer: Treffer mit einem match_score darunter gelten als False Positive (von der Risikobewertung ausgeschlossen); bei oder darüber gelten sie als mögliche Unreviewed-Treffer.

Erforderlicher Bereich: 0 <= x <= 100
include_adverse_media
boolean
Standard:false

Auch Nachrichtenmedien nach negativen Berichten durchsuchen. Erhöht die Latenz um bis zu ~30 s, während Ergebnisse gesammelt werden – verwenden Sie ein Client-Timeout von ≥60 s.

include_ongoing_monitoring
boolean
Standard:false

Dieses Profil kontinuierlich erneut screenen und Änderungen per Webhook übertragen. Erfordert save_api_request=true (andernfalls 400).

save_api_request
boolean
Standard:true

Das Screening als Sitzung beibehalten (Sichtbarkeit in der Konsole, Entscheidungs-Endpoint, Webhooks, Trefferprüfung). Für eine zustandslose Prüfung auf false setzen.

vendor_data
string

Ihre Kennung für den geprüften Benutzer; wird zurückgegeben und mit der Sitzung gespeichert.

metadata
object | null

Freiform-JSON, das mit der Anfrage gespeichert und zurückgegeben wird.

sandbox_scenario
string

Nur für die Sandbox gültiger Szenario-Slug. Wird nur akzeptiert, wenn der API-Schlüssel zu einer Anwendung im Sandbox-Modus gehört; bei Live-Anwendungen abgelehnt. Ein eigenständiges Screening verfügt über keine Sitzung, die vorbereitet werden könnte, daher wird der Slug direkt in der Screening-Anfrage angegeben: decline_aml_hit gibt einen Treffer in Produktionsform zurück und schließt das Screening mit Declined ab, review_aml_possible_match schließt es mit In Review ab, und ein Szenario, das kein AML-Ergebnis vorbereitet, lässt das Screening ohne Treffer. Den Szenarienkatalog finden Sie unter GET /v1/sandbox/scenarios/ oder Sandbox & Test Data.

Beispiel:

"decline_aml_hit"

Antwort

Screening abgeschlossen. aml.status spiegelt Ihre Schwellenwerte wider; jeder Treffer, der den internen Mindestwert erreicht oder überschreitet, wird in aml.hits mit seinem Identitäts-match_score, Entitäts-risk_score und einer score_breakdown zur Erklärung der Übereinstimmung aufgeführt.

request_id
string<uuid>

Beibehaltene Sitzungs-ID, wenn save_api_request=true (verwendbar mit GET /v3/session/{sessionId}/decision/); andernfalls eine vorübergehende Korrelations-UUID.

aml
object
vendor_data
string | null

Wiedergabe der von Ihnen gesendeten vendor_data.

metadata
object | null

Rückgabe der von Ihnen gesendeten metadata.

created_at
string<date-time>
Zuletzt geändert am 7. November 2026