Zum Hauptinhalt springen
GET
curl
Dieser Endpoint gibt den Webhook auf Anwendungsebene zurück, der vor der Einführung von Zielen bestand, zusammen mit der Liste Ihrer Ziele. Didit stellt Webhooks an Ihre Webhook-Ziele zu, und jeder Webhook ist mit dem eigenen secret_shared_key des jeweiligen Ziels signiert. Die Felder webhook_url, webhook_version und secret_shared_key auf oberster Ebene werden nur verwendet, solange kein Ziel aktiviert ist, und dann nur für status.updated und data.updated.
Die Antwort enthält alle Signatur-Geheimnisse Ihrer Anwendung. Halten Sie sie aus Logs und clientseitigem Code fern.
Um diese Einstellungen zu ändern, verwenden Sie Webhook-Konfiguration aktualisieren. Informationen zur Signaturprüfung und zu den Payloads finden Sie im Webhook-Leitfaden. Zu den Feldern der Datenaufbewahrung siehe Datenaufbewahrung.

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.

Antwort

Die Webhook-Konfiguration.

Webhook-Konfiguration auf Anwendungsebene, Aufbewahrungsrichtlinie und Hosts für die Rückgabe der Digital-ID-Wallet sowie alle Webhook-Ziele.

webhook_url
string<uri> | null
erforderlich

Webhook-URL auf Anwendungsebene (Legacy). Didit sendet nur daran, solange die Anwendung kein aktiviertes Ziel hat, und dann nur status.updated und data.updated. Jedes Erstellen, Aktualisieren oder Löschen eines Ziels setzt sie auf die URL des ältesten aktivierten Ziels bzw. auf null, wenn keines aktiviert ist.

webhook_version
enum<string>
erforderlich

Payload-Version der Legacy-webhook_url. Jedes Ziel hat eine eigene webhook_version.

Verfügbare Optionen:
v1,
v2,
v3
secret_shared_key
string
erforderlich

Signaturgeheimnis auf Anwendungsebene (43 Zeichen langes URL-sicheres Token). Es signiert ausschließlich Zustellungen an die Legacy-webhook_url; jedes Ziel signiert mit seinem eigenen secret_shared_key. Aufrufer mit API-Schlüssel erhalten es immer vollständig; Console-Benutzer ohne read:webhooks erhalten eine leere Zeichenfolge.

capture_method
enum<string>
erforderlich

Veraltete Anwendungseinstellung. Der Verifizierungsablauf liest diesen Wert nicht aus: Erfassungsoptionen werden pro Workflow konfiguriert.

Verfügbare Optionen:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null
erforderlich

Automatisches Löschfenster. Sitzungen zur Benutzerverifizierung, die vor mehr als der angegebenen Anzahl von Monaten erstellt wurden (ein Monat entspricht 30 Tagen), werden automatisch gelöscht, und diese Löschung ist unwiderruflich. null bedeutet, dass Sitzungen niemals automatisch gelöscht werden. Siehe Datenaufbewahrung.

Erforderlicher Bereich: 1 <= x <= 120
face_retention_policy
enum<string>
erforderlich

Was mit dem Gesichts-Embedding einer Sitzung passiert, wenn die Sitzung gelöscht wird. delete_with_session (Standard) löscht es mit der Sitzung. retain_until_user_deleted ist das Opt-in für die Aufbewahrung biometrischer Templates: Ein mit dem Benutzer verknüpftes bildfreies biometrisches Template wird separat verwaltet, bis seine Aufbewahrungsfrist endet, der Benutzer gelöscht wird oder Sie es bereinigen.

Verfügbare Optionen:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null
erforderlich

Aufbewahrungsfrist in Tagen für biometrische Templates unter retain_until_user_deleted. Erforderlich, wenn diese Richtlinie festgelegt ist.

Erforderlicher Bereich: 1 <= x <= 3650
available_events
object[]
erforderlich

Jeder Ereignistyp, den ein Ziel abonnieren kann, mit einer Anzeigebezeichnung.

allowed_return_hosts
string[]
erforderlich

Hostnamen (exakte Übereinstimmung, nur HTTPS), zu denen eine eigenständige Digital-ID-Wallet-Verifizierung den Benutzer mit ihrer return_url zurücksenden darf. Ihre White-Label-Domain ist ebenfalls stets zulässig. Siehe Registrieren Sie Ihr Rückkehrziel.

Maximum array length: 20
Maximum string length: 253
endpoints
object[]
erforderlich

Jedes Webhook-Ziel der Anwendung, das älteste zuerst, jeweils mit seinem Signaturgeheimnis. Hier schreibgeschützt: Verwalten Sie Ziele über die /v3/webhook/destinations/-Endpoints.

Wann der gehostete Ablauf und die nativen SDKs die Person vor einer Gesichtserfassung um eine ausdrückliche biometrische Einwilligung bitten. auto (Standard) fragt nur ab, wenn ein Auslöser zutrifft: Ein angegebener Bundesstaat, die IP-Adresse der Person oder der Aussteller des Ausweisdokuments liegt in Illinois, Texas oder Colorado, oder die Person scheint sich ohne bekannten Bundesstaat in den USA zu befinden. always fragt jede Person ab, deren Workflow ein Gesicht erfasst. never zeigt den Schritt nie an, und Sie holen die Einwilligung vor dem Selfie selbst ein. Jede Änderung wird im Audit-Log protokolliert. Siehe Biometrische Einwilligung.

Verfügbare Optionen:
auto,
always,
never
allowed_domains
string[]

Origins (zum Beispiel https://app.example.com; http nur für localhost), in die der gehostete Verifizierungs-Workflow eingebettet werden darf und an die der Benutzer mit einem Sitzungs-Callback zurückgeleitet werden darf. Server-zu-Server-Aufrufe sind davon nicht betroffen. Eine leere Liste bedeutet keine Einschränkung. Didit speichert jeden Origin in Kleinbuchstaben ohne Standard-Port. Ein ungültiger Eintrag schlägt mit 400 bei allowed_domains fehl.

Maximum array length: 50
Maximum string length: 300
Beispiel:
Zuletzt geändert am 7. November 2026