Адрес¶

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

Родитель: address_result. Адрес регистрации, полученный по ИИН; общий блок вариантов адресной технологии.

Поля address_result.

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

Поле	Тип в JSON	Назначение и условия
`iin`	string	Обязателен. ИИН запроса.
`status`	string, enum	Обязателен: `UNAPPROVED`, `PENDING`, `VALID`, `INVALID`, `TIMEOUT`, `NOT_FOUND`, `FAILED`, `REQUEST_RATE_LIMIT_EXCEEDED_ERROR`; значения.
`address`	object	Структурированный адрес, если получен; таблица ниже.
`failure_reason`	string, UUID	Идентификатор записанной причины ошибки при её наличии. В этом блоке это не объект `{type, detail}`. Общий массив ошибок может содержать описание причины.
`result`	boolean	Сохранённый результат технологии: `true` — принята, `false` — отрицательный результат. До расчёта может отсутствовать; учитывайте статус и особенности ниже.

result адреса может быть false уже в начальной записи до получения ответа; интерпретируйте его вместе со status.

Родитель: address_result.address.

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

Поле	Тип в JSON	Назначение и условия
`country`	object	Страна; структура территориального элемента ниже.
`region`	object	Регион; структура территориального элемента ниже.
`district`	object	Район; структура территориального элемента ниже.
`city`	string	Населённый пункт.
`street`	string	Улица.
`building`	string	Номер / обозначение здания.
`flat`	string	Номер / обозначение квартиры.
`foreign_data`	object	Динамические данные зарубежного адреса; вложенная схема не зафиксирована.

Родители: address_result.address.country, .region, .district.

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

Поле	Тип в JSON	Назначение и условия
`code`	string	Код территориальной единицы из источника; закрытого справочника в API нет.
`nameRu`	string	Наименование на русском языке.
`nameKz`	string	Наименование на казахском языке.
`changeDate`	string или object	Дата изменения в формате поставщика; возможен динамический объект вместо строки. Единый формат и вложенная схема не установлены.

JSON-примеры¶

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

{
  "address_result": {
    "iin": "000000000000",
    "status": "FAILED",
    "result": false,
    "failure_reason": "55555555-5555-4555-8555-555555555555"
  }
}