> ## 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-Sync-Run-API abrufen: Ergebnisse pro Konto

> Der Endpoint Sync-Run abrufen von Didit liefert pro Konto und Ressource das Ergebnis: neue, geänderte, entfernte Einträge oder den Fehler.

Der Didit-Endpoint Get a Sync Run gibt einen Sync mit seinem Ergebnis für jedes Konto und jede Ressource zurück: die Anzahl der hinzugefügten, geänderten und entfernten Einträge oder den Fehler.
Die `sync_id` stammt aus [Verbindung aktualisieren](https://docs.didit.me/de/standalone-apis/bank-connection-refresh.md) oder aus dem Webhook `bank.data.updated`.


## OpenAPI

````yaml de/openapi-25.json GET /v3/bank/connections/{id}/sync-runs/{sync_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/connections/{id}/sync-runs/{sync_id}/:
    get:
      tags:
        - Bank Data
      summary: Synchronisationslauf abrufen
      description: >-
        Gibt einen Synchronisierungslauf mit seinen Ergebnissen je Konto und
        Ressource zurück.


        Erfordert einen API-Schlüssel mit der Berechtigung Bankdaten
        (`bank-data`): Lesen für diesen Vorgang. Ein Schlüssel mit vollem
        Zugriff umfasst sie nicht: Erteilen Sie sie beim Erstellen des
        Schlüssels ausdrücklich, andernfalls antwortet der Aufruf mit `403
        bank_data_access_denied`.
      operationId: getBankSyncRun
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Die Verbindungs-ID.
        - name: sync_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Die ID des Synchronisierungslaufs.
      responses:
        '200':
          description: Der Synchronisierungslauf.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankSyncRun'
              examples:
                Succeeded:
                  summary: Ein geplanter Lauf
                  value:
                    id: d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14
                    connection_id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    trigger: scheduled
                    status: succeeded
                    started_at: '2026-11-21T06:00:02Z'
                    finished_at: '2026-11-21T06:00:19Z'
                    results:
                      - account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        resource: transactions
                        outcome: succeeded
                        added: 3
                        modified: 0
                        removed: 1
                        error: null
                      - account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        resource: balances
                        outcome: succeeded
                        added: 0
                        modified: 0
                        removed: 0
                        error: null
                      - account_id: c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                        resource: transactions
                        outcome: succeeded
                        added: 0
                        modified: 0
                        removed: 0
                        error: null
                    error: 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 ist nicht aktiv: Sie wurde gelöscht oder ihre
            Aufbewahrungsfrist ist abgelaufen (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Verbindung 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
        '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/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/sync-runs/d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14/'
            \
              -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_sync_run(
                "11111111-2222-3333-4444-555555555555",
                "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.getSyncRun(
              "11111111-2222-3333-4444-555555555555",
              "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.GetSyncRun(ctx, \"11111111-2222-3333-4444-555555555555\", \"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().getSyncRun("11111111-2222-3333-4444-555555555555",
            "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->getSyncRun('11111111-2222-3333-4444-555555555555',
            '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_sync_run(
              "11111111-2222-3333-4444-555555555555",
              "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.GetSyncRunAsync("11111111-2222-3333-4444-555555555555",
            "11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    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
    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
    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
    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
    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.