Перейти к содержанию

MRZ

Общие правила чтения полей, причины отказа и форматы файлов full/light описаны в обзоре.

Родитель: mrz_result. Получение и распознавание машиночитаемой зоны документа.

Поля mrz_result.

Поля с пометкой «Обязателен» присутствуют всегда внутри этого объекта. Остальные поля — при наличии значения; null исключается из ответа.

Поле Тип в JSON Назначение и условия
status string, enum Обязателен: NOT_REQUESTED — не запрошено; REQUESTED — запрошено; IN_PROCESS — в обработке; RECEIVED — получено; REQUEST_FAILED — ошибка запроса; PARSE_FAILED — ошибка распознавания.
photo string URL фото, если файл есть; ссылка в обоих вариантах ответа.
mrz_string string Распознанная MRZ, до 255 символов; может содержать разделители строк. Не является объектом разобранных полей документа.
result boolean Сохранённый результат технологии: true — принята, false — отрицательный результат. До расчёта может отсутствовать; учитывайте статус и особенности ниже.
failure_reason object Причина отказа, если записана; структура.

JSON-примеры

Фрагменты корневого объекта ответа, а не целостные ответы. Все значения и ссылки условные. Формат файлов соответствует пояснениям на этой странице.

{
  "mrz_result": {
    "status": "PARSE_FAILED",
    "result": false,
    "failure_reason": {
      "type": "CLIENT"
    }
  }
}