Pular para o conteúdo principal
POST
curl
A API de link de usuário final da Travel Rule da Didit emite um link para que o usuário escolha a carteira ou a contraparte, e pode enviá-lo por e-mail ao endereço registrado. Envie {"channel": "link"} para copiar um link, ou {"channel": "email"} para também tentar o envio por e-mail. Se channel for omitido, o padrão é link. O e-mail usa o endereço do usuário final registrado na Didit e o idioma da sessão de verificação, quando disponível. Não é possível informar um destinatário arbitrário. A API exige acesso de gravação a transações e a uma transferência de saída nos estados AWAITING_COUNTERPARTY, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, UNCONFIRMED_OWNERSHIP ou ON_HOLD. Em outros estados, a resposta é 409. Uma transação desconhecida ou uma transferência inexistente retorna 404. A resposta contém end_user_link, expires_at, emailed_to e email_available. Um novo link revoga os links de usuário final abertos anteriormente para essa transferência. Compartilhe-o somente com o usuário final pretendido. Quando não existe e-mail registrado, channel: email retorna 409 com code: end_user_email_missing. Nesse caso, solicite channel: link. Se o envio falhar, a API ainda retorna um link utilizável, com emailed_to vazio. email_available indica que existe um endereço, não que a entrega foi bem-sucedida. Para a escolha explícita do usuário durante a criação, consulte Criar uma transação e o guia da Travel Rule. Para ações sobre a transferência, consulte Atualizar uma transferência.

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

transaction_id
string<uuid>
obrigatório

UUID estável da transação na Didit à qual a transferência pertence.

Corpo

application/json
channel
enum<string>
padrão:link

link retorna um novo link; email também tenta enviá-lo para o e-mail do registro do usuário final na Didit.

Opções disponíveis:
link,
email

Resposta

Resposta bem-sucedida.

Novo link para o usuário final. Os links abertos anteriores desta transferência são revogados.

expires_at
string<date-time>
obrigatório

Expiração do link.

emailed_to
string
obrigatório

Destinatário quando o envio foi bem-sucedido; caso contrário, uma string vazia. Uma falha no e-mail ainda retorna um link utilizável.

email_available
boolean
obrigatório

Se o usuário final tem um e-mail no seu registro da Didit.

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