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

# Bank Link API abrufen: Status und connection_id

> Der Endpoint Get a Bank Link von Didit liefert den Status eines Links und nach Abschluss dessen connection_id und check_id.

Der Endpoint „Get a Bank Link“ von Didit gibt den Status eines Links zurück und, sobald dieser abgeschlossen ist, dessen `connection_id` und `check_id`.
Rufen Sie ihn von Ihrem Server aus auf, nachdem `onSuccess` ausgelöst wurde, oder bei `bank.link.completed`: Vertrauen Sie einer vom Browser gesendeten Link-ID niemals.
Ein fehlgeschlagener Link gibt `200` mit `status: failed` und einem `error` mit einem Code wie `duplicate_conflict` oder `reduced_grant` zurück.


## OpenAPI

````yaml de/openapi-25.json GET /v3/bank/links/{id}/
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/links/{id}/:
    get:
      tags:
        - Bank Data
      summary: Bank-Link abrufen
      description: >-
        Gibt den Status eines Links zurück und, sobald er `completed` ist,
        dessen `connection_id` und `check_id`. Dies ist die maßgebliche Antwort:
        Rufen Sie sie von Ihrem Server aus auf, nachdem der Browser den Erfolg
        gemeldet hat, oder beim Webhook `bank.link.completed`.


        Ein fehlgeschlagener Link ist kein HTTP-Fehler: Er wird mit `200` und
        `status: failed` sowie einem `error`-Objekt zurückgegeben, zum Beispiel
        `duplicate_conflict` mit `conflicts_with`. `url` und `client_token`
        werden nur bei der Erstellung des Links zurückgegeben.


        Erforderlich ist ein API-Schlüssel mit der Berechtigung für Bankdaten
        (`bank-data`): Leseberechtigung für diesen Vorgang. Ein Schlüssel mit
        vollem Zugriff umfasst sie nicht: Erteilen Sie sie beim Erstellen des
        Schlüssels ausdrücklich, da der Aufruf sonst mit `403
        bank_data_access_denied` antwortet.
      operationId: getBankLink
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Die Link-ID.
      responses:
        '200':
          description: Der Link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Completed:
                  summary: Ein abgeschlossener Link
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: completed
                    url: null
                    client_token: null
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    check_id: null
                    reused: false
                    error: null
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
                Failed with a duplicate:
                  summary: >-
                    Ein Link, der fehlgeschlagen ist, weil die Person diese
                    Konten bereits freigegeben hat
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: failed
                    url: null
                    client_token: null
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: null
                    check_id: null
                    reused: false
                    error:
                      code: duplicate_conflict
                      message: >-
                        The person already shares some of these accounts through
                        another connection.
                      conflicts_with:
                        - 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: 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
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/links/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

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


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


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

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


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


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

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


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


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

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

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

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

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


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

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankLink:
      type: object
      description: >-
        Ein Durchlauf von Bank Link für eine Person: eine Bank anbinden oder
        eine Verbindung erneuern. Bestätigen Sie einen Link selbst mit
        `get_link`: vertrauen Sie nie einer vom Browser gesendeten ID.
      properties:
        id:
          type: string
          description: Kennung des Links.
          format: uuid
        mode:
          type: string
          enum:
            - connect
            - renew
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - created
            - opened
            - connecting
            - completed
            - cancelled
            - expired
            - failed
          description: >-
            Status des Links. `completed`, `cancelled`, `expired` und `failed`
            sind endgültig.
        url:
          type: string
          description: >-
            Die gehostete Verifizierungsseite, zu der die Person geleitet werden
            soll. Wird nur beim Erstellen des Verifizierungslinks zurückgegeben;
            bei späteren Abfragen `null`, weil das Token nicht gespeichert wird.
          nullable: true
          format: uri
        client_token:
          type: string
          description: >-
            Das Token für den eingebetteten Bank Link von Didit, der noch nicht
            freigegeben ist: Öffnen Sie heute `url`. Wird nur bei der Erstellung
            des Links zurückgegeben; bei späteren Abfragen `null`. Es hat einen
            einzigen Zweck und ist nur kurz gültig. Es enthält keine
            personenbezogenen Daten. Protokollieren Sie es niemals.
          nullable: true
        expires_at:
          type: string
          description: Wann ein nicht eingelöster Link nicht mehr funktioniert.
          format: date-time
        connection_id:
          type: string
          description: >-
            Die Verbindung, die dieser Link erstellt oder erneuert hat, sobald
            `status` `completed` ist.
          format: uuid
          nullable: true
        check_id:
          type: string
          description: >-
            Das Ergebnis zur Eigentümerstruktur dieses Links, wenn er
            `ownership.compare` mit einem anderen Wert als `none` angefordert
            hat.
          format: uuid
          nullable: true
        reused:
          type: boolean
          description: >-
            `true`, wenn der Link als Erneuerung einer bestehenden Verbindung
            abgeschlossen wurde, weil die Person genau diese Konten bereits
            gemeinsam nutzt (`duplicates: reuse`). Es wird nichts doppelt
            berechnet.
        error:
          allOf:
            - $ref: '#/components/schemas/BankLinkError'
          nullable: true
          description: >-
            Warum der Link fehlgeschlagen ist, wenn `status` `failed` ist.
            Andernfalls `null`.
        quote:
          $ref: '#/components/schemas/BankLinkQuote'
        vendor_data:
          type: string
          description: Ihre Referenz aus der Anfrage.
          nullable: true
      required:
        - id
        - mode
        - access
        - status
        - url
        - client_token
        - expires_at
        - connection_id
        - check_id
        - reused
        - error
        - quote
        - vendor_data
    BankDataError:
      type: object
      description: 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
    BankLinkError:
      type: object
      description: >-
        Der Grund, aus dem ein Link mit `failed` beendet wurde. Es wurde nichts
        veröffentlicht oder berechnet.
      properties:
        code:
          type: string
          enum:
            - duplicate_conflict
            - renewal_login_mismatch
            - reduced_grant
            - corporate_approval_not_supported
            - ongoing_access_not_available
            - bank_unavailable
            - bank_cancelled
            - consent_declined
            - read_limit
            - renewal_not_needed
            - renewal_window_expired
            - first_sync_failed
          description: >-
            Warum der Link fehlgeschlagen ist. Ein fehlgeschlagener Link ist
            kein HTTP-Fehler: Der Link wird mit `status: failed` und diesem
            Objekt zurückgegeben. Ein Erneuerungslink, dessen Verbindung sich
            inzwischen geändert hat, liefert `renewal_not_needed` oder
            `renewal_window_expired`.
        message:
          type: string
          description: Verständliche Erklärung für Entwickler.
        conflicts_with:
          type: array
          nullable: true
          items:
            type: string
            format: uuid
          description: >-
            Bei `duplicate_conflict`: die IDs der aktiven Verbindungen, die sich
            überschneiden. Erneuern Sie eine davon oder erstellen Sie den Link
            erneut mit `duplicates: allow`.
      required:
        - code
        - message
        - conflicts_with
    BankLinkQuote:
      type: object
      description: >-
        Der Preis eines Links, der bei seiner Erstellung festgeschrieben wird.
        Berechnet wird der Preis aus dem Angebot. Lesevorgänge werden nie
        abgerechnet.
      properties:
        id:
          type: string
          description: Kennung des Angebots.
          format: uuid
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Die Positionen, die dieser Link für die angeforderten Bereiche
            berechnet.
        fallback_lines:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Was ein einmaliger Fallback berechnen würde, nur wenn der Link mit
            `allow_one_time_fallback` erstellt wurde. Er wird in der Antwort zur
            Erstellung angezeigt und ist andernfalls `null`. Ein einmaliger
            Abruf mit Daten kann mehr kosten als ein erster Monat laufender
            Zugriff.
        total_usd:
          type: string
          description: >-
            Summe der `lines` in USD. Die Summe kann nur sinken: bei einer
            reduzierten Freigabe oder wenn die Person ein Land mit einem
            niedrigeren Preis wählt.
          pattern: ^-?\d+(\.\d+)?$
        valid_until:
          type: string
          description: >-
            Das Angebot ist an den Link gebunden und gilt für dessen gesamte
            Laufzeit, daher entspricht es `expires_at`.
          format: date-time
        scopes:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Die Datenbereiche bestimmen die Preise des Angebots.
      required:
        - id
        - lines
        - fallback_lines
        - total_usd
        - valid_until
        - scopes
    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
    BankLinkQuoteLine:
      type: object
      description: Eine bepreiste Position eines Angebots.
      properties:
        meter:
          type: string
          description: >-
            Was berechnet wird, zum Beispiel `bank_data_connection_month` oder
            `bank_verification`.
          example: bank_data_connection_month
        unit:
          type: string
          description: >-
            Was eine Einheit ist, zum Beispiel `connection_month` oder
            `completed_sign_in`.
          example: connection_month
        price_usd:
          type: string
          description: >-
            Preis pro Einheit in USD, ein Dezimalstring mit 4 Nachkommastellen.
            Beträge in Beispielen dienen nur der Veranschaulichung; den Preis
            für ein Land finden Sie auf der Preisseite.
          pattern: ^-?\d+(\.\d+)?$
          example: '0.9000'
      required:
        - meter
        - unit
        - price_usd
  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.