Zum Hauptinhalt springen
POST
Python
Die Vorschau ändert die Sitzung nicht und sendet keine E-Mail. Bestätigen Sie nach Prüfung der Antwort die erneute Einreichung mit Session-Status aktualisieren und übergeben Sie das zurückgegebene preview_token als email_preview_token. Der Beleg läuft nach 15 Minuten ab. Ein geänderter oder abgelaufener Beleg liefert 409, bevor die Sitzung geändert oder eine E-Mail gesendet wird. Erstellen Sie nach einem Konflikt eine neue Vorschau. Bestehende API-Integrationen dürfen den Beleg weglassen; die Konsole stellt ihn beim Bestätigen einer Vorschau bereit. Absender und Branding richten sich nach Ihrer bestehenden White-Label-Konfiguration. Der Inhalt der Nachricht stammt aus der übersetzten Verifizierungsvorlage; beliebige Betreffzeilen, Nachrichtentexte und Aktions-URLs werden nicht als Vorlageneingaben akzeptiert.

Wer die E-Mail erhält

email_address ist optional. Ohne diesen Wert geht die E-Mail an die eigene Adresse der Person: an die Adresse, die sie in einem E-Mail-Verifizierungsschritt des Workflows verifiziert hat, andernfalls an die Adresse aus contact_details, die bei der Erstellung der Sitzung angegeben wurde. Eine in email_address übergebene Adresse hat Vorrang. recipient_source zeigt an, welche Adresse gilt:

Ob die E-Mail versendet wird

will_be_sent ist true, wenn die erneute Einreichung mit send_email: true bestätigt wird und die E-Mail versendet wird. Ist der Wert false, erklärt not_sent_reason den Grund:

Erneute Einreichung bestätigen

Rufen Sie Session-Status aktualisieren mit diesen Feldern auf: Die language in der Antwort gibt die Sprache an, in der die E-Mail verfasst ist: Englisch, wenn die angeforderte Sprache nicht angeboten wird.

Wiederholte rein serverseitige erneute Einreichungen

Wenn jeder erneut einzureichende Schritt ohne die Person läuft (AML, Datenbankvalidierung oder IP-Analyse), kann eine Sitzung nur alle 30 Sekunden für die Person erneut eingereicht werden. Innerhalb dieses Zeitfensters liefert die Vorschau 429 wie bei Session-Status aktualisieren, und die Wartezeit steht im Header Retry-After.

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

sessionId
string<uuid>
erforderlich

UUID der zu aktualisierenden Verifizierungssitzung. Akzeptiert sowohl Benutzer- (KYC) als auch Unternehmens- (KYB) Sitzungs-IDs — der Dienst löst die ID über beide Sitzungstypen hinweg auf.

Beispiel:

"11111111-2222-3333-4444-555555555555"

Body

application/json
nodes_to_resubmit
object[]

Schritte für die Vorschau unter Verwendung derselben Validierung, Auswahl und Workflow-Reihenfolge wie bei einer erneuten Einreichung. Weglassen, um aufgezeichnete Versuche, die eine erneute Einreichung erfordern, automatisch auszuwählen.

email_address
string<email>

Optional. Sendet die E-Mail an diese Adresse statt an die eigene Adresse der Person. Ohne diese Angabe ist der Empfänger die Adresse, die die Person im Ablauf verifiziert hat, andernfalls die in contact_details angegebene Adresse. Durch diesen Aufruf wird keine E-Mail versendet.

Beispiel:

"user@example.com"

email_language
string
Standard:en

Sprache für die Benachrichtigungs-E-Mail. Akzeptiert auf Schemaebene beliebige Zeichenketten; bei nicht unterstützten Codes wird stillschweigend auf Englisch (en) zurückgegriffen.

Beispiel:

"en"

Antwort

Nur Vorschau. Die Sitzung bleibt unverändert und es wird keine E-Mail gesendet.

recipient
string
erforderlich

Die Adresse, an die die E-Mail gesendet wird. Eine leere Zeichenkette, wenn keine Adresse für die Person bekannt ist: Dann kann keine E-Mail gesendet werden und preview_token ist ebenfalls leer. Übergeben Sie sie als email_address, wenn Sie bestätigen.

Beispiel:

"person@example.com"

recipient_source
enum<string>
erforderlich

Woher recipient stammt. request: die von Ihnen übergebene email_address. email_verification: die Adresse, die die Person in einem E-Mail-Verifizierungsschritt des Ablaufs verifiziert hat. contact_details: die in contact_details bei der Erstellung der Sitzung angegebene Adresse. Eine leere Zeichenkette, wenn keine Adresse vorhanden ist.

Verfügbare Optionen:
email_verification,
contact_details,
request,
Beispiel:

"email_verification"

sender
string
erforderlich

Der From-Header, mit dem die E-Mail gesendet wird.

Beispiel:

"Example App <no-reply@mail.example.com>"

sender_name
string
erforderlich

Der Teil des Anzeigenamens von sender.

Beispiel:

"Example App"

sender_email
string<email>
erforderlich

Der Adressteil von sender.

Beispiel:

"no-reply@mail.example.com"

sender_kind
enum<string>
erforderlich

customer: Die E-Mail wird von der verifizierten Absender-Domain Ihrer Anwendung versendet (White-Label). didit: Sie wird vom Didit-eigenen Absender versendet.

Verfügbare Optionen:
customer,
didit
Beispiel:

"customer"

subject
string
erforderlich

Die Betreffzeile genau so, wie sie gesendet wird.

Beispiel:

"Action Required: Complete your verification in Example App"

html
string
erforderlich

Das HTML der E-Mail exakt so, wie es versendet wird, mit eingebettetem Logo als Data-URL. Rendern Sie es in einem Sandboxed-Frame, niemals direkt im DOM Ihrer Anwendung.

Beispiel:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
erforderlich

Der Text der E-Mail als Klartext, wie ihn der Nachrichtenverlauf der Person speichert, für eine kompakte Vorschau (das HTML bleibt die E-Mail, die die Person erhält).

Beispiel:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

language
string
erforderlich

Die Sprache, in der die E-Mail verfasst ist. Englisch (en), wenn das angeforderte email_language nicht angeboten wird.

Beispiel:

"en"

will_be_sent
boolean
erforderlich

Gibt an, ob das Bestätigen der Änderung mit send_email: true diese E-Mail versendet. false, wenn not_sent_reason gesetzt ist.

Beispiel:

true

not_sent_reason
enum<string> | null
erforderlich

Warum bei der Bestätigung keine E-Mail gesendet werden würde, oder null, wenn sie gesendet wird. no_user_action: Jeder ausgewählte Schritt wird ohne die Person ausgeführt, sodass die erneute Einreichung von selbst abgeschlossen wird und keine E-Mail versendet wird. no_recipient: Für die Person ist keine Adresse bekannt und Sie haben keine übergeben. sandbox: Eine Sandbox-Sitzung, deren Empfänger die Sandbox-E-Mail-Zustellung nicht aktiviert hat, sodass der Versand nur simuliert wird.

Verfügbare Optionen:
no_user_action,
no_recipient,
sandbox,
null
Beispiel:

null

nodes_to_resubmit
object[]
erforderlich
requires_user_action
boolean
erforderlich

Gibt an, ob mindestens eine ausgewählte Prüfung eine Benutzerinteraktion erfordert. Dies lässt keinen Rückschluss auf das endgültige Workflow-Ergebnis zu.

preview_token
string
erforderlich

Signierte Quittung für genau diese E-Mail, gültig für 15 Minuten. Übergeben Sie sie als email_preview_token an Sitzungsstatus aktualisieren. Eine leere Zeichenfolge, wenn kein Empfänger vorhanden ist.

Beispiel:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

Zuletzt geändert am 7. November 2026