Статус проверки

Метод check/{id}

Этот запрос нужен, чтобы проверить статус запроса check и получить ответ на проверку паспорта физлица.

Добавьте в адрес запроса идентификатор, полученный в ответ на запрос проверки паспортных данных. В ответ придет статус проверки.

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

• Для тестирования GET https://kyc-stage.bank131.ru/api/v1.1/check/{id}
• Для реальных операциийGET https://kyc.bank131.ru/api/v1.1/check/{id}

Запрос

Тело запроса пустое.

Пример запроса

cURL

  -X GET https://kyc-stage.bank131.ru/api/v1.1/check/7 \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name'

Ответ

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

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

Содержимое ответа

Дальше описано содержимое объектов Data и Error, которые приходят в ответе при HTTP-коде 200. Посмотреть все HTTP-коды ответа

Статус ok

Проверка прошла успешно, можно отправлять деньги.

Пример ответа

{
    "status": "ok",
    "data":
        {
            "id": "7", // идентификатор запроса `check`
            "description": "valid"
           }
}

Статус pending

Данные отправлены на проверку. Чтобы узнать результат, повторите запрос check{id} чуть позже.

Пример ответа

{
    "status": "pending",
    "data":
        {
            "id": "7",
            "description": "Check in progress"
           }
}

Статус error

code	description	Описание ошибки
invalid_sign	Signature verification failure	Некорректная подпись запроса check
passport_validation_failure, inn_validation_failure	Passport, inn validation failure	Данные не прошли проверку. Проверьте номер паспорта и ИНН и отправьте на проверку еще раз
already_exists	Request with the same data already exists	Вы уже отправляли эти данные на проверку. Чтобы узнать результат, отправьте запрос check{id} с идентификатором предыдущей проверки, который пришел в поле data.id
request_not_found	Request with given id not found	Запрос на проверку с этим идентификатором не найден
partner_project_not_found	partner project not found	Идентификатор проекта, отправленный в заголовке X-PARTNER-PROJECT, не существует

Пример ответа с ошибкой. Данные уже проверили

{
    "status": "error",
    "error": {
        "code": "already_exists",
        "description": "Request with the same data already exists"
    }
    "data": {
        "id": "7" // идентификатор предыдущей проверки
       }
}