Zum Hauptinhalt springen
POST
curl
Füge einen Eintrag zu einer Liste hinzu. Der Wert wird anhand des Eintragstyps der Liste validiert:
  • email: eine gültige E-Mail-Adresse
  • phone: eine gültige internationale Telefonnummer, gespeichert im Format E.164 (zum Beispiel +14155552671)
  • ip_address: eine gültige IP-Adresse oder ein CIDR-Bereich (z. B. 192.168.1.1 oder 10.0.0.0/8)
  • device_fingerprint: mindestens 8 Zeichen aus Buchstaben, Ziffern, -, _, : und .. Eine Sperrliste lehnt einen Fingerprint ab, den mehrere unterschiedliche Geräte gemeldet haben, weil die Sperre unbeteiligte Personen abweisen würde.
  • country: ein gültiger ISO 3166-1 Alpha-3-Ländercode (z. B. USA, GBR, ESP). Alpha-2-Codes (z. B. US) werden akzeptiert und automatisch in Alpha-3 umgewandelt.
  • user, business: der vendor_data des Benutzers bzw. des Unternehmens
  • face, document, wallet_address, bank_account, key: eine beliebige nicht leere Zeichenkette
Alle Eintragswerte werden ohne Berücksichtigung der Groß- und Kleinschreibung behandelt. Gesendete Werte werden beim Speichern normalisiert (Telefonnummern ins Format E.164, Ländercodes in Großbuchstaben, alles andere in Kleinbuchstaben) und bei der Verifizierung ohne Berücksichtigung der Groß- und Kleinschreibung abgeglichen. Wenn Sie zum Beispiel User@Example.COM sperren, wird auch user@example.com erkannt. Eine Liste enthält jeden Wert nur einmal: Wenn Sie einen Wert hinzufügen, der bereits in der Liste enthalten ist, wird 400 zurückgegeben.
Für ein Gesicht verwenden Sie Gesicht hochladen, wenn Sie nur ein Bild haben, oder senden Sie eine reference_session_id, um das Gesicht einer bestehenden Sitzung zu übernehmen. Ein Gesichtseintrag benötigt ein gespeichertes Gesicht zum Abgleich, das ein eingegebener value nicht liefert.

Hinzufügen aus einer Sitzung

Wenn Sie eine reference_session_id angeben, führt Didit folgende Schritte aus:
  1. Didit sucht die Sitzung (sie muss zur selben Anwendung gehören).
  2. Didit liest den Wert aus dem neuesten Datensatz der Sitzung mit dem Eintragstyp der Liste:
    • face: das Gesicht des Liveness-Selfies; value ist die Gesichts-UUID
    • document: die Dokumentnummer; der vollständige Name, der Ausstellungsstaat, der Dokumenttyp, die Region und die Dokumentnummer werden in metadata gespeichert, und display_label ist standardmäßig der Name des Inhabers und die Dokumentnummer
    • phone: die Telefonnummer
    • email: die E-Mail-Adresse
    • ip_address: die IP-Adresse der Sitzung
    • device_fingerprint: ein Fingerprint, der ein einzelnes Gerät identifiziert; bevorzugt wird ein Gerät, das einen Verifizierungsschritt abgeschlossen hat. Bei einer Sperrliste lehnt Didit eine Sitzung ab, die nur einen Fingerprint der Geräteklasse enthält oder die auf mehr als einem Gerät abgeschlossen wurde. Senden Sie in diesem Fall den exakten Fingerprint als value.
  3. Didit verknüpft den Eintrag zur Nachverfolgbarkeit mit der Sitzung (reference_session_id) und mit dem Datensatz (reference_object_uuid).
Bei den systemseitigen Sperrlisten für Gesichter, Dokumente, Telefonnummern und E-Mail-Adressen wird der Datensatz außerdem als gesperrt markiert, sodass neue Sitzungen, die ihm entsprechen, abgelehnt werden. Für alle anderen Eintragstypen senden Sie zusätzlich value. Didit gibt 400 zurück, wenn die Sitzung nicht gefunden wird oder keine Daten für den angeforderten Eintragstyp enthält.

Gesichter aus dem Selfie der Dokumentenaufnahme

Während der Benutzer sein Dokument fotografiert, kann die Frontkamera ein Selfie von ihm aufnehmen (die Bilder front_image_camera_front und back_image_camera_front des Berichts zur Ausweisverifizierung). Dieses Gesicht kann zusätzlich zur Liveness-Gesichtsaufnahme in die Gesichtssperrliste aufgenommen werden. Übergeben Sie dazu face_image_source mit dem gewünschten Bild.
  • Der Eintrag wird nur in der systemseitigen Gesichtssperrliste erstellt, und value muss leer bleiben: Didit übernimmt das Gesicht aus dem Selfie der Sitzung.
  • Das Selfie muss genau ein klar erkennbares Gesicht enthalten. Ist dies nicht der Fall, gibt die Anfrage 400 zurück und es wird nichts hinzugefügt.
  • Jedes Selfie kann nur einmal hinzugefügt werden. metadata.face_image_source und metadata.reference_node_id des Eintrags geben an, von welchem Selfie er stammt.
  • In einem Workflow mit mehreren ID-Verifizierungsschritten wählt reference_node_id den Schritt, dessen Selfie verwendet wird. Standardmäßig verwendet Didit die neueste ID-Verifizierung, die dieses Selfie enthält.
  • Anschließend wird das Gesicht wie jedes andere gesperrte Gesicht geprüft: gegen das Liveness-Selfie jeder neuen Sitzung und gegen jedes neue Selfie der Dokumentenaufnahme (siehe FRONT_CAMERA_FACE_IN_BLOCKLIST).
  • Wenn Sie den Eintrag löschen, wird das Gesicht aus der Sperrliste entfernt und nicht mehr mit neuen Sitzungen abgeglichen.

Sitzungen mit mehreren Datensätzen desselben Typs

Eine Sitzung kann mehrere Datensätze eines Typs enthalten, zum Beispiel zwei Telefonnummern aus einem mehrstufigen Workflow. Didit liest immer den neuesten Datensatz. Wenn Sie value zusammen mit reference_session_id senden, speichert der Eintrag Ihren value, bleibt aber mit dem neuesten Datensatz verknüpft. Auf einer systemseitigen Sperrliste wird dieser Datensatz markiert. Um einen Wert aus einem früheren Datensatz zu sperren, fügen Sie ihn nur über value hinzu, ohne reference_session_id:

Referenzierung von Transaktionen, Benutzern und Unternehmen

Wenn Sie Daten aus einer Transaktion oder einem Benutzer bzw. Unternehmen des Anbieters sperren, übergeben Sie die UUID der Entität als reference_object_uuid und geben den Quelltyp in metadata an:
So können Sie in der Konsole vom Sperrlisteneintrag zur ursprünglichen Transaktion, zum ursprünglichen Benutzer oder zum ursprünglichen Unternehmen zurückspringen. Didit speichert Ihre metadata-Schlüssel mit Ausnahme von reference_image_url und front_image_url, die nur Didit setzt. Bei einem Eintrag, der aus einer Sitzung gelesen wird, ergänzt Didit eigene Schlüssel zu Ihren, und die Schlüssel von Didit haben Vorrang. Auf den systemseitigen Sperrlisten für Benutzer und Unternehmen setzt Didit außerdem die passenden Benutzer bzw. Unternehmen auf BLOCKED: diejenigen, deren vendor_data gleich value ist, bzw. deren didit_internal_id gleich reference_object_uuid ist. Siehe Benutzersperrliste und Unternehmenssperrliste.

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.

Pfadparameter

list_uuid
string<uuid>
erforderlich

UUID der Liste, zu der hinzugefügt werden soll. Für ein Gesicht, das Sie nur als Bild vorliegen haben, verwenden Sie stattdessen Gesicht in eine Liste hochladen.

Body

application/json

Senden Sie value, reference_session_id oder beides. Welche Felder gelten, hängt vom entry_type der Liste ab.

value
string

Der aufzulistende Wert, validiert anhand des entry_type der Liste: email eine gültige E-Mail-Adresse; phone eine gültige internationale Nummer, gespeichert in E.164; ip_address eine Adresse oder ein CIDR-Bereich (zum Beispiel 10.0.0.0/8); device_fingerprint mindestens 8 Zeichen aus Buchstaben, Ziffern, -, _, : und . (eine Sperrliste lehnt einen Fingerprint ab, den mehrere verschiedene Geräte gemeldet haben); country ein ISO 3166-1 Alpha-2- oder Alpha-3-Code, gespeichert als Alpha-3; user und business die vendor_data; jeder andere Typ eine nicht-leere Zeichenkette. Gespeichert in Kleinbuchstaben mit Ausnahme von Telefonnummern und Ländercodes; eine Liste enthält jeden Wert nur einmal (ohne Berücksichtigung der Groß-/Kleinschreibung). Erforderlich, sofern nicht reference_session_id übermittelt wird; muss bei face_image_source mit Dokumentenerfassung leer gelassen werden.

reference_session_id
string<uuid>

Eine Benutzer- oder Unternehmensverifizierungssitzung Ihrer Anwendung, aus der der Wert übernommen werden soll. Didit liest den neuesten Datensatz der Sitzung für den Eintragstyp der Liste (face, document, phone, email, ip_address oder device_fingerprint), verknüpft den Eintrag mit der Sitzung sowie diesem Datensatz und füllt display_label und metadata für Dokumente aus. Bei einer device_fingerprint-Sperrliste wird eine Sitzung abgelehnt, die nur über einen Fingerabdruck der Geräteklasse verfügt oder auf mehr als einem Gerät abgeschlossen wurde: Senden Sie den exakten Fingerabdruck als value. Bei anderen Eintragstypen oder wenn die Sitzung keinen solchen Datensatz aufweist, senden Sie ebenfalls value; Ihr value wird dann gespeichert und der Eintrag bleibt weiterhin mit der Sitzung verknüpft.

reference_object_uuid
string<uuid>

UUID des Datensatzes, für den der Eintrag steht, wenn er nicht aus einer Sitzung stammt: eine Transaktions-UUID oder die didit_internal_id eines Benutzers oder Unternehmens. Kombinieren Sie dies mit metadata.reference_type. Wird durch den Datensatz der Sitzung ersetzt, wenn reference_session_id einen bereitstellt.

face_image_source
enum<string>
Standard:liveness

Gesichtslisten mit reference_session_id: Aus welchem der Bilder der Sitzung das Gesicht entnommen wird. liveness (Standard) ist das Liveness-Selfie. front_image_camera_front und back_image_camera_front sind die Selfies, die die Frontkamera aufgenommen hat, während der Benutzer die Vorder- oder Rückseite seines Dokuments fotografiert hat: werden nur für die systemweite Gesichtssperrliste akzeptiert, mit reference_session_id und einem leeren value. Jedes Selfie kann einmal hinzugefügt werden und muss ein einzelnes, deutliches Gesicht zeigen.

Verfügbare Optionen:
liveness,
front_image_camera_front,
back_image_camera_front
reference_node_id
string | null

Bei einer Dokumentenerfassung mit face_image_source: Der Knoten der Ausweisverifizierung, dessen Selfie verwendet werden soll, bei Workflows mit mehr als einem Knoten. Standardmäßig die jüngste Ausweisverifizierung, die dieses Bild enthält. Wird bei liveness abgelehnt.

Maximum string length: 100
display_label
string

Lesbare Bezeichnung. Wenn leer, leitet Didit nach Möglichkeit eine aus der Sitzung ab (beispielsweise Name und Dokumentennummer des Inhabers).

Maximum string length: 512
comment
string

Freitext-Notiz, beispielsweise der Grund für die Listung.

metadata
object

Freiform-JSON, das mit dem Eintrag gespeichert und unverändert zurückgegeben wird. Verwenden Sie reference_type und reference_id, damit die Konsole zurück zur Quelle verlinkt. reference_image_url und front_image_url werden ausschließlich von Didit festgelegt und verworfen, falls Sie sie senden. Bei einem aus einer Sitzung gelesenen Eintrag werden die Schlüssel von Didit mit Ihren zusammengeführt.

Antwort

Der Eintrag wurde erstellt.

Ein Wert in einer Liste.

uuid
string<uuid>
erforderlich

Eintrags-ID. Verwenden Sie sie als entry_uuid in „Listeneintrag löschen“.

value
string
erforderlich

Der gelistete Wert: eine Telefonnummer in E.164, eine E-Mail-Adresse, eine Dokumentennummer, eine IP-Adresse oder ein CIDR-Bereich, ein Geräte-Fingerprint, eine Wallet-Adresse, ein Bankkonto, ein Ländercode nach ISO 3166-1 Alpha-3, ein vendor_data, eine beliebige Zeichenfolge auf einer key-Liste oder die UUID des gespeicherten Gesichts auf einer Gesichtsliste. Von Ihnen gesendete Werte werden in Kleinbuchstaben gespeichert, mit Ausnahme von Telefonnummern und Ländercodes. Der Abgleich erfolgt ohne Berücksichtigung der Groß-/Kleinschreibung.

display_label
string | null
erforderlich

Lesbare Bezeichnung. Didit füllt sie für aus einer Sitzung übernommene Einträge aus (beispielsweise Name und Dokumentennummer des Inhabers), wenn Sie keine übermitteln.

Maximum string length: 512
comment
string
erforderlich

Freitext-Notiz. Leere Zeichenkette, wenn nicht festgelegt.

added_by
string | null
erforderlich

Wer den Eintrag hinzugefügt hat: api (ein API-Schlüssel), die E-Mail-Adresse eines Benutzers der Konsole oder console, system oder migration (von Didit erstellte Einträge) oder rule (eine Transaktions- oder Überwachungsregel-Aktion).

reference_session_id
string<uuid> | null
erforderlich

Verifizierungssitzung, aus der der Eintrag übernommen wurde. null, wenn der Eintrag als Wert hinzugefügt wurde.

reference_session_number
integer | null
erforderlich

Nummer dieser Sitzung innerhalb der Anwendung, wie in der Console angezeigt.

reference_session_type
enum<string> | null
erforderlich

kyc für eine Sitzung zur Personenverifizierung, kyb für eine Sitzung zur Unternehmensverifizierung, null, wenn keine Sitzung vorhanden ist.

Verfügbare Optionen:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
erforderlich

Der Datensatz, für den der Eintrag steht: der aus einer Sitzung gelesene Gesichts-, Dokumenten-, Telefon- oder E-Mail-Datensatz, das über Ein Gesicht zu einer Liste hochladen erstellte Gesicht oder die von Ihnen gesendete UUID (z. B. eine Transaktions-UUID oder die didit_internal_id eines Benutzers).

metadata
object | null
erforderlich

Zusätzlicher Kontext. Enthält die von Didit festgelegten Schlüssel (hier aufgeführt), zusammengeführt mit allen metadata, die Sie beim Erstellen des Eintrags gesendet haben, zurückgegeben wie gespeichert. null, wenn keine vorhanden sind.

created_at
string<date-time>
erforderlich

Wann der Eintrag hinzugefügt wurde.

Zuletzt geändert am 7. November 2026