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

Статус идентификации

Метод check/{id}​

Чтобы узнать результат проверки анкеты физлица, используйте этот метод.

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

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

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

Запрос​

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

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

  -X GET https://kyc.bank131.ru/api/v2.0/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"
       }
}