> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Получить запуск синхронизации банка: API с результатами по счетам

> Didit: эндпоинт Get a Sync Run возвращает синхронизацию с результатом по каждому счёту и ресурсу: добавлено, изменено, удалено или ошибка.

Эндпоинт Get a Sync Run возвращает одну синхронизацию с результатом по каждому счёту и ресурсу: количество добавленных, изменённых и удалённых записей либо ошибку.
Значение `sync_id` берётся из [Обновить подключение](https://docs.didit.me/ru/standalone-apis/bank-connection-refresh.md) или из webhook `bank.data.updated`.


## OpenAPI

````yaml ru/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: API верификации личности. Аутентификация через заголовок x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, подключения, счета, балансы, транзакции, учреждения и покрытие.
      Банковские данные доступны для приложений в песочнице. Вызовы из
      приложения в продакшн-среде возвращают `404`, пока доступ к такой среде не
      объявлен. В песочнице ничего не списывается. Вызов, выполненный с
      API-ключом, требует ключа с разрешением на банковские данные
      (`bank-data`): read для чтения, write для операций, которые что-то меняют.
      Проверка счёта является исключением: для неё нужен доступ write к сессиям
      или полный доступ, а не разрешение на банковские данные. Банковские данные
      не входят в полный доступ: ключ с полным доступом отклоняется, и вызов
      возвращает `403 bank_data_access_denied`, пока вы не создадите ключ с этим
      разрешением. Необработанные банковские данные (счета, балансы, транзакции
      и лента изменений) также отклоняют запрос без API-ключа.


      Каждый отказ под `/v3/bank/`, кроме отказа проверки счёта, имеет одно и то
      же тело JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Путь, который не является операцией, идентификатор,
      который не является UUID, или неизвестный подресурс возвращают `404
      not_found` для любого метода, а любая непредвиденная ошибка возвращает
      `500 internal_error` с `request_id`. Там, где банковские данные
      недоступны, каждая операция возвращает стандартный `404` платформы, точно
      так же, как неизвестный маршрут.
paths:
  /v3/bank/connections/{id}/sync-runs/{sync_id}/:
    get:
      tags:
        - Bank Data
      summary: Получить запуск синхронизации
      description: >-
        Возвращает один запуск синхронизации с результатами по каждому счёту и
        ресурсу.


        Нужен API-ключ с разрешением «Данные банка» (`bank-data`): чтение для
        этой операции. Ключ с полным доступом это разрешение не включает:
        выдайте его явно при создании ключа, иначе вызов вернёт `403
        bank_data_access_denied`.
      operationId: getBankSyncRun
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Идентификатор подключения.
        - name: sync_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Идентификатор запуска синхронизации.
      responses:
        '200':
          description: Запуск синхронизации.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankSyncRun'
              examples:
                Succeeded:
                  summary: Запланированный запуск
                  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: Ресурс не существует в этом приложении и среде.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Не найдено
                  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: >-
            Подключение неактивно: оно удалено или срок его хранения истёк
            (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Подключение не активно
                  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: >-
        Одна синхронизация подключения. Перечислены только первоначальные,
        плановые и запрошенные синхронизации.
      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: Что выполнил запуск, по каждому счёту и ресурсу.
        error:
          type: object
          nullable: true
          description: >-
            Почему запуск завершился ошибкой в целом. `null`, если запуск не
            завершился ошибкой. Ошибки отдельных счетов и ресурсов находятся в
            `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: >-
        Тело ошибки для каждой операции с банковскими данными. Все поля всегда
        присутствуют.
      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: >-
            Машиночитаемый код ошибки. Ориентируйтесь на него в логике
            обработки, но никогда не на `message`.
        message:
          type: string
          description: >-
            Пояснение простым языком для разработчика. Формулировка может
            измениться; не разбирайте её программно.
        request_id:
          type: string
          description: Идентификатор этого запроса. Укажите его при обращении в поддержку.
        field:
          type: string
          description: >-
            Поле запроса, которое нужно исправить, если ошибка относится к
            одному полю. В остальных случаях `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: >-
            Какие действия выполнить дальше, чтобы клиент мог действовать без
            догадок. `null`, если стандартного следующего шага нет.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Количество секунд ожидания перед повторной попыткой. Задаётся при
            ошибках превышения лимита и при временных ошибках, иначе `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` для результата по всему подключению.'
          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: Обязательно, когда `outcome` равен `failed`.
      required:
        - account_id
        - resource
        - outcome
        - added
        - modified
        - removed
        - error
    RateLimitBudgetError:
      type: object
      description: >-
        Возвращается только при отказе middleware из-за исчерпания бюджета
        лимита запросов. Другие ошибки 429, включая конфликты идемпотентности и
        ограничения конкретного endpoint, не гарантируют эти поля метаданных.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Существующее понятное человеку сообщение об отказе по бюджету.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Непрозрачный идентификатор для службы поддержки: RL- и затем 32
            шестнадцатеричных символа UUID в нижнем регистре.
        limit:
          type: integer
          description: Бюджет области, в которой превышен лимит; равен X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Оставшийся бюджет, приведённый к нулю; совпадает с
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: Время сброса окна в секундах Unix; равно X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Длительность фиксированного окна в секундах, а не оставшееся время
            ожидания. Учитывайте Retry-After перед повторной попыткой.
      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: Почему не удалась синхронизация.
      properties:
        code:
          type: string
          description: Код ошибки Didit.
        message:
          type: string
          description: Пояснение простым языком.
        at:
          type: string
          description: Когда это произошло. `null` для результата по отдельному счёту.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: Не авторизован
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Недействительный API-ключ
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        API-ключ не имеет разрешения на доступ к банковским данным (`bank-data`)
        или, для необработанных банковских данных в продакшн-приложении,
        отключена настройка приложения «Bank data in the API». Банковские данные
        не входят в полный доступ: ключ с полным доступом, ключ с ограничением
        на другие ресурсы и запрос без API-ключа (client credentials, для
        необработанных данных) отклоняются с этим ответом, поэтому создайте ключ
        и выдайте разрешение явно. Отказ происходит до любого поиска, поэтому он
        ничего не говорит о том, существует ли объект.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Доступ к банковским данным не разрешён
              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: >-
        Превышен лимит чтения middleware. Соблюдайте Retry-After перед повторной
        попыткой.
      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: >-
        Что-то пошло не так на стороне Didit. Любая непредвиденная ошибка в
        `/v3/bank/` возвращается в формате ошибки Bank, а не в виде
        HTML-страницы: укажите `request_id` в обращении в поддержку.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Непредвиденная ошибка
              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: >-
        Секунды ожидания, округлённые вверх до следующего окна. Присутствует при
        отказах middleware из-за исчерпания бюджета.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        Область, бюджет которой превышен. Присутствует при отказах middleware
        из-за исчерпания бюджета.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Бюджет области, в которой превышен лимит; равен лимиту в теле ответа.
        Присутствует при отказах по бюджету промежуточного ПО.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Оставшийся бюджет, приведённый к нулю; совпадает с remaining в теле
        ответа. Присутствует в отказах из-за бюджета middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Время сброса в секундах Unix; равно reset в теле ответа. Присутствует
        при отказах middleware из-за исчерпания бюджета.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API-ключ вашего приложения берётся в разделе Developers -> API keys в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        можно ограничить: доступ для каждого ресурса (нет доступа, только чтение
        или запись), ограничение некоторыми сценариями или одобренными сессиями,
        список IP-адресов и дата истечения срока. Ответ 401 означает, что ключ
        неверный, отозван или истёк. Ответ 403 означает, что ключ не передан, у
        ключа нет доступа к этому ресурсу или действию либо запрос пришёл с
        адреса вне его списка IP. Ответ 404 на маршруте сессии означает, что
        сессия находится вне сценариев или статусов, доступных ключу. Ключ без
        доступа к медиа получает URL изображений, видео и PDF как null, а ключ
        без права записи в сессии получает ссылки и токены сессий как null. См.
        https://docs.didit.me/console/api-keys.

````

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