Saltar para o conteúdo principal
POST
Python
A pré-visualização não altera a sessão nem envia um e-mail. Depois de analisar a resposta, confirme com Atualizar estado da sessão e passe o preview_token devolvido como email_preview_token. O comprovativo expira após 15 minutos. Um comprovativo alterado ou expirado devolve 409 antes de a sessão ser alterada ou de um e-mail ser enviado. Gere uma nova pré-visualização após um conflito. As integrações de API existentes podem omitir o comprovativo; a consola fornece-o ao confirmar uma pré-visualização. O remetente e a identidade visual seguem a sua configuração de marca branca. O conteúdo da mensagem vem do modelo de verificação traduzido; não são aceites como entradas do modelo assuntos, corpos de mensagem nem URLs de ação arbitrários.

Quem recebe o e-mail

email_address é opcional. Sem este campo, o e-mail é enviado para o endereço da própria pessoa: o que verificou num passo de verificação de e-mail do fluxo, ou então o indicado em contact_details quando a sessão foi criada. Um endereço indicado em email_address tem prioridade. recipient_source indica qual o endereço que se aplica:

Se o e-mail é enviado ou não

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

Confirmar o reenvio

Chame Atualizar estado da sessão com estes campos: O language da resposta é o idioma em que o e-mail é escrito: inglês, quando o idioma pedido não está disponível.

Reenvios repetidos apenas pelo backend

Quando todos os passos que vão ser reenviados são executados sem a pessoa (AML, Validação de base de dados ou Análise de IP), uma sessão só pode ser reenviada em nome dela uma vez a cada 30 segundos. Dentro dessa janela, a pré-visualização devolve 429, tal como aconteceria em Atualizar estado da sessão, com o tempo de espera no cabeçalho Retry-After.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. 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 atualizar. Aceita IDs de sessão de utilizador (KYC) e de empresa (KYB) — o serviço resolve o ID em ambos os tipos de sessão.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Corpo

application/json
nodes_to_resubmit
object[]

Passos a pré-visualizar, utilizando a mesma validação, seleção e ordenação do fluxo de um reenvio. Omita para selecionar automaticamente tentativas registadas que necessitem de reenvio.

email_address
string<email>

Opcional. Envie o e-mail para este endereço em vez do da própria pessoa. Sem este campo, o destinatário é o endereço que a pessoa verificou no fluxo ou, na sua ausência, o fornecido 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 cadeia de caracteres ao nível do esquema; códigos não suportados revertem silenciosamente para inglês (en).

Exemplo:

"en"

Resposta

Apenas pré-visualização. A sessão permanece inalterada e nenhum e-mail é enviado.

recipient
string
obrigatório

O endereço para o qual o e-mail é enviado. Uma string vazia quando não se conhece qualquer endereço para a pessoa: nesse caso, nenhum e-mail pode ser enviado e preview_token fica também vazio. Passe-o como email_address quando confirmar.

Exemplo:

"person@example.com"

recipient_source
enum<string>
obrigatório

De onde provém recipient. request: o email_address que passou. email_verification: o endereço que a pessoa verificou num passo de verificação de e-mail do fluxo. contact_details: o endereço fornecido em contact_details aquando da criação da sessão. Uma string vazia quando não existir 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 apresentação de sender.

Exemplo:

"Example App"

sender_email
string<email>
obrigatório

A parte da morada de sender.

Exemplo:

"no-reply@mail.example.com"

sender_kind
enum<string>
obrigatório

customer: o e-mail sai a partir do domínio de remetente verificado da sua aplicação (marca branca). didit: sai a partir do remetente próprio da 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 respetivo logótipo incorporado como data URL. Renderize-o numa frame isolada (sandbox), nunca diretamente no DOM da sua aplicação.

Exemplo:

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

text
string
obrigatório

O texto simples do e-mail, tal como o histórico de Mensagens da pessoa o guarda, para uma pré-visualização compacta (o HTML continua a ser 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 estiver disponível.

Exemplo:

"en"

will_be_sent
boolean
obrigatório

Se confirmar a alteração com send_email: true envia este e-mail. false quando not_sent_reason estiver definido.

Exemplo:

true

not_sent_reason
enum<string> | null
obrigatório

O motivo pelo qual a confirmação não enviaria nenhum e-mail, ou null quando será enviado. no_user_action: todos os passos selecionados são executados sem a pessoa, pelo que o novo envio é concluído de forma autónoma e nenhum e-mail é enviado. no_recipient: nenhum endereço é conhecido para a pessoa e você não transmitiu nenhum. sandbox: uma sessão de sandbox cujo destinatário não aceitou a entrega de e-mails em sandbox, pelo que 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

Se pelo menos uma das verificações selecionadas requer a interação do utilizador. Isto 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 estado da sessão. Uma string vazia quando não há destinatário.

Exemplo:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

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