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

MxDocument

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

Родитель: mxdocument_result. Распознавание мексиканского документа, извлечение QR-данных и результаты дополнительных проверок.

Поля mxdocument_result.

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

Поле Тип в JSON Назначение и условия
result boolean Сохранённый результат технологии: true — принята, false — отрицательный результат. До расчёта может отсутствовать; учитывайте статус и особенности ниже.
frontside_image string Лицевая сторона: Base64 / ссылка в light при наличии файла.
backside_image string Оборотная сторона: Base64 / ссылка в light при наличии файла.
face_photo string Лицо, извлечённое из QR-данных: Base64 / ссылка в light при наличии файла.
result_json JSON Данные ответа поставщика; динамическая структура.
qr_extraction_data JSON Данные, извлечённые из QR; динамическая структура.
qr_validation_data JSON Проверка QR; динамическая структура.
face_comparison_data JSON Сравнение лиц; динамическая структура.
failure_reason object Причина отказа, если записана; структура.

JSON-примеры

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

{
  "mxdocument_result": {
    "result": true,
    "frontside_image": "https://files.example.invalid/mx/front.png"
  }
}