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

# Bankverbindungen per API auflisten: Filter nach Status und Einwilligung

> Mit Didits Endpoint Bankverbindungen auflisten: filtern nach Status, Zugriff, Bank, Land, eigenen Referenzen und Ende der Einwilligung.

Der Endpoint List Bank Connections von Didit gibt Ihre Verbindungen zurück, gefiltert nach Status, Zugriff, Bank, Land, Ihren eigenen Referenzen und dem Enddatum der Einwilligung.
Verwenden Sie `consent_expires_before`, um Einwilligungen zu finden, die erneuert werden müssen, und `end_user_reference`, um die Verbindungen eines Kunden zu finden.
Die Liste wird mit `cursor` paginiert.


## OpenAPI

````yaml de/openapi-25.json GET /v3/bank/connections/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: Identitätsverifizierungs-API. Authentifizierung mit dem x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, Verbindungen, Konten, Guthaben, Transaktionen, Institute und
      Abdeckung. Bankdaten sind für Sandbox-Anwendungen verfügbar. Aufrufe einer
      Live-Anwendung antworten mit `404`, bis der Live-Zugriff angekündigt wird.
      In der Sandbox fallen keine Kosten an. Ein Aufruf mit einem API-Schlüssel
      benötigt einen Schlüssel mit der Berechtigung für Bankdaten (`bank-data`):
      Lesezugriff für Lesevorgänge, Schreibzugriff für Operationen, die etwas
      ändern. Die Kontoprüfung ist die Ausnahme: Sie benötigt Schreibzugriff auf
      Sitzungen oder vollen Zugriff, nicht die Berechtigung für Bankdaten.
      Bankdaten sind nicht Teil des vollen Zugriffs: Ein Schlüssel mit vollem
      Zugriff wird abgelehnt, und der Aufruf antwortet mit `403
      bank_data_access_denied`, bis Sie einen Schlüssel mit dieser Berechtigung
      erstellen. Rohe Bankdaten (Konten, Guthaben, Transaktionen und der
      Änderungs-Feed) lehnen außerdem jede Anfrage ab, die keinen API-Schlüssel
      enthält.


      Jede Ablehnung unter `/v3/bank/` außer der der Kontoprüfung hat denselben
      JSON-Body (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Ein Pfad, der keine Operation ist, eine ID, die keine UUID
      ist, oder eine unbekannte Unterressource antwortet für jede Methode mit
      `404 not_found`, und jeder unerwartete Fehler antwortet mit `500
      internal_error` und einer `request_id`. Wo Bankdaten nicht verfügbar sind,
      antwortet jede Operation mit dem standardmäßigen `404` der Plattform,
      genau wie bei einer unbekannten Route.
paths:
  /v3/bank/connections/:
    get:
      tags:
        - Bank Data
      summary: Bank-Verbindungen auflisten
      description: >-
        Listet die Verbindungen Ihrer Anwendung auf, die neueste zuerst, mit
        Cursor-Paginierung. Alle Filter gelten innerhalb Ihrer Anwendung und
        Umgebung.


        Erfordert einen API-Schlüssel mit der Berechtigung Bankdaten
        (`bank-data`): Lesezugriff für diesen Vorgang. Ein Schlüssel mit vollem
        Zugriff enthält sie nicht: Erteilen Sie sie beim Erstellen des
        Schlüssels ausdrücklich, sonst antwortet der Aufruf mit `403
        bank_data_access_denied`.


        In dieser Liste zeigt `sync.budgets` nur die bereits vorhandenen
        Budgets; `GET /v3/bank/connections/{id}/` öffnet die heutigen Budgets.
      operationId: listBankConnections
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - active
              - renewal_required
              - paused
              - revoked
              - deleted
              - failed
          description: Nur Verbindungen mit diesem Status.
        - name: access
          in: query
          required: false
          schema:
            type: string
            enum:
              - one_time
              - ongoing
          description: Nur dieser Zugriffsmodus.
        - name: institution_id
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: Nur diese Bank.
        - name: country
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: Nur Banken in diesem Land.
        - name: vendor_data
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Nur Verbindungen mit diesem `vendor_data`.
        - name: end_user_reference
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Nur Verbindungen mit diesem `end_user.reference`.
        - name: consent_expires_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            Nur Verbindungen, deren Einwilligung vor diesem Zeitpunkt endet, zum
            Beispiel um Verlängerungslinks zu senden.
        - name: created_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Nur Verbindungen, die nach diesem Zeitpunkt erstellt wurden.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Seitengröße, 1 bis 500. Standard 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaker Cursor aus dem `next_cursor` der vorherigen Seite.
      responses:
        '200':
          description: Eine Seite mit Verbindungen.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnectionList'
              examples:
                Page:
                  summary: Eine Verbindung
                  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: Ein Parameter ist ungültig.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Ungültiger Cursor
                  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: Ungültige Anfrage
                  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: Eine Seite mit Verbindungen.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankConnection'
        next_cursor:
          type: string
          description: >-
            Übergeben Sie ihn als `cursor` für die nächste Seite. `null` auf der
            letzten Seite.
          nullable: true
      required:
        - items
        - next_cursor
    BankDataError:
      type: object
      description: Fehler-Body jeder Bankdaten-Operation. Jedes Feld ist immer vorhanden.
      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: >-
            Maschinenlesbarer Fehlercode. Richten Sie Ihre Logik danach aus, nie
            nach `message`.
        message:
          type: string
          description: >-
            Verständliche Erklärung für Entwickler. Der Wortlaut kann sich
            ändern; parsen Sie ihn nicht.
        request_id:
          type: string
          description: >-
            Kennung dieser Anfrage. Geben Sie sie an, wenn Sie den Support
            kontaktieren.
        field:
          type: string
          description: >-
            Das Anfragefeld, das korrigiert werden muss, wenn sich der Fehler
            auf ein einzelnes Feld bezieht. Andernfalls `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: >-
            Was als Nächstes zu tun ist, damit ein Client handeln kann, ohne zu
            raten. `null`, wenn es keinen Standardschritt gibt.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Sekunden, die vor einem Wiederholungsversuch zu warten sind. Wird
            bei Rate-Limit-Fehlern und vorübergehenden Fehlern gesetzt,
            andernfalls `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: >-
        Die Berechtigung der Person für Ihre Anwendung, die Daten einer Bank
        auszulesen. Eine Erneuerung behält die Verbindungs-ID und alle Konto-IDs
        bei. Eine gelöschte Verbindung antwortet nur mit `id`, `status`,
        `status_reason`, `created_at` und `erasure`: Alle anderen Felder fehlen,
        und es verbleiben keine Bank-, Personen- oder Kontodaten darin.
      properties:
        id:
          type: string
          description: Kennung der Verbindung.
          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`: Erste Synchronisierung läuft. `active`: Einwilligung
            gültig. `renewal_required`: Die Einwilligung ist beendet oder die
            Bank verlangt, dass sich die Person erneut anmeldet; die Daten sind
            wie zuletzt synchronisiert lesbar, und es wird nichts berechnet.
            `paused`: Guthaben für den Monat zu niedrig. `revoked`: Zugriff von
            der Person, der Bank oder Ihnen beendet. `deleted`: Nur `id`,
            `status`, `status_reason`, `created_at` und `erasure` bleiben
            erhalten. `failed`: Die erste Synchronisierung ist nie erfolgreich
            gewesen.
        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: >-
            Warum die Verbindung sich in diesem Status befindet.
            `paused_by_customer` ist reserviert. Bei einer `deleted`-Verbindung:
            `deleted_by_customer`, `consent_lapsed`, `retention_elapsed` oder
            `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: Die Scopes, die die Person akzeptiert hat.
        consent:
          $ref: '#/components/schemas/BankConnectionConsent'
        sync:
          $ref: '#/components/schemas/BankConnectionSync'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/BankConnectionAccountSummary'
          description: >-
            Übersicht aller Konten in der Verbindung. Das vollständige Konto
            lesen Sie mit `get_account`.
        ownership:
          $ref: '#/components/schemas/BankConnectionOwnership'
        end_user:
          type: object
          properties:
            reference:
              type: string
              description: Ihre ID für die Person oder das Unternehmen.
              nullable: true
          required:
            - reference
        manage_url:
          type: string
          description: >-
            Die eigene Zugriffsseite der Person. `null`, bis die Zugriffsseite
            verfügbar ist.
          nullable: true
          format: uri
        billing:
          $ref: '#/components/schemas/BankConnectionBilling'
        possible_duplicate_of:
          type: string
          description: >-
            Wird gesetzt, wenn diese Verbindung möglicherweise eine andere
            aktive Verbindung dupliziert, aber kein `end_user.reference` eine
            bestimmte Übereinstimmung zulässt.
          format: uuid
          nullable: true
        erasure:
          allOf:
            - $ref: '#/components/schemas/BankConnectionErasure'
          nullable: true
          description: Wird nach `delete_connection` gesetzt, andernfalls `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: >-
        Wird nur bei einer Ablehnung durch das Rate-Limit-Budget der Middleware
        zurückgegeben. Andere 429-Fehler, einschließlich Idempotenzkonflikten
        und endpunktspezifischer Obergrenzen, garantieren diese Metadatenfelder
        nicht.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Bestehende, für Menschen lesbare Meldung zur Budgetablehnung.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Opake Support-Referenz: RL- gefolgt von 32 hexadezimalen Zeichen der
            UUID in Kleinbuchstaben.
        limit:
          type: integer
          description: >-
            Budget für den überschrittenen Bereich; entspricht
            X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Verbleibendes Budget, auf null begrenzt. Entspricht
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Reset-Zeit des Zeitfensters in Unix-Sekunden; entspricht
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Dauer des festen Zeitfensters in Sekunden, nicht die verbleibende
            Wartezeit. Vor einem erneuten Versuch Retry-After beachten.
      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: Die Bank, für die eine Verbindung oder ein Link bestimmt ist.
      properties:
        id:
          type: string
          description: >-
            Didit-Kennung der Bank, ein stabiler Slug. Verwenden Sie sie als
            `institution_id`.
          example: es-banco-norte
        name:
          type: string
          description: Der Name der Bank.
          example: Banco Norte
        country:
          type: string
          description: Land der Bank, ISO 3166-1 alpha-3.
          pattern: ^[A-Z]{3}$
          example: ESP
        logo_url:
          type: string
          description: Logo der Bank oder `null`.
          nullable: true
          format: uri
      required:
        - id
        - name
        - country
        - logo_url
    BankConnectionConsent:
      type: object
      description: Die Einwilligung der Person für diese Verbindung.
      properties:
        status:
          type: string
          enum:
            - granted
            - expired
            - revocation_pending
            - revoked
            - revocation_failed
          description: >-
            `revocation_pending`, bis die Bank bestätigt, dass die Einwilligung
            beendet wurde, danach `revoked`. `revocation_failed` wird
            automatisch erneut versucht. Bankabrufe werden sofort beendet,
            sobald ein Widerruf angefordert wird.
        version:
          type: integer
          description: >-
            Version der Einwilligung. Eine Erneuerung erstellt die nächste
            Version auf derselben Verbindung.
        granted_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: >-
            Wann die Einwilligung bei der Bank endet. Die Bank legt dies fest,
            bis zu `consent_days`.
          format: date-time
          nullable: true
        days_granted:
          type: integer
          description: Dauer der Einwilligung in Tagen, wie die Bank sie gewährt hat.
          nullable: true
        renewed_count:
          type: integer
          description: Wie oft die Einwilligung erneuert wurde.
        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: IDs der Konten, die die Person teilt.
        renewal_action:
          type: string
          enum:
            - reconfirm
            - bank_auth
            - null
          description: >-
            Wie eine Erneuerung abläuft: `reconfirm` bedeutet, dass die Person
            auf dem Bildschirm von Didit bestätigt, ohne Anmeldung bei der Bank,
            sofern die Bank und die Regeln des Landes dies erlauben. `bank_auth`
            ist eine Anmeldung bei der Bank.
          nullable: true
        renew_by:
          type: string
          description: >-
            Das Ende der Einwilligung: Erneuern Sie sie davor, damit keine Lücke
            entsteht.
          format: date-time
          nullable: true
        reconfirm_by:
          type: string
          description: >-
            Wird gesetzt, wenn `renewal_action` `reconfirm` ist: der letzte
            Zeitpunkt für die erneute Bestätigung.
          format: date-time
          nullable: true
        renewable_until:
          type: string
          description: >-
            Der späteste Zeitpunkt, zu dem dieselbe Verbindung nach dem Ende der
            Einwilligung reaktiviert werden kann. Danach verbindet sich die
            Person erneut. Er entspricht `retain_until`.
          format: date-time
          nullable: true
        retain_until:
          type: string
          description: >-
            Wird gesetzt, sobald der Zugriff beendet ist: Wie lange die
            gespeicherten Daten lesbar bleiben, bestimmt die
            Aufbewahrungseinstellung Ihrer Anwendung.
          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: >-
            Wer den Zugriff beendet hat, abgeleitet aus Nachweisen. `unknown`,
            wenn weder die Bank noch die Synchronisierung dies angibt.
          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: Synchronisierungsstatus einer Verbindung.
      properties:
        status:
          type: string
          enum:
            - pending
            - ok
            - failing
          description: >-
            `failing` nach 24 Stunden fehlgeschlagener Versuche, die mit
            zunehmenden Wartezeiten wiederholt werden. Verlangt eine Bank, dass
            sich die Person erneut anmeldet, wird die Verbindung stattdessen
            `renewal_required`.
        initial_status:
          type: string
          enum:
            - pending
            - succeeded
            - partial
            - failed
          description: >-
            Ergebnis der ersten Synchronisierung. Die Verbindung wird bei
            `succeeded` oder `partial` zu `active`, und die Verbindung wird zu
            `failed`, wenn kein Konto erfolgreich war.
        initial_complete:
          type: boolean
          description: >-
            `true` nur, wenn `initial_status` den Wert `succeeded` hat: Konten,
            Salden und aktuelle Transaktionen sind dann lesbar.
        history_complete:
          type: boolean
          description: >-
            `true`, wenn das Nachladen des Verlaufs aus welchem Grund auch immer
            beendet wurde. Nicht abgerufene Zeiträume stehen jeweils in
            `history_coverage.missing_ranges` des Kontos.
        last_synced_at:
          type: string
          description: >-
            Wann die Daten zuletzt von der Bank abgerufen wurden, nicht wann Sie
            sie zuletzt gelesen haben.
          format: date-time
          nullable: true
        next_sync_at:
          type: string
          description: >-
            Wann die nächste automatische Synchronisierung geplant ist. Die
            automatische Synchronisierung läuft je nach Bank ein- bis viermal
            täglich (siehe `frequency_per_day`).
          format: date-time
          nullable: true
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncBudget'
          description: Die Limits der Bank für Abrufe ohne anwesende Person.
        last_error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: Der letzte Synchronisierungsfehler oder `null`.
        frequency_per_day:
          type: integer
          minimum: 1
          maximum: 4
          description: >-
            Wie oft pro Tag die automatische Synchronisation für diese
            Verbindung läuft, je nach Bank einmal bis viermal. Wo die Bank mehr
            Abrufe ohne Anwesenheit erlaubt, bleiben immer mindestens zwei pro
            Tag für Live-Synchronisationen erhalten.
        live_syncs_left_today:
          type: integer
          minimum: 0
          description: >-
            Wie viele Live-Synchronisationen (`refresh_connection`) heute
            innerhalb des Limits der Bank noch verfügbar sind: der Wert
            `remaining` des knappsten Budgets. `null`, wenn die Bank kein Limit
            festlegt. Live-Synchronisationen sind im monatlichen Preis
            enthalten.
          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: Kurzform eines Kontos innerhalb einer Verbindung.
      properties:
        id:
          type: string
          description: >-
            Konto-ID. Über die gesamte Lebensdauer der Verbindung stabil, auch
            bei Erneuerungen.
          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: ISO-4217-Währungscode.
        iban_last4:
          type: string
          description: Die letzten vier Zeichen der IBAN, sofern das Konto eine hat.
          nullable: true
        status:
          type: string
          enum:
            - open
            - closed
            - access_removed
      required:
        - id
        - name
        - type
        - usage
        - currency
        - iban_last4
        - status
    BankConnectionOwnership:
      type: object
      description: >-
        Der optionale Abgleich des Kontoinhabers mit einer Person oder einem
        Unternehmen.
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
        match:
          type: string
          enum:
            - any_holder
            - all_holders
            - null
          nullable: true
        check_id:
          type: string
          description: >-
            ID des Ergebnisses der Eigentümerstruktur, wenn ein Vergleich
            angefordert wurde.
          format: uuid
          nullable: true
        result:
          type: string
          enum:
            - match
            - close_match
            - no_match
            - unknown
            - null
          description: >-
            Befund. `unknown`, wann immer fehlende Nachweise zum Kontoinhaber
            ihn verändern könnten, und wenn die Bank keinen Kontoinhaber
            übermittelt.
          nullable: true
      required:
        - compare
        - match
        - check_id
        - result
    BankConnectionBilling:
      type: object
      description: Was diese Verbindung kostet. Für die Sandbox wird nie etwas berechnet.
      properties:
        unit:
          type: string
          description: >-
            Abrechnungseinheit: `connection_month` für laufenden Zugriff, sonst
            `one_time`.
          enum:
            - connection_month
            - one_time
        price_usd:
          type: string
          description: >-
            Ihr heutiger Preis für den Monatszähler, für Ihre Anwendung und das
            Land, in USD, als Dezimalzeichenkette mit 4 Dezimalstellen. Eine
            Verbindung wird nur dann für einen Monat berechnet, wenn jeder
            akzeptierte Scope in diesem Monat Daten für mindestens ein Konto
            veröffentlicht hat. `null` für einmalige Verbindungen und in der
            Sandbox. Dauerhafter Zugriff wird pro aktiver Verbindung und Monat
            berechnet; der aktuelle Preis steht auf der Preisseite
            (https://docs.didit.me/getting-started/pricing). Beträge in
            Beispielen sind illustrativ; der Preis für ein Land wird auf der
            Preisseite angezeigt.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        billed_through:
          type: string
          description: Das letzte bereits abgerechnete Monatsende.
          format: date
          nullable: true
      required:
        - unit
        - price_usd
        - billed_through
    BankConnectionErasure:
      type: object
      description: Fortschritt einer von Ihnen angeforderten Löschung.
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            `pending`, während die Löschung läuft, `erased`, wenn weder eine
            gespeicherte Kopie noch Zugriff bei der Bank verbleibt, `failed`,
            wenn sie nicht innerhalb von 24 Stunden bestätigt werden konnte.
            Eine fehlgeschlagene Löschung hält die Daten der Verbindung
            gesperrt, wird wiederholt, und Didit wird alarmiert.
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Wann die Löschung abgeschlossen war. `null`, bis `status` `erased`
            ist.
      required:
        - status
        - requested_at
        - erased_at
    BankSyncBudget:
      type: object
      description: >-
        Ein Kontingent des Abruflimits der Bank für Abrufe ohne anwesende
        Person.
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: Wogegen die Bank das Budget verrechnet.
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: Das Konto, wenn `scope` `account` ist.
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            Wie oft Didit pro Tag Daten von der Bank abrufen darf, ohne dass die
            Person anwesend ist, gemäß der Definition der Bank. Dies ist eine
            von der Bank festgelegte Obergrenze, keine Zusage.
        remaining:
          type: integer
          description: >-
            Verbleibende Abrufe für Ihre Aktualisierungen im aktuellen
            Zeitfenster. Die für die automatischen Synchronisationen
            vorgesehenen Abrufe sind bereits abgezogen. Eine automatische
            Synchronisation verbraucht nie die letzten beiden Abrufe des Tages,
            sodass immer zwei manuelle Aktualisierungen verfügbar bleiben.
        resets_at:
          type: string
          description: Wann das Zeitfenster zurückgesetzt wird.
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncError:
      type: object
      description: Warum eine Synchronisierung fehlgeschlagen ist.
      properties:
        code:
          type: string
          description: Didit-Fehlercode.
        message:
          type: string
          description: Verständliche Erklärung.
        at:
          type: string
          description: Wann es passiert ist. `null` bei einem Ergebnis pro Konto.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: Nicht autorisiert
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Ungültiger API-Schlüssel
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        Der API-Schlüssel hat nicht die Berechtigung Bank data (`bank-data`).
        Alternativ ist bei Rohdaten der Bank in einer Live-Anwendung die
        Anwendungseinstellung "Bank data in the API" deaktiviert. Bank data ist
        nicht Teil des Vollzugriffs: Ein Schlüssel mit Vollzugriff, ein
        Schlüssel, der auf andere Ressourcen beschränkt ist, und eine Anfrage,
        die ohne API-Schlüssel authentifiziert wurde (Client Credentials, bei
        Rohdaten), werden alle mit diesem Body abgelehnt. Erstellen Sie daher
        einen Schlüssel und gewähren Sie die Berechtigung ausdrücklich. Die
        Ablehnung erfolgt vor jeder Suche und sagt deshalb nichts darüber aus,
        ob ein Objekt existiert.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Bankdaten nicht zulässig
              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: >-
        Lesebudget der Middleware überschritten. Beachten Sie Retry-After, bevor
        Sie es erneut versuchen.
      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: >-
        Bei Didit ist etwas schiefgelaufen. Jeder unerwartete Fehler unter
        `/v3/bank/` antwortet im Bank-Fehlerformat, niemals mit einer
        HTML-Seite: Geben Sie dem Support die `request_id` an.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Ein unerwarteter Fehler
              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: >-
        Wartezeit in Sekunden, aufgerundet auf das nächste Zeitfenster.
        Vorhanden bei Ablehnungen durch das Middleware-Budget.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        Der Geltungsbereich, dessen Budget überschritten wurde. Vorhanden bei
        Ablehnungen durch das Middleware-Budget.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Budget für den überschrittenen Bereich; entspricht dem Limit im Body.
        Vorhanden bei Ablehnungen durch das Middleware-Budget.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Verbleibendes Budget, auf null begrenzt. Entspricht remaining im Body.
        Bei Ablehnungen durch das Middleware-Budget vorhanden.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Reset-Zeit in Unix-Sekunden; entspricht dem Body-Feld reset. Vorhanden
        bei Ablehnungen durch das Middleware-Budget.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Der API-Schlüssel Ihrer Anwendung, zu finden unter Developers -> API
        keys in der Business Console. Der primäre Schlüssel hat vollen Zugriff.
        Ein benannter Schlüssel kann eingeschränkt werden: pro Ressource keine,
        nur Lese- oder nur Schreibrechte, begrenzt auf einzelne Workflows oder
        nur auf genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein
        Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder
        abgelaufen ist. 403 bedeutet, dass kein Schlüssel gesendet wurde, der
        Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die
        Anfrage von einer Adresse außerhalb seiner IP-Liste kam. 404 bei einer
        Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder
        Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält
        Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibzugriff auf Sitzungen erhält Sitzungslinks und Tokens als null.
        Siehe https://docs.didit.me/console/api-keys.

````

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