Saltar para o conteúdo principal
POST
curl
A API de ligações para utilizadores finais da Travel Rule da Didit emite uma ligação para que o utilizador conclua a escolha da carteira ou da contraparte, e pode enviá-la por e-mail para o endereço de e-mail registado. Envie {"channel": "link"} para copiar uma ligação, ou {"channel": "email"} para também tentar a entrega por e-mail. Se omitir channel, o valor por defeito é link. O e-mail usa o endereço do utilizador final no registo da Didit e o idioma da sessão de verificação, quando disponível. Não pode indicar um destinatário arbitrário. A API requer acesso de escrita 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. Os restantes estados devolvem 409; uma transação desconhecida ou uma transferência em falta devolve 404. A resposta contém end_user_link, expires_at, emailed_to e email_available. Uma nova ligação revoga as ligações de utilizador final abertas anteriormente para essa transferência. Partilhe-a apenas com o utilizador final pretendido. Quando não existe um e-mail registado, channel: email devolve 409 com code: end_user_email_missing; em vez disso, envie channel: link. Se o envio falhar, a API continua a devolver uma ligação 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 utilizador durante a criação, veja Criar uma transação e o guia da Travel Rule. Para ações sobre transferências, veja Atualizar uma transferência.

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

transaction_id
string<uuid>
obrigatório

UUID de transação estável da Didit proprietário da transferência.

Corpo

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

link devolve uma nova ligação; email também tenta enviá-la para o e-mail do registo Didit do utilizador final.

Opções disponíveis:
link,
email

Resposta

Resposta bem-sucedida.

Nova ligação para o utilizador final. As ligações abertas anteriores desta transferência são revogadas.

expires_at
string<date-time>
obrigatório

Expiração da ligação.

emailed_to
string
obrigatório

Destinatário quando o envio foi bem-sucedido; caso contrário, uma string vazia. Uma falha no e-mail continua a devolver uma ligação utilizável.

email_available
boolean
obrigatório

Se o utilizador final tem um e-mail no seu registo Didit.

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