PPS¶

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

Родитель: pps_result. Полученные по ИИН фотографии документов, в том числе повторно использованные.

Поля pps_result.

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

Поле	Тип в JSON	Назначение и условия
`iin`	string	Обязателен. ИИН запроса, до 12 символов.
`status`	string, enum	Обязателен: `UNAPPROVED`, `PENDING`, `VALID`, `COPIED`, `INVALID`, `TIMEOUT`, `NOT_FOUND`, `FAILED`, `ERROR_ACCEPTED`; значения.
`source_session`	string, UUID	Исходная сессия для скопированного результата.
`photos`	object[]	Обязателен, может быть `[]`. Все сохранённые фотографии результата, от новых к старым.
`result`	boolean	Сохранённый результат технологии: `true` — принята, `false` — отрицательный результат. До расчёта может отсутствовать; учитывайте статус и особенности ниже.
`failure_reason`	object	Причина отказа, если записана; структура.

Родитель: pps_result.photos[].

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

Поле	Тип в JSON	Назначение и условия
`code_type_doc`	string	Код типа документа от поставщика, до 64 символов.
`num_doc`	string	Номер документа, до 50 символов.
`photo`	string	URL фотографии при наличии файла; ссылка и в полном, и в light-ответе.

JSON-примеры¶

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

{
  "pps_result": {
    "iin": "000000000000",
    "status": "COPIED",
    "result": true,
    "source_session": "44444444-4444-4444-8444-444444444444",
    "photos": [
      {
        "photo": "https://files.example.invalid/pps/photo.png"
      }
    ]
  }
}