Zum Hauptinhalt springen
GET
curl

Überblick

Gibt eine Massenlöschung von Sitzungen zurück, die mit Mehrere Sitzungen löschen gestartet wurde: ihren Status, wie viele Sitzungen verarbeitet wurden und wie viele mit welchem Ergebnis endeten. Wenn ein Massenlöschvorgang mehr als 20 KYC-Sitzungen betrifft, die über session_numbers ausgewählt oder mit delete_all festgelegt wurden, gibt die Anfrage 202 mit einem Job im Status PENDING zurück, und die Sitzungen werden im Hintergrund gelöscht. Fragen Sie diesen Endpoint alle paar Sekunden ab, bis status den Wert COMPLETED oder FAILED hat. Jede Sitzung, die der Job löscht, wird genauso gelöscht wie bei Sitzung löschen: Die Sitzung, alle Verifizierungsversuche, die sie enthält, und alle gespeicherten Dateien werden gelöscht, und ihre Medien-URLs werden nicht mehr aufgelöst. Die Löschung ist endgültig und nicht rückgängig zu machen. Der Job meldet nur Zählwerte. Er listet nie auf, welche Sitzungen er gelöscht hat.

Jobstatus

Ein delete_all-Job löscht nur die Sitzungen, die vor der Anfrage erstellt wurden. Sitzungen, die während seiner Laufzeit gestartet werden, werden nicht gelöscht.

Ergebniszähler

deleted_child_verifications zählt die Verifizierungen, die von gelöschten Unternehmensverifizierungen erstellt und zusammen mit diesen gelöscht wurden. Bei einem Job, der über Mehrere Sitzungen löschen gestartet wurde, ist der Wert immer 0, da dieser Endpoint ausschließlich KYC-Sitzungen löscht.

Berechtigungen

Jeder aktive API-Schlüssel der Anwendung kann diesen Endpoint aufrufen. Ein Job ist nur für die Anwendung sichtbar, die ihn erstellt hat. Jede andere job_id liefert 404.

Verwandte Themen

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

job_id
string<uuid>
erforderlich

Die mit dem 202 von POST /v3/sessions/delete/ zurückgegebene job_id.

Antwort

Der Job.

Eine Massenlöschung von Sitzungen, die im Hintergrund ausgeführt wird: Fortschritt und Anzahlen pro Ergebnis, niemals welche Sitzungen gelöscht wurden.

job_id
string<uuid>

Rufen Sie GET /v3/sessions/delete/{job_id}/ mit dieser ID regelmäßig ab.

status
enum<string>

PENDING: Akzeptiert, noch nicht gestartet. PROCESSING: Wird gelöscht; processed und outcomes werden aktualisiert. COMPLETED: Jede ausgewählte Sitzung wurde berücksichtigt. FAILED: Der Auftrag wurde vorzeitig abgebrochen; siehe error.

Verfügbare Optionen:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

Sitzungen, die ausgewählt wurden, als die Löschung angefordert wurde.

processed
integer

Sitzungen, die der Job bisher abgeschlossen hat.

outcomes
object

Wie viele Sitzungen mit welchem Ergebnis geendet haben. Jeder Schlüssel ist immer vorhanden.

deleted_child_verifications
integer

Verifizierungen, die durch die gelöschten Unternehmensverifizierungen erstellt wurden und mit ihnen gelöscht werden. Immer 0 bei einem Job, der durch POST /v3/sessions/delete/ gestartet wurde, da dieser nur KYC-Sitzungen löscht.

error
string | null

null, außer wenn status auf FAILED steht; dann der Grund, warum die Löschung gestoppt wurde. Die Sitzungen, die der Job noch nicht erreicht hatte, bleiben bestehen: Wiederholen Sie die Anfrage, um sie zu löschen.

created_at
string<date-time>

Wann die Löschung angefordert wurde.

completed_at
string<date-time> | null

Wann der Job beendet wurde; null, während er läuft.

Zuletzt geändert am 7. November 2026