> ## 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 de liste des connexions bancaires : filtrer par statut et consentement

> Didit renvoie vos connexions bancaires, filtrables par statut, accès, banque, pays, références et fin de consentement.

Le endpoint List Bank Connections de Didit renvoie vos connexions bancaires, filtrées par statut, accès, banque, pays, vos propres références et date de fin du consentement.
Utilisez `consent_expires_before` pour trouver les consentements à renouveler et `end_user_reference` pour trouver les connexions d'un client.
La liste est paginée avec `cursor`.


## OpenAPI

````yaml fr/openapi-25.json GET /v3/bank/connections/
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/connections/:
    get:
      tags:
        - Bank Data
      summary: Lister les connexions bancaires
      description: "Liste les connexions de votre application, de la plus récente à la plus ancienne, avec pagination par curseur. Tous les filtres s'appliquent au sein de votre application et de votre environnement.\n\nNé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é, sinon l'appel répond `403 bank_data_access_denied`.\n\nDans cette liste, `sync.budgets` n'affiche que les budgets déjà existants\_; `GET /v3/bank/connections/{id}/` ouvre les budgets du jour."
      operationId: listBankConnections
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - active
              - renewal_required
              - paused
              - revoked
              - deleted
              - failed
          description: Uniquement les connexions ayant ce statut.
        - name: access
          in: query
          required: false
          schema:
            type: string
            enum:
              - one_time
              - ongoing
          description: Uniquement ce mode d'accès.
        - name: institution_id
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: Uniquement cette banque.
        - name: country
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: Uniquement les banques de ce pays.
        - name: vendor_data
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Uniquement les connexions ayant ce `vendor_data`.
        - name: end_user_reference
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Uniquement les connexions ayant cette `end_user.reference`.
        - name: consent_expires_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            Uniquement les connexions dont le consentement prend fin avant cette
            date et heure, par exemple pour envoyer des liens de renouvellement.
        - name: created_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Uniquement les connexions créées après cette date et heure.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Taille de page, de 1 à 500. Par défaut 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Curseur opaque issu de `next_cursor` de la page précédente.
      responses:
        '200':
          description: Une page de connexions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnectionList'
              examples:
                Page:
                  summary: Une connexion
                  value:
                    items:
                      - id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                        environment: live
                        access: ongoing
                        status: active
                        status_reason: null
                        institution:
                          id: es-banco-norte
                          name: Banco Norte
                          country: ESP
                          logo_url: https://static.example.com/banks/es-banco-norte.png
                        segment: business
                        data:
                          - accounts
                          - balances
                          - transactions
                        consent:
                          status: granted
                          version: 1
                          granted_at: '2026-11-21T12:04:11Z'
                          expires_at: '2027-05-20T12:04:11Z'
                          days_granted: 180
                          renewed_count: 0
                          scopes_requested:
                            - accounts
                            - balances
                            - transactions
                          scopes_granted:
                            - accounts
                            - balances
                            - transactions
                          accounts_granted:
                            - a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                            - c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                          renewal_action: bank_auth
                          renew_by: '2027-05-20T12:04:11Z'
                          reconfirm_by: null
                          renewable_until: null
                          retain_until: null
                          ended_at: null
                          ended_by: null
                        sync:
                          status: ok
                          initial_status: succeeded
                          initial_complete: true
                          history_complete: true
                          last_synced_at: '2026-11-21T12:04:40Z'
                          next_sync_at: '2026-11-22T06:00:00Z'
                          budgets:
                            - scope: connection
                              resource: all
                              limit: 4
                              remaining: 3
                              resets_at: '2026-11-22T00:00:00Z'
                          last_error: null
                          frequency_per_day: 1
                          live_syncs_left_today: 3
                        accounts:
                          - id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                            name: Cuenta negocio
                            type: current
                            usage: business
                            currency: EUR
                            iban_last4: '1332'
                            status: open
                          - id: c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                            name: Cuenta de ahorro
                            type: savings
                            usage: business
                            currency: EUR
                            iban_last4: '7708'
                            status: open
                        ownership:
                          compare: none
                          match: null
                          check_id: null
                          result: null
                        end_user:
                          reference: client-7731
                        manage_url: null
                        billing:
                          unit: connection_month
                          price_usd: '0.9000'
                          billed_through: '2026-11-30'
                        possible_duplicate_of: null
                        erasure: null
                        vendor_data: client-7731
                        created_at: '2026-11-21T12:03:02Z'
                        updated_at: '2026-11-21T12:04:40Z'
                    next_cursor: null
        '400':
          description: Un paramètre est invalide.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Curseur invalide
                  value:
                    code: invalid_cursor
                    message: The cursor or page token is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: cursor
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Requête invalide
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: limit
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '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/connections/?status=active&country=ESP&limit=50'
            \
              -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.list_connections()
            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.listConnections();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.ListConnections(ctx, didit.BankListConnectionsParams{})\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().listConnections();
            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->listConnections();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.bank.list_connections
            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.ListConnectionsAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankConnectionList:
      type: object
      description: Une page de connexions.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankConnection'
        next_cursor:
          type: string
          description: >-
            À transmettre comme `cursor` pour la page suivante. `null` sur la
            dernière page.
          nullable: true
      required:
        - items
        - next_cursor
    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
    BankConnection:
      type: object
      description: "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."
      properties:
        id:
          type: string
          description: Identifiant de la connexion.
          format: uuid
        environment:
          type: string
          enum:
            - live
            - sandbox
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - pending
            - active
            - renewal_required
            - paused
            - revoked
            - deleted
            - failed
          description: >-
            `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.
        status_reason:
          type: string
          enum:
            - 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
          description: >-
            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`.
          nullable: true
        institution:
          $ref: '#/components/schemas/BankInstitutionSummary'
        segment:
          type: string
          enum:
            - personal
            - business
            - null
          nullable: true
        data:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Les scopes acceptés par la personne.
        consent:
          $ref: '#/components/schemas/BankConnectionConsent'
        sync:
          $ref: '#/components/schemas/BankConnectionSync'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/BankConnectionAccountSummary'
          description: >-
            Récapitulatif de chaque compte de la connexion. Lisez le compte
            complet avec `get_account`.
        ownership:
          $ref: '#/components/schemas/BankConnectionOwnership'
        end_user:
          type: object
          properties:
            reference:
              type: string
              description: Votre identifiant pour la personne ou l'entreprise.
              nullable: true
          required:
            - reference
        manage_url:
          type: string
          description: >-
            La page d'accès propre à la personne. `null` tant que la page
            d'accès n'est pas disponible.
          nullable: true
          format: uri
        billing:
          $ref: '#/components/schemas/BankConnectionBilling'
        possible_duplicate_of:
          type: string
          description: >-
            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.
          format: uuid
          nullable: true
        erasure:
          allOf:
            - $ref: '#/components/schemas/BankConnectionErasure'
          nullable: true
          description: Défini après `delete_connection` ; sinon `null`.
        vendor_data:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - status
        - status_reason
        - created_at
        - erasure
    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
    BankInstitutionSummary:
      type: object
      description: La banque à laquelle se rattache une connexion ou un lien.
      properties:
        id:
          type: string
          description: >-
            Identifiant Didit de la banque, un slug stable. Utilisez-le comme
            `institution_id`.
          example: es-banco-norte
        name:
          type: string
          description: Le nom de la banque.
          example: Banco Norte
        country:
          type: string
          description: Pays de la banque, ISO 3166-1 alpha-3.
          pattern: ^[A-Z]{3}$
          example: ESP
        logo_url:
          type: string
          description: Logo de la banque, ou `null`.
          nullable: true
          format: uri
      required:
        - id
        - name
        - country
        - logo_url
    BankConnectionConsent:
      type: object
      description: Le consentement de la personne pour cette connexion.
      properties:
        status:
          type: string
          enum:
            - granted
            - expired
            - revocation_pending
            - revoked
            - revocation_failed
          description: >-
            `revocation_pending` jusqu'à ce que la banque confirme la
            résiliation du consentement, puis `revoked`. `revocation_failed`
            fait l'objet de nouvelles tentatives automatiques. Les récupérations
            de données auprès de la banque s'arrêtent dès qu'une révocation est
            demandée.
        version:
          type: integer
          description: >-
            Version du consentement. Un renouvellement crée la version suivante
            sur la même connexion.
        granted_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: >-
            Quand le consentement de la banque prend fin. La banque le fixe,
            dans la limite de `consent_days`.
          format: date-time
          nullable: true
        days_granted:
          type: integer
          description: Durée du consentement en jours, telle qu'accordée par la banque.
          nullable: true
        renewed_count:
          type: integer
          description: Nombre de fois où le consentement a été renouvelé.
        scopes_requested:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        scopes_granted:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        accounts_granted:
          type: array
          items:
            type: string
            format: uuid
          description: Identifiants des comptes que la personne partage.
        renewal_action:
          type: string
          enum:
            - reconfirm
            - bank_auth
            - null
          description: >-
            Fonctionnement du renouvellement : `reconfirm` correspond à la
            confirmation par la personne sur l'écran de Didit, sans connexion à
            la banque, lorsque la banque et la réglementation du pays le
            permettent. `bank_auth` correspond à une connexion à la banque.
          nullable: true
        renew_by:
          type: string
          description: >-
            La fin du consentement : renouvelez avant cette date pour éviter
            toute interruption.
          format: date-time
          nullable: true
        reconfirm_by:
          type: string
          description: >-
            Défini lorsque `renewal_action` vaut `reconfirm` : la dernière date
            limite pour reconfirmer.
          format: date-time
          nullable: true
        renewable_until:
          type: string
          description: >-
            Le dernier moment auquel la même connexion peut être réactivée après
            la fin du consentement. Passé ce délai, la personne doit se
            reconnecter. Il est égal à `retain_until`.
          format: date-time
          nullable: true
        retain_until:
          type: string
          description: >-
            Défini une fois l’accès terminé : durée pendant laquelle les données
            stockées restent lisibles, selon le paramètre de conservation de
            votre application.
          format: date-time
          nullable: true
        ended_at:
          type: string
          format: date-time
          nullable: true
        ended_by:
          type: string
          enum:
            - end_user
            - bank
            - customer
            - unknown
            - null
          description: >-
            Qui a mis fin à l'accès, déterminé à partir des éléments
            disponibles. `unknown` lorsque ni la banque ni la synchronisation ne
            l'indiquent.
          nullable: true
      required:
        - status
        - version
        - granted_at
        - expires_at
        - days_granted
        - renewed_count
        - scopes_requested
        - scopes_granted
        - accounts_granted
        - renewal_action
        - renew_by
        - reconfirm_by
        - renewable_until
        - retain_until
        - ended_at
        - ended_by
    BankConnectionSync:
      type: object
      description: État de synchronisation d'une connexion.
      properties:
        status:
          type: string
          enum:
            - pending
            - ok
            - failing
          description: >-
            `failing` après 24 heures de tentatives échouées, relancées avec un
            délai croissant. Une banque qui demande à la personne de se
            reconnecter place la connexion en `renewal_required` à la place.
        initial_status:
          type: string
          enum:
            - pending
            - succeeded
            - partial
            - failed
          description: >-
            Résultat de la première synchronisation. La connexion passe à
            `active` en cas de `succeeded` ou `partial`, et à `failed`
            lorsqu'aucun compte n'a réussi.
        initial_complete:
          type: boolean
          description: "`true` uniquement lorsque `initial_status` vaut `succeeded` :\_les comptes, les soldes et les transactions récentes sont lisibles."
        history_complete:
          type: boolean
          description: >-
            `true` lorsque la reprise de l'historique s'est terminée, quelle
            qu'en soit la raison. Les plages qui n'ont pas pu être récupérées
            figurent dans `history_coverage.missing_ranges` de chaque compte.
        last_synced_at:
          type: string
          description: >-
            Quand les données ont été récupérées pour la dernière fois auprès de
            la banque, et non quand vous les avez lues pour la dernière fois.
          format: date-time
          nullable: true
        next_sync_at:
          type: string
          description: >-
            Quand la prochaine synchronisation automatique est prévue. La
            synchronisation automatique s'exécute entre une et quatre fois par
            jour selon la banque (voir `frequency_per_day`).
          format: date-time
          nullable: true
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncBudget'
          description: >-
            Les limites de la banque pour les récupérations effectuées sans la
            présence de la personne.
        last_error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: La dernière erreur de synchronisation, ou `null`.
        frequency_per_day:
          type: integer
          minimum: 1
          maximum: 4
          description: >-
            Nombre de fois par jour où la synchronisation automatique s'exécute
            pour cette connexion, entre une et quatre selon la banque. Lorsque
            la banque autorise davantage de lectures sans surveillance, au moins
            deux par jour restent toujours réservées aux synchronisations en
            direct.
        live_syncs_left_today:
          type: integer
          minimum: 0
          description: >-
            Nombre de synchronisations en direct (`refresh_connection`) encore
            disponibles aujourd'hui dans la limite de la banque : le `remaining`
            du budget le plus contraint. `null` lorsque la banque ne fixe aucune
            limite. Les synchronisations en direct sont incluses dans le prix
            mensuel.
          nullable: true
      required:
        - status
        - initial_status
        - initial_complete
        - history_complete
        - last_synced_at
        - next_sync_at
        - budgets
        - last_error
        - frequency_per_day
        - live_syncs_left_today
    BankConnectionAccountSummary:
      type: object
      description: Forme courte d’un compte au sein d’une connexion.
      properties:
        id:
          type: string
          description: >-
            Identifiant du compte. Stable pendant toute la durée de vie de la
            connexion, renouvellements inclus.
          format: uuid
        name:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - current
            - savings
            - card
            - loan
            - investment
            - other
        usage:
          type: string
          enum:
            - personal
            - business
            - unknown
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Code de devise ISO 4217.
        iban_last4:
          type: string
          description: >-
            Quatre derniers caractères de l'IBAN, lorsque le compte en possède
            un.
          nullable: true
        status:
          type: string
          enum:
            - open
            - closed
            - access_removed
      required:
        - id
        - name
        - type
        - usage
        - currency
        - iban_last4
        - status
    BankConnectionOwnership:
      type: object
      description: >-
        La comparaison facultative du titulaire du compte avec une personne ou
        une entreprise.
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
        match:
          type: string
          enum:
            - any_holder
            - all_holders
            - null
          nullable: true
        check_id:
          type: string
          description: >-
            Identifiant du résultat d'actionnariat lorsqu'une comparaison a été
            demandée.
          format: uuid
          nullable: true
        result:
          type: string
          enum:
            - match
            - close_match
            - no_match
            - unknown
            - null
          description: >-
            Verdict. `unknown` lorsqu'un justificatif manquant du titulaire
            pourrait le modifier, et lorsque la banque ne partage aucun
            titulaire.
          nullable: true
      required:
        - compare
        - match
        - check_id
        - result
    BankConnectionBilling:
      type: object
      description: Ce que coûte cette connexion. Le sandbox n'est jamais facturé.
      properties:
        unit:
          type: string
          description: >-
            Unité de facturation, `connection_month` pour l'accès continu,
            `one_time` sinon.
          enum:
            - connection_month
            - one_time
        price_usd:
          type: string
          description: >-
            Votre prix pour le compteur mensuel à la date du jour, pour votre
            application et le pays, en USD, sous forme de chaîne décimale à 4
            décimales. Une connexion n'est facturée pour un mois que si chaque
            périmètre accepté a publié des données pour au moins un compte
            durant ce mois. `null` pour les connexions ponctuelles et dans le
            sandbox. L'accès continu est facturé par connexion active et par
            mois ; le prix actuel figure sur la page Tarifs
            (https://docs.didit.me/getting-started/pricing). Les montants des
            exemples sont illustratifs ; le prix pour un pays figure sur la page
            Tarifs.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        billed_through:
          type: string
          description: La dernière fin de mois déjà clôturée.
          format: date
          nullable: true
      required:
        - unit
        - price_usd
        - billed_through
    BankConnectionErasure:
      type: object
      description: Progression d'une suppression que vous avez demandée.
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            `pending` pendant l'exécution de la suppression, `erased` lorsqu'il
            ne reste ni copie stockée ni accès auprès de la banque, `failed`
            lorsqu'elle n'a pas pu être confirmée dans les 24 heures. Une
            suppression en échec maintient les données de la connexion
            inaccessibles, est réessayée, et Didit est alerté.
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quand la suppression s'est achevée. `null` tant que `status` n'est
            pas `erased`.
      required:
        - status
        - requested_at
        - erased_at
    BankSyncBudget:
      type: object
      description: >-
        Une tranche de la limite de la banque sur les récupérations effectuées
        sans la présence de la personne.
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: Ce à quoi la banque impute le budget.
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: Le compte, lorsque `scope` vaut `account`.
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            Nombre de fois par jour où Didit peut interroger la banque en
            l'absence de la personne, selon la définition de la banque. Il
            s'agit d'un plafond fixé par la banque, et non d'une garantie.
        remaining:
          type: integer
          description: >-
            Lectures restantes pour vos actualisations dans la fenêtre en cours.
            Les lectures réservées aux synchronisations automatiques sont déjà
            déduites, et une synchronisation automatique ne prend jamais les
            deux dernières lectures de la journée, afin que deux actualisations
            à la demande restent toujours disponibles.
        resets_at:
          type: string
          description: Quand la fenêtre se réinitialise.
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncError:
      type: object
      description: Pourquoi une synchronisation a échoué.
      properties:
        code:
          type: string
          description: Code d'erreur Didit.
        message:
          type: string
          description: Explication en langage clair.
        at:
          type: string
          description: Quand l'événement s'est produit. `null` sur un résultat par compte.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  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.