Passer au contenu principal
GET
curl
L’endpoint Get a Bank Link renvoie le statut d’un lien et, une fois celui-ci terminé, son connection_id et son check_id. Appelez-le depuis votre serveur après onSuccess ou sur bank.link.completed : ne faites jamais confiance à un identifiant de lien envoyé par un navigateur. Un lien ayant échoué renvoie un 200 avec status: failed et une error contenant un code tel que duplicate_conflict ou reduced_grant.

Autorisations

x-api-key
string
header
requis

La clé API de votre application, disponible dans Developers -> API keys de la Business Console. La clé principale a un accès complet. Une clé nommée peut être limitée : aucun accès, lecture ou écriture par ressource, restreinte à certains workflows ou à certaines 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 à cette action, ou que la requête provient d'une adresse hors de sa liste d'adresses IP ; 404 sur une route de session signifie que la session se trouve hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL des images, vidéos et 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

id
string<uuid>
requis

L'identifiant du lien.

Réponse

Le lien.

Une exécution de Bank Link pour une personne : connecter une banque ou renouveler une connexion. Confirmez vous-même un lien avec get_link : ne faites jamais confiance à un identifiant envoyé par le navigateur.

id
string<uuid>
requis

Identifiant du lien.

mode
enum<string>
requis
Options disponibles:
connect,
renew
access
enum<string>
requis
Options disponibles:
one_time,
ongoing
status
enum<string>
requis

Statut du lien. completed, cancelled, expired et failed sont des statuts définitifs.

Options disponibles:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
requis

La page hébergée vers laquelle orienter la personne. Renvoyée uniquement à la création du lien ; null lors des lectures ultérieures, car le token n'est pas stocké.

client_token
string | null
requis

Le jeton du Bank Link intégré de Didit, qui n'est pas encore disponible : ouvrez url dès aujourd'hui. Renvoyé uniquement à la création du lien ; null lors des lectures suivantes. Usage unique et de courte durée. Il ne contient aucune donnée personnelle. Ne le journalisez jamais.

expires_at
string<date-time>
requis

Quand un lien non utilisé cesse de fonctionner.

connection_id
string<uuid> | null
requis

La connexion créée ou renouvelée par ce lien, une fois que status vaut completed.

check_id
string<uuid> | null
requis

Le résultat de la comparaison de l'actionnariat de ce lien, lorsque ownership.compare a été demandé avec une valeur autre que none.

reused
boolean
requis

true lorsque le lien a été finalisé comme un renouvellement d'une connexion existante, car la personne partage déjà exactement ces comptes (duplicates: reuse). Aucun montant n'est facturé deux fois.

error
object | null
requis

Pourquoi le lien a échoué, lorsque status vaut failed. Sinon null.

quote
object
requis

Le prix d'un lien, figé à sa création. Le montant facturé est celui du devis. Les lectures ne sont jamais facturées.

vendor_data
string | null
requis

Votre référence issue de la requête.

Dernière modification le 22 novembre 2026