> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# 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.
Prompt de previsualització del correu de decisió
Copia el prompt al porta-retalls
\
\`Preview the Approved or Declined email a Didit session sends the person, then confirm the decision so exactly that email goes out.
Endpoint:
POST https://verification.didit.me/v3/session/{session_id}/decision-email-preview/
Authentication:
x-api-key (client API key) or a user-auth token. Privilege: write:sessions. A scoped API key needs write access to decisions.
Path parameter:
\- session_id (UUID): KYC or KYB; Didit resolves it against both session types.
Request body:
\- new_status (string, required): "Approved" or "Declined".
\- email_language (string, optional, default "en"): language of the email. A language that is not offered falls back to English.
The session's current status must be one of: Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted.
Previewing changes nothing and sends nothing.
Response (200, Cache-Control: no-store):
\- recipient: the person's own address (the one they verified in the flow, else the one in contact_details). Empty string when none is known.
\- recipient_source: "email_verification", "contact_details", or "" when there is no address.
\- sender, sender_name, sender_email: the From header and its parts.
\- sender_kind: "customer" (your verified sender domain) or "didit" (Didit's sender).
\- subject, html: the email exactly as sent. Render html in a sandboxed frame.
\- language: the language actually used.
\- will_be_sent (boolean) and not_sent_reason: null, "status_unchanged", "notification_emails_disabled", "no_recipient" or "sandbox".
\- preview_token: receipt for this exact email, valid 15 minutes. Empty when there is no recipient.
Confirm with PATCH https://verification.didit.me/v3/session/{session_id}/update-status/:
\{
"new_status": "",
"send_email": true,
"email_address": "",
"email_language": "",
"email_preview_token": ""
}
If the recipient, language, session status, sender or email changed since the preview, or the receipt is older than 15 minutes, update-status returns 409 { "detail": "This email preview changed or expired. Preview the message again before confirming." } and changes nothing. Preview again and confirm with the new receipt.
curl example:
curl -X POST https://verification.didit.me/v3/session//decision-email-preview/ \
-H "x-api-key: " \
-H "Content-Type: application/json" \
-d '{ "new_status": "Approved", "email_language": "en" }'
Failure modes:
\- 400: the session is not in an accepted status ({ "detail": "Only sessions with status ... can be updated. Current status: ..." }), or new_status is missing or invalid.
\- 401: the scoped API key has expired.
\- 403: missing credentials (a wrong, revoked or expired key gets 401), the caller lacks write:sessions, a scoped key lacks decisions write, or the session belongs to another application ({ "detail": "You do not have permission to perform this action." }).
\- 404: { "detail": "Not found." } when no session with this session_id exists.
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`
\
Enganxa a
Previsualitzar no canvia res i no envia res.
La resposta mostra el correu exactament tal com el rep la persona quan canvies la sessió a `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 correuEl 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 a `contact_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](https://docs.didit.me/ca/console/white-label.md) (`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](https://docs.didit.me/ca/integration/sandbox-testing.md#codis-otp-i-opció-d’activar-l’enviament-de-correus-electrònics). |## Confirma la decisióCrida [Update Session Status](https://docs.didit.me/ca/sessions-api/update-status.md) 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ó |El rebut caduca als 15 minuts.
Si el destinatari, l'idioma, l'estat de la sessió, el remitent o el correu han canviat des de la previsualització, l'actualització retorna `409` abans que es canviï res.
Torna a previsualitzar i confirma amb el nou rebut.## Continguts relacionats- [Update Session Status](https://docs.didit.me/ca/sessions-api/update-status.md): aprova o rebutja la sessió i envia el correu.
- [Preview Resubmission Email](https://docs.didit.me/ca/sessions-api/preview-resubmission.md): previsualitza el correu per a una nova presentació.
- [Marca blanca](https://docs.didit.me/ca/console/white-label.md): el remitent i la marca que utilitza el correu.
## OpenAPI
````yaml ca/openapi-25.json POST /v3/session/{sessionId}/decision-email-preview/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/session/{sessionId}/decision-email-preview/:
post:
tags:
- Sessions
summary: Previsualitza el correu electrònic de decisió d'una sessió
description: >-
Genera el correu electrònic que rep la persona quan estableixes una
sessió a `Approved` o `Declined` amb `send_email: true`, sense modificar
la sessió ni enviar res. La resposta mostra l'assumpte i l'HTML
exactament com s'envien, el destinatari, el remitent, l'idioma i si la
confirmació del canvi envia el correu electrònic (`will_be_sent`,
`not_sent_reason`).
El destinatari és la pròpia adreça de la persona: la que va verificar en
un pas de verificació de correu electrònic del flux, o bé la indicada a
`contact_details` en crear la sessió. El remitent és el domini de
remitent verificat de la teva aplicació quan s'aplica marca blanca
(`sender_kind: customer`), o bé el remitent de Didit (`sender_kind:
didit`).
Per enviar exactament el que has previsualitzat, crida [Update Session
Status](/ca/sessions-api/update-status) amb el mateix `new_status`,
`send_email: true`, `email_address` establert a `recipient`,
`email_language` establert a `language` i `email_preview_token`
establert a `preview_token`. El justificant caduca al cap de 15 minuts.
Si el destinatari, l'idioma, l'estat de la sessió, el remitent o el
correu han canviat des de la previsualització, l'actualització retorna
`409` abans que canviï res; torna a fer la previsualització i confirma
amb el nou justificant.
Funciona per a sessions de Verificació d'usuaris (KYC) i Verificació
d'empreses (KYB) en estat `Approved`, `Declined`, `In Review`, `Kyc
Expired`, `Abandoned` o `Resubmitted`. La comprovació d'estat s'executa
abans de la validació del cos. Requereix el permís `write:sessions`; una
clau d'API amb abast limitat necessita accés d'escriptura a les
decisions. Les respostes utilitzen `Cache-Control: no-store`: tracta-les
com a contingut confidencial de verificació.
operationId: post_v3_session_decision_email_preview
parameters:
- in: path
name: sessionId
required: true
description: >-
UUID de la sessió de verificació. Accepta tant IDs de sessió
d'usuari (KYC) com d'empresa (KYB).
schema:
type: string
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- new_status
properties:
new_status:
type: string
enum:
- Approved
- Declined
description: >-
La decisió el correu electrònic de la qual vols
previsualitzar.
example: Approved
email_language:
type: string
default: en
description: >-
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.
example: en
examples:
Approved:
summary: Previsualitza el correu d'aprovació en anglès
value:
new_status: Approved
Declined in Spanish:
summary: Previsualitza el correu de rebuig en espanyol
value:
new_status: Declined
email_language: es
responses:
'200':
description: >-
Només previsualització. La sessió no canvia i no s'envia cap correu
electrònic.
headers:
Cache-Control:
description: >-
Sempre `no-store`: la previsualització conté contingut de
verificació i no s'ha d'emmagatzemar a la memòria cau.
schema:
type: string
example: no-store
content:
application/json:
schema:
type: object
required:
- recipient
- recipient_source
- sender
- sender_name
- sender_email
- sender_kind
- subject
- html
- text
- language
- will_be_sent
- not_sent_reason
- preview_token
properties:
recipient:
type: string
description: >-
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.
example: person@example.com
recipient_source:
type: string
enum:
- email_verification
- contact_details
- ''
description: >-
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.
example: email_verification
sender:
type: string
description: La capçalera `From` amb què s'envia el correu electrònic.
example: Example App
sender_name:
type: string
description: La part del nom visible de `sender`.
example: Example App
sender_email:
type: string
format: email
description: La part de l'adreça de `sender`.
example: no-reply@mail.example.com
sender_kind:
type: string
enum:
- customer
- didit
description: >-
`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.
example: customer
subject:
type: string
description: La línia de l'assumpte exactament tal com s'envia.
example: Your verification has been approved in Example App
html:
type: string
description: >-
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ó.
example: ...
text:
type: string
description: >-
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).
example: >-
Verification Approved
Your identity has been successfully verified with Acme
Pay. No further action is needed on your part.
language:
type: string
description: >-
L'idioma en què està escrit el correu electrònic. Anglès
(`en`) quan el `email_language` que has demanat no
s'ofereix.
example: en
will_be_sent:
type: boolean
description: >-
Indica si confirmar el canvi amb `send_email: true` envia
aquest correu electrònic. `false` quan s'ha definit
`not_sent_reason`.
example: true
not_sent_reason:
type: string
nullable: true
enum:
- status_unchanged
- notification_emails_disabled
- no_recipient
- sandbox
- null
description: >-
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.
example: null
preview_token:
type: string
description: >-
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ó](/ca/sessions-api/update-status). Una cadena buida
quan no hi ha destinatari.
example: >-
eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000
examples:
Will Be Sent:
summary: >-
El correu electrònic d'aprovació s'envia a l'adreça
verificada en el flux
value:
recipient: person@example.com
recipient_source: email_verification
sender: Example App
sender_name: Example App
sender_email: no-reply@mail.example.com
sender_kind: customer
subject: Your verification has been approved in Example App
html: ...
language: en
will_be_sent: true
not_sent_reason: null
preview_token: >-
eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000
No Recipient:
summary: No es coneix cap adreça per a la persona
value:
recipient: ''
recipient_source: ''
sender: Example App
sender_name: Example App
sender_email: no-reply@mail.example.com
sender_kind: customer
subject: Your verification has been declined in Example App
html: ...
language: en
will_be_sent: false
not_sent_reason: no_recipient
preview_token: ''
'400':
description: >-
La sessió no es troba en un estat que aquest endpoint accepti
(`{"detail": ...}`), o el cos no és vàlid (`{"":
[""]}`).
content:
application/json:
examples:
Wrong Current Status:
summary: >-
La sessió no es troba en un estat que aquest endpoint
accepti
value:
detail: >-
Only sessions with status Approved, Declined, In Review,
Kyc Expired, Abandoned, Resubmitted can be updated.
Current status: In Progress
Invalid new_status:
summary: new_status no és Approved o Declined
value:
new_status:
- '"Resubmitted" is not a valid choice.'
Missing new_status:
summary: S'ha omès un camp obligatori
value:
new_status:
- This field is required.
'401':
description: La clau d'API amb abast ha caducat.
content:
application/json:
examples:
Expired API Key:
summary: Clau d'API amb abast que ha superat la data de caducitat
value:
detail: This API key has expired.
'403':
description: >-
Falten les credencials, qui fa la crida no té el privilegi
`write:sessions`, la clau d'API amb abast limitat no té l'accés que
necessita aquest endpoint, o el `session_id` pertany a una altra
aplicació.
content:
application/json:
examples:
Invalid Credentials:
summary: Falta l'x-api-key o no és vàlid
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Missing Privilege:
summary: L'emissor de la crida no disposa de write:sessions
value:
detail: You do not have permission to perform this action.
Scoped Key Without Access:
summary: Clau d'API amb abast sense aquest accés
value:
detail: This API key has no write access to decisions.
'404':
description: No existeix cap sessió de KYC o KYB amb aquest `session_id`.
content:
application/json:
examples:
Not Found:
summary: session_id desconegut
value:
detail: Not found.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: |-
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"}'
- lang: python
label: Python
source: |-
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)
- lang: javascript
label: Node.js
source: >-
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);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.PreviewDecisionEmail(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.SessionsPreviewDecisionEmailParams{\n\tNewStatus: \"Approved\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
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);
- lang: php
label: PHP
source: >-
sessions->previewDecisionEmail('3fa85f64-5717-4562-b3fc-2c963f66afa6',
[
'new_status' => 'Approved',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
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_h
- lang: csharp
label: .NET
source: >-
using 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));
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
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.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.