Passer au contenu principal
POST
curl
L’API de lien Travel Rule destinée à l’utilisateur final de Didit émet un lien permettant à l’utilisateur de finaliser le choix de son portefeuille ou de sa contrepartie, et peut l’envoyer à l’adresse e-mail enregistrée. Envoyez {"channel": "link"} pour copier un lien, ou {"channel": "email"} pour tenter aussi l’envoi par e-mail. Si channel est omis, la valeur par défaut est link. L’e-mail utilise l’adresse enregistrée de l’utilisateur final dans Didit et la langue de sa session de vérification lorsqu’elle est disponible. Vous ne pouvez pas indiquer un destinataire arbitraire. L’API exige un accès en écriture aux transactions ainsi qu’un transfert sortant dans l’état AWAITING_COUNTERPARTY, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, UNCONFIRMED_OWNERSHIP ou ON_HOLD. Dans les autres états, elle renvoie 409. Si la transaction est inconnue ou si le transfert est absent, elle renvoie 404. La réponse contient end_user_link, expires_at, emailed_to et email_available. Un nouveau lien révoque les liens utilisateur final ouverts précédemment pour ce transfert. Ne le partagez qu’avec l’utilisateur final concerné. Lorsqu’aucune adresse e-mail enregistrée n’existe, channel: email renvoie 409 avec code: end_user_email_missing ; demandez plutôt channel: link. Si l’envoi échoue, l’API renvoie tout de même un lien utilisable, avec un emailed_to vide. email_available indique qu’une adresse existe, et non que la livraison a réussi. Pour le choix explicite de l’utilisateur lors de la création, consultez Créer une transaction et le guide Travel Rule. Pour les actions sur un transfert, consultez Mettre à jour un transfert.

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Paramètres de chemin

transaction_id
string<uuid>
requis

UUID de transaction stable attribué par Didit propriétaire du transfert.

Corps

application/json
channel
enum<string>
défaut:link

link renvoie un nouveau lien ; email tente aussi de l'envoyer à l'adresse e-mail de la fiche Didit de l'utilisateur final.

Options disponibles:
link,
email

Réponse

Réponse réussie.

Nouveau lien pour l'utilisateur final. Les liens ouverts précédemment pour ce transfert sont révoqués.

expires_at
string<date-time>
requis

Date d'expiration du lien.

emailed_to
string
requis

Destinataire lorsque l'envoi a réussi, sinon une chaîne vide. Un échec d'envoi renvoie tout de même un lien utilisable.

email_available
boolean
requis

Indique si l'utilisateur final a une adresse e-mail dans son enregistrement Didit.

Dernière modification le 12 novembre 2026