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));Previsualitzar el correu de decisió: aprovada i rebutjada
Consulteu el correu d’aprovació o rebuig que rep l’usuari, amb destinatari, remitent i idioma, abans de canviar l’estat de la sessió amb Didit.
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));Approved o Declined amb send_email: true.
També indica qui el rep, qui l’envia i si confirmar-ho l’envia realment.
Qui rep el correu
El correu va a l’adreça pròpia de la persona: la que va verificar en un pas de verificació de correu electrònic del flux o, si no n’hi ha cap, la indicada acontact_details en crear la sessió.
recipient_source indica quina s’aplica (email_verification o contact_details).
Quan la sessió no té cap adreça per a la persona, recipient, recipient_source i preview_token són cadenes buides i no es pot enviar cap correu.
El correu s’envia des del domini remitent verificat de la teva aplicació quan s’aplica la teva configuració de Marca blanca (sender_kind: customer); en cas contrari, s’envia des del remitent de Didit (sender_kind: didit).
Si el correu s’envia
will_be_sent és true quan confirmar el canvi amb send_email: true envia el correu.
Quan és false, not_sent_reason indica el motiu:
not_sent_reason | Què significa |
|---|---|
status_unchanged | La sessió ja té aquest estat, de manera que l’actualització no canvia res i no envia res. |
notification_emails_disabled | La sessió es va crear sense contact_details.send_notification_emails: true, de manera que cap correu de decisió no arriba a l’adreça indicada a contact_details. |
no_recipient | No es coneix cap adreça per a la persona. |
sandbox | La sessió és una sessió sandbox i el destinatari no ha donat el seu consentiment per rebre correus del sandbox, de manera que el correu només se simula. Consulta inscripció al correu. |
Confirma la decisió
Crida Update Session Status amb aquests camps:| Camp de Update Session Status | Valor |
|---|---|
new_status | El mateix new_status que has previsualitzat |
send_email | true |
email_address | recipient de la previsualització |
email_language | language de la previsualització |
email_preview_token | preview_token de la previsualització |
409 abans que es canviï res.
Torna a previsualitzar i confirma amb el nou rebut.
Continguts relacionats
- Update Session Status: aprova o rebutja la sessió i envia el correu.
- Preview Resubmission Email: previsualitza el correu per a una nova presentació.
- Marca blanca: el remitent i la marca que utilitza el correu.
Autoritzacions
La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.
Paràmetres de ruta
UUID de la sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB).
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Cos
La decisió el correu electrònic de la qual vols previsualitzar.
Approved, Declined "Approved"
Idioma del correu electrònic, el mateix valor per defecte que a Update Session Status. Un idioma que no s'ofereixi torna a l'anglès; el camp language de la resposta indica quin s'utilitza.
"en"
Resposta
Només previsualització. La sessió no canvia i no s'envia cap correu electrònic.
L'adreça a la qual s'envia el correu electrònic. Una cadena buida quan no es coneix cap adreça per a la persona: en aquest cas no es pot enviar cap correu electrònic i preview_token també és buit. Envia-la com a email_address en confirmar.
"person@example.com"
D'on prové recipient. email_verification: l'adreça que la persona ha verificat en un pas de verificació de correu electrònic del flux. contact_details: l'adreça indicada a contact_details en crear la sessió. Una cadena buida quan no hi ha cap adreça.
email_verification, contact_details, "email_verification"
La capçalera From amb què s'envia el correu electrònic.
"Example App <no-reply@mail.example.com>"
La part del nom visible de sender.
"Example App"
La part de l'adreça de sender.
"no-reply@mail.example.com"
customer: el correu electrònic s'envia des del domini de remitent verificat de la teva aplicació (marca blanca). didit: s'envia des del remitent propi de Didit.
customer, didit "customer"
La línia de l'assumpte exactament tal com s'envia.
"Your verification has been approved in Example App"
L'HTML del correu electrònic exactament com s'envia, amb el seu logotip incrustat com a URL de dades. Renderitza'l en un frame aïllat (sandbox), mai directament al DOM de la teva aplicació.
"<!DOCTYPE html><html><body>...</body></html>"
El text del correu electrònic com a text pla, tal com el manté el fil de missatges de la persona, per a una previsualització compacta (l'HTML continua sent el correu electrònic que rep la persona).
"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."
L'idioma en què està escrit el correu electrònic. Anglès (en) quan el email_language que has demanat no s'ofereix.
"en"
Indica si confirmar el canvi amb send_email: true envia aquest correu electrònic. false quan s'ha definit not_sent_reason.
true
Per què en confirmar no s'enviaria cap correu electrònic, o null quan s'enviarà. status_unchanged: la sessió ja té aquest estat, per la qual cosa l'actualització no canvia res ni envia res. notification_emails_disabled: la sessió es va crear sense contact_details.send_notification_emails: true, per la qual cosa no s'envia cap correu electrònic de decisió a l'adreça indicada a contact_details. no_recipient: no es coneix cap adreça per a la persona. sandbox: una sessió de sandbox el destinatari de la qual no ha acceptat el lliurament de correus electrònics en sandbox, per la qual cosa l'enviament només es simula.
status_unchanged, notification_emails_disabled, no_recipient, sandbox, null null
Justificant signat per a aquesta adreça electrònica exacta, vàlid durant 15 minuts. Passa'l com a email_preview_token a Actualitzar l'estat de la sessió. Una cadena buida quan no hi ha destinatari.
"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"