Перейти к основному содержанию
GET
curl
Endpoint Get an Institution от Didit возвращает один банк с его возможностями и состоянием. Значение, которое никогда не наблюдалось, возвращается как null, а не как догадка.

Авторизации

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.

Параметры пути

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

Идентификатор учреждения, например es-banco-norte.

Ответ

Банк.

Банк и его возможности. Значения берутся из данных о наблюдаемых возможностях и обновляются ежедневно. Значение, которое ни разу не наблюдалось, равно null, а не предположение.

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

Идентификатор банка в Didit, стабильный слаг.

Пример:

"es-banco-norte"

name
string
обязательно
country
string
обязательно
Pattern: ^[A-Z]{3}$
logo_url
string<uri> | null
обязательно
timezone
string | null
обязательно

Часовой пояс IANA, в котором указаны даты банка.

segments
enum<string>[]
обязательно
Доступные опции:
personal,
business
access
enum<string>[]
обязательно

ongoing указывается только для банков, где включен постоянный доступ.

Доступные опции:
one_time,
ongoing
ongoing_access
boolean
обязательно

Доступен ли постоянный доступ в этом банке.

Самое длительное согласие, которое разрешает банк, в днях. null, если не наблюдалось.

history_days_max
integer | null
обязательно

Максимальная глубина истории, которую отдаёт банк, в днях. null, если не наблюдалась.

pending_transactions
boolean | null
обязательно

Передаёт ли банк ожидающие транзакции.

pending_linkage
boolean | null
обязательно

Связывает ли банк ожидающую транзакцию с проведённой, что и задаёт pending_id.

balance_types
enum<string>[]
обязательно
Доступные опции:
booked,
available,
expected
transaction_fields
string[]
обязательно

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

sign_in
enum<string> | null
обязательно

Как пользователь входит в банк.

Доступные опции:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
обязательно

Требует ли Bank Link подтверждённый адрес электронной почты у человека.

corporate_accounts
boolean | null
обязательно

Поддерживаются ли счета компаний.

bank_account_selection
boolean | null
обязательно

Выбирает ли человек счета в банке, а не в Bank Link.

Требует ли банк ещё одно подтверждение для предоставления более ранних данных истории.

reconfirmation
boolean | null
обязательно

Можно ли подтвердить продление на экране Didit без входа в банк.

sync_frequency_hours
integer | null
обязательно

Количество часов между автоматическими синхронизациями, если банк допускает более частый график. null означает ежедневный режим по умолчанию.

health
enum<string>
обязательно
Доступные опции:
operational,
degraded,
down
Последнее изменение 22 ноября 2026 г.