curl -X POST \
https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/decision-email-preview/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"new_status": "Approved", "email_language": "en"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.preview_decision_email(
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
new_status="Approved",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.previewDecisionEmail("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
new_status: "Approved",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.PreviewDecisionEmail(ctx, "3fa85f64-5717-4562-b3fc-2c963f66afa6", didit.SessionsPreviewDecisionEmailParams{
NewStatus: "Approved",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SessionsPreviewDecisionEmailParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().previewDecisionEmail("3fa85f64-5717-4562-b3fc-2c963f66afa6", SessionsPreviewDecisionEmailParams.builder()
.newStatus(SessionsPreviewDecisionEmailParams.NewStatus.of("Approved"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->previewDecisionEmail('3fa85f64-5717-4562-b3fc-2c963f66afa6', [
'new_status' => 'Approved',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.preview_decision_email(
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
new_status: "Approved"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.PreviewDecisionEmailAsync("3fa85f64-5717-4562-b3fc-2c963f66afa6", new SessionsPreviewDecisionEmailParams
{
NewStatus = "Approved",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"recipient": "person@example.com",
"recipient_source": "email_verification",
"sender": "Example App <no-reply@mail.example.com>",
"sender_name": "Example App",
"sender_email": "no-reply@mail.example.com",
"sender_kind": "customer",
"subject": "Your verification has been approved in Example App",
"html": "<!DOCTYPE html><html><body>...</body></html>",
"language": "en",
"will_be_sent": true,
"not_sent_reason": null,
"preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"
}Entscheidungs-E-Mail-Vorschau API: genehmigt, abgelehnt
Didit zeigt die genehmigte oder abgelehnte E-Mail mit Empfänger, Absender und Sprache, bevor Sie den Sitzungsstatus ändern.
curl -X POST \
https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/decision-email-preview/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"new_status": "Approved", "email_language": "en"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.preview_decision_email(
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
new_status="Approved",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.previewDecisionEmail("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
new_status: "Approved",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.PreviewDecisionEmail(ctx, "3fa85f64-5717-4562-b3fc-2c963f66afa6", didit.SessionsPreviewDecisionEmailParams{
NewStatus: "Approved",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SessionsPreviewDecisionEmailParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().previewDecisionEmail("3fa85f64-5717-4562-b3fc-2c963f66afa6", SessionsPreviewDecisionEmailParams.builder()
.newStatus(SessionsPreviewDecisionEmailParams.NewStatus.of("Approved"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->previewDecisionEmail('3fa85f64-5717-4562-b3fc-2c963f66afa6', [
'new_status' => 'Approved',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.preview_decision_email(
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
new_status: "Approved"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.PreviewDecisionEmailAsync("3fa85f64-5717-4562-b3fc-2c963f66afa6", new SessionsPreviewDecisionEmailParams
{
NewStatus = "Approved",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"recipient": "person@example.com",
"recipient_source": "email_verification",
"sender": "Example App <no-reply@mail.example.com>",
"sender_name": "Example App",
"sender_email": "no-reply@mail.example.com",
"sender_kind": "customer",
"subject": "Your verification has been approved in Example App",
"html": "<!DOCTYPE html><html><body>...</body></html>",
"language": "en",
"will_be_sent": true,
"not_sent_reason": null,
"preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"
}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 incontact_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:
not_sent_reason | Bedeutung |
|---|---|
status_unchanged | Die Sitzung hat diesen Status bereits. Die Aktualisierung ändert daher nichts und versendet nichts. |
notification_emails_disabled | Die Sitzung wurde ohne contact_details.send_notification_emails: true erstellt, daher wird keine Entscheidungs-E-Mail an die in contact_details angegebene Adresse versendet. |
no_recipient | Für die Person ist keine Adresse bekannt. |
sandbox | Die Sitzung ist eine Sandbox-Sitzung, und der Empfänger hat den E-Mail-Versand in der Sandbox nicht aktiviert. Die E-Mail wird daher nur simuliert. Siehe E-Mail-Opt-in. |
Entscheidung bestätigen
Rufen Sie Sitzungsstatus aktualisieren mit diesen Feldern auf:| Feld von Sitzungsstatus aktualisieren | Wert |
|---|---|
new_status | Der gleiche new_status wie in der Vorschau |
send_email | true |
email_address | recipient aus der Vorschau |
email_language | language aus der Vorschau |
email_preview_token | preview_token aus der Vorschau |
409 zurück, bevor sich etwas ändert.
Erstellen Sie dann eine neue Vorschau und bestätigen Sie mit dem neuen Beleg.
Verwandte Themen
- Sitzungsstatus aktualisieren: Sitzung genehmigen oder ablehnen und die E-Mail versenden.
- Vorschau der E-Mail zur erneuten Einreichung: stattdessen die E-Mail für eine erneute Einreichung in der Vorschau anzeigen.
- White-Label: Absender und Branding, die für die E-Mail verwendet werden.
Autorisierungen
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
UUID der Verifizierungssitzung. Akzeptiert sowohl Benutzer- (KYC) als auch Unternehmens- (KYB) Sitzungs-IDs.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Body
Die Entscheidung, deren E-Mail Sie in der Vorschau anzeigen möchten.
Approved, Declined "Approved"
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.
"en"
Antwort
Nur Vorschau. Die Sitzung bleibt unverändert und es wird keine E-Mail gesendet.
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.
"person@example.com"
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.
email_verification, contact_details, "email_verification"
Der From-Header, mit dem die E-Mail gesendet wird.
"Example App <no-reply@mail.example.com>"
Der Teil des Anzeigenamens von sender.
"Example App"
Der Adressteil von sender.
"no-reply@mail.example.com"
customer: Die E-Mail wird von der verifizierten Absender-Domain Ihrer Anwendung versendet (White-Label). didit: Sie wird vom Didit-eigenen Absender versendet.
customer, didit "customer"
Die Betreffzeile genau so, wie sie gesendet wird.
"Your verification has been approved in Example App"
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.
"<!DOCTYPE html><html><body>...</body></html>"
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).
"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."
Die Sprache, in der die E-Mail verfasst ist. Englisch (en), wenn das angeforderte email_language nicht angeboten wird.
"en"
Gibt an, ob das Bestätigen der Änderung mit send_email: true diese E-Mail versendet. false, wenn not_sent_reason gesetzt ist.
true
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.
status_unchanged, notification_emails_disabled, no_recipient, sandbox, null null
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.
"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"