Статус проверки
check/{id}
Метод Этот запрос нужен, чтобы проверить статус запроса check
и получить ответ на проверку паспорта физлица.
Добавьте в адрес запроса идентификатор, полученный в ответ на запрос проверки паспортных данных. В ответ придет статус проверки.
Адрес для отправки запроса
- Для тестирования
GET https://kyc-stage.bank131.ru/api/v1.1/check/{id}
- Для реальных операциий
GET https://kyc.bank131.ru/api/v1.1/check/{id}
Запрос
Тело запроса пустое.
Пример запроса
-X GET https://kyc.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 | Описание статуса запроса |
participant | - | Participant | Данные получателя выплаты |
reference | - | string | Идентификатор получателя |
error | - | Error | Объект с данными ошибки |
code | + | string | Код ошибки |
description | + | string | Описание ошибки |
Пример успешного ответа
{
"status": "ok",
"data":
{
"id": "7", // идентификатор запроса `check`
"description": "valid",
"participant":
{
"reference": "123"
}
}
}
Пример ответа: запрос в обработке
Повторите запрос check/{id} с этими же данными чуть позже.
{
"status": "pending",
"data":
{
"id": "7",
"description": "Check in progress"
}
}
Пример ответа с ошибкой. Данные уже проверили
{
"status": "error",
"error": {
"code": "already_exists",
"description": "Request with the same data already exists"
}
"data": {
"id": "7" // идентификатор предыдущей проверки
}
}