Zum Hauptinhalt springen
POST
curl
Die Vorschau ändert nichts und versendet nichts. Die Antwort zeigt die E-Mail genau so, wie die Person sie erhält, wenn Sie die Sitzung mit send_email: true auf Approved oder Declined setzen. Außerdem wird angegeben, wer die E-Mail erhält, von wem sie kommt und ob die Bestätigung sie tatsächlich versendet.

Wer die E-Mail erhält

Die E-Mail geht an die eigene Adresse der Person: an die, die sie in einem E-Mail-Verifizierungsschritt des Ablaufs verifiziert hat, andernfalls an die in contact_details bei der Erstellung der Sitzung angegebene Adresse. recipient_source gibt an, welche davon gilt (email_verification oder contact_details). Wenn die Sitzung für die Person keine Adresse hat, sind recipient, recipient_source und preview_token leere Zeichenketten, und es kann keine E-Mail versendet werden. Die E-Mail wird über die verifizierte Absenderdomain Ihrer Anwendung versendet, wenn Ihre White-Label-Konfiguration gilt (sender_kind: customer). Andernfalls wird sie über den Absender von Didit versendet (sender_kind: didit).

Ob die E-Mail versendet wird

will_be_sent ist true, wenn die Bestätigung der Änderung mit send_email: true die E-Mail versendet. Ist der Wert false, erklärt not_sent_reason, warum:

Entscheidung bestätigen

Rufen Sie Sitzungsstatus aktualisieren mit diesen Feldern auf: Der Beleg läuft nach 15 Minuten ab. Wenn sich Empfänger, Sprache, Sitzungsstatus, Absender oder E-Mail seit der Vorschau geändert haben, gibt die Aktualisierung 409 zurück, bevor sich etwas ändert. Erstellen Sie dann eine neue Vorschau und bestätigen Sie mit dem neuen Beleg.

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 Verifizierungssitzung. Akzeptiert sowohl Benutzer- (KYC) als auch Unternehmens- (KYB) Sitzungs-IDs.

Beispiel:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Body

application/json
new_status
enum<string>
erforderlich

Die Entscheidung, deren E-Mail Sie in der Vorschau anzeigen möchten.

Verfügbare Optionen:
Approved,
Declined
Beispiel:

"Approved"

email_language
string
Standard:en

Sprache der E-Mail, derselbe Standardwert wie bei Sitzungsstatus aktualisieren. Wird eine nicht angebotene Sprache angegeben, erfolgt ein Fallback auf Englisch; das Feld language in der Antwort gibt an, welche Sprache verwendet wird.

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. 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,
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:

"Your verification has been approved 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:

"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."

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. status_unchanged: Die Sitzung hat diesen Status bereits, daher ändert die Aktualisierung nichts und sendet nichts. notification_emails_disabled: Die Sitzung wurde ohne contact_details.send_notification_emails: true erstellt, daher geht keine Entscheidungs-E-Mail an die in contact_details angegebene Adresse. no_recipient: Für die Person ist keine Adresse bekannt. sandbox: Eine Sandbox-Sitzung, deren Empfänger die Sandbox-E-Mail-Zustellung nicht aktiviert hat, sodass der Versand nur simuliert wird.

Verfügbare Optionen:
status_unchanged,
notification_emails_disabled,
no_recipient,
sandbox,
null
Beispiel:

null

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