E-Document¶

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

Родитель: edocument_result. Полученный электронный документ и вспомогательные сведения.

Поля edocument_result.

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

Поле	Тип в JSON	Назначение и условия
`status`	string, enum	Обязателен: `NOT_RECEIVED` — не получен; `PENDING` — ожидание; `RECEIVED` — получен; `CANCELED` — получение отменено; `COPIED` — использован прежний результат.
`document_type`	string, enum	Обязателен. Тип электронного документа, значения ниже; отличается от обозначений типа во входных параметрах.
`result_json`	JSON	Данные документа от Государственного сервиса. Динамический JSON, зависящий от типа документа.
`face_photo`	string	Фото лица; только при наличии файла.
`barcode`	string	Изображение штрихкода; только при наличии файла.
`qrcode`	string	Изображение QR-кода; только при наличии файла.
`document_image`	string	Изображение документа; только при наличии файла.
`document_pdf`	string	PDF документа; только при наличии файла.
`is_subject_in_mcdb`	boolean	Найден ли пользователь в Базе мобильных граждан (БМГ / MCDB), если проверка дала значение.
`phone`	string	Телефон пользователя, если сохранён; может быть пустой строкой. Единый формат здесь не проверяется.
`source_session`	string, UUID	Исходная сессия при повторном использовании данных.
`gender`	string	Вычисляется по 7-й цифре ИИН владельца в `result_json.common.docOwner.iin`: `male` — нечётная 1/3/5, `female` — чётная 2/4/6, `foreigner` — 0, `error` — цифра больше 6. При отсутствии исходного ИИН поле отсутствует. Это результат декодирования ИИН, не модельная оценка лица.
`extra`	object	Обязателен, может быть `{}`. Дополнительные даты в нормализованном формате.
`result`	boolean	Сохранённый результат технологии: `true` — принята, `false` — отрицательный результат. До расчёта может отсутствовать; учитывайте статус и особенности ниже.
`failure_reason`	object	Причина отказа, если записана; структура.

Пять файловых полей содержат Base64 в полном ответе и ссылки в light. Документ не обязан содержать все файлы одновременно.

Родитель: edocument_result.extra или edocument_child_result.extra.

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

Поле	Тип в JSON	Назначение и условия
`date_of_birth`	string, date	Дата рождения, `YYYY-MM-DD`, если извлечена.
`date_of_issue`	string, date	Дата выдачи, `YYYY-MM-DD`, если извлечена.
`date_of_expire`	string, date	Дата окончания действия, `YYYY-MM-DD`, если извлечена. Обратите внимание на имя `expire`, а не `expiry`.

extra формируется из временных меток документа, выраженных в миллисекундах Unix. API возвращает уже преобразованную календарную дату; не трактуйте эти строки как исходные метки времени. Структуры common, domain и других разделов result_json не становятся обязательными лишь потому, что из них извлекаются отдельные значения.

Значения edocument_result.document_type и edocument_child_result.document_type.

Это перечень значений модели результата, а не гарантия доступности всех документов в каждом Workflow.

Поле	Тип в JSON	Назначение и условия
`IdentityCard`	string	удостоверение личности
`DriverLicense`	string	водительское удостоверение
`BirthCertificate`	string	свидетельство о рождении
`MarriageCertificate`	string	свидетельство о браке
`ChangeFioCertificate`	string	свидетельство о перемене ФИО
`DivorceCertificate`	string	свидетельство о расторжении брака
`Diploma`	string	диплом
`SRTS`	string	свидетельство о регистрации транспортного средства
`Vaccination`	string	документ о вакцинации
`SocialId`	string	социальное удостоверение
`DisabilityCertificate`	string	справка об инвалидности
`LargeFamilyCertificate`	string	документ многодетной семьи
`AspCertificate`	string	справка об адресной социальной помощи
`TechPassport`	string	технический паспорт
`Pension`	string	пенсионный документ
`Passport`	string	паспорт
`StudentCard`	string	студенческий билет
`Vnzh`	string	вид на жительство
`PcrCertificate`	string	справка ПЦР
`LbgCard`	string	удостоверение лица без гражданства
`InsurancePolicy`	string	страховой полис
`Hunter`	string	удостоверение охотника
`Oralman`	string	удостоверение оралмана / кандаса
`Attorney`	string	документ типа Attorney; точная категория локальным кодом не раскрыта
`SchoolCard`	string	школьный документ
`CollegeDiploma`	string	диплом колледжа
`Voucher`	string	документ типа Voucher; точное назначение локальным кодом не раскрыто
`ChildIdentityCard`	string	удостоверение личности ребёнка
`ChildBirthCertificate`	string	свидетельство о рождении ребёнка
`ChildPassport`	string	паспорт ребёнка
`ChildSchoolCard`	string	школьный документ ребёнка

Детский E-Document¶

Родитель: edocument_child_result. Отдельно выбирается результат детской технологии; структура всех полей и объекта extra совпадает с E-Document.

В этом блоке оба endpoints возвращают Base64 в face_photo, barcode, qrcode, document_image, document_pdf. Light не заменяет их ссылками. Условия наличия, исключение null, статусы и enum типов документов те же, что в таблицах E-Document. Обычный и детский блоки могут присутствовать одновременно.

JSON-примеры¶

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

{
  "edocument_result": {
    "status": "COPIED",
    "document_type": "IdentityCard",
    "result": true,
    "source_session": "44444444-4444-4444-8444-444444444444",
    "extra": {
      "date_of_birth": "1990-01-01",
      "date_of_issue": "2025-01-01",
      "date_of_expire": "2035-01-01"
    }
  }
}

{
  "edocument_child_result": {
    "status": "PENDING",
    "document_type": "ChildBirthCertificate",
    "extra": {}
  }
}