Zum Hauptinhalt springen
POST
curl

Verhalten

Jede passende Sitzung wird genauso gelöscht wie bei Sitzung löschen: Die Sitzung, alle Verifizierungsversuche, die sie enthält, ihre Entscheidung und extrahierten Daten, ihre Funktionsdatensätze und alle gespeicherten Dateien werden gelöscht. Sie verschwindet aus jedem Lese-Endpoint, und zuvor ausgegebene Medien-URLs werden nicht mehr aufgelöst. Webhook-Zustellungen, die für eine gelöschte Sitzung noch ausstehen, und deren Wiederholungen werden verworfen. Bereits zugestellte Webhooks sind davon nicht betroffen. Die Löschung ist endgültig und nicht rückgängig zu machen. Wenn eine ausgewählte Sitzung Teil eines abgeschlossenen Regulierungsberichts ist, gibt die gesamte Anfrage 409 zurück, und es wird nichts gelöscht. Die Antwort verwendet code: in_filed_report und nennt jeden Bericht. Löschen Sie jeden Bericht mit Bericht löschen und wiederholen Sie danach die Anfrage. Das Löschen des Berichts löscht die Sitzung nicht. Die Sitzung bleibt bestehen, bis Sie diese Anfrage wiederholen. Die Anzahl der passenden Sitzungen bestimmt, wie die Anfrage beantwortet wird, unabhängig davon, ob Sie sie mit session_numbers oder mit delete_all auswählen: Ein Ergebnis bestätigt, dass die Sitzung gelöscht wurde, außer wenn ihr face_retention_outcome den Wert failed_retryable hat. Dann wurde die Sitzung nicht gelöscht und ist weiterhin vorhanden. Behandeln Sie dieses Ergebnis daher als fehlgeschlagen und führen Sie einen Wiederholungsversuch durch. Betrachten Sie es niemals als Bestätigung der Löschung. Nummern, die keiner aktiven KYC-Sitzung in Ihrer Anwendung entsprechen, werden übersprungen und erscheinen nicht in results.

delete_all mit Filtern einschränken

Mit delete_all: true können Sie die Auswahl mit den Filtern von Sitzungen auflisten einschränken. Jeder Filter erhält das Präfix filter_. Sie akzeptieren dieselben Werte wie die Abfrageparameter. Ein Filter, der mehrere Werte annimmt (status, workflow_id, country, region, document_type, document_name, session_type, warning, organization_name), akzeptiert eine durch Kommas getrennte Zeichenkette oder ein Array:
  • Filter wirken nur zusammen mit delete_all. Mit session_numbers werden sie geprüft, verändern die Auswahl aber nicht.
  • Jeder andere Filter nimmt genau einen Wert entgegen. Ein Array wird zu einem einzigen, durch Kommas getrennten Wert zusammengefügt. Mehrere Daten, UUIDs oder api_service-Werte führen daher zu 400. Mehrere Texte für vendor_data, search oder screened_full_name werden nicht als Alternativen abgeglichen.
  • Ein Filter mit leerem Wert wird ignoriert und schränkt die Auswahl daher nicht ein.
  • Ein unbekannter filter_*-Schlüssel gibt 400 mit {"filter_reviewer": "Unknown filter."} zurück. Ein Wert, der nicht verarbeitet werden kann, gibt 400 zurück, unter dem jeweiligen filter_*-Schlüssel, zum Beispiel {"filter_date_from": ["Enter a valid date."]}. In beiden Fällen wird nichts gelöscht. Ein falsch geschriebener Filter erweitert die Löschung daher nie auf alle Sitzungen.
  • Ein Löschauftrag wendet dieselben Filter an. Wie jede delete_all-Anfrage erfasst er nur Sitzungen, die vor der Anfrage erstellt wurden.

Aufbewahrungs- und Anweisungsfelder

Der Endpoint akzeptiert dieselben optionalen Felder wie der Endpoint für eine einzelne Sitzung und wendet sie auf jede passende Sitzung an: Was ein beibehaltenes Template enthält und was nicht, wie expires_at berechnet wird und was eine Anweisung zur Datenschutz-Löschung bewirkt, finden Sie unter Sitzung löschen.

Ergebnisse pro Sitzung

Bei bis zu 20 passenden Sitzungen gibt 200 OK ein Ergebnis pro Sitzung zurück:
Jedes Ergebnis enthält dieselben Felder wie die Antwort von Sitzung löschen. biometric_template_expires_at gibt an, wann eine beibehaltene Vorlage gelöscht wird. deleted_child_verifications ist hier immer 0, weil dieser Endpoint nur KYC-Sitzungen löscht. Sitzungen werden in Gruppen gelöscht. Kann eine Gruppe nicht gelöscht werden, wird jede Sitzung darin als failed_retryable gemeldet. Die übrigen Gruppen sind davon nicht betroffen und bleiben gelöscht.

Große Auswahlen werden als Auftrag ausgeführt

Wenn mehr als 20 Sitzungen übereinstimmen, lautet die Antwort 202 Accepted mit einem Löschauftrag anstelle von results:
Fragen Sie Löschauftrag einer Session abrufen alle paar Sekunden ab, bis status den Wert COMPLETED oder FAILED hat.
  • Der Auftrag meldet, wie viele Sitzungen auf die einzelnen Ergebnisse entfielen, aber niemals, welche Sitzungen er gelöscht hat.
  • Ein delete_all-Auftrag löscht nur Sitzungen, die vor Ihrer Anfrage erstellt wurden. Sitzungen, die während der Ausführung gestartet werden, bleiben erhalten.
  • Die Felder für Aufbewahrung und Anweisungen Ihrer Anfrage gelten für jede Sitzung, die der Auftrag löscht.
  • Kann eine Gruppe noch nicht gelöscht werden, wiederholt der Auftrag den Vorgang selbstständig.
  • Ein FAILED-Auftrag erklärt den Grund in error. Die Sitzungen, die er noch nicht erreicht hat, bestehen weiterhin: Wiederholen Sie die Anfrage, um sie zu löschen.

Beispiele

Migration von 204-Antworten

Bis zu dieser Version gab der Endpoint 204 No Content zurück. Jetzt gibt er 200 OK mit results[] zurück oder 202 Accepted mit einem Löschauftrag, wenn mehr als 20 Sitzungen übereinstimmen. Aktualisieren Sie Clients, die auf 204 prüfen. Das Standardverhalten beim Löschen bleibt unverändert: Bestehende Anwendungen bleiben bei delete_with_session, bis Sie die Richtlinie ausdrücklich ändern.

Verwandte Inhalte

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.

Body

application/json
session_numbers
string[]

Numerische session_number-Werte der zu löschenden KYC-Sitzungen als reine Ziffern-Strings (JSON-Zahlen werden ebenfalls akzeptiert und umgewandelt). Erforderlich, es sei denn, delete_all ist true; eine leere Liste gibt 400 zurück. Jeder nicht aus Ziffern bestehende Eintrag lehnt die gesamte Anfrage mit 400 ab (es sei denn, delete_all ist true, in welchem Fall die Validierung übersprungen und die Einträge ignoriert werden). Nummern, die keiner Live-Sitzung in Ihrer Anwendung entsprechen, werden stillschweigend übersprungen.

Minimum array length: 1
Pattern: ^[0-9]+$
Beispiel:
delete_all
boolean
Standard:false

Wenn true, wird jede verbleibende KYC-Sitzung in der aufrufenden Anwendung gelöscht und session_numbers wird ignoriert, es sei denn, Sie schränken die Auswahl mit filter_*-Schlüsseln ein. Mehr als 20 übereinstimmende Sitzungen werden als Löschauftrag (202) ausgeführt, der nur die vor der Anfrage erstellten Sitzungen umfasst. Standardmäßig false. Unumkehrbar; es gibt keinen Bestätigungsschritt.

Beispiel:

false

retain_face_embeddings
boolean | null

Überschreibt die face_retention_policy der Anwendung für diese Löschung. true behält ein bildfreies biometrisches Gesichts-Template, das dem Benutzer der Sitzung zugeordnet ist, bei, nachdem die Sitzung gelöscht wurde; false löscht das Gesichts-Embedding mit der Sitzung; weglassen oder null, um der Richtlinie der Anwendung zu folgen. Wird für KYB-Sitzungen und für Sitzungen ohne Gesichts-Embedding ignoriert.

Beispiel:

true

face_retention_days
integer

Endliche Aufbewahrungsdauer in Tagen für ein aufbewahrtes Template. Erforderlich, wenn ein Template aufbewahrt wird, es sei denn, die Anwendung legt bereits face_retention_days fest. Das expires_at des Templates wird durch den frühesten der folgenden Zeitpunkte bestimmt: diese Dauer, der allgemeine Datenaufbewahrungszeitraum der Anwendung und face_retention_deadline.

Erforderlicher Bereich: 1 <= x <= 3650
Beispiel:

365

face_retention_deadline
string<date-time>

Optionaler fester Ablaufzeitpunkt für ein aufbewahrtes Template. Muss in der Zukunft liegen.

Beispiel:

"2027-08-28T00:00:00Z"

deletion_instruction
enum<string>
Standard:operational_session_delete

Die Art der Anweisung, die Sie erteilen. operational_session_delete löscht die Sitzung und behält ein Template nur dann bei, wenn die Richtlinie oder retain_face_embeddings dies vorschreibt. privacy_erasure löscht jedes beibehaltene biometrische Template, das mit dem Benutzer der Sitzung verknüpft ist, bevor die Sitzung gelöscht wird, kann nicht durch die Anwendungsrichtlinie überschrieben werden und kann nicht mit retain_face_embeddings: true kombiniert werden (400).

Verfügbare Optionen:
operational_session_delete,
privacy_erasure
Beispiel:

"operational_session_delete"

instruction_id
string

Ihre dauerhafte Referenz für diese Löschanweisung (beispielsweise die ID eines Löschtickets). Wird im Audit-Log und auf jedem aufbewahrten Template erfasst. Wird von Didit generiert, wenn sie weggelassen wird.

Maximum string length: 255
Beispiel:

"dsar-2026-0142"

filter_status

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter status von List Sessions entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenkette oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_vendor_data
string

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter vendor_data von List Sessions entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen kommagetrennten Text zusammengefügt, sodass mehrere Werte nicht als Alternativen abgeglichen werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter search von List Sessions entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen kommagetrennten Text zusammengefügt, sodass mehrere Werte nicht als Alternativen abgeglichen werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_workflow_id

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter workflow_id von List Sessions entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenkette oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_date_from
string<date>

Grenzt ein delete_all auf die Sitzungen ein, die dem date_from-Filter von Sitzungen auflisten entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen, durch Kommas getrennten Wert zusammengefügt, sodass mehrere Werte mit 400 abgelehnt werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_date_to
string<date>

Grenzt ein delete_all auf die Sitzungen ein, die dem date_to-Filter von Sitzungen auflisten entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen, durch Kommas getrennten Wert zusammengefügt, sodass mehrere Werte mit 400 abgelehnt werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_country

Grenzt ein delete_all auf die Sitzungen ein, die dem country-Filter von Sitzungen auflisten entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenfolge oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_document_type

Grenzt ein delete_all auf die Sitzungen ein, die dem document_type-Filter von Sitzungen auflisten entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenfolge oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_document_name

Grenzt ein delete_all auf die Sitzungen ein, die dem document_name-Filter von Sitzungen auflisten entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenfolge oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_region

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter region von List Sessions entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenkette oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_didit_internal_id
string<uuid>

Grenzt ein delete_all auf die Sitzungen ein, die dem didit_internal_id-Filter von Sitzungen auflisten entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen, durch Kommas getrennten Wert zusammengefügt, sodass mehrere Werte mit 400 abgelehnt werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_session_type

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter session_type von List Sessions entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenkette oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_api_service
string

Grenzt ein delete_all auf die Sitzungen ein, die dem api_service-Filter von Sitzungen auflisten entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen, durch Kommas getrennten Wert zusammengefügt, sodass mehrere Werte mit 400 abgelehnt werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_screened_full_name
string

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter screened_full_name von List Sessions entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen kommagetrennten Text zusammengefügt, sodass mehrere Werte nicht als Alternativen abgeglichen werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_warning

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter warning von List Sessions entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenkette oder ein Array. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_status_initialized_as_in_review
boolean

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter status_initialized_as_in_review von List Sessions entsprechen, mit denselben Werten. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_is_kyc_to_be_reviewed
boolean

Grenzt ein delete_all auf die Sitzungen ein, die dem is_kyc_to_be_reviewed-Filter von Sitzungen auflisten entsprechen, mit denselben Werten. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_euuid
string<uuid>

Grenzt ein delete_all auf die Sitzungen ein, die dem euuid-Filter von Sitzungen auflisten entsprechen, mit demselben Wert. Ein einzelner Wert, keine Liste: Ein Array wird zu einem einzelnen, durch Kommas getrennten Wert zusammengefügt, sodass mehrere Werte mit 400 abgelehnt werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

filter_organization_name

Grenzt ein delete_all auf die Sitzungen ein, die dem Filter organization_name von List Sessions entsprechen, mit denselben Werten. Eine kommagetrennte Zeichenkette oder ein Array. Mit einem API-Schlüssel kann dies nur mit dem Namen Ihrer eigenen Organisation übereinstimmen, sodass entweder alle Ihre Sitzungen oder keine ausgewählt werden. Wird ohne delete_all ignoriert. Ein leerer Wert wird ignoriert und schränkt die Auswahl nicht ein.

Antwort

Bis zu 20 Sitzungen stimmten überein und wurden in der Anfrage verarbeitet. Ein Ergebnis pro übereinstimmender Sitzung; Nummern, die mit nichts übereinstimmten (unbekannt oder bereits gelöscht), werden übersprungen und erscheinen nicht. Ein Ergebnis bestätigt die Löschung, außer wenn face_retention_outcome den Wert failed_retryable hat: Diese Sitzung wurde NICHT gelöscht und sollte wiederholt werden.

results
object[]
Zuletzt geändert am 7. November 2026