Обработка ответов и коды ошибок

Обработка ответа

Сначала следует анализировать HTTP-код ответа.

Если код ответа 200, нужно смотреть, что пришло в поле status.

Если статус ok, значит, запрос прошел успешно, смотрите подробности в объекте data.

HTTP-коды ответа

200 — Запрос сформирован правильно, посмотрите, что пришло в поле status.

422 — Ошибка в запросе, подробности — в поле error.description:

• request_body_validation_error — ошибка в теле запроса;
• request_header_validation_error — отсутствует заголовок x-partner-project.

500 — Ошибка на стороне Банка 131, повторите запрос позже.

Статусы ответа

Статусы ответа приходят в поле status.

ok — запрос успешно обработан, смотрите подробности в объекте data.

pending — запрос в обработке, чтобы узнать результат, повторите запрос с теми же данными чуть позже.

error — ошибка в результате обработки запроса, посмотрите, что пришло в объекте error.

Коды ошибок

Ошибки приходят в объекте error:

• code — код ошибки,
• description — описание ошибки.

Код	Описание	Вариант решения
invalid_sign	Запрос с указанным идентификатором подписан некорректно	Проверьте формирование подписи запроса
passport_validation_failure	В базе данных МВД отсутствуют сведения о предоставленном паспорте	Проверьте паспортные данные
passport_validation_failure	По данным МДВ предоставленный паспорт признан недействительным	Проверьте паспортные данные
inn_validation_failure	По данным ФНС предоставленный паспорт не соответствует предоставленному ИНН	Проверьте ИНН
already_exists	Запрос на проверку с теми же данными был направлен ранее	Вы уже отправляли эти данные на идентификацию. Чтобы узнать результат, отправьте запрос check{id} с идентификатором предыдущей проверки, который пришел в поле data.id
request_not_found	Не найден запрос с указанным идентификатором	Запрос на проверку с этим идентификатором не найден. Проверьте идентификатор
partner_project_not_found	Не найден проект с указанным в заголовке идентификатором	Идентификатор проекта, отправленный в заголовке X-PARTNER-PROJECT, не существует. Проверьте идентификатор
birthday_validation_failure	Возраст проверяемого лица ниже допустимого порога	Проверяемый должен быть совершеннолетним. Если вы получили эту ошибку при работе с номинальным счетом, обратитесь к своему менеджеру
validation_error	Запрос не прошел валидацию. Пример: 1 validation error for Request.body → payload → documents → 2 → expire_date. Document MIGRATION_CARD is expired (type=value_error)	Ошибки формата или контролей передаваемых значений. Подробное описание передается в поле description

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

Паспорт недействителен

{
  "status": "error",
  "error": {
    "code": "passport_validation_failure",
    "description": "По данным МДВ предоставленный паспорт признан недействительным"
  }
}

Нет сведений о паспорте

{
  "status": "error",
  "error": {
    "code": "passport_validation_failure",
    "description": "В базе данных МВД отсутствуют сведения о предоставленном паспорте"
  }
}

ИНН и паспорт не прошли проверку

{
  "status": "error",
  "error": {
    "code": "inn_validation_failure",
    "description": "По данным ФНС предоставленный паспорт не соответствует предоставленному ИНН"
  }
}