Отправка анкеты на проверку
Метод check
Для отправки анкеты бенефициара или выгодоприобретателя в Банк 131 на идентификацию вам следует использовать этот метод.
Запрос v 2.0 позволяет отправить на проверку анкеты физических лиц резидентов и нерезидентов РФ. Запрос v 1.1 позволяет отправить на проверку анкеты только резидентов РФ.
В ответе возвращается идентификатор запроса, по нему можно узнать результат проверки.
- 2.0
- 1.1
Адрес для отправки запроса
Для тестирования
POST https://kyc-stage.bank131.ru/api/v2.0/check
При тестировании реальная проверка паспортных данных в СМЭВ не производится, ответ будет эмулирован. Не используйте тестовую среду для идентификации клиентов.
Для реальных операций
POST https://kyc.bank131.ru/api/v2.0/check
Запрос
Для нерезидентов РФ есть возможность подписи запроса через алгоритм RSA. Для подключения данной возможности обратитесь к вашему менеджеру в Банке 131.
Параметры запроса (данные получателя)
Название | Обязательность | Тип | Описание |
---|---|---|---|
type | + | string | Тип получателя. Возможные значения:FL_RESIDENT — ФЛ-резидент;FL_NONRESIDENT — ФЛ-нерезидент |
last_name | + | string | Фамилия |
first_name | + | string | Имя |
patronymic | - | string | Отчество |
birthday | + | string | Дата рождения. Формат: ДД.ММ.ГГГГ. Получатель должен быть старше 18-ти лет |
birthplace | + | string | Место рождения |
citizenship | + | string | Гражданство. Формат: ISO 3166-1 alpha-2 |
inn | + | string | ИНН. Допустимое количество символов: минимум — 6, максимум — 14 |
phone_number | + | string | Номер телефона в любом формате |
+ | string | Адрес электронной почты (нужен валидный адрес) | |
documents | + | array | Набор обязательных документов, меняется в зависимости от типа бенефициара и его гражданства:для физлиц резидентов РФ — обязателен только паспорт РФ PASSPORT_RF ;для физлиц нерезидентов РФ - обязателен иностранный паспорт FOREIGN_PASSPORT и любой другой тип документа, кроме паспорта РФ PASSPORT_RF ;для граждан республики Беларусь — обязателен только иностранный паспорт FOREIGN_PASSPORT |
type | + | string | Тип документа. Возможные значения:PASSPORT_RF — паспорт РФ;FOREIGN_PASSPORT — иностранный паспорт;MIGRATION_CARD — миграционная карта;RESIDENT_CARD — вид на жительство;REFUGEE_CERTIFICATE — удостоверение беженца;VISA — виза;ARRIVAL_NOTICE — уведомление о прибытии;TEMPORARY_RESIDENCE_PERMIT — разрешение на временное проживание;PATENT — патент |
number | + (не обязательно только для типа ARRIVAL_NOTICE ) | string | Номер документа. Допустимое количество символов для типа FOREIGN_PASSPORT : минимум — 2, максимум — 10. Для остальных типов без ограничений. При наличии серии передаётся вместе с номером в формате СЕРИЯНОМЕР |
issuer | - (обязательно только для типов PASSPORT_RF и FOREIGN_PASSPORT ) | string | Кем выдан |
issuer_date | + | string | Дата выдачи в формате ДД.ММ.ГГГГ |
expire_date | + (обязательно для всех типов, кроме PASSPORT_RF и FOREIGN_PASSPORT ) | string | Дата окончания срока действия документа. Указываемая дата должна быть строго больше текущей. Разница между датой выдачи и датой окончания не должна превышать определенный срок, в зависимости от типа:MIGRATION_CARD — 1 год;RESIDENT_CARD — 10 лет;REFUGEE_CERTIFICATE — 3 года; VISA — 3 года;ARRIVAL_NOTICE — 180 дней;TEMPORARY_RESIDENCE_PERMIT — 3 года; PATENT — 1 год |
issuer_code | - (обязательно только для типа PASSPORT_RF ) | string | Код подразделения |
address | + | string | Адрес |
postcode | - | string | Почтовый индекс |
agent_contract_number | + | string | Номер агентского договора с получателем |
agent_contract_date | + | string | Дата агентского договора с получателем. Формат: ДД.ММ.ГГГГ. Дата должна быть меньше или равна текущей дате |
beneficial_owners | + | string | Сведения о бенефициарных владельцах. Возможные значения: БВ отсутствуют |
public_officials | + | string | Принадлежность к ПДЛ. Возможные значения: Нет |
Примеры запросов
- Для ФЛ-резидента
- Для ФЛ-нерезидента
- Для ФЛ-нерезидента с подписью через RSA
curl -X POST
https://kyc.bank131.ru/api/v2.0/check/ \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payload": {
"type": "FL_RESIDENT",
"last_name": "Дмитриев",
"first_name": "Иван",
"patronymic": "Герасимович",
"birthday": "01.01.1970",
"birthplace": "г. Новгород",
"citizenship": "RU",
"inn": "065553161159",
"phone_number": "+79000000000",
"email": "name@email.com",
"documents": [
{
"type": "PASSPORT_RF ",
"number": "0234567890",
"issuer": "ОТДЕЛОМ УФМС РОССИИ",
"issuer_date": "01.01.2010",
"issuer_code": "123-000"
}
],
"address": "г. Новгород, алл. Прибрежная, д. 53 стр. 9",
"postcode": "365826",
"agent_contract_number": "123456789-0",
"agent_contract_date": "01.01.2020",
"beneficial_owners": "БВ отсутствуют",
"public_officials": "Нет"
},
"signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'
curl -X POST
https://kyc.bank131.ru/api/v2.0/check/ \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"payload": {
"type": "FL_NONRESIDENT",
"last_name": "Гусейнов",
"first_name": "Гусейн",
"patronymic": "Гусейнович",
"birthday": "13.01.1990",
"birthplace": "г. Душанбе",
"citizenship": "TJ",
"inn": "AA0000000",
"phone_number": "+79000000000",
"email": "name@email.com",
"documents": [
{
"type": "FOREIGN_PASSPORT",
"number": "FA0000000",
"issuer": "УВД г. Душанбе",
"issuer_date": "12.02.2020"
},
{
"type": "MIGRATION_CARD",
"number": "11111111111",
"issuer_date": "12.10.2023",
"expire_date": "11.10.2024"
}
],
"address": "г. Новгород, алл. Прибрежная, д. 53 стр. 9",
"postcode": "365826",
"agent_contract_number": "123456789-0",
"agent_contract_date": "01.01.2020",
"beneficial_owners": "БВ отсутствуют",
"public_officials": "Нет"
},
"signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'
curl -X POST \
https://kyc.bank131.ru/api/v2.0/check/ \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"type": "FL_NONRESIDENT",
"last_name": "Гусейнов",
"first_name": "Гусейн",
"patronymic": "Гусейнович",
"birthday": "13.01.1990",
"birthplace": "г. Душанбе",
"citizenship": "TJ",
"inn": "AA0000000",
"phone_number": "+79000000000",
"email": "name@email.com",
"address": "г. Новгород, алл. Прибрежная, д. 53 стр. 9",
"agent_contract_number": "123456789-0",
"agent_contract_date": "01.01.2020",
"beneficial_owners": "БВ отсутствуют",
"public_officials": "Нет",
"documents": [
{
"type": "FOREIGN_PASSPORT",
"number": "FA0000000",
"issuer": "УВД г. Душанбе",
"issuer_date": "12.02.2020"
},
{
"type": "MIGRATION_CARD",
"number": "11111111111",
"issuer_date": "05.12.2023",
"expire_date": "01.12.2024"
}
],
"postcode": "365826"
}'
Ответ
При тестировании успех проверки (значение поля
status
в ответе) зависит от последней цифры номера паспорта в полеpassport_number
в запросе.
Последняя цифра passport_number | Значение status |
---|---|
Четный, включая 0 | ok |
Нечетный | error |
Параметры ответа
Название | Обязательность | Тип | Описание |
---|---|---|---|
status | + | string | Статус идентификации. Возможные варианты: ok , error |
data | - | Data | Объект с данными ответа |
id | - | number | Идентификатор запроса check |
description | - | string | Описание статуса запроса |
error | - | Error | Объект с данными ошибки |
code | + | string | Код ошибки |
description | + | string | Описание ошибки |
Примеры ответов
- Успешный ответ
- Ответ с ошибкой
{
"status": "ok",
"data": {
"id": "7",
"description": "запрос добавлен в очередь"
}
}
{
"status": "error",
"error": {
"code": "partner_project_not_found",
"description": "partner project not found"
}
}
Адрес для отправки запроса
Для тестирования
POST https://kyc-stage.bank131.ru/api/v1.1/check
При тестировании реальная идентификация паспортных данных в СМЭВ не производится, результат идентификации будет эмулирован. Не используйте идентификацию на тестовой среде для идентификации клиентов.
Для реальных операций
POST https://kyc.bank131.ru/api/v1.1/check
Запрос
Параметры запроса
Данные получателя
Название | Обязательность | Тип | Описание |
---|---|---|---|
last_name | + | string | Фамилия |
first_name | + | string | Имя |
patronymic | + | string | Отчество |
birthday | + | string | Дата рождения |
birthplace | + | string | Место рождения |
inn | + | string | ИНН, 12 цифр |
Удостоверение личности (паспорт)
Название | Обязательность | Тип | Описание |
---|---|---|---|
identity_document | + | string | Тип документа. Всегда: Паспорт гражданина РФ |
passport_number | + | string | Серия и номер паспорта, без пробелов. Пример: 1234567890 . |
issuer | + | string | Кем выдан |
issuer_code | + | string | Код подразделения |
issuer_date | + | string | Дата выдачи в формате ДД.ММ.ГГГГ |
citizenship | + | string | Гражданство. Всегда РФ |
Адрес регистрации
Название | Обязательность | Тип | Описание |
---|---|---|---|
postcode | + | string | Индекс |
address | + | string | Адрес |
Контакты получателя
Название | Обязательность | Тип | Описание |
---|---|---|---|
+ | string | Адрес электронной почты (нужен валидный адрес) | |
phone_number | + | string | Номер телефона в любом формате |
Дополнительные данные
Название | Обязательность | Тип | Описание |
---|---|---|---|
agent_contract_number | + | string | Номер агентского договора с получателем |
agent_contract_date | + | string | Дата агентского договора с получателем |
beneficial_owners | + | string | Всегда БВ отсутствуют |
public_officials | + | string | Всегда Нет |
migration_card | + | string | Всегда - |
right_to_stay_in_rf | + | string | Всегда - |
Пример запроса
curl -X POST \
https://kyc.bank131.ru/api/v1/check/' \
-H 'x-partner-project: test-partner-project' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
-d '{
"payload": {
"inn": "065553161159",
"email": "name@email.com",
"issuer": "ОТДЕЛОМ УФМС РОССИИ",
"address": "г. Бобруйск, алл. Прибрежная, д. 53 стр. 9, 365826",
"birthday": "01.01.1970",
"postcode": "365826",
"birthplace": "г. Бобруйск",
"last_name": "Дмитриев",
"first_name": "Иван",
"patronymic": "Герасимович",
"citizenship": "РФ",
"issuer_code": "123-000",
"issuer_date": "01.01.2010",
"phone_number": "+79000000000",
"migration_card": "-",
"passport_number": "0234567890",
"public_officials": "Нет",
"beneficial_owners": "БВ отсутствуют",
"identity_document": "Паспорт гражданина РФ",
"agent_contract_date": "01.01.2020",
"right_to_stay_in_rf": "-",
"agent_contract_number": "123456789-0"
},
"signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'
Ответ
При тестировании успех идентификации (значение поля
status
в ответе) зависит от последней цифры номера паспорта в полеpassport_number
в запросе.
Последняя цифра passport_number | Значение status |
---|---|
Четный, включая 0 | ok |
Нечетный | error |
Параметры ответа
Название | Обязательность | Тип | Описание |
---|---|---|---|
status | + | string | Статус идентификации. Возможные варианты: ok , error |
data | - | Data | Объект с данными ответа |
id | - | number | Идентификатор запроса check |
description | - | string | Описание статуса запроса |
error | - | Error | Объект с данными ошибки |
code | + | string | Код ошибки |
description | + | string | Описание ошибки |
Примеры ответов
- Успешный ответ
- Ответ с ошибкой
{
"status": "ok",
"data": {
"id": "7",
"description": "запрос добавлен в очередь"
}
}
{
"status": "error",
"error": {
"code": "partner_project_not_found",
"description": "partner project not found"
}
}