> ## 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.
# API de prévia do e-mail de decisão: aprovado e recusado
> Veja no Didit o e-mail de Aprovado ou Recusado que a pessoa recebe, com destinatário, remetente e idioma, antes de alterar o status da sessão.
Prompt para pré-visualizar o e-mail de decisão
Copiar o prompt para a área de transferência
\
\`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.`
\
Colar em
A pré-visualização não altera nada e não envia nada.
A resposta mostra o e-mail exatamente como a pessoa o recebe quando você define a sessão como `Approved` ou `Declined` com `send_email: true`.
Ela também informa quem recebe o e-mail, quem o envia e se a confirmação de fato o envia.## Quem recebe o e-mailO e-mail vai para o próprio endereço da pessoa: o que ela verificou em uma etapa de verificação de e-mail do fluxo ou, caso contrário, o informado em `contact_details` quando a sessão foi criada.
`recipient_source` indica qual deles se aplica (`email_verification` ou `contact_details`).
Quando a sessão não tem endereço para a pessoa, `recipient`, `recipient_source` e `preview_token` são strings vazias e nenhum e-mail pode ser enviado.O e-mail é enviado a partir do domínio de remetente verificado da sua aplicação quando sua [configuração de marca própria](https://docs.didit.me/pt-br/console/white-label.md) se aplica (`sender_kind: customer`) ou, caso contrário, a partir do remetente da Didit (`sender_kind: didit`).## Se o e-mail será enviado`will_be_sent` é `true` quando a confirmação da alteração com `send_email: true` envia o e-mail.
Quando é `false`, `not_sent_reason` informa o motivo:| `not_sent_reason` | O que significa |
| - | - |
| `status_unchanged` | A sessão já tem esse status, então a atualização não altera nada e não envia nada. |
| `notification_emails_disabled` | A sessão foi criada sem `contact_details.send_notification_emails: true`, então nenhum e-mail de decisão é enviado para o endereço informado em `contact_details`. |
| `no_recipient` | Não há endereço conhecido para a pessoa. |
| `sandbox` | A sessão é de sandbox e o destinatário não optou pelo recebimento de e-mails de sandbox, então o e-mail é apenas simulado. Consulte [opt-in de e-mail](https://docs.didit.me/pt-br/integration/sandbox-testing.md#códigos-otp-e-opt-in-de-e-mail). |## Confirmar a decisãoChame [Update Session Status](https://docs.didit.me/pt-br/sessions-api/update-status.md) com estes campos:| Campo de Update Session Status | Valor |
| - | - |
| `new_status` | O mesmo `new_status` que você pré-visualizou |
| `send_email` | `true` |
| `email_address` | `recipient` da pré-visualização |
| `email_language` | `language` da pré-visualização |
| `email_preview_token` | `preview_token` da pré-visualização |O comprovante expira após 15 minutos.
Se o destinatário, o idioma, o status da sessão, o remetente ou o e-mail tiverem mudado desde a pré-visualização, a atualização retorna `409` antes que qualquer coisa seja alterada.
Pré-visualize novamente e confirme com o novo comprovante.## Relacionados- [Update Session Status](https://docs.didit.me/pt-br/sessions-api/update-status.md): aprove ou recuse a sessão e envie o e-mail.
- [Preview Resubmission Email](https://docs.didit.me/pt-br/sessions-api/preview-resubmission.md): visualize o e-mail de um reenvio.
- [Marca própria](https://docs.didit.me/pt-br/console/white-label.md): o remetente e a identidade visual que o e-mail usa.
## OpenAPI
````yaml pt-br/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 verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/session/{sessionId}/decision-email-preview/:
post:
tags:
- Sessions
summary: Pré-visualizar o e-mail de decisão de uma sessão
description: >-
Renderiza o e-mail que a pessoa recebe quando você define uma sessão
como `Approved` ou `Declined` com `send_email: true`, sem alterar a
sessão nem enviar nada. A resposta mostra o assunto e o HTML exatamente
como são enviados, o destinatário, o remetente, o idioma e se a
confirmação da alteração de fato envia o e-mail (`will_be_sent`,
`not_sent_reason`).
O destinatário é o próprio endereço da pessoa: o que ela verificou em
uma etapa de verificação de e-mail do fluxo ou, caso contrário, o
informado em `contact_details` quando a sessão foi criada. O remetente é
o domínio de envio verificado da sua aplicação quando a marca própria se
aplica (`sender_kind: customer`) ou, caso contrário, o remetente da
Didit (`sender_kind: didit`).
Para enviar exatamente o que você pré-visualizou, chame [Update Session
Status](/pt-br/sessions-api/update-status) com o mesmo `new_status`,
`send_email: true`, `email_address` definido como `recipient`,
`email_language` definido como `language` e `email_preview_token`
definido como `preview_token`. O comprovante expira após 15 minutos.
Quando o destinatário, o idioma, o status da sessão, o remetente ou o
e-mail mudaram desde a pré-visualização, a atualização retorna `409`
antes que qualquer coisa seja alterada; pré-visualize novamente e
confirme com o novo comprovante.
Funciona para sessões de Verificação de usuários (KYC) e Verificação de
empresas (KYB) com status `Approved`, `Declined`, `In Review`, `Kyc
Expired`, `Abandoned` ou `Resubmitted`. A verificação de status é
executada antes da validação do corpo. Requer o privilégio
`write:sessions`; uma chave de API com escopo precisa de acesso de
escrita a decisões. As respostas usam `Cache-Control: no-store`:
trate-as como conteúdo de verificação sensível.
operationId: post_v3_session_decision_email_preview
parameters:
- in: path
name: sessionId
required: true
description: >-
UUID da sessão de verificação. Aceita IDs de sessão tanto de usuário
(KYC) quanto de 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: A decisão cujo e-mail você quer pré-visualizar.
example: Approved
email_language:
type: string
default: en
description: >-
Idioma do e-mail, com o mesmo padrão de Update Session
Status. Um idioma que não é oferecido passa a usar inglês;
`language` na resposta indica qual é usado.
example: en
examples:
Approved:
summary: Pré-visualizar o e-mail de aprovação em inglês
value:
new_status: Approved
Declined in Spanish:
summary: Pré-visualizar o e-mail de recusa em espanhol
value:
new_status: Declined
email_language: es
responses:
'200':
description: >-
Somente pré-visualização. A sessão não é alterada e nenhum e-mail é
enviado.
headers:
Cache-Control:
description: >-
Sempre `no-store`: a pré-visualização contém conteúdo da
verificação e não deve ser armazenada em cache.
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: >-
O endereço para o qual o e-mail vai. Uma string vazia
quando nenhum endereço da pessoa é conhecido. Nesse caso,
nenhum e-mail pode ser enviado e `preview_token` também
fica vazio. Envie-o como `email_address` ao confirmar.
example: person@example.com
recipient_source:
type: string
enum:
- email_verification
- contact_details
- ''
description: >-
A origem de `recipient`. `email_verification`: o endereço
que a pessoa verificou em uma etapa de verificação de
e-mail do fluxo. `contact_details`: o endereço informado
em `contact_details` quando a sessão foi criada. Uma
string vazia quando não há endereço.
example: email_verification
sender:
type: string
description: O cabeçalho `From` com o qual o e-mail é enviado.
example: Example App
sender_name:
type: string
description: A parte do nome de exibição de `sender`.
example: Example App
sender_email:
type: string
format: email
description: A parte de endereço de `sender`.
example: no-reply@mail.example.com
sender_kind:
type: string
enum:
- customer
- didit
description: >-
`customer`: o e-mail é enviado a partir do domínio de
remetente verificado da sua aplicação (marca própria).
`didit`: ele é enviado a partir do remetente da própria
Didit.
example: customer
subject:
type: string
description: A linha de assunto exatamente como é enviada.
example: Your verification has been approved in Example App
html:
type: string
description: >-
O HTML do e-mail exatamente como é enviado, com o logotipo
incorporado como data URL. Renderize-o em um frame isolado
(sandbox), nunca diretamente no DOM da sua aplicação.
example: ...
text:
type: string
description: >-
O texto do e-mail em texto simples, como a conversa de
Mensagens da pessoa o mantém, para uma pré-visualização
compacta (o HTML continua sendo o e-mail que a pessoa
recebe).
example: >-
Verification Approved
Your identity has been successfully verified with Acme
Pay. No further action is needed on your part.
language:
type: string
description: >-
O idioma em que o e-mail está escrito. Inglês (`en`)
quando o `email_language` solicitado não é oferecido.
example: en
will_be_sent:
type: boolean
description: >-
Indica se confirmar a alteração com `send_email: true`
envia este e-mail. `false` quando `not_sent_reason` está
definido.
example: true
not_sent_reason:
type: string
nullable: true
enum:
- status_unchanged
- notification_emails_disabled
- no_recipient
- sandbox
- null
description: >-
Por que a confirmação não enviaria nenhum e-mail, ou
`null` quando ele será enviado. `status_unchanged`: a
sessão já tem esse status, então a atualização não muda
nada e não envia nada. `notification_emails_disabled`: a
sessão foi criada sem
`contact_details.send_notification_emails: true`, então
nenhum e-mail de decisão é enviado ao endereço informado
em `contact_details`. `no_recipient`: nenhum endereço é
conhecido para a pessoa. `sandbox`: uma sessão sandbox
cujo destinatário não ativou a entrega de e-mails no
sandbox, então o envio é apenas simulado.
example: null
preview_token:
type: string
description: >-
Recibo assinado para este e-mail exato, válido por 15
minutos. Passe-o como `email_preview_token` para
[Atualizar status da
sessão](/pt-br/sessions-api/update-status). Uma string
vazia quando não há destinatário.
example: >-
eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000
examples:
Will Be Sent:
summary: >-
O e-mail de aprovação é enviado para o endereço verificado
no fluxo
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: Nenhum endereço é conhecido para a pessoa
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: >-
A sessão não está em um status aceito por este endpoint (`{"detail":
...}`), ou o corpo é inválido (`{"": [""]}`).
content:
application/json:
examples:
Wrong Current Status:
summary: A sessão não está em um status aceito por este endpoint
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 não é Approved nem Declined
value:
new_status:
- '"Resubmitted" is not a valid choice.'
Missing new_status:
summary: Campo obrigatório omitido
value:
new_status:
- This field is required.
'401':
description: A chave de API com escopo expirou.
content:
application/json:
examples:
Expired API Key:
summary: Chave de API com escopo após a data de validade
value:
detail: This API key has expired.
'403':
description: >-
Credenciais ausentes, um chamador sem o privilégio `write:sessions`,
uma chave de API com escopo sem o acesso de que este endpoint
precisa, ou um `session_id` que pertence a outra aplicação.
content:
application/json:
examples:
Invalid Credentials:
summary: x-api-key ausente ou inválido
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Missing Privilege:
summary: O chamador não tem write:sessions
value:
detail: You do not have permission to perform this action.
Scoped Key Without Access:
summary: Chave de API com escopo sem este acesso
value:
detail: This API key has no write access to decisions.
'404':
description: Não existe nenhuma sessão de KYC ou KYB com este `session_id`.
content:
application/json:
examples:
Not Found:
summary: session_id desconhecido
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: >-
Chave de API da sua aplicação, em Developers -> API keys no Business
Console. A chave principal tem acesso total. Uma chave nomeada pode ter
escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
uma data de validade. 401 significa que a chave está errada, revogada ou
expirada; 403 significa que nenhuma chave foi enviada, que a chave não
tem acesso a este recurso ou ação, ou que a requisição veio de um
endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
que a sessão está fora dos fluxos ou status da chave. Uma chave sem
acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
sem permissão de escrita em sessões recebe links e tokens de sessão como
null. Consulte https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.