Passer au contenu principal
GET
curl
L’endpoint Get a Bank Connection de Didit renvoie une connexion avec son statut, ses dates de consentement, son état de synchronisation, les résumés de ses comptes et son coût. sync.initial_status indique à partir de quand les premières données sont lisibles, consent.expires_at indique quand renouveler le consentement, et sync.budgets indique combien de rafraîchissements la banque autorise encore. Voir Connexions.

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 de la connexion.

Réponse

La connexion.

L'autorisation accordée par la personne à votre application pour lire une banque. Un renouvellement conserve l'identifiant de connexion et tous les identifiants de compte. Une connexion supprimée ne renvoie que id, status, status_reason, created_at et erasure : tous les autres champs sont absents, et aucune donnée de banque, de personne ou de compte n'y subsiste.

id
string<uuid>
requis

Identifiant de la connexion.

status
enum<string>
requis

pending : première synchronisation en cours. active : consentement valide. renewal_required : le consentement a pris fin ou la banque demande à la personne de se reconnecter ; les données restent lisibles telles que synchronisées en dernier et rien n'est facturé. paused : solde insuffisant pour le mois. revoked : accès interrompu par la personne, la banque ou vous. deleted : seuls id, status, status_reason, created_at et erasure subsistent. failed : la première synchronisation n'a jamais réussi.

Options disponibles:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
requis

Pourquoi la connexion se trouve dans ce statut. paused_by_customer est réservé. Pour une connexion deleted : deleted_by_customer, consent_lapsed, retention_elapsed ou application_deleted.

Options disponibles:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
requis

Défini après delete_connection ; sinon null.

created_at
string<date-time>
requis
environment
enum<string>
Options disponibles:
live,
sandbox
access
enum<string>
Options disponibles:
one_time,
ongoing
institution
object

La banque à laquelle se rattache une connexion ou un lien.

segment
enum<string> | null
Options disponibles:
personal,
business,
null
data
enum<string>[]

Les scopes acceptés par la personne.

Options disponibles:
accounts,
balances,
transactions

Le consentement de la personne pour cette connexion.

sync
object

État de synchronisation d'une connexion.

accounts
object[]

Récapitulatif de chaque compte de la connexion. Lisez le compte complet avec get_account.

ownership
object

La comparaison facultative du titulaire du compte avec une personne ou une entreprise.

end_user
object
manage_url
string<uri> | null

La page d'accès propre à la personne. null tant que la page d'accès n'est pas disponible.

billing
object

Ce que coûte cette connexion. Le sandbox n'est jamais facturé.

possible_duplicate_of
string<uuid> | null

Défini lorsque cette connexion peut en dupliquer une autre active, mais qu’aucun end_user.reference n’a permis d’établir une correspondance certaine.

vendor_data
string | null
updated_at
string<date-time>
Dernière modification le 22 novembre 2026