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

# Bankverbindung aktualisieren API: Jetzt synchronisieren

> Didit synchronisiert die Bankverbindung sofort: 202 mit sync_id oder 200 mit abgeschlossener Synchronisation, wenn Sie bis zu 25 Sekunden warten.

Der Endpoint „Refresh a Bank Connection“ von Didit fordert eine sofortige Synchronisierung an und antwortet mit `202` und der `sync_id`.
Mit `"wait": true` wartet der Aufruf bis zu 25 Sekunden und liefert die abgeschlossene Synchronisierung in einem einzigen Aufruf, ohne zusätzliche Kosten.
Die Bank begrenzt den unbeaufsichtigten Zugriff, daher kann der Aufruf mit `429 refresh_limit_reached` und `Retry-After` antworten.
Siehe [Bankdaten bei Bedarf aktualisieren](https://docs.didit.me/de/use-cases/refresh-bank-data-on-demand.md).


## OpenAPI

````yaml de/openapi-25.json POST /v3/bank/connections/{id}/refresh/
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/{id}/refresh/:
    post:
      tags:
        - Bank Data
      summary: Bankverbindung aktualisieren
      description: >-
        Synchronisiert jetzt: Liest die Bank jederzeit auf neue Daten aus.
        Antwortet mit `202` und der `sync_id`. Läuft bereits eine
        Synchronisation, erhalten Sie dieselbe `sync_id` und keinen zweiten
        Auftrag. Mit `"wait": true` im Body oder dem Header `Prefer:
        wait=<seconds>` (bis 25) wartet der Aufruf bis zu 25 Sekunden und
        antwortet mit `200` und der abgeschlossenen Synchronisation (`outcome`,
        die Anzahl je Konto und `balances_changed`), sodass eine Anfrage
        aktuelle Daten liefert. Hat die Bank in dieser Zeit nicht geantwortet,
        antwortet der Aufruf mit `202`: Lesen Sie die Synchronisation mit
        `get_sync_run` über die `sync_id` aus oder abonnieren Sie
        `bank.sync.completed`. `bank.data.updated` folgt nur, wenn die
        Synchronisation Änderungen speichert.


        Live-Synchronisationen sind im monatlichen Preis der Verbindung
        enthalten, genau wie die automatischen Synchronisationen: Es fallen
        keine zusätzlichen Kosten an. Die einzige Grenze setzt die Bank. Banken
        begrenzen Abrufe ohne anwesende Person, zum Beispiel auf vier pro Tag
        (die Didit Test Bank in der Sandbox verhält sich genauso). Die
        automatischen Synchronisationen des Tages (`sync.frequency_per_day`)
        werden zuerst reserviert, der Rest steht Ihnen zur Verfügung.
        `sync.budgets` zeigt daher, was übrig ist, und
        `sync.live_syncs_left_today`, wie viele Live-Synchronisationen heute
        noch verbleiben. Der automatische Zeitplan verwendet nie die letzten
        zwei Abrufe eines Tages, daher verbleiben immer zwei
        Live-Synchronisationen. Ist das Budget aufgebraucht, antwortet der
        Aufruf mit `429 refresh_limit_reached` und `Retry-After` (die Sekunden
        bis zum Zurücksetzen des Budgets, 1 bis 86400) sowie einem `sync`-Objekt
        mit `live_syncs_left_today` und `budgets`. Das Limit ist eine von der
        Bank festgelegte Obergrenze und keine Zusage über eine bestimmte Anzahl
        von Synchronisationen.


        Speichert eine Synchronisation Änderungen, informiert Sie
        `bank.data.updated`. Lesen Sie danach den Änderungsfeed.


        Erfordert einen API-Schlüssel mit der Berechtigung Bank data
        (`bank-data`): Schreibzugriff für diesen Vorgang, der etwas ändert. Ein
        Schlüssel mit Vollzugriff schließt sie nicht ein: Gewähren Sie sie beim
        Erstellen des Schlüssels ausdrücklich, sonst antwortet der Aufruf mit
        `403 bank_data_access_denied`.


        Das Aktualisieren einer gelöschten Verbindung antwortet mit `409
        connection_not_active`.
      operationId: refreshBankConnection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Die Verbindungs-ID.
        - $ref: '#/components/parameters/IdempotencyKey'
        - name: Prefer
          in: header
          required: false
          schema:
            type: string
            example: wait=25
          description: >-
            `wait=<seconds>` hält den Aufruf bis zu dieser Anzahl von Sekunden
            an, maximal 25, wie `wait: true` im Anfragetext.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankRefreshRequest'
            examples:
              Wait for the result:
                summary: Auf das Ergebnis warten
                value:
                  wait: true
      responses:
        '200':
          description: Die Synchronisierung wurde innerhalb von 25 Sekunden abgeschlossen.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankSyncCompleted'
              examples:
                Finished:
                  summary: Eine abgeschlossene Live-Synchronisierung
                  value:
                    id: d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14
                    connection_id: 5e1d2a70-6b3c-4f8e-a1d9-0c7b2e4f8a36
                    trigger: requested
                    status: succeeded
                    started_at: '2026-11-21T12:30:02Z'
                    finished_at: '2026-11-21T12:30:09Z'
                    results:
                      - account_id: a71f0c2e-4d85-4b1a-9e63-2f8c0d5b7a14
                        resource: transactions
                        outcome: succeeded
                        added: 3
                        modified: 0
                        removed: 1
                        error: null
                    outcome: succeeded
                    balances_changed: true
                    error: null
        '202':
          description: >-
            Aktualisierung angenommen: in die Warteschlange eingereiht oder wird
            bereits ausgeführt. Mit `wait` hat die Bank nicht innerhalb von 25
            Sekunden geantwortet: Lesen Sie die Synchronisierung mit der
            `sync_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankRefreshAccepted'
              examples:
                Queued:
                  summary: Eine Synchronisierung wurde in die Warteschlange gestellt
                  value:
                    sync_id: d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14
                    status: queued
                    next_refresh_at: null
        '400':
          description: >-
            Der Body ist ungültig, zum Beispiel ist `wait` kein Boolean. `field`
            benennt das Feld.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid request:
                  summary: Ungültige Anfrage
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: wait
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: Die Ressource existiert in dieser Anwendung und Umgebung nicht.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Nicht gefunden
                  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
        '409':
          description: >-
            Die Verbindung kann nicht aktualisiert werden:
            `connection_not_active` (widerrufen, pausiert, fehlgeschlagen oder
            gelöscht) oder `consent_expired` (erneuern Sie sie zuerst).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Nicht aktiv
                  value:
                    code: connection_not_active
                    message: This connection is not active.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: create_link
                    retry_after: null
                Consent expired:
                  summary: Einwilligung abgelaufen
                  value:
                    code: consent_expired
                    message: The consent ended. Renew the connection to sync again.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: renew_connection
                    retry_after: null
        '429':
          description: >-
            Das Abrufkontingent der Bank für Abrufe ohne anwesende Person ist
            aufgebraucht.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankRefreshLimitError'
              examples:
                Refresh limit reached:
                  summary: Aktualisierungslimit erreicht
                  value:
                    code: refresh_limit_reached
                    message: >-
                      The bank's limit on fetches without the person present is
                      used up for today.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: retry_later
                    retry_after: 3600
                    sync:
                      live_syncs_left_today: 0
                      budgets:
                        - scope: connection
                          resource: all
                          limit: 4
                          remaining: 0
                          resets_at: '2026-11-22T00:00:00Z'
          headers:
            Retry-After:
              description: Sekunden, die vor der nächsten Anfrage zu warten sind.
              schema:
                type: integer
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/refresh/'
            \
              -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.refresh_connection(
                "11111111-2222-3333-4444-555555555555",
                wait=True,
            )
            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.refreshConnection("11111111-2222-3333-4444-555555555555",
            {
              wait: true,
            });

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

            import me.didit.types.BankRefreshConnectionParams;

            import me.didit.types.BankRefreshRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().refreshConnection("11111111-2222-3333-4444-555555555555",
            BankRefreshConnectionParams.builder()
                    .wait_(true)
                    .build());
            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->refreshConnection('11111111-2222-3333-4444-555555555555',
            [
                'wait' => true,
            ]);

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

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

            result = didit.bank.refresh_connection(
              "11111111-2222-3333-4444-555555555555",
              wait: true
            )
            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.RefreshConnectionAsync("11111111-2222-3333-4444-555555555555",
            new BankRefreshRequest

            {
                Wait = true,
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Optionaler Schlüssel zur Wiederholungssicherheit für einen Vorgang, den
        Sie selbst wählen, bis zu 255 Zeichen (eine UUID eignet sich). Eine
        Anfrage, die mit demselben Schlüssel, demselben Endpoint, denselben
        Query-Parametern und demselben Body wiederholt wird, erhält die erste
        Antwort mit demselben Status und demselben Body zurück und wird kein
        zweites Mal ausgeführt oder berechnet. Derselbe Schlüssel mit einem
        anderen Endpoint, anderen Query-Parametern oder einem anderen Body
        liefert `409` mit `idempotency_key_reused`. Solange die erste Anfrage
        noch läuft, liefert er `409` mit `idempotency_key_in_progress` und
        `Retry-After`. Eine fehlgeschlagene Anfrage (jeder `4xx`- oder
        `5xx`-Fehler) wird nicht gespeichert, sodass Sie sie mit demselben
        Schlüssel erneut senden können. Schlüssel gehören zu Ihrer Anwendung,
        unabhängig davon, ob Sie mit einem API-Schlüssel oder einem
        Zugriffstoken aufrufen. Siehe [Wiederholungsversuche und
        Idempotenz](/de/integration/api-errors#wiederholungsversuche-und-idempotenz).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankRefreshRequest:
      type: object
      description: Optionaler Request-Body einer Aktualisierung.
      properties:
        wait:
          type: boolean
          default: false
          description: >-
            `true` holds the call for up to 25 seconds and answers `200` with
            the finished sync, so one request returns fresh data. If the bank
            has not answered in that time the call answers `202`: read the sync
            with `get_sync_run` using the `sync_id`, or subscribe to
            `bank.sync.completed`. `bank.data.updated` follows only when the
            sync stores changes. The header `Prefer: wait=<seconds>` (up to 25)
            does the same.
    BankSyncCompleted:
      allOf:
        - $ref: '#/components/schemas/BankSyncRun'
        - type: object
          properties:
            outcome:
              type: string
              enum:
                - succeeded
                - partial
                - failed
              description: Wie die Synchronisation endete.
            balances_changed:
              type: boolean
              description: Ob sich irgendein Guthaben geändert hat.
          required:
            - outcome
            - balances_changed
      description: >-
        Eine abgeschlossene Synchronisierung, die von einer Aktualisierung mit
        `wait` zurückgegeben wird: der Synchronisierungslauf mit seinem
        `outcome`, die Anzahl je Konto in `results` und `balances_changed`.
    BankRefreshAccepted:
      type: object
      description: >-
        Eine Aktualisierung wurde angenommen. Ein zweiter Aufruf, während eine
        Synchronisierung läuft, gibt dieselbe `sync_id` zurück.
      properties:
        sync_id:
          type: string
          description: >-
            Die Synchronisierung, die in die Warteschlange eingereiht wurde,
            oder die bereits laufende.
          format: uuid
        status:
          type: string
          enum:
            - queued
            - running
        next_refresh_at:
          type: string
          description: >-
            Der früheste Zeitpunkt, zu dem eine neue Aktualisierung angefordert
            werden kann. `null`, außer wenn ein Budget aufgebraucht ist.
          format: date-time
          nullable: true
      required:
        - sync_id
        - status
        - next_refresh_at
    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
    BankRefreshLimitError:
      allOf:
        - $ref: '#/components/schemas/BankDataError'
        - type: object
          properties:
            sync:
              type: object
              description: Die aktuellen Synchronisierungslimits der Verbindung.
              properties:
                live_syncs_left_today:
                  type: integer
                  nullable: true
                  minimum: 0
                budgets:
                  type: array
                  items:
                    $ref: '#/components/schemas/BankSyncBudget'
              required:
                - live_syncs_left_today
                - budgets
          required:
            - sync
      description: >-
        Der Fehler wegen des Aktualisierungslimits mit den `sync`-Limits der
        Verbindung. `Retry-After` enthält die Sekunden bis zum Zurücksetzen des
        Budgets, zwischen 1 und 86400.
    BankSyncRun:
      type: object
      description: >-
        Eine Synchronisierung einer Verbindung. Nur initiale, geplante und
        angeforderte Synchronisierungen werden aufgelistet.
      properties:
        id:
          type: string
          format: uuid
        connection_id:
          type: string
          format: uuid
        trigger:
          type: string
          enum:
            - initial
            - scheduled
            - requested
        status:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - partial
            - failed
        started_at:
          type: string
          format: date-time
          nullable: true
        finished_at:
          type: string
          format: date-time
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncRunResult'
          description: Was der Lauf pro Konto und Ressource getan hat.
        error:
          type: object
          nullable: true
          description: >-
            Warum der Lauf insgesamt fehlgeschlagen ist. `null`, wenn nicht.
            Fehler einzelner Konten und Ressourcen stehen in `results`.
          properties:
            code:
              type: string
            message:
              type: string
            at:
              type: string
              format: date-time
          required:
            - code
            - message
            - at
      required:
        - id
        - connection_id
        - trigger
        - status
        - started_at
        - finished_at
        - results
        - error
    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
    BankSyncRunResult:
      type: object
      properties:
        account_id:
          type: string
          description: '`null` für ein Ergebnis, das die gesamte Verbindung betrifft.'
          format: uuid
          nullable: true
        resource:
          type: string
          enum:
            - accounts
            - balances
            - transactions
        outcome:
          type: string
          enum:
            - succeeded
            - failed
            - skipped
        added:
          type: integer
        modified:
          type: integer
        removed:
          type: integer
        error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: Erforderlich, wenn `outcome` `failed` ist.
      required:
        - account_id
        - resource
        - outcome
        - added
        - modified
        - removed
        - error
    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
    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
  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.