> ## 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: подключение или обновление банка

> Didit: эндпоинт Create a Bank Link запускает сеанс Bank Link и возвращает размещённую ссылку для подключения банка.

Эндпоинт Didit Create a Bank Link запускает на вашем сервере один запуск Bank Link, чтобы подключить банк или продлить подключение, и возвращает размещённый `url`.
Каждое поле имеет значение по умолчанию, поэтому минимальный запрос выглядит так: `{}` и всё, что вы хотите указать.
Сохраняйте возвращённый `id`, связав его с пользователем, и сами проверяйте результат через [Получить ссылку на банковское подключение](https://docs.didit.me/ru/standalone-apis/bank-link-get.md) или webhook `bank.link.completed`.
См. [быстрый старт](https://docs.didit.me/ru/core-technology/bank-verification/quickstart.md) и [Bank Link](https://docs.didit.me/ru/core-technology/bank-verification/bank-link.md).


## OpenAPI

````yaml ru/openapi-25.json POST /v3/bank/links/
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/links/:
    post:
      tags:
        - Bank Data
      summary: Создать банковскую ссылку
      description: >-
        Создаёт ссылку Bank Link: один запуск сценария, в котором пользователь
        подключает банк или продлевает подключение. Отправьте пользователя по
        `url`. `client_token` предназначен для встроенного Bank Link Didit,
        который ещё не выпущен: сейчас откройте `url`. Завершённая ссылка
        создаёт подключение.


        Минимальный запрос: `{}` плюс то, что вам нужно. Значения по умолчанию:
        `mode` connect, `access` one_time, `data` только счета, `history_days`
        90, `ownership.compare` none, `segment` any, `duplicates` reuse,
        `allow_one_time_fallback` false, а для постоянного доступа согласие на
        срок, который разрешает банк.


        Ответ содержит расценку: цена закрепляется за ссылкой и списывается по
        расценке. API-ключ никогда не попадает в браузер или приложение: только
        `url`.


        Подтверждайте результат сами через `get_link` или webhook
        `bank.link.completed`: никогда не доверяйте идентификатору ссылки,
        присланному браузером. История: передайте `history_from` или
        `history_days`, но не оба. Там, где это разрешает банк, постоянный
        доступ работает до окончания согласия: точная дата указана в каждом
        подключении.


        Нужен API-ключ с разрешением Bank data (`bank-data`): это операция
        записи, которая что-то меняет. Ключ с полным доступом это разрешение не
        включает: выдайте его явно при создании ключа, иначе вызов вернёт `403
        bank_data_access_denied`.
      operationId: createBankLink
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankLinkCreateRequest'
            example:
              mode: connect
              access: ongoing
              country: ESP
              segment: business
              data:
                - accounts
                - balances
                - transactions
              history_from: '2026-01-01'
              consent_days: 180
              ownership:
                compare: none
              end_user:
                reference: client-7731
                email: ana@example.com
              redirect_url: https://app.example.com/bank/return
              allowed_origins:
                - https://app.example.com
              language: es
              vendor_data: client-7731
      responses:
        '201':
          description: Ссылка создана.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Ongoing business connection:
                  summary: Постоянный доступ для счёта компании в Испании
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: created
                    url: https://verify.didit.me/bank/link/example-link-token
                    client_token: example-client-token
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: null
                    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
        '400':
          description: >-
            Запрос отклонён до открытия каких-либо экранов. `field` указывает,
            что нужно исправить: `invalid_request` для значения вне допустимого
            диапазона или недопустимого сочетания значений, а также более
            конкретные коды, показанные здесь.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Bank cannot keep access open:
                  summary: Банк не может сохранить доступ открытым
                  value:
                    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
                History window ambiguous:
                  summary: Неоднозначный период истории
                  value:
                    code: history_window_ambiguous
                    message: Send history_from or history_days, not both.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: history_from
                    next_action: null
                    retry_after: null
                Redirect URL not registered:
                  summary: URL перенаправления не зарегистрирован
                  value:
                    code: redirect_url_not_registered
                    message: >-
                      This redirect_url is not one of the return addresses
                      registered for your application. Addresses are matched
                      exactly (scheme, host, port, path and query); in sandbox a
                      plain http localhost address needs no registration. Send a
                      registered address, or leave redirect_url out (automatic
                      return to your page is then not promised).
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: redirect_url
                    next_action: null
                    retry_after: null
                Segment not available:
                  summary: Сегмент недоступен
                  value:
                    code: segment_not_available
                    message: >-
                      This bank does not offer this kind of account through Bank
                      Link.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: segment
                    next_action: null
                    retry_after: null
                Window not available:
                  summary: Окно недоступно
                  value:
                    code: window_not_available
                    message: This bank cannot deliver the requested history window.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: history_from
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Недопустимый запрос
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: expires_in
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: >-
            Баланса недостаточно для оплаты указанной цены. Пополните баланс и
            повторите попытку.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Insufficient credits:
                  summary: Недостаточно кредитов
                  value:
                    code: insufficient_credits
                    message: The balance cannot cover the quoted price.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: top_up_balance
                    retry_after: null
        '403':
          description: >-
            Отказано: в вашем договоре нет тарифа для этой страны или у ключа
            нет разрешения Bank data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                No contract rate:
                  summary: Нет договорного тарифа
                  value:
                    code: contract_rate_missing
                    message: Your contract has no rate for bank data in this country.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
                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
        '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
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X POST 'https://verification.didit.me/v3/bank/links/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "mode": "connect",
                "access": "ongoing",
                "country": "ESP",
                "segment": "business",
                "data": [
                  "accounts",
                  "balances",
                  "transactions"
                ],
                "history_from": "2026-01-01",
                "consent_days": 180,
                "ownership": {
                  "compare": "none"
                },
                "end_user": {
                  "reference": "client-7731",
                  "email": "ana@example.com"
                },
                "redirect_url": "https://app.example.com/bank/return",
                "allowed_origins": [
                  "https://app.example.com"
                ],
                "language": "es",
                "vendor_data": "client-7731"
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.create_link(
                mode="connect",
                access="ongoing",
                country="ESP",
                segment="business",
                data=["accounts", "balances", "transactions"],
                history_from="2026-01-01",
                consent_days=180,
                ownership={
                    "compare": "none",
                },
                end_user={
                    "reference": "client-7731",
                    "email": "ana@example.com",
                },
                redirect_url="https://app.example.com/bank/return",
                allowed_origins=["https://app.example.com"],
                language="es",
                vendor_data="client-7731",
            )
            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.createLink({
              mode: "connect",
              access: "ongoing",
              country: "ESP",
              segment: "business",
              data: ["accounts", "balances", "transactions"],
              history_from: "2026-01-01",
              consent_days: 180,
              ownership: {
                compare: "none",
              },
              end_user: {
                reference: "client-7731",
                email: "ana@example.com",
              },
              redirect_url: "https://app.example.com/bank/return",
              allowed_origins: ["https://app.example.com"],
              language: "es",
              vendor_data: "client-7731",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.CreateLink(ctx, didit.BankCreateLinkParams{\n\tBody: didit.BankLinkCreateRequest{\n\t\tMode:        didit.Some(didit.BankLinkCreateRequestMode(\"connect\")),\n\t\tAccess:      didit.Some(didit.BankLinkCreateRequestAccess(\"ongoing\")),\n\t\tCountry:     didit.String(\"ESP\"),\n\t\tSegment:     didit.Some(didit.BankLinkCreateRequestSegment(\"business\")),\n\t\tData:        didit.Some([]didit.BankLinkCreateRequestData{\"accounts\", \"balances\", \"transactions\"}),\n\t\tHistoryFrom: didit.String(\"2026-01-01\"),\n\t\tConsentDays: didit.Int(180),\n\t\tOwnership: didit.Some(didit.BankLinkOwnershipRequest{\n\t\t\tCompare: didit.Some(didit.BankLinkOwnershipRequestCompare(\"none\")),\n\t\t}),\n\t\tEndUser: didit.Some(didit.BankLinkEndUser{\n\t\t\tReference: didit.String(\"client-7731\"),\n\t\t\tEmail:     didit.String(\"ana@example.com\"),\n\t\t}),\n\t\tRedirectURL:    didit.String(\"https://app.example.com/bank/return\"),\n\t\tAllowedOrigins: didit.Some([]string{\"https://app.example.com\"}),\n\t\tLanguage:       didit.String(\"es\"),\n\t\tVendorData:     didit.String(\"client-7731\"),\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.time.LocalDate;

            import java.util.List;

            import me.didit.Didit;

            import me.didit.types.BankLinkCreateRequest;

            import me.didit.types.BankLinkEndUser;

            import me.didit.types.BankLinkOwnershipRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().createLink(BankLinkCreateRequest.builder()
                    .mode(BankLinkCreateRequest.Mode.of("connect"))
                    .access(BankLinkCreateRequest.Access.of("ongoing"))
                    .country("ESP")
                    .segment(BankLinkCreateRequest.Segment.of("business"))
                    .data(List.of(BankLinkCreateRequest.Data.of("accounts"), BankLinkCreateRequest.Data.of("balances"), BankLinkCreateRequest.Data.of("transactions")))
                    .historyFrom(LocalDate.parse("2026-01-01"))
                    .consentDays(180L)
                    .ownership(BankLinkOwnershipRequest.builder()
                            .compare(BankLinkOwnershipRequest.Compare.of("none"))
                            .build())
                    .endUser(BankLinkEndUser.builder()
                            .reference("client-7731")
                            .email("ana@example.com")
                            .build())
                    .redirectUrl("https://app.example.com/bank/return")
                    .allowedOrigins(List.of("https://app.example.com"))
                    .language("es")
                    .vendorData("client-7731")
                    .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->createLink([
                'mode' => 'connect',
                'access' => 'ongoing',
                'country' => 'ESP',
                'segment' => 'business',
                'data' => ['accounts', 'balances', 'transactions'],
                'history_from' => '2026-01-01',
                'consent_days' => 180,
                'ownership' => [
                    'compare' => 'none',
                ],
                'end_user' => [
                    'reference' => 'client-7731',
                    'email' => 'ana@example.com',
                ],
                'redirect_url' => 'https://app.example.com/bank/return',
                'allowed_origins' => ['https://app.example.com'],
                'language' => 'es',
                'vendor_data' => 'client-7731',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.bank.create_link(
              mode: "connect",
              access: "ongoing",
              country: "ESP",
              segment: "business",
              data: ["accounts", "balances", "transactions"],
              history_from: "2026-01-01",
              consent_days: 180,
              ownership: {
                compare: "none",
              },
              end_user: {
                reference: "client-7731",
                email: "ana@example.com",
              },
              redirect_url: "https://app.example.com/bank/return",
              allowed_origins: ["https://app.example.com"],
              language: "es",
              vendor_data: "client-7731"
            )
            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.CreateLinkAsync(new
            BankLinkCreateRequest

            {
                Mode = new BankLinkCreateRequestMode("connect"),
                Access = new BankLinkCreateRequestAccess("ongoing"),
                Country = "ESP",
                Segment = new BankLinkCreateRequestSegment("business"),
                Data = new BankLinkCreateRequestData[] { "accounts", "balances", "transactions" },
                HistoryFrom = "2026-01-01",
                ConsentDays = 180,
                Ownership = new BankLinkOwnershipRequest
                {
                    Compare = new BankLinkOwnershipRequestCompare("none"),
                },
                EndUser = new BankLinkEndUser
                {
                    Reference = "client-7731",
                    Email = "ana@example.com",
                },
                RedirectUrl = "https://app.example.com/bank/return",
                AllowedOrigins = new string[] { "https://app.example.com" },
                Language = "es",
                VendorData = "client-7731",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Необязательный ключ для безопасных повторных запросов, который вы
        выбираете для одной операции, до 255 символов (подойдёт UUID). Запрос,
        повторённый с тем же ключом, endpoint, параметрами запроса и телом,
        получает первый ответ с тем же статусом и тем же телом и не выполняется
        и не тарифицируется повторно. Тот же ключ с другим endpoint, параметрами
        запроса или телом возвращает `409` `idempotency_key_reused`, а пока
        первый запрос ещё выполняется, `409` `idempotency_key_in_progress` с
        `Retry-After`. Неудачный запрос (любой `4xx` или `5xx`) не сохраняется,
        поэтому его можно отправить повторно с тем же ключом. Ключи принадлежат
        вашему приложению, независимо от того, вызываете ли вы API с API-ключом
        или с токеном доступа. См. [Повторные попытки и
        идемпотентность](/ru/integration/api-errors#повторные-попытки-и-идемпотентность).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankLinkCreateRequest:
      type: object
      description: >-
        Создайте Bank Link. Минимальный запрос: `{}` плюс то, что вам нужно. У
        каждого поля есть значение по умолчанию.
      properties:
        mode:
          type: string
          enum:
            - connect
            - renew
          description: >-
            `connect` (по умолчанию) создает новое подключение. `renew` требует
            `connection_id` и использует настройки этого подключения.
          default: connect
        connection_id:
          type: string
          description: 'Подключение для продления. Только при `mode: renew`.'
          format: uuid
        access:
          type: string
          enum:
            - one_time
            - ongoing
          description: >-
            `one_time` (по умолчанию) считывает данные однократно. `ongoing`
            поддерживает доступ открытым до окончания согласия или пока кто-либо
            не остановит доступ. Если задан `institution_id`, банк, который не
            может поддерживать доступ открытым, возвращает `400
            ongoing_access_not_available` до показа экрана. Без него в выборе
            банка отображаются только банки, которые могут.
          default: one_time
        country:
          type: string
          description: >-
            Необязательно. Без него человек выбирает из стран, которые ваше
            приложение включило. Страна должна обслуживаться Bank Link; любая
            другая, включая `ZZZ`, возвращает `400 invalid_request` с `field:
            country`. Пустое тело запроса остаётся допустимым.
          pattern: ^[A-Z]{3}$
        institution_id:
          type: string
          description: >-
            Необязательный банк для предварительного выбора из
            `list_institutions`. Пропускает выбор банка.
          maxLength: 64
        segment:
          type: string
          enum:
            - personal
            - business
            - any
          description: >-
            Фильтрует список выбора банка и указывает банку, какой логин открыть
            там, где банк разделяет логины. По умолчанию `any`.
          default: any
        data:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: >-
            Что читать. `accounts` включается всегда: название, тип, валюта,
            идентификаторы и имя владельца, если банк его передаёт. По умолчанию
            `["accounts"]`.
          default:
            - accounts
          maxItems: 3
        history_days:
          type: integer
          description: >-
            Количество дней истории транзакций для запроса, от 1 до 365, по
            умолчанию 90. Банк может предоставить меньше: каждый счёт сообщает,
            что он передал, в `history_coverage`. Нельзя отправлять вместе с
            `history_from`.
          minimum: 1
          maximum: 365
          default: 90
        history_from:
          type: string
          description: >-
            Дата начала истории, которую нужно запросить, вместо `history_days`.
            Нельзя передавать вместе с `history_days`: при совместной передаче
            ответ `400 history_window_ambiguous`. Дата старше 365 дней или в
            будущем возвращает `400 window_not_available`.
          format: date
        extended_history:
          type: string
          enum:
            - standard
            - allow_extra_auth
          description: >-
            `allow_extra_auth` позволяет банку, который запрашивает еще одно
            подтверждение, передать более старую историю.
          default: standard
        consent_days:
          type: integer
          description: >-
            Только для режима ongoing. Сколько дней банку нужно держать доступ
            открытым, 1 или больше. По умолчанию: максимум, который разрешает
            банк. Подключение возвращает дату, которую банк фактически
            предоставил, в `consent.expires_at`. При `access: one_time`
            возвращается `400 invalid_request` с `field: consent_days`.
          minimum: 1
          maximum: 32767
        ownership:
          $ref: '#/components/schemas/BankLinkOwnershipRequest'
        end_user:
          $ref: '#/components/schemas/BankLinkEndUser'
        redirect_url:
          type: string
          description: >-
            Куда браузер переходит в конце, с `link_id`, `status` и подписанным
            `state` (только для отображения: основным источником являются
            webhook и `get_link`). В песочнице для приложения обычный адрес
            `http` с `localhost`, `127.0.0.1` или `[::1]` (любой порт и путь,
            без учётных данных и фрагмента) не требует регистрации. Любой другой
            адрес возвращает `400 redirect_url_not_registered`: регистрация
            других адресов пока недоступна. Без `redirect_url` человек завершает
            работу на собственной странице результатов Didit.
          format: uri
          maxLength: 2048
        allowed_origins:
          type: array
          items:
            type: string
            format: uri
          description: >-
            Принимается, но сейчас не используется: зарезервировано для
            встроенного Bank Link Didit, который ещё не выпущен. Источники
            HTTPS, до 50.
          maxItems: 50
        language:
          type: string
          description: >-
            Необязательный код языка, например `es` или `pt-BR`. Иначе
            используется язык браузера.
          pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
          maxLength: 16
        vendor_data:
          type: string
          description: Ваш собственный референс, возвращается в ссылке и подключении.
          maxLength: 255
        expires_in:
          type: integer
          description: Время жизни ссылки в секундах, от 300 до 86400. По умолчанию 3600.
          minimum: 300
          maximum: 86400
          default: 3600
        duplicates:
          type: string
          enum:
            - reuse
            - allow
          description: >-
            `reuse` (по умолчанию) завершает ссылку, которая ведет к счетам, уже
            общим для вас, как продление этого подключения. `allow` создает
            независимое второе подключение.
          default: reuse
        allow_one_time_fallback:
          type: boolean
          description: >-
            Для `ongoing` позволяет пользователю продолжить однократным чтением
            в банке, который не может поддерживать доступ открытым, после
            подтверждения сокращенного доступа на собственном экране банка. В
            котировке показано, сколько это стоит. Только при `access: ongoing`:
            при одноразовом доступе возвращается `400 invalid_request` с `field:
            allow_one_time_fallback`.
          default: false
        accept_reduced_grant:
          type: boolean
          description: >-
            Если банк или человек предоставляет меньше, чем вы запросили, ссылка
            завершается, и оплачиваются только предоставленные области доступа.
            В противном случае ссылка завершается со статусом `failed` и
            причиной `reduced_grant`, и оплата не взимается.
          default: false
        sandbox:
          type: object
          description: >-
            Только для приложений в sandbox: выбирает клиента Didit Test Bank. В
            продакшн-приложении игнорируется.
          properties:
            persona:
              type: string
              enum:
                - personal_basic
                - business_multi
                - long_history
                - pending
                - sparse_fields
                - no_ongoing
              description: >-
                Клиент Test Bank: `personal_basic` (один текущий счёт, 60
                операций), `business_multi` (три счёта, принадлежащих компании),
                `long_history` (один счёт с историей за 400 дней и 1 400
                операциями; чтение возвращает последние 365 дней, поэтому
                задайте `history_days` равным 365), `pending` (включает
                транзакции в ожидании), `sparse_fields` (без даты валютирования,
                без IBAN контрагента и без банковской ссылки) или `no_ongoing`
                (банк допускает только одноразовый доступ: используйте
                `allow_one_time_fallback`).
            switches:
              type: array
              items:
                type: string
                enum:
                  - partial_grant
                  - renewal_other_login
                  - expired_cursor
                  - webhook_twice
                  - midnight_booking
                  - blocked_popup
                  - bank_app_return
              description: >-
                Принимается и зарезервировано для симулятора песочницы: значения
                сейчас ничего не меняют.
    BankLink:
      type: object
      description: >-
        Один запуск Bank Link для одного пользователя: подключение банка или
        продление подключения. Подтверждайте ссылку сами с помощью `get_link`:
        никогда не доверяйте идентификатору, присланному браузером.
      properties:
        id:
          type: string
          description: Идентификатор ссылки.
          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: >-
            Состояние ссылки. `completed`, `cancelled`, `expired` и `failed`
            являются конечными.
        url:
          type: string
          description: >-
            Размещённая страница верификации, на которую нужно направить
            пользователя. Возвращается только при создании ссылки; при
            последующих чтениях равна `null`, потому что токен не сохраняется.
          nullable: true
          format: uri
        client_token:
          type: string
          description: >-
            Токен для встроенного Bank Link от Didit, который пока не
            предоставляется: откройте `url` сегодня. Возвращается только при
            создании ссылки; при последующих чтениях значение `null`. Имеет одно
            назначение и короткий срок жизни. Не содержит персональных данных.
            Никогда не записывайте его в журнал.
          nullable: true
        expires_at:
          type: string
          description: Когда перестаёт работать неиспользованная ссылка.
          format: date-time
        connection_id:
          type: string
          description: >-
            Подключение, которое создала или продлила эта ссылка, когда `status`
            принимает значение `completed`.
          format: uuid
          nullable: true
        check_id:
          type: string
          description: >-
            Результат проверки владения по этой ссылке, если запрошено
            `ownership.compare` со значением, отличным от `none`.
          format: uuid
          nullable: true
        reused:
          type: boolean
          description: >-
            `true`, когда ссылка завершилась как продление существующего
            подключения, потому что человек уже делится именно этими счетами
            (`duplicates: reuse`). Повторное списание не производится.
        error:
          allOf:
            - $ref: '#/components/schemas/BankLinkError'
          nullable: true
          description: >-
            Почему ссылка не сработала, когда `status` равен `failed`. Иначе
            `null`.
        quote:
          $ref: '#/components/schemas/BankLinkQuote'
        vendor_data:
          type: string
          description: Ваш референс из запроса.
          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: >-
        Тело ошибки для каждой операции с банковскими данными. Все поля всегда
        присутствуют.
      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
    BankLinkOwnershipRequest:
      type: object
      description: >-
        Необязательное сравнение владельца счёта с физическим лицом или
        компанией.
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
          description: >-
            С чем сравнивается владелец счёта. `none` (по умолчанию) не выносит
            вердикта и не требует эталона. `person` требует `reference_identity`
            или `session_id`. `business` требует `business` или
            `business_session_id`. Передайте ровно один эталон того типа, с
            которым сравниваете, и ни одного при `none`.
          default: none
        match:
          type: string
          enum:
            - any_holder
            - all_holders
          description: >-
            Должен ли совпадать один юридический владелец или каждый юридический
            владелец. Представители никогда не учитываются.
          default: any_holder
        reference_identity:
          type: object
          description: >-
            Значения, переданные вызывающей стороной, для сверки с владельцем
            счёта. Нельзя отправлять вместе с `session_id`.
          properties:
            full_name:
              type: string
              maxLength: 255
            date_of_birth:
              type: string
              format: date
            address:
              type: string
              maxLength: 500
            phone:
              type: string
              maxLength: 64
            email:
              type: string
              maxLength: 255
        session_id:
          type: string
          description: >-
            Завершённая сессия верификации Didit проверяемого лица, с которым
            выполняется сравнение. Нельзя передавать вместе с
            `reference_identity`.
          format: uuid
        business:
          type: object
          description: Компания для сравнения с владельцем счёта.
          properties:
            legal_name:
              type: string
              maxLength: 255
            registration_id:
              type: string
              maxLength: 128
          required:
            - legal_name
        business_session_id:
          type: string
          description: >-
            Верификация бизнеса Didit, с которой выполняется сравнение. Нельзя
            передавать вместе с `business`.
          format: uuid
    BankLinkEndUser:
      type: object
      description: Пользователь или компания, которые подключают счёт.
      properties:
        reference:
          type: string
          description: >-
            Ваш собственный идентификатор физического или юридического лица.
            Доступен для поиска через `end_user_reference` и используется для
            распознавания повторного подключения.
          maxLength: 255
        email:
          type: string
          description: >-
            Необязательно. Если маршрут банка требует подтверждённый адрес
            человека, а вы его не передали, Bank Link запрашивает его у
            человека. Никогда не используется в маркетинговых целях.
          format: email
          maxLength: 254
    BankLinkError:
      type: object
      description: >-
        Причина, по которой ссылка завершилась со статусом `failed`. Ничего не
        было опубликовано и не списано.
      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: >-
            Почему ссылка не сработала. Неудачная ссылка не является
            HTTP-ошибкой: ссылка возвращается с `status: failed` и этим
            объектом. Ссылка на продление, подключение по которой тем временем
            изменилось, возвращает `renewal_not_needed` или
            `renewal_window_expired`.
        message:
          type: string
          description: Пояснение простым языком для разработчика.
        conflicts_with:
          type: array
          nullable: true
          items:
            type: string
            format: uuid
          description: >-
            Для `duplicate_conflict`: идентификаторы активных подключений,
            которые пересекаются. Продлите одно из них или создайте ссылку
            заново с `duplicates: allow`.
      required:
        - code
        - message
        - conflicts_with
    BankLinkQuote:
      type: object
      description: >-
        Стоимость ссылки, зафиксированная при её создании. Списывается стоимость
        из котировки. Чтения не тарифицируются.
      properties:
        id:
          type: string
          description: Идентификатор котировки.
          format: uuid
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Тарифные позиции, за которые взимается плата по этой ссылке, за
            запрошенные области данных.
        fallback_lines:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Стоимость разового запасного чтения, которая указывается только если
            ссылка создана с `allow_one_time_fallback`. Отображается в ответе на
            создание и в остальных случаях равна `null`. Разовое чтение с
            данными может стоить дороже первого месяца постоянного доступа.
        total_usd:
          type: string
          description: >-
            Итог по `lines` в USD. Итог может только уменьшаться: при уменьшении
            предоставленного объёма или когда пользователь выбирает страну с
            более низкой ценой.
          pattern: ^-?\d+(\.\d+)?$
        valid_until:
          type: string
          description: >-
            Котировка закреплена за ссылкой и действует в течение всего срока её
            жизни, поэтому совпадает со значением `expires_at`.
          format: date-time
        scopes:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Данные определяют, к чему относятся цены котировки.
      required:
        - id
        - lines
        - fallback_lines
        - total_usd
        - valid_until
        - scopes
    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
    BankLinkQuoteLine:
      type: object
      description: Одна строка с ценой в ценовом предложении
      properties:
        meter:
          type: string
          description: >-
            Что тарифицируется, например `bank_data_connection_month`,
            `bank_verification`.
          example: bank_data_connection_month
        unit:
          type: string
          description: >-
            Что представляет собой одна единица, например `connection_month` или
            `completed_sign_in`.
          example: connection_month
        price_usd:
          type: string
          description: >-
            Цена одной единицы в USD, десятичная строка с 4 знаками после
            запятой. Суммы в примерах иллюстративные; цена для страны указана на
            странице цен.
          pattern: ^-?\d+(\.\d+)?$
          example: '0.9000'
      required:
        - meter
        - unit
        - price_usd
  responses:
    Unauthorized:
      description: Не авторизован
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Недействительный API-ключ
              value:
                detail: Invalid API Key.
    RateLimitedWrite:
      description: >-
        Превышен общий лимит записи: 300 запросов в минуту на один API-ключ.
        Перед повторной попыткой учитывайте `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          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
      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'
    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.