Проверка паспорта
check
Метод Этот запрос нужен, чтобы провести проверку паспортных данных получателя выплаты (физлица).
В ответе возвращается идентификатор запроса, по нему можно узнать результат проверки.
Адрес для отправки запроса
- Для тестирования
POST https://kyc-stage.bank131.ru/api/v1.1/check
- Для реальных операциий
POST https://kyc.bank131.ru/api/v1.1/check
Запрос
Параметры запроса
Данные получателя
Название | Обязательность | Тип | Описание |
---|---|---|---|
first_name | + | string | Фамилия |
last_name | + | string | Имя |
patronymic | - | string | Отчество |
birthday | + | string | Дата рождения |
birthplace | + | string | Место рождения |
inn | + | number | ИНН, 10 цифр |
Удостоверение личности (паспорт)
Название | Обязательность | Тип | Описание |
---|---|---|---|
identity_document | + | string | Тип документа. Всегда: Паспорт РФ |
passport_number | + | number | Серия и номер паспорта, без пробелов. Пример: 1234567890 |
issuer | + | string | Кем выдан |
issuer_code | + | string | Код подразделения |
issuer_date | + | string | Дата выдачи в формате ДД.ММ.ГГГГ |
citizenship | + | string | Гражданство. Всегда РФ |
Адрес регистрации
Название | Обязательность | Тип | Описание |
---|---|---|---|
postcode | + | number | Индекс |
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 | Всегда - |
Пример запроса
-X POST https://kyc-stage.bank131.ru/api/v1.1/check \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-d '{
"payload": {
"inn": "123456789012",
"email": "name@email.com",
"issuer": "ОТДЕЛОМ УФМС РОССИИ",
"address": "п. Сосьва (Хант.), алл. Прибрежная, д. 53 стр. 9, 365826",
"birthday": "28.02.1990",
"postcode": "365826",
"last_name": "Дмитриев",
"birthplace": "с. Ербогачен, пер. Павлика Морозова, д. 86 к. 267, 531558",
"first_name": "Иван",
"patronymic": "Герасимович",
"citizenship": "РФ",
"issuer_code": "123-000",
"issuer_date": "01.01.2010",
"phone_number": "+79000000000",
"migration_card": "-",
"passport_number": "1234567890",
"public_officials": "Нет",
"beneficial_owners": "БВ отсутствует",
"identity_document": "Паспорт гражданина РФ",
"agent_contract_date": "01.01.2020",
"right_to_stay_in_rf": "-",
"agent_contract_number": "123456789"
},
"signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'
Ответ
Параметры ответа
Название | Обязательность | Тип | Описание |
---|---|---|---|
status | + | string | Статус проверки. Возможные варианты: ok , error |
data | - | Data | Объект с данными ответа |
id | - | number | Идентификатор запроса check |
description | - | string | Описание статуса запроса |
error | - | Error | Объект с данными ошибки |
code | + | string | Код ошибки |
description | + | string | Описание ошибки |
Содержимое ответа
Дальше описано содержимое объектов Data
и Error
, которые приходят в ответе при HTTP-коде 200
. Посмотреть все HTTP-коды ответа
ok
Статус Запрос проверки создан. Чтобы узнать результат, отправьте запрос check{id}
с идентификатором из поля id
.
Пример ответа
{
"status": "ok",
"data":
{
"id": "7",
"description": "запрос добавлен в очередь"
}
}
error
Статус code | description | Описание ошибки |
---|---|---|
partner_project_not_found | partner project not found | Идентификатор проекта, отправленный в заголовке X-PARTNER-PROJECT , не существует |
Пример ответа с ошибкой
{
"status": "error",
"error": {
"code": "partner_project_not_found",
"description": "partner project not found"
}
}