Перейти к основному содержанию
POST
curl
Эндпоинт Didit Create a Bank Link запускает на вашем сервере один запуск Bank Link, чтобы подключить банк или продлить подключение, и возвращает размещённый url. Каждое поле имеет значение по умолчанию, поэтому минимальный запрос выглядит так: {} и всё, что вы хотите указать. Сохраняйте возвращённый id, связав его с пользователем, и сами проверяйте результат через Получить ссылку на банковское подключение или webhook bank.link.completed. См. быстрый старт и Bank Link.

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения берётся в разделе Developers -> API keys в Business Console. Основной ключ имеет полный доступ. Именованный ключ можно ограничить: доступ для каждого ресурса (нет доступа, только чтение или запись), ограничение некоторыми сценариями или одобренными сессиями, список IP-адресов и дата истечения срока. Ответ 401 означает, что ключ неверный, отозван или истёк. Ответ 403 означает, что ключ не передан, у ключа нет доступа к этому ресурсу или действию либо запрос пришёл с адреса вне его списка IP. Ответ 404 на маршруте сессии означает, что сессия находится вне сценариев или статусов, доступных ключу. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без права записи в сессии получает ссылки и токены сессий как null. См. https://docs.didit.me/console/api-keys.

Заголовки

Idempotency-Key
string

Необязательный ключ для безопасных повторных запросов, который вы выбираете для одной операции, до 255 символов (подойдёт UUID). Запрос, повторённый с тем же ключом, endpoint, параметрами запроса и телом, получает первый ответ с тем же статусом и тем же телом и не выполняется и не тарифицируется повторно. Тот же ключ с другим endpoint, параметрами запроса или телом возвращает 409 idempotency_key_reused, а пока первый запрос ещё выполняется, 409 idempotency_key_in_progress с Retry-After. Неудачный запрос (любой 4xx или 5xx) не сохраняется, поэтому его можно отправить повторно с тем же ключом. Ключи принадлежат вашему приложению, независимо от того, вызываете ли вы API с API-ключом или с токеном доступа. См. Повторные попытки и идемпотентность.

Required string length: 1 - 255

Тело

application/json

Создайте Bank Link. Минимальный запрос: {} плюс то, что вам нужно. У каждого поля есть значение по умолчанию.

mode
enum<string>
по умолчанию:connect

connect (по умолчанию) создает новое подключение. renew требует connection_id и использует настройки этого подключения.

Доступные опции:
connect,
renew
connection_id
string<uuid>

Подключение для продления. Только при mode: renew.

access
enum<string>
по умолчанию:one_time

one_time (по умолчанию) считывает данные однократно. ongoing поддерживает доступ открытым до окончания согласия или пока кто-либо не остановит доступ. Если задан institution_id, банк, который не может поддерживать доступ открытым, возвращает 400 ongoing_access_not_available до показа экрана. Без него в выборе банка отображаются только банки, которые могут.

Доступные опции:
one_time,
ongoing
country
string

Необязательно. Без него человек выбирает из стран, которые ваше приложение включило. Страна должна обслуживаться Bank Link; любая другая, включая ZZZ, возвращает 400 invalid_request с field: country. Пустое тело запроса остаётся допустимым.

Pattern: ^[A-Z]{3}$
institution_id
string

Необязательный банк для предварительного выбора из list_institutions. Пропускает выбор банка.

Maximum string length: 64
segment
enum<string>
по умолчанию:any

Фильтрует список выбора банка и указывает банку, какой логин открыть там, где банк разделяет логины. По умолчанию any.

Доступные опции:
personal,
business,
any
data
enum<string>[]

Что читать. accounts включается всегда: название, тип, валюта, идентификаторы и имя владельца, если банк его передаёт. По умолчанию ["accounts"].

Maximum array length: 3
Доступные опции:
accounts,
balances,
transactions
history_days
integer
по умолчанию:90

Количество дней истории транзакций для запроса, от 1 до 365, по умолчанию 90. Банк может предоставить меньше: каждый счёт сообщает, что он передал, в history_coverage. Нельзя отправлять вместе с history_from.

Требуемый диапазон: 1 <= x <= 365
history_from
string<date>

Дата начала истории, которую нужно запросить, вместо history_days. Нельзя передавать вместе с history_days: при совместной передаче ответ 400 history_window_ambiguous. Дата старше 365 дней или в будущем возвращает 400 window_not_available.

extended_history
enum<string>
по умолчанию:standard

allow_extra_auth позволяет банку, который запрашивает еще одно подтверждение, передать более старую историю.

Доступные опции:
standard,
allow_extra_auth

Только для режима ongoing. Сколько дней банку нужно держать доступ открытым, 1 или больше. По умолчанию: максимум, который разрешает банк. Подключение возвращает дату, которую банк фактически предоставил, в consent.expires_at. При access: one_time возвращается 400 invalid_request с field: consent_days.

Требуемый диапазон: 1 <= x <= 32767
ownership
object

Необязательное сравнение владельца счёта с физическим лицом или компанией.

end_user
object

Пользователь или компания, которые подключают счёт.

redirect_url
string<uri>

Куда браузер переходит в конце, с link_id, status и подписанным state (только для отображения: основным источником являются webhook и get_link). В песочнице для приложения обычный адрес http с localhost, 127.0.0.1 или [::1] (любой порт и путь, без учётных данных и фрагмента) не требует регистрации. Любой другой адрес возвращает 400 redirect_url_not_registered: регистрация других адресов пока недоступна. Без redirect_url человек завершает работу на собственной странице результатов Didit.

Maximum string length: 2048
allowed_origins
string<uri>[]

Принимается, но сейчас не используется: зарезервировано для встроенного Bank Link Didit, который ещё не выпущен. Источники HTTPS, до 50.

Maximum array length: 50
language
string

Необязательный код языка, например es или pt-BR. Иначе используется язык браузера.

Maximum string length: 16
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
vendor_data
string

Ваш собственный референс, возвращается в ссылке и подключении.

Maximum string length: 255
expires_in
integer
по умолчанию:3600

Время жизни ссылки в секундах, от 300 до 86400. По умолчанию 3600.

Требуемый диапазон: 300 <= x <= 86400
duplicates
enum<string>
по умолчанию:reuse

reuse (по умолчанию) завершает ссылку, которая ведет к счетам, уже общим для вас, как продление этого подключения. allow создает независимое второе подключение.

Доступные опции:
reuse,
allow
allow_one_time_fallback
boolean
по умолчанию:false

Для ongoing позволяет пользователю продолжить однократным чтением в банке, который не может поддерживать доступ открытым, после подтверждения сокращенного доступа на собственном экране банка. В котировке показано, сколько это стоит. Только при access: ongoing: при одноразовом доступе возвращается 400 invalid_request с field: allow_one_time_fallback.

accept_reduced_grant
boolean
по умолчанию:false

Если банк или человек предоставляет меньше, чем вы запросили, ссылка завершается, и оплачиваются только предоставленные области доступа. В противном случае ссылка завершается со статусом failed и причиной reduced_grant, и оплата не взимается.

sandbox
object

Только для приложений в sandbox: выбирает клиента Didit Test Bank. В продакшн-приложении игнорируется.

Ответ

Ссылка создана.

Один запуск Bank Link для одного пользователя: подключение банка или продление подключения. Подтверждайте ссылку сами с помощью get_link: никогда не доверяйте идентификатору, присланному браузером.

id
string<uuid>
обязательно

Идентификатор ссылки.

mode
enum<string>
обязательно
Доступные опции:
connect,
renew
access
enum<string>
обязательно
Доступные опции:
one_time,
ongoing
status
enum<string>
обязательно

Состояние ссылки. completed, cancelled, expired и failed являются конечными.

Доступные опции:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
обязательно

Размещённая страница верификации, на которую нужно направить пользователя. Возвращается только при создании ссылки; при последующих чтениях равна null, потому что токен не сохраняется.

client_token
string | null
обязательно

Токен для встроенного Bank Link от Didit, который пока не предоставляется: откройте url сегодня. Возвращается только при создании ссылки; при последующих чтениях значение null. Имеет одно назначение и короткий срок жизни. Не содержит персональных данных. Никогда не записывайте его в журнал.

expires_at
string<date-time>
обязательно

Когда перестаёт работать неиспользованная ссылка.

connection_id
string<uuid> | null
обязательно

Подключение, которое создала или продлила эта ссылка, когда status принимает значение completed.

check_id
string<uuid> | null
обязательно

Результат проверки владения по этой ссылке, если запрошено ownership.compare со значением, отличным от none.

reused
boolean
обязательно

true, когда ссылка завершилась как продление существующего подключения, потому что человек уже делится именно этими счетами (duplicates: reuse). Повторное списание не производится.

error
object | null
обязательно

Почему ссылка не сработала, когда status равен failed. Иначе null.

quote
object
обязательно

Стоимость ссылки, зафиксированная при её создании. Списывается стоимость из котировки. Чтения не тарифицируются.

vendor_data
string | null
обязательно

Ваш референс из запроса.

Последнее изменение 22 ноября 2026 г.