> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API pour consulter un lien bancaire : statut et connection_id

> L'endpoint Get a Bank Link de Didit renvoie le statut d'un lien et, une fois terminé, ses connection_id et check_id.

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`.


## OpenAPI

````yaml fr/openapi-25.json GET /v3/bank/links/{id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, connexions, comptes, soldes, transactions, établissements et
      couverture. Les données bancaires sont disponibles pour les applications
      en sandbox. Les appels d'une application en production renvoient `404`
      tant que l'accès en production n'est pas annoncé. Rien n'est facturé en
      sandbox. Un appel effectué avec une clé API doit utiliser une clé qui
      porte l'autorisation Données bancaires (`bank-data`) : lecture pour les
      lectures, écriture pour les opérations qui modifient quelque chose. La
      vérification de compte fait exception : elle nécessite un accès en
      écriture aux sessions, ou un accès complet, et non l'autorisation Données
      bancaires. Les données bancaires ne font pas partie de l'accès complet :
      une clé à accès complet est refusée, et l'appel renvoie `403
      bank_data_access_denied` tant que vous n'avez pas créé une clé portant
      cette autorisation. Une requête qui ne porte aucune clé API est également
      refusée pour les données bancaires brutes (comptes, soldes, transactions
      et flux des modifications).


      Chaque refus sous `/v3/bank/`, sauf celui de la vérification de compte, a
      le même corps JSON (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Un chemin qui n'est pas une opération, un
      identifiant qui n'est pas un UUID ou une sous-ressource inconnue renvoie
      `404 not_found` quelle que soit la méthode, et toute erreur inattendue
      renvoie `500 internal_error` avec un `request_id`. Lorsque les données
      bancaires ne sont pas disponibles, chaque opération renvoie le `404`
      standard de la plateforme, exactement comme une route inconnue.
paths:
  /v3/bank/links/{id}/:
    get:
      tags:
        - Bank Data
      summary: Obtenir un lien bancaire
      description: >-
        Renvoie le statut d’un lien et, une fois qu’il est `completed`, son
        `connection_id` et son `check_id`. C’est la réponse de référence :
        appelez-le depuis votre serveur après que le navigateur a signalé le
        succès, ou sur le webhook `bank.link.completed`.


        Un lien en échec ne renvoie pas d’erreur HTTP : il renvoie `200` avec
        `status: failed` et un objet `error`, par exemple `duplicate_conflict`
        avec `conflicts_with`. `url` et `client_token` ne sont renvoyés qu’à la
        création du lien.


        Nécessite une clé API avec l’autorisation Bank data (`bank-data`) :
        lecture pour cette opération. Une clé à accès complet ne l’inclut pas :
        accordez-la explicitement lors de la création de la clé, faute de quoi
        l’appel répond `403 bank_data_access_denied`.
      operationId: getBankLink
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: L'identifiant du lien.
      responses:
        '200':
          description: Le lien.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Completed:
                  summary: Un lien finalisé
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: completed
                    url: null
                    client_token: null
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    check_id: null
                    reused: false
                    error: null
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
                Failed with a duplicate:
                  summary: >-
                    Un lien qui a échoué parce que la personne partage déjà ces
                    comptes
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: failed
                    url: null
                    client_token: null
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: null
                    check_id: null
                    reused: false
                    error:
                      code: duplicate_conflict
                      message: >-
                        The person already shares some of these accounts through
                        another connection.
                      conflicts_with:
                        - 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: >-
            La ressource n'existe pas dans cette application et cet
            environnement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Introuvable
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/links/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.get_link(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.bank.getLink("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.GetLink(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().getLink("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->bank->getLink('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.bank.get_link("11111111-2222-3333-4444-555555555555")
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Bank.GetLinkAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankLink:
      type: object
      description: "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."
      properties:
        id:
          type: string
          description: Identifiant du lien.
          format: uuid
        mode:
          type: string
          enum:
            - connect
            - renew
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - created
            - opened
            - connecting
            - completed
            - cancelled
            - expired
            - failed
          description: >-
            Statut du lien. `completed`, `cancelled`, `expired` et `failed` sont
            des statuts définitifs.
        url:
          type: string
          description: >-
            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é.
          nullable: true
          format: uri
        client_token:
          type: string
          description: "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."
          nullable: true
        expires_at:
          type: string
          description: Quand un lien non utilisé cesse de fonctionner.
          format: date-time
        connection_id:
          type: string
          description: >-
            La connexion créée ou renouvelée par ce lien, une fois que `status`
            vaut `completed`.
          format: uuid
          nullable: true
        check_id:
          type: string
          description: >-
            Le résultat de la comparaison de l'actionnariat de ce lien, lorsque
            `ownership.compare` a été demandé avec une valeur autre que `none`.
          format: uuid
          nullable: true
        reused:
          type: boolean
          description: >-
            `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:
          allOf:
            - $ref: '#/components/schemas/BankLinkError'
          nullable: true
          description: >-
            Pourquoi le lien a échoué, lorsque `status` vaut `failed`. Sinon
            `null`.
        quote:
          $ref: '#/components/schemas/BankLinkQuote'
        vendor_data:
          type: string
          description: Votre référence issue de la requête.
          nullable: true
      required:
        - id
        - mode
        - access
        - status
        - url
        - client_token
        - expires_at
        - connection_id
        - check_id
        - reused
        - error
        - quote
        - vendor_data
    BankDataError:
      type: object
      description: >-
        Corps d'erreur de toutes les opérations sur les données bancaires.
        Chaque champ est toujours présent.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Code d'erreur lisible par machine. Fondez votre logique sur ce code,
            jamais sur `message`.
        message:
          type: string
          description: "Explication en langage clair pour un développeur. Le libellé peut changer\_; ne l'analysez pas."
        request_id:
          type: string
          description: >-
            Identifiant de cette requête. Indiquez-le lorsque vous contactez le
            support.
        field:
          type: string
          description: >-
            Le champ de la requête à corriger, lorsque l'erreur concerne un seul
            champ. Sinon `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            La prochaine étape à suivre, pour qu'un client puisse agir sans
            deviner. `null` lorsqu'il n'existe pas d'étape suivante standard.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Secondes à attendre avant de réessayer. Défini pour les erreurs de
            limite de débit et les erreurs temporaires, sinon `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankLinkError:
      type: object
      description: >-
        La raison pour laquelle un lien s'est terminé en `failed`. Rien n'a été
        publié ni facturé.
      properties:
        code:
          type: string
          enum:
            - duplicate_conflict
            - renewal_login_mismatch
            - reduced_grant
            - corporate_approval_not_supported
            - ongoing_access_not_available
            - bank_unavailable
            - bank_cancelled
            - consent_declined
            - read_limit
            - renewal_not_needed
            - renewal_window_expired
            - first_sync_failed
          description: >-
            Pourquoi le lien a échoué. Un lien en échec n'est pas une erreur
            HTTP : le lien est renvoyé avec `status: failed` et cet objet. Un
            lien de renouvellement dont la connexion a entre-temps changé
            renvoie `renewal_not_needed` ou `renewal_window_expired`.
        message:
          type: string
          description: Explication en langage clair pour un développeur.
        conflicts_with:
          type: array
          nullable: true
          items:
            type: string
            format: uuid
          description: >-
            Avec `duplicate_conflict` : les identifiants des connexions actives
            qui se chevauchent. Renouvelez l'une d'elles, ou créez à nouveau le
            lien avec `duplicates: allow`.
      required:
        - code
        - message
        - conflicts_with
    BankLinkQuote:
      type: object
      description: >-
        Le prix d'un lien, figé à sa création. Le montant facturé est celui du
        devis. Les lectures ne sont jamais facturées.
      properties:
        id:
          type: string
          description: Identifiant du devis.
          format: uuid
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: Les lignes facturées par ce lien, pour les périmètres demandés.
        fallback_lines:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Coût d'un repli ponctuel, uniquement lorsque le lien a été créé avec
            `allow_one_time_fallback`. Il figure dans la réponse de création,
            sinon il vaut `null`. Une lecture ponctuelle avec données peut
            coûter plus cher qu'un premier mois d'accès continu.
        total_usd:
          type: string
          description: "Total des `lines` en USD. Le total ne peut que baisser\_: avec une autorisation réduite, ou lorsque la personne choisit un pays au tarif plus bas."
          pattern: ^-?\d+(\.\d+)?$
        valid_until:
          type: string
          description: >-
            Le devis est rattaché au lien, reste valide pendant toute sa durée
            de vie et est donc égal à `expires_at`.
          format: date-time
        scopes:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: >-
            Les données délimitent le périmètre sur lequel portent les prix du
            devis.
      required:
        - id
        - lines
        - fallback_lines
        - total_usd
        - valid_until
        - scopes
    RateLimitBudgetError:
      type: object
      description: >-
        Renvoyé uniquement pour un refus de quota du middleware lié à la limite
        de débit. Les autres erreurs 429, y compris les conflits d'idempotence
        et les plafonds propres à chaque endpoint, ne garantissent pas ces
        champs de métadonnées.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Message lisible de refus de budget existant.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: "Référence de support opaque\_: RL- suivi de 32 caractères hexadécimaux minuscules d'un UUID."
        limit:
          type: integer
          description: Budget du périmètre dépassé ; égal à X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Budget restant, ramené à zéro ; égal à X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Heure de réinitialisation de la fenêtre en secondes Unix ; égale à
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Durée de la fenêtre fixe en secondes, et non le temps d'attente
            restant. Respectez Retry-After avant de réessayer.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    BankLinkQuoteLine:
      type: object
      description: Une ligne chiffrée d'un devis.
      properties:
        meter:
          type: string
          description: >-
            Ce qui est facturé, par exemple `bank_data_connection_month`,
            `bank_verification`.
          example: bank_data_connection_month
        unit:
          type: string
          description: >-
            Ce que représente une unité, par exemple `connection_month` ou
            `completed_sign_in`.
          example: connection_month
        price_usd:
          type: string
          description: "Prix d'une unité en USD, sous forme de chaîne décimale à 4 décimales. Les montants des exemples sont indicatifs\_; le prix applicable à un pays figure sur la page Tarifs."
          pattern: ^-?\d+(\.\d+)?$
          example: '0.9000'
      required:
        - meter
        - unit
        - price_usd
  responses:
    Unauthorized:
      description: Non autorisé
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Clé API invalide
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        La clé API ne dispose pas de l'autorisation Bank data (`bank-data`) ou,
        pour les données bancaires brutes d'une application en production, le
        paramètre d'application « Bank data in the API » est désactivé. Les
        données bancaires ne font pas partie de l'accès complet : une clé à
        accès complet, une clé limitée à d'autres ressources et une requête
        authentifiée sans clé API (identifiants client, pour les données brutes)
        sont toutes refusées avec ce corps de réponse. Créez donc une clé et
        accordez-lui explicitement l'autorisation. Ce refus intervient avant
        toute recherche : il ne dit donc rien de l'existence d'un objet.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Données bancaires non autorisées
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        Dépassement du budget de lecture du middleware. Respectez Retry-After
        avant de réessayer.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Un problème s’est produit côté Didit. Toute erreur inattendue sous
        `/v3/bank/` répond dans le format d’erreur Bank, jamais par une page
        HTML : indiquez `request_id` au support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Une erreur inattendue
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        Nombre de secondes à attendre, arrondi à la fenêtre suivante. Présent
        sur les refus liés au quota du middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        Le périmètre dont le quota a été dépassé. Présent sur les refus liés au
        quota du middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Budget du périmètre dépassé ; égal à la limite du corps. Présent sur les
        refus de budget du middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Budget restant, ramené à zéro ; égal à remaining du corps. Présent lors
        des refus liés au budget du middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Heure de réinitialisation en secondes Unix ; égale à reset dans le
        corps. Présent sur les refus liés au quota du middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: "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."

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.