Подсказки по банкам (API)

Помогает человеку быстро ввести реквизиты банка на веб-форме или в приложении.

Ищет кредитные организации:

по БИК,
SWIFT,
ИНН,
ИНН + КПП,
названию,
адресу до улицы (с ограничениями).

Что умеет:

✔️ Фильтрует по типу: банки, НКО и филиалы.

✔️ Умеет искать как действующие банки, так и банки на ликвидации.

✔️ Учитывает, где вы находитесь (геолокация до города).

Запрос

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{ "query": "альфа" }' \
  http://ВАШ_СЕРВЕР:ПОРТ/suggestions/api/4_1/rs/suggest/bank

Заголовки

Заголовок Описание

Content-Type

Тип данных в запросе: application/json или application/xml

Accept

Тип данных в ответе: application/json или application/xml

Authorization

API-ключ в формате: Token ВАШ_КЛЮЧ

Только для пользователей подсказок DaData.ru

Параметры

Параметр	Обязательный?	Описание
`query`	да	Запрос, для которого нужно получить подсказки
count	нет	Количество возвращаемых подсказок (по умолчанию — 10, максимум — 20).
status	нет	Ограничение по статусу организации
type	нет	Ограничение по типу организации
locations	нет	Ограничение по адресу организации
locations_boost	нет	Приоритет города при ранжировании

Ответ

Возвращается список объектов банка:

Поле	Тип данных	Описание
value	string(1000)	Для банков (`opf.type = BANK`): краткое наименование (`data.name.short`). Если краткое наименование не указано — платежное наименование (`data.name.payment`). Для всех остальных: платежное наименование (`data.name.payment`).
unrestricted_value	string(1000)	= value
data.bic	string(10)	БИК
data.swift	string(20)	SWIFT
data.inn	string(20)	ИНН (начиная с версии 20.3)
data.kpp	string(10)	КПП (начиная с версии 20.3)
data.correspondent_account	string(20)	Корреспондентский счет
data.treasury_accounts[]	string[](20)	Казначейские счета территориального ОФК (21.2+)
data.registration_number	string(10)	Регистрационный номер
data.name └ payment └ full └ short	string(200) string(1000)	Наименование: — платежное — не заполняется — краткое
data.payment_city	string(50)	Город для платежного поручения (поля справочника Tnp + Nnp) (начиная с версии 19.7)
data.opf		Тип кредитной организации
└ type	string(50)	Код типа CBR — главное управление Банка России (21.2+) BANK — банк BANK_BRANCH — филиал банка NKO — небанковская кредитная организация (НКО) NKO_BRANCH — филиал НКО RKC — расчетно-кассовый центр TREASURY — территориальный орган Федерального казначейства (21.2+) OTHER — другой
└ full		не заполняется
└ short		не заполняется
data.cbr	object	Управление Банка России, к которому относится банк. Заполняется только при вызове через метод API findById (21.2+) В поле возвращается Объект банка без заполнения гранулярных полей адреса.
data.address		Адрес регистрации
└ value	string(1000)	— адрес банка одной строкой (краткий) Стандартизован, поэтому может отличаться от записанного в справочнике БИК.
└ unrestricted_value	string(1000)	— адрес банка одной строкой (полный)
└ data		— гранулярный адрес
└ data.source	string(1000)	— адрес одной строкой как в справочнике БИК
└ data.qc	string(10)	— код качества адреса (начиная с версии 19.1) 0 — адрес распознан уверенно 1 или 3 — требуется ручная проверка
data.state		Состояние
└ actuality_date	long	— дата актуальности сведений
└ registration_date	long	— дата регистрации
└ liquidation_date	long	— дата ликвидации
└ status	string(50)	— статус ACTIVE — действующая LIQUIDATING — ликвидируется LIQUIDATED — ликвидирована Статус LIQUIDATED в реальных данных не встречается, потому что Банк России не возвращает информацию о ликвидированных финансовых организациях.
data.okpo		не заполняется
data.phone		не заполняется
data.rkc		не заполняется

Формат даты

Даты регистрации и ликвидации — количество миллисекунд от 01.01.1970. Хранится в UTC.

Для JavaScript преобразуется в дату так:

var ticks = 989784000000,
    date = new Date(ticks);

Для PHP:

$ticks = 989784000000;
$sec = $ticks / 1000;
echo date("d.m.Y", $sec);

Для Java:

long ticks = 989784000000;
Calendar cal = Calendar.getInstance();
cal.setTimeInMillis(ticks);

Для C#:

long ticks = 989784000000;
DateTime date = new DateTime(long.Parse(ticks));

Примеры

Запрос:

{
  "query": "альфа" 
}

Ответ:

{
    "suggestions": [
        {
            "value": "АЛЬФА-БАНК",
            "unrestricted_value": "АЛЬФА-БАНК",
            "data": {
                "opf": {
                    "type": "BANK",
                    "full": null,
                    "short": null
                },
                "name": {
                    "payment": "АО \"АЛЬФА-БАНК\"",
                    "full": null,
                    "short": "АЛЬФА-БАНК"
                },
                "bic": "044525593",
                "swift": "ALFARUMMXXX",
                "inn": "7728168971",
                "kpp": "770801001",
                "okpo": null,
                "correspondent_account": "30101810200000000593",
                "registration_number": "1326",
                "payment_city": "г. Москва",
                "state": {
                    "status": "ACTIVE",
                    "actuality_date": 1583280000000,
                    "registration_date": 662860800000,
                    "liquidation_date": null
                },
                "rkc": null,
                "address": {
                    "value": "г Москва, ул Каланчевская, д 27",
                    "unrestricted_value": "107078, г Москва, Красносельский р-н, ул Каланчевская, д 27",
                    "data": {
					...                    }

                },
                "phones": null
            }
        }
	]
}