Актуальную версию документа см. на сайте Министерства цифрового развития, связи и массовых коммуникаций Российской Федерации по адресу https://digital.gov.ru/ru/documents/6186/.

Таблица 6 - Параметры ответа на запрос о персональных данных пользователя

Таблица 6 - Параметры ответа на запрос

о персональных данных пользователя

N

URI запрашиваемого ресурса

Описание ресурса

Предоставляемые данные

1.

/prns/{oid}

Данные о пользователе с идентификатором prn-id

Данные о физическом лице:

<rIdDoc> - идентификатор текущего документа пользователя;

<firstName> - имя;

<lastName> - фамилия;

<middleName> - отчество;

<birthDate> - дата рождения (в формате "ДД.ММ.ГГГГ");

<birthPlace> - место рождения пользователя;

<gender> - пол;

<trusted> - тип учетной записи (подтверждена ("true")/не подтверждена ("false"));

<citizenship> - гражданство (идентификатор страны гражданства);

<snils> - СНИЛС;

<inn> - ИНН;

<updatedOn> - дата последнего изменения учетной записи пользователя (задается как количество секунд, прошедших с 00:00:00 UTC 1 января 1970 года);

<verifying> - процесс проверки данных (true/false);

<status> - статус УЗ (Registered - зарегистрирована/Deleted - удалена);

<selfEmployed> - информация о самозанятом:

- <confirmed> - значение "true" - признак самозанятого есть, "false" - признака самозанятого нет;

- <confirmDate> - дата обновления статуса самозанятого;

<fmsValid> - валидность документа в ФМС (false - документ неактуален, в таком случае, к параметрам добавляется fmsState; true - документ актуален);

<fmsState> - статус документа в ФМС, может иметь значения:

- "PERSON_NOT_FOUND" - по указанному в запросе СНИЛС пользователь в БД ИС МВД не найден;

- "PASSPORT_NOT_FOUND" - в случае, если в полученном досье есть паспорт гражданина РФ и он имеет DOC_STATUS = 302 и в досье нет паспорта гражданина РФ с DOC_STATUS = 300;

- "PASSPORT_INVALID" - в случае, если в полученном досье есть паспорт гражданина РФ и он имеет DOC_STATUS = 301 и его данные (серия, номер) совпадают с указанными в УЗ пользователя, при этом в досье нет паспорта гражданина РФ с DOC_STATUS = 300;

- "AUTO_UPDATE_SUCCESS" - в случае успешного завершения автоматического обновления

2.

/prns/{oid}/ctts

Перечень контактов физического лица

Перечень контактов физического лица (в виде ссылок на ресурс с указанием {ctt_id}, содержащий данные о каждом контакте)

3.

/prns/{oid}/ctts/{ctt_id}

Сведения об отдельной записи в перечне контактов физического лица

Контактные данные:

<type> - тип записи, может иметь значения:

- "MBT" - мобильный телефон;

- "PHN" - домашний телефон;

- "EML" - электронная почта.

<vrfStu> - сведения о "подтвержденности" контактов, может иметь значения:

- "NOT_VERIFIED" - не подтвержден;

- "VERIFIED" - подтвержден.

В настоящее время статус "VERIFIED" может быть только у мобильного телефона ("MBT") и адреса электронной почты ("EML").

<value> - значение контакта;

<vrfValStu> - необязательный параметр, указывается в случае, если контакт находится в процессе подтверждения. Может принимать следующее значение:

- "VERIFYING" - в процессе подтверждения.

В настоящее время статус "VERIFYING" может быть только у мобильного телефона ("MBT") и адреса электронной почты ("EML").

<verifyingValue> - значение контакта, находящегося в процессе подтверждения.

4.

/prns/{oid}/addrs

Перечень адресов физического лица

Перечень адресов физического лица (в виде ссылок на ресурс с указанием {addr_id}, содержащий данные о каждом адресе)

5.

/prns/{oid}/addrs/{addr_id}

Сведения об отдельной записи в перечне адресов физического лица

Адреса:

<type> - тип записи, может иметь значения:

- "PLV" - адрес места проживания;

- "PTA" - адрес временной регистрации;

- "PRG" - адрес постоянной регистрации.

<zipCode> - индекс;

<countryId> - идентификатор страны;

<addressStr> - адрес в виде строки (не включая дом, строение, корпус, номер квартиры);

<building> - строение;

<frame> - корпус;

<house> - дом;

<flat> - квартира;

<fiasCode> - код КЛАДР;

<region> - регион;

<city> - город;

<district> - внутригородской район;

<area> - район;

<settlement> - поселение;

<additionArea> - доп. территория;

<additionAreaStreet> - улица на доп. территории;

<street> - улица.

6.

/prns/{oid}/docs

Перечень документов физического лица

Перечень документов физического лица (в виде ссылок на ресурс с указанием {doc_id}, содержащий данные о каждом документе);

7.

/prns/{oid}/docs/{doc_id}

Сведения об отдельной записи в перечне документов физического лица

Документы:

<type> - тип записи, может иметь значения:

- "RF_PASSPORT" - паспорт гражданина РФ;

- "FID_DOC" - документ иностранного гражданина;

- "RF_DRIVING_LICENSE" - водительское удостоверение.

- "MLTR_ID" - военный билет;

- "FRGN_PASS" - заграничный паспорт;

- "MDCL_PLCY" - полис ОМС;

- "RF_BRTH_CERT" - свидетельство о рождении - Россия;

- "FID_BRTH_CERT" - свидетельство о рождении - другая страна;

- "OLD_BRTH_CERT" - свидетельство о рождении - СССР.

<vrfStu> - сведения о "подтвержденности" документов, может иметь значения:

- "NOT_VERIFIED" - не подтвержден;

- "VERIFIED" - подтвержден.

<actNo> - номер актовой записи (для свидетельства о рождении РФ и СССР);

<actDate> - дата актовой записи (только для свидетельства о рождении ребенка РФ);

<series> - серия документа;

<number> - номер документа;

<issueDate> - дата выдачи документа;

<issueId> - код подразделения;

<issuedBy> - кем выдан;

<expiryDate> - срок действия документа;

<lastName> - фамилия (для заграничного паспорта);

<firstName> - имя (для заграничного паспорта).

<vrfValStu> - необязательный параметр, указывается в случае, если документ находится в процессе подтверждения. Может принимать следующее значение:

- "VERIFYING" - в процессе подтверждения;

- "VERIFICATION_FAILED" - ошибки проверки.

"vrfReqId" - идентификатор заявки;

<eTag> - тег изменяемого объекта;

<fmsValid> - валидность документа в ФМС (false - документ неактуален, в таком случае, к параметрам добавляется fmsState; true - документ актуален);

<fmsState> - статус документа в ФМС, может иметь значения:

- "PERSON_NOT_FOUND" - по указанному в запросе СНИЛС пользователь в БД ИС МВД не найден;

- "PASSPORT_NOT_FOUND" - в случае, если в полученном досье есть паспорт гражданина РФ и он имеет DOC_STATUS = 302 и в досье нет паспорта гражданина РФ с DOC_STATUS = 300;

- "PASSPORT_INVALID" - в случае, если в полученном досье есть паспорт гражданина РФ и он имеет DOC_STATUS = 301 и его данные (серия, номер) совпадают с указанными в УЗ пользователя, при этом в досье нет паспорта гражданина РФ с DOC_STATUS = 300;

- "AUTO_UPDATE_SUCCESS" - в случае успешного завершения автоматического обновления

8.

/prns/{oid}/orgs

Перечень организаций, сотрудником которых является данное физическое лицо

Перечень организаций, сотрудником которых является физическое лицо с данным {oid} (в виде ссылок на ресурс с указанием {oid}, содержащий данные о каждой организации)

9.

/prns/{oid}/kids

Перечень записей о детях физического лица

Перечень детей физического лица (в виде ссылок на ресурс с указанием {kid_id}, содержащий данные о каждом ребенке)

10.

/prns/{oid}/kids/{kid_id}

Сведения об отдельной записи в перечне детей физического лица

Дети:

<firstName> - имя ребенка;

<lastName> - фамилия ребенка;

<middleName> - отчество ребенка;

<birthDate> - дата рождения;

<gender> - пол;

<snils> - СНИЛС;

<inn> - ИНН;

<trusted> - признак подтвержденности данных о ребенке (подтверждены ("true")/не подтверждены ("false"));

<updatedOn> - дата последнего изменения данных о ребенке (задается как количество секунд, прошедших с 00:00:00 UTC 1 января 1970 года)

11.

/prns/{oid}/kids/{kid_id}/docs

Перечень документов ребенка физического лица

Перечень документов ребенка данного физического лица (в виде ссылок на ресурс с указанием {doc_id}, содержащий данные о каждом документе)

12.

/prns/{oid}/kids/{kid_id}/docs/{doc_id}

Сведения об отдельной записи в перечне документов ребенка физического лица

Документы ребенка описываются по аналогии с документами физического лица. Для детей предусмотрены следующие типы (<type>) документов:

- "MDCL_PLCY" - полис ОМС;

- "RF_BRTH_CERT" - свидетельство о рождении - Россия;

- "FID_BRTH_CERT" - свидетельство о рождении - другая страна;

- "OLD_BRTH_CERT" - свидетельство о рождении - СССР <31>.

13.

/prns/{oid}/vhls

Перечень транспортных средств

Перечень транспортных средств, которыми владеет данный пользователь

14.

prns/{oid}/vhls?embed=(vehi cles.elements)

Перечень транспортных средств с данными о каждом транспортном средстве

Перечень транспортных средств, которыми владеет данный пользователь, содержащий информацию о каждом транспортном средстве

15.

/prns/{oid}/vhls/{vhl-id}

Транспортное средство пользователя

<name> - имя автомобиля (например, марка или другое пользовательское описание);

<numberPlate> - государственный регистрационный знак;

<regCertificate> - данные свидетельства о государственной регистрации, включает в себя атрибуты:

- <series> - серия свидетельства;

- <number> - номер свидетельства.

--------------------------------

<31> Для просмотра полных данных о ребенке с его документами можно использовать режим встраивания (embed). В этих целях необходимо сделать запрос методом GET по следующему адресу:

/prns/{oid}/kids/{kid_id}?embed=(documents.elements)

При отображении всех коллекций используется механизм paging.

Пример ответа на запрос контактных данных физического лица (фрагмент, разрывы строк даны для удобства чтения):

{

"stateFacts": ["Identifiable"],

"type":"MBT",

"vrfStu":"VERIFIED",

"value":"+7(777)7777777"

}

Пример ответа на запрос конкретного адреса физического лица (фрагмент, разрывы строк даны для удобства чтения):

{

"stateFacts":["Identifiable"],

"eTag": "672951A704B88A0063A35C3F49409152B087A49A",

"id": 21423,

"type": "PRG",

"region": "Воронежская Область",

"addressStr": "Воронежская область, Воронеж город, ПКрл Маяк-1 территория",

"frame": "5",

"fiasCode": "5bf5ddff-6353-4a3d-80c4-6fb27f00c6c1",

"city": "Воронеж Город",

"countryId": "RUS",

Пример ответа на запрос конкретного документа физического лица (фрагмент, разрывы строк даны для удобства чтения):

{

"stateFacts": ["Identifiable"],

"type":"RF_PASSPORT",

"vrfStu":"VERIFIED",

"series":"3333",

"number":"333333",

"issueDate":"1383249600",

"issueId":"333333"

}

Пример ответа на запрос конкретного транспортного средства физического лица (фрагмент, разрывы строк даны для удобства чтения):

{

"stateFacts": ["Identifiable"],

"name": "Хонда",

"numberPlate": "А133ОН177",

"regCertificate": {

"series": "77УЕ",

"number": "204623"

}

}

Пример ответа на запрос всех транспортных средств физического лица, полученный с использованием возможностей встраивания <32> (фрагмент, разрывы строк даны для удобства чтения):

--------------------------------

<32> Запрошенный ресурс: /prns/100000?embed=(vehicles.elements) или /prns/100000/vhls?embed=(vehicles.elements)

{

"stateFacts": ["Paginated"],

"size": 5,

"pageSize": 5,

"pageIndex": 2,

"totalSize": 12,

"eTag": "E6DAE96DADE1CA29F5C50979BBB7C8BF4422FD62",

"elements": [{

"stateFacts": ["Identifiable"],

"id": 6590,

"name": "TOYOTA",

"numberPlate": "А111АА136",

"regCertificate": {"series": "1234","number": "123456"},

"eTag": "F69EEA8910E298E97C8E6249A130A7195DFE7F1A"},

............. }

Для получения категорий самозанятого пользователя система-клиент должна направить в https-адрес REST-API системы ЕСИА запрос методом GET. В запросе должен быть указан ресурс, содержащий необходимые данные. Иерархия идентификаторов этих ресурсов в ЕСИА имеет следующий вид:

/categories/prns/{oid}, где:

- categories - коллекция категорий, имеющихся в ЕСИА;

- prns - перечень (коллекция) пользователей, зарегистрированных в ЕСИА;

- {oid} - внутренний идентификатор объекта, в том числе пользователя, в ЕСИА.

В запрос должен быть добавлен header с маркером доступа, позволяющим получить доступ к данному ресурсу (scope self_employed).

Пример запроса (вызов сервиса в среде разработки):

GET /categories/prns/1077128402 HTTP/1.1\r\n

Authorization: Bearer

eyJ2ZXIiOjEsInR5cCI6IkpXVCIsInNidCI6ImFjY2VzcyIsImFsZyI6IlJTMjU2In0.eyJuYmYiOjE2MDAzNDE5NzEsInNjb3B

lIjoic2VsZl9lbXBsb3llZD9vaWQ9MTA3NzEyNzk1NSIsImlzcyI6Imh0dHA6XC9cL2VzaWEuZ29zdXNsdWdpLnJ1XC8iLCJ1cm

46ZXNpYTpzaWQiOiJjYWRhOTE5N2Q2MDAzZTVmZTI0MDIxOGMyODA1NDc1ZGM4YjIxNTFiZTQ0MGQ1YWQzMTQ3ODFiMDUxNGNmZ

WM2IiwidXJuOmVzaWE6c2JqX2lkIjoxMDc3MTI3OTU1LCJleHAiOjE2MDAzNDU1NzEsImlhdCI6MTYwMDM0MTk3MSwiY2xpZW50

X2lkIjoiUEdVIn0.VySaaGxci6XpwL7V0Df3yLIBENGP7R6ki9sQ4MqdHoc2ItkI4ObI7sClWNaaSQxE_vNXUqszYWUPde_vOWM

oNSbjSUbITPrXr9tgb6LuZbCpKSFxwnu8WAjqQfWfcssNWn9-

MxpAJHrEfVUu6eMpVfcME_qFDc4YtKVLmWQ8viPpL0E2gokn_E67EibHevnJY13H7GpKL0UYzNV40rr4O8Ai2zaGG8WZ3GM_ZRE

FMMbH3aW3mfoCSF_QDKqPiZI6OhhvNtgo6VKarverbFo4y1hqQD7p3KTSXjukoeQ2OYnNHQj9V01mJtxXrTxXIcnkyq8Fj60FCB

uX6bhtgwBQ9Q

Host: esia-portal1.test.gosuslugi.ru\r\n

Accept: */*\r\n

\r\n

Данные, которые ЕСИА возвращает в ответ на запрос, представлены в Таблице 7.