Zum Hauptinhalt springen
POST
curl
Massen-Löschung von Biometrie-Templates in einem Aufruf. Geben Sie entweder eine explizite ID-Liste oder delete_all: true an, optional eingeschränkt durch dieselben Filter wie bei Biometrische Templates auflisten.

Anfrage-Body

delete_all: true ohne Filter löscht jedes biometrische Template der Anwendung und kann nicht rückgängig gemacht werden. Führen Sie zuvor Biometrische Templates zählen mit denselben Filtern aus, um zu prüfen, was gelöscht wird.

Beispiele

Templates werden einzeln gelöscht. Jedes Ergebnis meldet purged oder already_purged. Wenn ein biometrischer Speicher nicht verfügbar ist, gibt der Aufruf beim ersten fehlgeschlagenen Template 503 zurück. Templates, die zuvor in derselben Anfrage gelöscht wurden, bleiben gelöscht. Das fehlgeschlagene Template wechselt in purge_failed (vom Abgleich bereits ausgeschlossen). Wenn Sie die Anfrage wiederholen, wird der Vorgang abgeschlossen.

Fehler

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
template_uuids
string<uuid>[]

Zu bereinigende Vorlagen. Erforderlich, es sei denn, delete_all ist true. Bereits bereinigte IDs werden als already_purged gemeldet.

Minimum array length: 1
delete_all
boolean
Standard:false

Wenn true, werden alle Vorlagen gelöscht, die den folgenden Filtern entsprechen (alle Vorlagen der Anwendung, wenn kein Filter angegeben ist). template_uuids wird ignoriert. Unumkehrbar.

vendor_data
string

Nur mit delete_all: Teilstring-Abgleich ohne Berücksichtigung der Groß-/Kleinschreibung mit dem vendor_data des besitzenden Benutzers.

vendor_user_uuid
string<uuid>

Nur mit delete_all: exakte Übereinstimmung mit dem besitzenden Benutzer.

status
enum<string>

Nur mit delete_all.

Verfügbare Optionen:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed
source_type
enum<string>

Nur mit delete_all.

Verfügbare Optionen:
session_delete,
automatic_retention,
backfill
retained_from
string<date-time>

Nur mit delete_all.

retained_to
string<date-time>

Nur mit delete_all. Darf nicht vor retained_from liegen.

Antwort

Bereinigungsergebnisse pro Vorlage.

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