Результаты проверки анкеты

Метод check/{id}

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

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

2.0

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

• Для тестирования 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	-	object	Объект с данными ответа
id	-	number	Идентификатор запроса check
description	-	string	Описание статуса запроса
error	-	object	Объект с данными ошибки
code	+	string	Код ошибки
description	+	string	Описание ошибки

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

Успешный ответ

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

Запрос в обработке

{
  "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"
  }
}

1.0

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

• Для тестирования 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	Описание статуса запроса
error	-	object	Объект с данными ошибки
code	+	string	Код ошибки
description	+	string	Описание ошибки

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

Успешный ответ

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

Запрос в обработке

Повторите запрос 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"
  }
}