Pular para o conteúdo principal
POST
Python
Visualizar a prévia não altera a sessão nem envia um e-mail. Depois de analisar a resposta, confirme com Update Session Status e passe o preview_token retornado como email_preview_token. O comprovante expira após 15 minutos. Um comprovante alterado ou expirado retorna 409 antes que a sessão seja alterada ou que um e-mail seja enviado. Gere uma nova prévia após um conflito. As integrações de API existentes podem omitir o comprovante. O console o fornece ao confirmar uma prévia. O remetente e a identidade visual seguem a sua configuração de marca branca existente. O conteúdo da mensagem vem do modelo de verificação traduzido. Assuntos, corpos de mensagem e URLs de ação arbitrários não são aceitos como entradas do modelo.

Quem recebe o e-mail

email_address é opcional. Sem ele, o 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, se não houver, o informado em contact_details quando a sessão foi criada. Um endereço que você passa em email_address tem prioridade. recipient_source indica qual endereço se aplica:

Se o e-mail é enviado

will_be_sent é true quando, ao confirmar o reenvio com send_email: true, o e-mail é enviado. Quando é false, not_sent_reason informa o motivo:

Confirmar o reenvio

Chame Update Session Status com estes campos: O language da resposta é o idioma em que o e-mail está escrito: inglês, quando o idioma solicitado não é oferecido.

Reenvios repetidos apenas no backend

Quando todas as etapas do reenvio são executadas sem a pessoa (AML, Validação de banco de dados ou Análise de IP), uma sessão só pode ser reenviada em nome da pessoa uma vez a cada 30 segundos. Dentro desse intervalo, a prévia retorna 429, assim como Update Session Status retornaria, com o tempo de espera no cabeçalho Retry-After.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

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.

Parâmetros de caminho

sessionId
string<uuid>
obrigatório

UUID da sessão de verificação a ser atualizada. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB): o serviço resolve o ID entre os dois tipos de sessão.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Corpo

application/json
nodes_to_resubmit
object[]

Etapas a pré-visualizar, usando a mesma validação, seleção e ordem do fluxo de um reenvio. Omita para selecionar automaticamente as tentativas registradas que precisam de reenvio.

email_address
string<email>

Opcional. Envia o e-mail para este endereço em vez do endereço da própria pessoa. Sem ele, o destinatário é o endereço que a pessoa verificou no fluxo ou, na ausência dele, o informado em contact_details. Nenhum e-mail é enviado por esta chamada.

Exemplo:

"user@example.com"

email_language
string
padrão:en

Idioma do e-mail de notificação. Aceita qualquer string no nível do schema; códigos não suportados passam a usar inglês (en) sem aviso.

Exemplo:

"en"

Resposta

Somente pré-visualização. A sessão não é alterada e nenhum e-mail é enviado.

recipient
string
obrigatório

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.

Exemplo:

"person@example.com"

recipient_source
enum<string>
obrigatório

A origem de recipient. request: o email_address que você enviou. 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.

Opções disponíveis:
email_verification,
contact_details,
request,
Exemplo:

"email_verification"

sender
string
obrigatório

O cabeçalho From com o qual o e-mail é enviado.

Exemplo:

"Example App <no-reply@mail.example.com>"

sender_name
string
obrigatório

A parte do nome de exibição de sender.

Exemplo:

"Example App"

sender_email
string<email>
obrigatório

A parte de endereço de sender.

Exemplo:

"no-reply@mail.example.com"

sender_kind
enum<string>
obrigatório

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.

Opções disponíveis:
customer,
didit
Exemplo:

"customer"

subject
string
obrigatório

A linha de assunto exatamente como é enviada.

Exemplo:

"Action Required: Complete your verification in Example App"

html
string
obrigatório

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.

Exemplo:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
obrigatório

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).

Exemplo:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

language
string
obrigatório

O idioma em que o e-mail está escrito. Inglês (en) quando o email_language solicitado não é oferecido.

Exemplo:

"en"

will_be_sent
boolean
obrigatório

Indica se confirmar a alteração com send_email: true envia este e-mail. false quando not_sent_reason está definido.

Exemplo:

true

not_sent_reason
enum<string> | null
obrigatório

Por que a confirmação não enviaria nenhum e-mail, ou null quando ele será enviado. no_user_action: todas as etapas selecionadas são executadas sem a pessoa, então o reenvio é concluído sozinho e nenhum e-mail é enviado. no_recipient: nenhum endereço é conhecido para a pessoa e você não informou nenhum. sandbox: uma sessão sandbox cujo destinatário não ativou a entrega de e-mails no sandbox, então o envio é apenas simulado.

Opções disponíveis:
no_user_action,
no_recipient,
sandbox,
null
Exemplo:

null

nodes_to_resubmit
object[]
obrigatório
requires_user_action
boolean
obrigatório

Indica se pelo menos uma verificação selecionada exige interação do usuário. Isso não prevê o resultado final do fluxo.

preview_token
string
obrigatório

Recibo assinado para este e-mail exato, válido por 15 minutos. Passe-o como email_preview_token para Atualizar status da sessão. Uma string vazia quando não há destinatário.

Exemplo:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

Última modificação em 1 de novembro de 2026