Перейти к основному содержимому

Отправка анкеты на проверку

Метод check​

Для отправки анкеты бенефициара или выгодоприобретателя в Банк 131 на идентификацию вам следует использовать этот метод.

Запрос API v2 позволяет отправить на проверку анкеты физических лиц резидентов и нерезидентов РФ. Запрос API v1 позволяет отправить на проверку анкеты только резидентов РФ.

В ответе возвращается идентификатор запроса, по нему можно узнать результат проверки.

Адрес для отправки запроса​

Для тестирования​

POST https://kyc-stage.bank131.ru/api/v2/check

При тестировании реальная проверка паспортных данных в СМЭВ не производится, ответ будет эмулирован. Не используйте тестовую среду для идентификации клиентов.

Для реальных операций​

POST https://kyc.bank131.ru/api/v2/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Номер телефона в любом формате
email+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Принадлежность к ПДЛ. Возможные значения: Нет
Примеры запросов 
curl -X POST 
https://kyc.bank131.ru/api/v2/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..."
}'

Ответ​

При тестировании успех проверки (значение поля status в ответе) зависит от последней цифры номера паспорта в поле passport_number в запросе.

Последняя цифра passport_numberЗначение status
Четный, включая 0ok
Нечетныйerror

Параметры ответа​

НазваниеОбязательностьТипОписание
status+stringСтатус идентификации. Возможные варианты: ok, error
data-DataОбъект с данными ответа
  id-numberИдентификатор запроса check
  description-stringОписание статуса запроса
error-ErrorОбъект с данными ошибки
  code+stringКод ошибки
  description+stringОписание ошибки
Примеры ответов 
{
  "status": "ok",
  "data": {
    "id": "7",
    "description": "запрос добавлен в очередь"
  }
}