Главная Книги - Разные МЕТОДИЧЕСКИЕ РЕКОМЕНДАЦИИ ПО ИНТЕГРАЦИИ С REST API ЦИФРОВОГО ПРОФИЛЯ (Версия 1.60)
поиск по сайту правообладателям
|
|
содержание .. 1 2 ..
МЕТОДИЧЕСКИЕ РЕКОМЕНДАЦИИ
ПО ИНТЕГРАЦИИ С REST API
ЦИФРОВОГО ПРОФИЛЯ
Версия 1.60
Москва 2023
2
Аннотация
Настоящий документ представляет собой методические рекомендации
по интеграции с REST API Цифрового профиля.
Документ предназначен для участников эксперимента по повышению качества
и связанности данных, содержащихся в государственных информационных ресурсах
(см. Постановление Правительства Российской Федерации от 03 июня 2019 г. № 710
«О проведении эксперимента по повышению качества и связанности данных,
содержащихся в государственных информационных ресурсах»).
Материал документа описывает базовые сценарии использования REST API
Цифрового профиля и предоставляет методические рекомендации по интеграции
информационных систем с REST API Цифрового профиля.
Описание сопровождается примерами с фрагментами кода запросов
от информационных систем участников эксперимента и ответов сервисов ЕСИА
и Цифрового профиля на эти запросы.
3
Содержание
Обозначения и сокращения
20
Термины и определения
24
1 Введение
25
2 Как подключиться к REST API цифрового профиля
26
2.1 Подключение к ЦП посредством использования существующего защищенного
канала СМЭВ
28
3 Среды для интеграционного тестирования
30
4 Online-режим запроса согласий
31
4.1 Структура JSON-объекта параметра «permissions»
33
4.2 Сервисы REST API ЕСИА для взаимодействия с платформой согласий
45
4.2.1 Получение всех доступных типов согласий из реестра согласий
45
4.2.2 Получение конкретного типа согласия
48
4.2.3 Получение всех согласий пользователя, выданных организации,
по идентификатору пользователя (oid)
49
4.2.4 Получение согласия пользователя, выданного организации, по идентификатору
согласия
55
4.2.5 Получение архива с подписанным согласием пользователя, выданного
организации, по идентификатору согласия
57
4.2.6 Получение всех архивов с подписанными согласиями пользователя, выданных
организации, по идентификатору пользователя (OID)
58
4.3 Уведомление потребителей платформы согласий
58
5 Получение данных Цифрового профиля пользователя
62
5.1 Методы REST API для получения сведений пользователя
62
5.1.1 Получение основных сведений о гражданине
62
5.1.2 Получение коллекции ссылок на документы определенного типа
63
5.1.3 Получение сведений определенного документа
66
5.1.4 Получение сведений документа в определенном формате (XML или PDF) ...67
5.1.5 Получение сведений определенного документа
68
5.1.6 Получение сведений всех документов, определенного типа
68
5.1.7 Получение сведений документа в определенном формате (XML или PDF) ...72
5.1.8 Получение сведений документа в исходном виде
72
5.1.9 Получение сведений документа в исходном виде по идентификатору документа
..................................................................................................................................76
5.1.10 Получение списка ссылок на файлы, полученные от ведомства,
детализирующие документы данного типа у гражданина
78
5.1.11 Получение ссылки на файл, полученный от ведомства, детализирующий
данный документ
79
4
5.1.12 Получение файла, полученного от ведомства, детализирующего данный
документ
80
5.1.13 Получение всех файлов, полученных от ведомства, детализирующих
документы данного типа для данного гражданина
81
5.2 Данные документов
81
5.2.1 Паспорт гражданина РФ
81
5.2.2 История выданных паспортов
83
5.2.3 Документ иностранного гражданина, удостоверяющий личность на территории
РФ
88
5.2.4 Водительское удостоверение
90
5.2.5 Заграничный паспорт
93
5.2.6 Свидетельство о рождении - другая страна
95
5.2.7 Свидетельство о рождении - СССР
97
5.2.8 Свидетельство о рождении - Россия
98
5.2.9 Свидетельство о заключении брака
100
5.2.10 Свидетельство о расторжении брака
119
5.2.11 Свидетельство о перемене имени
137
5.2.12 Свидетельство об установлении отцовства
157
5.2.13 Сведения о состоянии индивидуального страхового счета застрахованного
лица
179
5.2.14 Справка о доходах и суммах налога физического лица
227
5.2.15 Справка о назначенных пенсиях и социальных выплатах на дату
233
5.2.16 Сведения о трудовой деятельности застрахованного лица в системе
обязательного пенсионного страхования
245
5.2.17 Сведения о назначенных и реализованных мерах социальной защиты
(поддержки)
253
5.2.18 Сведения об инвалидности гражданина
267
5.2.19 Сведения о выписке из регистра сертификатов материнского (семейного)
капитала
273
5.2.20 Сведения об отнесении гражданина к категории граждан предпенсионного
возраста
277
5.2.21 Сведения о полисе ОМС и прикреплении к медицинской организации
284
5.2.22 Выписка о транспортном средстве по владельцу
286
5.2.23 Выписка об ИП из реестра ЕГРИП
290
5.2.24 Выписка о ЮЛ из реестра ЕГРЮЛ
300
5.2.25 Сведения о доходах физического лица и о выплатах страховых взносов,
произведенных в пользу физического лица
321
5.2.26 Сведения о недвижимости пользователя, получаемые из базы данных
Росреестра
325
5.2.27 Цифровой документ об образовании пользователя
330
5
5.2.28 Сведения о статусе самозанятого
349
5.2.29 Сведения о водительском удостоверении, полученном из ГИБДД
352
5.3 Тестирование REST API ЦП
356
5.3.1 Получение тестовых сведений всех документов, определенного типа
356
5.3.2 Получение тестовых сведений документа в исходном виде
360
5.3.3 Получение тестового списка ссылок на файлы, полученные от ведомства,
детализирующие документы данного типа у гражданина
362
5.3.4 Получение тестового файла, полученного от ведомства, детализирующего
данный документ
363
5.3.5 Получение тестового архива с файлами, полученными от ведомства,
детализирующими документ данного типа
363
6
Таблица изменений
Версия
Дата
Автор
Изменение
1.0
13.04.2020
Петраков С.В.
Создание документа
Цирихов А.М.
Жукова Д.А.
1.1
24.04.2020
Жукова Д.А.
Удаление
информации
о
методе
/api/public/v1/prns/{oid}/claimed/permissions;
Обновление спецификации (раздел «Спецификация
сервисов REST API Цифрового профиля и плаформы
согласий»)
1.2
06.05.2020
Цирихов А.М.
Подраздел 5.1 - исключение scope death_cert_doc
из реестра типов согласий и таблицы с перечнем
предоставляемыех
ЕСИА
наборов
данных
о пользователе (scope);
Раздел
6
- исключение типа документа
DEATH_CERT и scope death_cert_doc из видов
документов пользователя в ЦП;
Исключение подраздела 6.2.13 с описанием типа
документа «Свидетельство о смерти» из подраздела
6.2;
Обновление спецификации (раздел «Спецификация
сервисов REST API Цифрового профиля и плаформы
согласий»)
1.3
14.05.2020
Цирихов А.М.
Подраздел
5.5
- добавлено описание требований
к учетной записи уполномоченного сотрудника
организации-потребителя
платформы
согласий,
выполняющего настройку механизмов рассылки
уведомлений о событиях платформы согласий
в «Технологическом портале ЕСИА»
1.4
18.05.2020
Цирихов А.М.
Подраздел 5.5 - добавлены требования к сертификату
SSL для ИС организации-потребителя, для корректного
приема по HTTPS-протоколу REST-сервисом ИС
организации-потребителя уведомлений о событиях
платформы согласий
1.5
25.05.2020
Петраков С.В.
Скорректированы неточности в подразделе 5.2.13
«Сведения о состоянии индивидуального страхового
счета застрахованного лица»:
удален параметр gender;
у параметра version исправлен тип со «строка»
на «целое число»;
7
Версия
Дата
Автор
Изменение
в параметрах ipk, otherPeriodPensFactor,
PensFactor,
currentYearPensFactor,
pensFactorBefore2015
удалено
округление
до трех знаков;
у параметров ipkBefore2015, ipkCurrentYear,
pensRightsTill2002,
pensRights20022014
исправлен тип с «массив» на «объект»;
у параметра quarter (из блока detailPeriods)
указан его тип - массив;
исправлено название параметра detailsPeriod
на detailPeriods.
Раздел 5 - обновлена: добавлен новый вид документа
INCOME_REFERENCE (Справка о доходах и суммах
налога физического лица (форма 2-НДФЛ);
В подразделы
5.1.3 и 5.1.6 добавлено описание
сервисов, позволяющих получить данные по справке
о доходах и суммах налога физического лица только
в одном формате (XML или PDF);
Добавлен подраздел с данными документа «Справка
о доходах и суммах налога физического лица»;
Обновление спецификации (раздел «Спецификация
сервисов REST API Цифрового профиля и плаформы
согласий»)
1.6
02.06.2020
Цирихов А.М.
Исключен подраздел «Offline-режим запроса
Жукова Д.А.
согласий»;
Исключен подраздел «Сервисы REST API ЕСИА
для взаимодействия с платформой соласий»;
Корректировки текста в разделе 5, в подразделах 5.2
(«Online-режим запроса согласий») и «Спецификация
сервисов
REST
API
Цифрового
профиля
и Платформы согласий»;
Обновление
спецификации
(подраздел
«Спецификация сервисов REST API Цифрового
профиля и плаформы согласий»);
Добавлен п.
2.1
с описанием требования
подключения к защищенному каналу СМЭВ
для направления REST-запросов к ЦП
1.7
21.07.2020
Онацкая Т.В.
Добавлен раздел
6.2.16 Справка о назначенных
18.09.2020
Жукова Д.А.
пенсиях и социальных выплатах на дату;
8
Версия
Дата
Автор
Изменение
Добавлен раздел
6.2.17 Сведения о трудовой
деятельности застрахованного лица в системе
обязательного пенсионного страхования;
В разделе 5.1.6 добавлена информация о получении
в ответе идентификаторов запроса и пользователя;
Обновлено вложение zip-архив
1.8
23.09.2020
Жукова Д.А.
Добавление раздела о тестировании REST API ЦП -
п. 5.2.27
1.9
30.09.2020
Жукова Д.А.
Добавление раздела с информацией об интеграционных
средах (п. 3)
1.10
30.10.2020
Тихонова М.А.
В пункте 5.2.1, в таблице 6 - Паспорт гражданина РФ,
пункте 5.2.3, в таблице
8
- Документ иностранного
гражданина, удостоверяющий личность на территории
РФ и в пункте 5.2.5, в таблице 10 - Заграничный паспорт
изменено требование к обязательности атрибутов
«birthplace» и «issiedBy» на «необязательно»
1.11
28.12.2020
Петраков С.В.
Скорректирована информация о Справке о доходах
и суммах налога физического лица в п. 7.1.1, 7.1.2, 7.1.3,
7.2.15.
Добавлен новый тип согласий и новая цель
-
MFO_AGREEMENT
1.12
16.02.2021
Цветкова Г.А.
В разделах 5.2.14, 5.2.15, 5.2.16 заменены строки
Жукова Д.А.
с полным кодом файлов в BASE64 на сокращенный
вариант и указание папки, где хранятся полные
примеры;
Изменено описание примеров ответа на запрос
сведений;
В разделе
5.1.3 обновлено описание пути
/digital/api/public/{version}/pso/{oid}/docs/{doc_type}/
{id}/{fileType};
В разделе
5.2.16 скорректировано описание
параметра dismissalBasis и добавлен вложенный
параметр type;
Добавлен раздел 5.2.17 «Сведения о назначенных
и реализованных
мерах
социальной
защиты
(поддержки)»;
Добавлен раздел 5.2.18 «Сведения об инвалидности
гражданина»;
9
Версия
Дата
Автор
Изменение
Добавлен раздел
5.2.19 «Сведения о выписке
из регистра сертификатов материнского (семейного)
капитала»;
Добавлен раздел 5.2.20 «Сведения об отнесении
гражданина к категории граждан предпенсионного
возраста»;
Добавлен раздел 5.2.21 «Сведения о полисе ОМС
и прикреплении к медицинской организации»;
Добавлен раздел
5.1.1 «Основные сведения
о гражданине»;
Вложение zip-архив в разделе «Спецификация
сервисов REST API Цифрового профиля и плаформы
согласий» заменено вынесено из документа
в отдельный архив;
Разделы с реестрами платформы согласий (типы
согласий, цели, действия, scope) и реестр доступных
сведений ЦП перенесены в документ «Сценарии
использования
инфраструктуры
Цифрового
профиля»;
Добавлен раздел «Сервисы REST API ЕСИА
для взаимодействия с платформой согласий»
1.13
05.03.2021
Петраков С.В.
Удален ошибочно указанный параметр eventGroup
в таблице 22 (Сведения о трудовой деятельности
застрахованного лица в системе обязательного
пенсионного страхования);
Добавлены параметры «error» и «errorUpdatedOn»
в таблицу 14, которые будут возвращаться во второй
версии сервисов REST API для получения сведений
пользователя (пп.
5.1.3 и
5.1.6) для получения
документа «Сведения о состоянии индивидуального
страхового счета застрахованного лица»
1.14
24.03.2021
Губанов В.Ю.
Добавлен
метод
REST
API:
GET
/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/r
aw (Получение выписки в исходном виде
у пользователя с идентификатором oid) (п. 5.1.8);
Добавлен раздел 5.2.22 «Выписка о транспортном
средстве по владельцу»;
В разделе
5.1.1 добавлено уточнение по scope
«addresses»
10
Версия
Дата
Автор
Изменение
1.15
13.04.2021
Петраков С.В.
В п. 5.1.6 добавлен признак расширенной модели
данных (может быть указан только в отношении
свидетельств о браке и разводе);
В п. 5.2.9 добавлено описание параметров и пример
расширенной модели данных для свидетельства
о браке;
В п. 5.2.10 добавлено описание параметров и пример
расширенной модели данных для свидетельства
о разводе;
В п. 7.3 добавлены новые виды сведений:
MDCL_PLCY - 1 заглушка;
PRE_RETIREMENT_AGE - 2 заглушки;
FAMILY_ASSETS - 3 заглушки;
DISABLED_PERSON - 2 заглушки;
PAYMENTS_EGISSO - 1 заглушка
1.16
28.04.2021
Губанов В.Ю.
В п. 7.2.16 добавлены параметры ответа и их описание.
Обновлен пример ответа на запрос справки
о назначенных пенсиях и социальных выплатах
1.17
04.05.2021
Тихонова М.А.
В п.
5.1.6 и
5.1.8 добавлено описание реализации
идентификатора запроса при ответе от вызов метода
REST API ЕСИА
1.18
28.06.2021
Михайлюк К.А.
В п. 7.2.2 добавлены параметры ответа и их описание.
Добавлены дополнительные примеры ответов
1.19
13.07.2021
Тихонова М.А.
Скорректирована
информация
по использованию
сертификатов по ГОСТ-2012
1.20
20.07.2021
Тихонова М.А.
В п.4.2.3 и 4.2.4 скорректированы ответы от вызовов
метода REST API ЕСИА
- изменен тип действия
(ALL_ACTIONS_TO_DATA)
1.21
26.07.2021
Губанов В.Ю.
В п. 7.3 добавлено описание метода REST API
для тестирования:
/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/
raw;
В п.
7.3 добавлено описание типа документа
для тестирования при использовании метода REST
API
/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/
raw:
VEHICLE_INFO - 1 заглушка
11
Версия
Дата
Автор
Изменение
1.22
30.07.2021
Маркелова М.Н.
В п. 5.1.6 добавлена информация об ответе на запрос
по документам
FID_BRTH_CERT,
OLD_BRTH_CERT,
RF_BRTH_CERT,
MARRIED_CERT,
DIVORCE_CERT,
NAME_CHANGE_CERT и FATHERHOOD_CERT;
В п.5.2.17 и п. 5.2.22 добавлены параметры «error»
и «errorUpdatedOn»,
изменены
требования
обязательности по некоторым параметрам, а также
добавлены новые таблицы с описанием возможных
ошибок и примеры ответов с ошибкой;
Поправлен пример в п. 5.2.20
1.23
02.08.2021
Тихонова М.А.
В разделе
5.2.17
скорректировано требование
к заполнению поля «comment»
1.24
18.08.2021
Тихонова Е.Н.
В разделах 7.2.14, 7.2.18, 7.2.21 и 7.2.23:
1. Добавлено описание параметров «errorUpdatedOn»
и «error»;
2. Добавлены пример ответа при отправке запроса
в ведомство для получения сведений и примеры
ответа при получении ошибки в процессе
запроса/обновления сведений
1.25
23.08.2021
Космачева М.А.
В раздел 5.2.14 добавлен код ошибки ESIA-020131
1.26
29.09.2021
Шарафутдинова Н.Ю.
Добавлены разделы 7.2.24 и 7.2.25
1.27
08.10.2021
Губанов В.Ю.
В разделе 7.2.23:
1.
Изменено
описание
параметров
«status»,
«validateDateDoc», «nameDoc», «content»;
2.
Добавлена
информация
по
актуализации
устаревших данных
1.28
03.11.2021
Шарафутдинова Н.Ю.
1. Добавлен раздел 7.2.26;
2. В
п.
7.1.5
добавлены типы документов
PAYOUT_INCOME, ILS_PFR;
3. В п.
7.3 добавлено описание типа документа
для тестирования при использовании метода REST
API
/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/
raw:
PAYOUT_INCOME;
4. Добавлена модель данных ИЛС ПФР в исходном
состоянии в п. 5.2.13 и скорректирован ответ метода
REST API ЕСИА, при получении ошибки в процессе
12
Версия
Дата
Автор
Изменение
запроса сведений о состоянии индивидуального
страхового счета застрахованного лица;
5. В разделах 5.2.13, 5.2.14, 5.2.15, 5.2.16, 5.2.17, 5.2.18,
5.2.20,
5.2.22
была
внесена
информация
о новом параметре «formationDateISO8601»
1.28
16.11.2021
Маркелова М.Н.
1. В разделе 2.1 изменен IP-адрес баллансировщика
в защищаемой сети инфраструктуры электронного
правительства;
2. Удален раздел 8 «Спецификация сервисов REST API
Цифрового профиля и плаформы согласий»
1.28
17.11.2021
Тихонова Е.Н.
В раздел
5.2.13 добавлена таблица
15 «Список
возможных ошибок»
1.29
17.11.2021
Маркелова М.Н.
В разделах 5.2.9 и 5.2.10 в п.33 добавлен комментарий
1.30
10.12.2021
Маркелова М.Н.
В раздел 2.1 добавлена информация о способе создания
необходимой
заявки
на
получение
доступа
через существующий защищенный канал СМЭВ
1.31
21.12.2021
Стешина А.В.
1. Изменен адрес единой точки входа для отправки
обращений заявителей на sd@sc.digital.gov.ru;
2. В разделах 6 и 7 удалены ссылки на удаленный
раздел «Спецификация сервисов REST API
Цифрового профиля и плаформы согласий»
1.32
26.01.2022
Губанов В.Ю.
1. Удален
ошибочно
указанный
параметр
Кузнецова Е.М.
formationDateISO8601 из разделов
5.2.13,
5.2.14,
5.2.15, 5.2.16, 5.2.17, 5.2.18, 0, 5.2.20, 5.2.22;
2. Добавлена информация о актуализации данных
с типом документа VEHICLE_INFO при получении
ошибки, раздел 5.2.22;
3. Добавлен параметры incInfo в Таблица 24, который
будет возвращаться во второй версии (v2) сервисов
REST API для получения сведений пользователя
(раздел 5.1.6) для получения документа «Справка
о доходах и суммах налога физического лица»
(раздел 5.2.14) INCOME_REFERENCE;
4. Добавлены
параметры needToSetDefaultCert,
updateCerts в документы MARRIED_CERT (раздел
5.2.9) DIVORCE_CERT (раздел 5.2.10);
5. Добавлены
параметры
actRecordFound,
needToSetDefaultCert, updateCerts в документ
FATHERHOOD_CERT (ыраздел 5.2.12);
13
Версия
Дата
Автор
Изменение
6. Добавлены параметры расширенных сведений
о перемене
имени
и
actRecordFound,
needToSetDefaultCert, updateCerts в документ
NAME_CHANGE_CERT (раздел 5.2.11);
7. Поправлена опечатка в названии ошибки (раздел
5.2.20);
8. Дополнено описание формата параметров ipk,
currentYearPensFactor
и дописаны незначащие
0 после точки в примере (раздел 5.2.13)
1.33
03.02.2022
Дыбова И.А.
Добавлена аннотация. Исправлено форматирование,
опечатки, проставлена автоматическая нумерация
таблиц, начиная с таблицы 28 «Выписка из ЕГРИП»
1.34
17.02.2022
Цветкова Г.А.
Добавлена информация о доступности второй версии (v2)
сервисов REST API для получения документов «История
выданных
гражданину
РФ
паспортов»
типа
PASSPORT_HISTORY (раздел 5.1.6)
1.35
10.03.2022
Быкадоров Д.А.
1.
Удалены ошибочно добавлены
параметры
needToSetDefaultCert, updateCerts в документы
MARRIED_CERT (раздел 5.2.9) DIVORCE_CERT
(раздел 5.2.10);
2. Удалены
ошибочно
добавлены
параметры,
needToSetDefaultCert, updateCerts в документ
FATHERHOOD_CERT ( раздел 5.2.12);
3.
Добавлен параметр birthplace и раздел параметров
actRecord
расширенной
версии
FATHERHOOD_CERT ( раздел 5.2.12);
4.
Добавлен пример ответа рассширенной версии
FATHERHOOD_CERT ( раздел 5.2.12);
5. Удалены
ошибочно
добавлены
параметры
needToSetDefaultCert, updateCerts в документ
NAME_CHANGE_CERT (раздел 5.2.11);
6. Добавлен пример ответа рассширенной версии
NAME_CHANGE_CERT (раздел 5.2.11);
7.
Исправлены опечатки countryCode, countryName,
MARRIED_CERT (раздел 5.2.9) DIVORCE_CERT
(раздел 5.2.10);
1.36
29.04.2022
Долматов А.В.
1.
Добавлен раздел
325
- модель документа
REG_REALESTATE, список ошибок для него
и примеры ответов REST;
2.
В раздел
330 добавлена информация про тип
документа
REG_REALESTATE
в
список
14
Версия
Дата
Автор
Изменение
возможных типов документов REST и описание
заглушек
1.37
31.05.2022
Новикова Е.С.
1.
В разделе 5.1.2 добавлен в описание новый тип
документа
DIGITAL_EDUC_DOC
(Цифровой
документ об образовании пользователя) - модель
ответа в случае успеха и ответ в случае отсутствия
даных;
2.
В разделе 5.1.6 добавлен в описание ответа в случае
отстутсвия данных новый тип документа
DIGITAL_EDUC_DOC
(Цифровой
документ
об образовании пользователя);
3.
В разделе 5.1.8 добавлен в описание новый тип
документа
DIGITAL_EDUC_DOC
(Цифровой
документ об образовании пользователя) - модель
ответа в случае успеха и ответ в случае отсутствия
даных;
4.
Добавлен новый раздел 5.1.9;
5.
Добавлен новый раздел 5.2.27 с описанием модели
документа «Цифровой документ об оборазовании
пользователя»
1.38
28.06.2022
Фадеев А.В.
Добавлены подразделы:
Получение архива с подписанным согласием
пользователя,
выданного
организации,
по идентификатору согласия;
Получение всех архивов с подписанными согласиями
пользователя,
выданных
организации,
по идентификатору пользователя (oid)
1.39
07.07.2022
Космачева М.А.
В разделах 5.2.23 и 5.2.24:
Обновлены примеры ответа на запрос;
Обновлено описание таблиц «Таблица 36 - Выписка
из ЕГРИП», «Таблица 37 - Выписка из ЕГРЮЛ»
1.40
22.07.2022
Быкадоров Д.А.
В разделы 5.2.8 - 5.2.12 добавлено описание нового поля
«actNo2018»
1.41
27.07.2022
Маркелова М.Н.
В разделе 2 скорректированны ссылки на приложение
1.42
01.08.2022
Маркелова М.Н.
В раздел
5.1.8 добавлен новый тип документа
DISABLED_PERSON;
В раздел 5.2.18 добавлена информация о структуре
данных для получения информации в исходном виде
15
Версия
Дата
Автор
Изменение
1.43
14.09.2022
Федорко В.В.
В разделе
4 актуализировано описание параметра
«permissions»
1.44
22.09.2022
Зорин Д.А.
В разделе 0 добавлено описание тестовой заглушки
PAYOUT_INCOME
1.45
03.10.2022
Кругликова Е.И.
Добавлен раздел
6 «Получение данных цифрового
профиля организации», включающий в себя подразделы:
6.1
«Сведения
о
лицензиях,
полученные
от лицензирующих органов»;
6.2
«Сведения из реестра малого и среднего
предпринимательства»;
6.3 «Сведения из налоговых деклараций по налогу,
уплачиваемому в связи с применением упрощенной
системы налогообложения»;
6.4 «Сведения из налоговых деклараций по налогу
на добавленную стоимость»;
6.5 «Сведения из налоговых деклараций по налогу
на прибыль организаций»;
6.6 «Сведения из налоговых деклараций, представленных
индивидуальными предпринимателями, применяющими
специальные налоговые режимы»;
6.7
«Сведения о наличии счетов организаций
(индивидуальных предпринимателей) в банках»
1.46
12.10.2022
Кругликова Е.И.
Удален раздел 6 «Получение данных цифрового профиля
организации»
1.47
13.10.2022
Сапронов П.В.
Скорректировано форматирование в соответствии
с ГОСТ Р 2.105-2019
1.48
26.11.2022
Новикова Е.С.
1. В разделе 5.1.2 добавлен в описание новый тип
документа DIGITAL_EDUC_DOC_V2 (Цифровой
документ об образовании пользователя версии 2.0.6)
- модель ответа в случае успеха и ответ
в случае отсутствия даных;
2. В разделе 5.1.6 добавлен в описание ответа в случае
отстутсвия
данных
новый
тип
документа
DIGITAL_EDUC_DOC_V2 (Цифровой документ
об образовании пользователя версии 2.0.6);
3. В разделе 5.1.8 добавлен в описание новый тип
документа DIGITAL_EDUC_DOC_V2 (Цифровой
документ об образовании пользователя версии 2.0.6)
- модель ответа в случае успеха и ответ
в случае отсутствия даных;
16
Версия
Дата
Автор
Изменение
4.
В раздел 5.1.9 добавлен в описание новый тип
документа DIGITAL_EDUC_DOC_V2 (Цифровой
документ об образовании пользователя версии 2.0.6)
- модель ответа в случае успеха и ответ
в случае отсутствия даных;
5.
В раздел
5.2.27 добавлено описание модели
документа «Цифровой документ об оборазовании
пользователя версии 2.0.6»
1.49
09.12.2022
Саблев М.В.
1.
В разделе
5.1.6
изменены
формулировки
в упоминании о возможности получения сведений
в том виде, в котором они были получены
от ведомства; в описании случая, когда сведения
документа запрошены в ведомстве, но ответ
от ведомства еще не поступил;
2.
В разделе 5.1.8 добавлены сведения о типе документа
«Сведения
о
статусе
самозанятого»
(SELF_EMPLOYED) в описание возможности
получения сведений в том виде, в котором они были
получены из ведомства;
3.
В подразделах 5.2 исправлена опечатка в коде поля
«Уникальный идентификатор документа» (id);
4.
В разделе
5.2.28 добавлено описание модели
документа «Сведения о статусе самозанятого»
(SELF_EMPLOYED);
5.
В разделе 5.2.29 для упрощения навигации добавлена
структура подразделов;
6.
В разделе 5.3.1 добавлены сведения о тестовых
ответах при запросе документа «Сведения о статусе
самозанятого» (SELF_EMPLOYED)
1.50
09.12.2022
Сайфиева Д.Р.
1.
В разделе 5.1.8 добавлен в описание новый тип
документа GIBDD_DRIVER_LICENSE (Сведения
о водительском удостоверении, полученном
из ГИБДД) - модель ответа в случае успеха и ответ
в случае отсутствия даных;
2.
Добавлен раздел 5.2.29 «Сведения о водительском
удостоверении, полученном из ГИБДД»;
3.
Добавлен раздел
5.3.2.3 в виде описания типа
документа
GIBDD_DRIVER_LICENSE
для тестирования внешними системами;
4.
Обновлен разделы 5.2.23-5.2.24:
17
Версия
Дата
Автор
Изменение
Обновлены пример ответа на запрос;
Обновлено описание таблицы «Таблица 36 -
Выписка из ЕГРИП»;
Обновлено описание таблицы «Таблица 37 -
Выписка из ЕГРЮЛ»
1.51
28.12.2022
Долматов А.В.
1.
Добавлен раздел 5.1.10 «Получение списка ссылок
на файлы, полученные от ведомства, детализирующие
документы данного типа у гражданина»;
2.
Добавлен раздел 5.1.11 «Получение ссылки на файл,
полученный от ведомства, детализирующий данный
документ»;
3.
Добавлен раздел
5.1.12 «Получение файла,
полученного от ведомства, детализирующего данный
документ»;
4.
Добавлен раздел 5.1.13 «Получение всех файлов,
полученных
от
ведомства,
детализирующих
документы данного типа для данного гражданина»;
5.
В разделе 5.2.26:
добавлены поля в структуру данных;
модифицированы
примеры
возвращаемых
структур
6.
Добавлен раздел 5.3.3 «Получение тестового списка
ссылок на файлы, полученные от ведомства,
детализирующие
документы
данного
типа
у гражданина»;
7.
Добавлен раздел 5.3.4 «Получение тестового файла,
полученного от ведомства, детализирующего данный
документ»;
8.
Добавлен раздел 5.3.5 «Получение тестового архива
с
файлами,
полученными
от
ведомства,
детализирующими документ данного типа»
1.52
30.12.2022
Сайфиева Д.Р.
Обновлены примеры ответов на запросы в разделах
5.2.23, 5.2.24
1.53
14.02.2023
Зорин Д.А.
Удален раздел «Сведения о транспортном средстве»,
содержащий сведения о добавленых вручную
транспортных средствах физического лица (doc_type =
VEHICLE_CERT).
Сапронов П.В.
ПФР заменен на СФР
1.54
28.02.2023
Сизонов С.О.
1. В разделе
4 внесены уточнения по возрасту
Захарова Е.В.
пользователя для запроса согласия: старше 18 лет;
18
Версия
Дата
Автор
Изменение
Сапронов П.В.
2. Структура JSON-объекта параметра «permissions»
выведена в подраздел 4.1;
3. В подраздел 4.1 добавлены примеры содержимого
параметра «permissions»:
стандартный запрос согласия пользователя
от внешней организации;
одновременная выдача согласий для нескольких
организаций;
согласие на распространение общедоступных
персональных
данных
субъекта
(PERS_DATA_EXT);
для авторизации в региональном электронном
журнале и дневнике с помощью детских учетных
записей ЕСИА (EDU_JORNAL)
4. Для метода REST «Получение всех согласий
пользователя,
выданных
организации,
по идентификатору пользователя» (oid)
- раздел
4.2.3, добавлено примечание по типу согласия
EDU_JORNAL;
5. «scope» заменен на «область доступа (scope)»
1.55
17.03.2023
Захарова Е.В.
1. В раздел 4.1 добавлены возможные коды ошибок;
2. В разделах
4.2.5,
4.2.6 внесена корректировка
по требуемой области доступа (scope):
заменен на «usr_prm»
1.56
02.06.2023
Цветкова Г.А.
В раздел 5.1.1 добавлена сноска с описанием формата
параметра «snils».
1.57
27.06.2023
Захарова Е.В.
1.
В
разделе
4
дополнение
информации
по возможности
выдачи
согласия
на несовершеннолетних пользователей;
2.
В
разделе
4
уточнение
формулировок
по передаваемым
атрибутам
в
параметре
«permission»;
3.
В разделе
4.1 скорректирована формулировка
по обязательности атрибута «forbiddens» при запросе
согласия PERS_DATA_EXT;
4.
Дополнительно указан пример передаваемых
параметров в ответе REST (Раздел
4.2.3), если
19
Версия
Дата
Автор
Изменение
у пользователя
выдано
согласие
на несовершеннолетнего;
5.
Добавлены описания основных параметров,
передаваемых в REST 4.2.3 и 4.2.4
1.58
29.06.2023
Губанов В.Ю.
1.
Внесены изменения в таблице 38:
изменено описание атрибута «content»;
добавлено описание атрибутов «xmlFile»,
«pdfFile», «file», «sig»;
2.
В разделе 5.2.25 обновлен пример ответа на запрос
сведений о доходах физического лица и о выплатах
страховых взносов, произведенных в пользу
физического лица;
3.
Для поля «version» изменен комментарий в таблицах:
Таблица 18;
Таблица 42;
Таблица 43;
Таблица 44
1.59
02.08.2023
Яковлева М.Ю.
В раздел 5.2.13 добавлено описание ответа на запрос при
отсутствии согласия на запрос и получение сведений
о состоянии индивидуального страхового счета
застрахованного лица
1.60
01.09.2023
Захарова Е.В.
В раздел 5.2.14 добавлен код ошибки ESIA-036746
20
Обозначения и сокращения
Обозначение / сокращение
Полное наименование / описание
АГС
Акт гражданского состояния
БД
База данных
ВС
Вид сведений
ГИС
Государственная информационная система
ГРН
Государственный регистрационный номер
ГРНИП
Реестр индивидуальных предпринимателей
ЕГИССО
Единая государственная информационная система социального
обеспечения
ЕГР ЗАГС
Единый государственный реестр записей актов гражданского состояния
ЕГРИП
Единый государственный реестр индивидуальных предпринимателей
ЕГРН
Единый государственный реестр недвижимости
ЕГРЮЛ
Единый государственный реестр юридических лиц
ЕНП ОМС
Единый номер полиса обязательного медицинского страхования
ЕПГУ
Федеральная государственная информационная система «Единый портал
государственных
и
муниципальных
услуг
(функций)»
ЕСИА
Федеральная государственная информационная система «Единая система
идентификации и аутентификации в инфраструктуре, обеспечивающей
информационно-технологическое
взаимодействие
информационных
систем,
используемых
для
предоставления
государственных
и муниципальных услуг в электронной форме»
ЗАГС
Запись актов гражданского состояния
ИЛС
Индивидуальный лицевой счет
ИНН
Идентификационный номер налогоплательщика
ИП
Индивидуальный предприниматель
ИПК
Индивидуальный пенсионный коэффициент
ИС
Информационная система
КЛАДР
Классификатор адресов РФ
КПП
Код причины постановки
КФХ
Крестьянско-фермерское хозяйство
КЭП
Усиленная квалифицированная электронная подпись
ОГРН
Основной государственный регистрационный номер
ОГРНИП
Основной государственный регистрационный номер индивидуального
предпринимателя
ОКВЭД
Общероссийский классификатор видов экономической деятельности
ОКПД
Общероссийский классификатор продукции по видам экономической
деятельности
ОКСМ
Общероссийский классификатор стран мира
21
Обозначение / сокращение
Полное наименование / описание
ОКТМО
Общероссийский классификатор территорий муниципальных образований
ОН
Объект недвижимости
ОПФ
Организационно-правовая форма
РО
Регистрационный орган
РФ
Российская Федерация
СВЗАГС
Единый государственный реестр записей актов гражданского состояния
СДРАГС
Справочник видов документов, используемых при государственной
регистрации актов гражданского состояния и при совершении иных
юридически значимых действий
СМЭВ
Федеральная государственная информационная система «Единая система
межведомственного электронного взаимодействия». Версии СМЭВ
соответствуют версиям «Методических рекомендаций по работе с Единой
системой межведомственного электронного взаимодействия». Например,
СМЭВ
3.х функционирует в соответствии с «Методическими
рекомендациями…» версии 3.х, а СМЭВ 2.х - версии 2.х
СНИЛС
Страховой номер индивидуального лицевого счета в системе
государственного пенсионного страхования РФ
СОСТАГС
Справочник состояния и статуса записи акта гражданского состояния
СЦ
Федеральная государственная информационная система «Федеральный
ситуационный центр электронного правительства» (https://sc.digital.gov.ru)
СФР
Социальный фонд Российской Федерации (СФР) (заменил два других -
Пенсионный фонд Российской Федерации (ПФР) и Фонд социального
страхования (ФСС))
ФГИС ФРИ
Федеральная государственная информационная система «Федеральный
реестр инвалидов»
ФЗ
Федеральный закон
ФИАС
Федеральная информационная адресная система
ФЛ
Физическое лицо
ФСС
Фонд социального страхования Российской Федерации
ЦП
Цифровой профиль в учетной записи ЕСИА
ЮЛ
Юридическое лицо
API
Application Programming Interface (программный интерфейс приложения,
интерфейс прикладного программирования) - набор готовых классов,
процедур, функций, структур и констант, предоставляемых приложением
(библиотекой, сервисом) или операционной системой для использования
во внешних программных продуктах
HTTP (Hypertext Transfer
Протокол передачи гипертекста
Protocol)
HTTPS (HyperText Transfer
Расширение протокола HTTP для поддержки шифрования в целях
Protocol Secure)
повышения безопасности. Данные в протоколе HTTPS передаются поверх
22
Обозначение / сокращение
Полное наименование / описание
криптографических протоколов SSL или TLS. В отличие от HTTP с TCP-
портом 80, для HTTPS по умолчанию используется TCP-порт 443
IP
Маршрутизируемый протокол сетевого уровня стека TCP/IP
IP-адрес
Уникальный числовой идентификатор устройства в компьютерной сети,
работающей
по протоколу IP
OAuth2.0
Открытый протокол авторизации, который позволяет предоставить третьей
стороне ограниченный доступ к защищенным ресурсам пользователя
без необходимости передавать данной третьей стороне логин и пароль
OID
(Object
Identifier,
Строка или последовательность десятичных цифр, однозначно
идентификатор объекта)
идентифицирующая объект
PDF (Portable Document
Межплатформенный открытый формат электронных документов
Format,
переносимый
формат документов)
PUSH
Способ распространения информации (контента) в Интернете,
когда данные поступают от поставщика к пользователю на основе
установленных параметров. Пользователь же, в свою очередь,
либо отвергает, либо принимает данные
PUSH-уведомление
PUSH-уведомления (PUSH-сообщения)
- краткие всплывающие
сообщения, отображаемые на экране персонального компьютера
или мобильного устройства (смартфона и т.п.). Предназначены
для информирования (уведомления) пользователя, для запроса
на выполнение или побуждения пользователя к совершению определенных
действий и др. PUSH-уведомления могут появляться на экране любого
устройства, где есть область оповещений или возможность вывода на экран
данных, принятых из сети Интернет. В ЕПГУ PUSH-уведомления
инициируются сервером ЕПГУ
REST (Representational State
Архитектурный стиль взаимодействия компонентов распределенного
Transfer, передача состояния
приложения в сети. REST представляет собой согласованный набор
представления)
ограничений, учитываемых при проектировании распределенной
гипермедиа-системы. То есть REST
- это набор принципов
и ограничений взаимодействия клиента и сервера в сети Интернет,
использующий существующие стандарты (протокол HTTP, стандарт
построения URL, форматы данных JSON и XML) в ходе взаимодействия
Область доступа (scope)
Тип данных, к которым система-клиент намерена получить доступ.
Перечень актуальных и устаревших областей доступа приведен в документе
«Методические рекомендации по использованию Единой системы
идентификации и аутентификации»
23
Обозначение / сокращение
Полное наименование / описание
SQL
(Structured
Query
Декларативный язык программирования, применяемый для создания,
Language,
язык
модификации и управления данными в реляционной базе данных,
структурированных
управляемой соответствующей системой управления базами данных
запросов)
URL (Uniform Resource
Стандартизированный способ записи адреса ресурса в сети Интернет
Locator, единый указатель
ресурса)
UUID (Universally
Unique
Стандарт идентификации, используемый в создании ПО
Identifier,
универсальный
уникальный идентификатор)
XML (eXtensible Markup
Язык для создания структурированных машиночитаемых документов
Language,
расширяемый
язык разметки)
24
Термины и определения
Термин
Определение
Администратор
профиля
Уполномоченное должностное лицо заявителя, которое является
государственной
пользователем ЕСИА и обладает полномочиями по ведению профиля
организации
государственной организации в ЕСИА
Аутентификация
Процедура идентификации и установления подлинности источника
информации
Маркер доступа
Выдается системе-клиенту для получения доступа к запрашиваемому
ресурсу
Токен
Объект, предназначенный для обеспечения информационной безопасности
и идентификации пользователя
25
1 Введение
Настоящий документ разработан в целях реализации и во исполнение
постановления Правительства Российской Федерации от
03 июня
2019 г.
№ 710
«О проведении эксперимента по повышению качества и связанности данных,
содержащихся в государственных информационных ресурсах».
Данные методические рекомендации:
1) Описывают базовые сценарии использования REST API Цифрового профиля:
идентификация и аутентификация пользователей посредством ЕСИА
(см. п. 2);
запрос согласий пользователей для доступа к его сведениям (см. п. 4);
получения информационными системами участников эксперимента
данных из регистров, хранимых в Цифровом профиле (см. п. 5).
2) Предоставляет методические рекомендации по интеграции информационных
систем с REST API Цифрового профиля.
26
2 Как подключиться к REST API цифрового профиля
В ЕСИА создан механизм аутентификации пользователей, основанный
на спецификациях OAuth 2.0 и расширении OpenID Connect 1.0.
Для предоставления пользователям вашей ИС возможности входа через ЕСИА
и предоставления доступа к своим сведениям из ЦП со стороны подключающейся ИС
необходимо:
Зарегистрировать свою организацию в ЕСИА.
Для регистрации организации в ЕСИА потребуется подтвержденная учетная
запись и квалифицированная электронная подпись (КЭП) руководителя.
Процесс регистрации ЮЛ в ЕСИА описан в Руководстве пользователя ЕСИА
Зарегистрировать ИС в регистре информационных систем ЕСИА
(в соответствии с Регламентом1).
Ответственному
сотруднику
необходимо
предоставить
доступ
к Технологическому порталу ЕСИА: руководитель или администратор
профиля организации должен включить его в специальную группу доступа
«Технологический портал».
Ответственному сотруднику необходимо зарегистрировать свою ИС
через технологический
портал,
доступный
по
ссылке:
Руководство
пользователя
технологического
портала
доступно
по
ссылке:
https://digital.gov.ru/ru/documents/6190/.
В
результате
регистрации
информационная система заносится в регистр ИС, взаимодействующих
с ЕСИА.
Сгенерировать для ИС криптографические ключи и выпустить на них
сертификат
ключа
квалифицированной
электронной
подписи
для подключаемой информационной системы (должен быть выпущен УЦ
и содержать ОГРН ЮЛ). Загрузить сертификат для зарегистрированной ИС
в Технологический портал.
Сертификат, используемый для проверки подписи, должен быть
предварительно зарегистрирован в ЕСИА и привязан к учетной записи
системы-клиента в ЕСИА. ЕСИА использует сертификаты в формате X.509
1 Регламент размещен по ссылке: https://digital.gov.ru/ru/documents/4244/.
Раздел 6 Регламента.
27
и взаимодействует с алгоритмами формирования электронной подписи
ГОСТ Р 34.10-2012 и криптографического хэширования ГОСТ Р 34.11-2012.
Согласовать подключение и регистрацию системы с целью идентификации
и аутентификации и получения сведений пользователей в тестовой среде
в соответствии с Регламентом2. Для этого необходимо отправить форму заявки
на адрес: sd@sc.digital.gov.ru (актуальная форма заявки приведена
в приложении Г Регламента). В заявке указываются перечень областей доступа
(scope) - областей данных пользователя, которые хочет получать потребитель.
Исполнение этого процесса предоставляет возможность потребителю
производить взаимодействие с ЕСИА в тестовой среде.
В результате подключения будет предоставлена инструкция по созданию
учетных записей пользователей в тестовой среде.
Реализовать интерфейсы подключения, доработать дизайн и провести
тестирование.
Сертификаты тестовой и продуктивной сред ЕСИА, используемые
для формирования электронных подписей ответов как поставщика, доступны
по ссылке: http://esia.gosuslugi.ru/public/esia.zip.
Реализовать интерфейсы системы-клиента REST-сервисов ЕСИА и модели
контроля доступа, основанной на OAuth
2.0. Детальная информация
содержится в приложениях Приложении Б и Приложении В «Методических
рекомендаций по использованию Единой системы идентификации
и аутентификации» по ссылке: https://digital.gov.ru/ru/documents/6186/.
Недопустимо отображать страницу аутентификации ЕСИА во фрейме сайта.
Обеспечить в соответствии с требованиями законодательства комплекс мер,
необходимых для обеспечения информационной безопасности и защиты
персональных данных пользователей, получаемых информационной системой
в процессе ее взаимодействия с инфраструктурой ЦП, в соответствии
с Федеральным законом от 27 июля 2006 г. № 152-ФЗ «О персональных
данных».
Подключиться к защищенному каналу СМЭВ для направления запросов REST
API к Цифровому профилю (см. п. 2.1).
2 Раздел 9 Регламента.
28
Синхронизировать системное время сервера со значением точного времени.
Расхождение более чем в минуту может приводить к возникновению ошибок
при взаимодействии потребителя с поставщиком идентификации ЕСИА.
Подключить продуктивную версию интегрируемой системы к продуктивной
среде ЕСИА и инфраструктуре Цифрового профиля в соответствии
с Регламентом3. Для этого необходимо отправить форму заявки на адрес:
sd@sc.digital.gov.ru (актуальная форма заявки приведена в приложении Г
Регламента). При подключении к продуктивной среде оператором
эксплуатации будет проверена работоспособность интеграции в тестовой
среде.
После подключения ИС к промышленной ЕСИА проверить работу
промышленной версии ЕСИА с промышленной версией Вашей системы.
2.1 Подключение к ЦП посредством использования существующего
защищенного канала СМЭВ
В целях исполнения Постановления Правительства Российской Федерации
от 03 июня
2019 г.
№ 710 «О проведении эксперимента по повышению качества
и связанности данных, содержащихся в государственных информационных ресурсах»
Минцифры России совместно с ПАО «Ростелеком» была разработана принципиальная
схема информационного взаимодействия на период проведения эксперимента.
Главная идея текущей схемы заключается в разделении запросов
на аутентификацию (https://esia.gosuslugi.ru/aas/oauth2/*) и запросов к REST API Цифрового
профиля (https://esia.gosuslugi.ru/digital/api/*) на стороне участников эксперимента.
Запросы на аутентификацию должны обрабатываться стандартным образом в соответствии
с «Методическими рекомендациями по использованию Единой системы идентификации
с использованием каналов связи общего пользования. Запросы же к Цифровому профилю
должны перенаправляться посредством прокси сервера на стороне участников
эксперимента в защищенную сеть системы межведомственного электронного
взаимодействия (далее - СМЭВ) на IP-адрес баллансировщика в защищаемой сети
инфраструктуры электронного правительства:
109.207.15.2/443
(109.207.15.0/24
не маршрутизируемая в Интернете сеть). IP-адрес доступен только через крипто-сеть
СМЭВ).
3 Раздел 10 Регламента.
29
В случае организации вышеуказанного информационного взаимодействия
из подсети (подсетей), уже указанных в настройках криптографического маршрутизатора
на стороне участника эксперимента, доступ к REST API Цифрового профиля будет
предоставлен в рамках уже существующего защищенного канала до СМЭВ
и соответствующего договора на эксплуатацию этого канала.
Для предоставления доступа к REST API Цифрового профиля через существующий
защищенный канал СМЭВ необходимо отправить по адресу: kriptokanal@rt.ru заявку
в свободной форме. В заявке необходимо указать информацию том, что необходимо
предоставить доступ до IP-адресу: 109.207.15.2 через защищенный канал, IP-адрес
источника со стороны участника эксперимента, номер действующего договора
на эксплуатацию канала СМЭВ, контактные данные участника эксперимента.
По вопросам подключения, работы и решению проблем, связанных
с криптоканалами, необходимо обращаться по адресу: kriptokanal@rt.ru.
а)
б)
Рисунок 1 - Схема информационного взаимодействия на период проведения эксперимента
30
3 Среды для интеграционного тестирования
Среды для интеграционного тестирования:
- интеграционная среда ЕСИА и ЦП
(необходимо использовать для тестирования аутентификации, REST API
платформы согласий и ЦП);
(необходимо использовать для просмотра и изменения данных пользователя
и управления согласиями через интерфейс Личного кабинета Госуслуг).
Интегрирована с тестовой средой ЕСИА и ЦП (https://esia-
portal1.test.gosuslugi.ru/) в части атуентификации и данных пользователей.
31
4 Online-режим запроса согласий
При запросе согласия пользователя в online-режиме системе-клиенту необходимо
реализовать стандартный механизм взаимодействия с ЕСИА для получения маркера
доступа при аутентификации пользователя с некоторыми особенностями. Актуальная
версия стандартных сервисов ЕСИА, основанных на протоколе OAuth 2.0 и OpenID Connect
1.0, представлена в «Методических рекомендациях по использованию Единой системы
(Приложение В).
В рамках эксперимента для запроса согласия пользователя в качестве значения
параметра области доступа (scope) необходимо использовать значение openid (область
доступа (scope), дающая право запросить проведение аутентификации пользователя
и получения маркера идентификации). Использование других значений области доступа
(scope) в рамках сценария запрещено. Запрос согласий возможен только у граждан старше
18 лет и имеющих подтвержденную учетную запись в ЕСИА. В противном случае будет
выполнена аутентификация с выдачей маркера доступа с областью доступа (scope)
«openid», но без запроса и выдачи согласий. При выполнении определенных настроек
и соблюдении ряда условий возможна организация запроса согласия у родителя
на несовершеннолетнего пользователя.
В запросе к OAuth2.0 ЕСИА метода /aas/oauth2/ac (Приложение В.2.2
«Методических рекомендаций по использованию Единой системы идентификации
и аутентификации») должен быть указан дополнительный параметр - «permissions» -
JSON-объект со списком запрашиваемых согласий, закодированный в формате BASE64 url
safe. Для каждого запрашиваемого согласия должны быть указаны цель и действие,
планируемые для работы с данными пользователя. Содержимое параметра «permissions» -
перечень мнемоник запрашиваемых типов согласий и с перечнем для каждого типа
согласия:
expire - срок действия запрашиваемого типа согласия;
responsibleObject - необязательный атрибут - лицо (сотрудник организации)
или организация, осуществляющее обработку данных (строка с ФИО или
другой информацией);
scopes - мнемоники и признаки обязательности области доступа (scope);
purposes - мнемоники целей;
actions - мнемоники действий;
32
ogrn - необязательный атрибут - ОГРН организации, для которой выполняется
запрос согласия;
terms - необязательный атрибут - мнемоники условий обработки данных
оператором с указанием причины обязательного условия (актуально только
для согласия на распространение данных);
sites - необязательный атрибут - информационный ресурс оператора для
распространения данных пользователя (актуально только для согласия
на распространение данных).
Мнемоники типа согласия, цели и действия должны быть указаны строго
из реестров платформы согласий. Реестр платформы согласий указан в документе
«Сценарии использования инфраструктуры Цифрового профиля».
Запрашиваемый срок действия согласия не может превышать максимальный срок
действия, определенный для данного типа согласия.
После аутентификации пользователю отображается страница предоставления
согласий в интерфейсе ЕСИА. У пользователя есть возможность с помощью визуальных
элементов управления выбрать только часть запрошенных согласий, а также часть области
доступа (scope) (доступов к данным) в рамках согласия (в случае, если эти области доступа
(scope) для указанного типа согласия не обязательны, но желательны).
Если пользователь ранее предоставлял согласие на запрошенный тип согласия
с данной мнемоникой и такой же список целей, действий и областей доступа (scope), и срок
действия его не истек, то такое согласие не отображается на странице запроса согласий,
и данный шаг пропускается.
После утверждения пользователем запрошенных согласий производится выдача
авторизационного кода. Запрос к методу /aas/oauth2/te следует выполнять
без дополнительного параметра «permissions», а в параметре «scope» также указать только
одно значение - «openid». После успешной обработки запроса произойдет выдача маркера
доступа на все запрошенные и утвержденные области доступа (scope), привязанные
к запрошенным типам согласий. Также в маркер доступа включается endpoint метода REST
API ЕСИА, по которому ИС сможет получить все согласия, которые пользователь выдал
организации-владельцу ИС - параметр «permissions_url».
В ответе на запрос метода /aas/oauth2/te возвращается маркер доступа
(access_token) с включенными в него областями доступа (scope) в соответствии
с запрошенными и выданными пользователем согласиями. Маркер обновления
(refresh_token) в этом случае в ответе не возвращается. В случае истечения срока
33
действия выданного маркера доступа (access_token) необходимо выполнить запрос метода
/aas/oauth2/te с указанием в параметре «scope» значения prm_chg?oid={oid}, где {oid} - OID
учетной записи пользователя. OID учетной записи пользователя может быть получен
либо из ранее выданного маркера доступа, либо из события уведомления о выдаче согласия.
В ответе на запрос будет возвращен новый действующий пользовательский маркер доступа
(access_token).
Пример получаемого маркера доступа при запросе согласий:
eyJ2ZXIiOjEsInR5cCI6IkpXVCIsInNidCI6ImFjY2VzcyIsImFsZyI6IkdPU1QzNDEwXzIwMTJfM
jU2In0.eyJuYmYiOjE1ODIxNDIwMDcsInBlcm1pc3Npb25zIjoiQ1JFRElUIiwic2NvcGUiOiJvcG
VuaWQgZW1haWw_bW9kZT13Jm9pZD0xMDc3MDk5NjAwIGZ1bGxuYW1lP21vZGU9dyZvaWQ9MTA3NzA
5OTYwMCBtb2JpbGU_bW9kZT13Jm9pZD0xMDc3MDk5NjAwIiwiaXNzIjoiaHR0cDpcL1wvZXNpYS5n
b3N1c2x1Z2kucnVcLyIsInVybjplc2lhOnNpZCI6IjZCNTkwNDQ1NTI5OEM0NUQyN0NGNzQwMkYzM
DM2OTc4IiwidXJuOmVzaWE6c2JqX2lkIjoxMDc3MDk5NjAwLCJleHAiOjE1ODIxNDM4MDcsImlhdC
I6MTU4MjE0MjAwNywiY2xpZW50X2lkIjoiVEVTVF9TWVMiLCJwZXJtaXNzaW9uc191cmwiOiJodHR
wczpcL1wvZXNpYS1kZXYudGVzdC5nb3N1c2x1Z2kucnVcL2VzaWEtcnNcL2FwaVwvcHVibGljXC92
MVwvcHJuc1wvMTA3NzA5OTYwMFwvaXNzdWVkXC9wZXJtaXNzaW9ucyJ9.-EHrq3WQxfOKbguf-
hd52biJlcP6Z1Cprgzuo70XYKOgOBxbwR4cm5094BJTfBYBY9-7PUMa8Z5mQEXAp9gvmg
4.1 Структура JSON-объекта параметра «permissions»
{
"type": "array",
"items": {
"properties": {
"ogrn": {
"type": "integer",
"description": "ОГРН
организации
от
лица
которой
производится
запрос
согласия"
},
"sysname": {
"type": "string",
"description": "Мнемоника
типа
согласия"
},
"responsibleObject": {
"type": "string",
"description": "Лицо
(сотрудник
организации),
осуществляющее
обработку
данных
согласия
-
на
усмотрение
организации,
запрашивающей
согласие
(строка
с
ФИО
или
другой
информацией,
переданная
в
запросе)"
},
"expire": {
"type": "integer",
"description": "Срок,
на
который
будет
выдано
согласие
после
утверждения
(в
минутах)"
},
34
"purposes": {
"type": "array",
"description": "Перечень
мнемоник
целей",
"items": {
"properties": {
"sysname": {
"type": "string",
"description": "Мнемоника
цели"
}
},
"required": [
"sysname"
]
}
},
"actions": {
"type": "array",
"description": "Перечень
мнемоник
действий",
"items": {
"properties": {
"sysname": {
"type": "string",
"description": "Мнемоника
действия"
}
},
"required": [
"sysname"
]
}
},
"scopes": {
"type": "array",
"description": "Перечень
мнемоник
scope",
"items": {
"properties": {
"sysname": {
"type": "string",
"description": "Мнемоника
scope"
}
},
"required": [
"sysname"
35
]
}
},
"terms": {
"type": "array",
"description": "Перечень
условий
обработки
персональных
данных
для
распространения
оператором",
"items": {
"properties": {
"sysname": {
"type": "string",
"description": "Мнемоника
условия"
},
"require": {
"type": "boolean",
"description": "Признак
обязательного
указания
в
запросе
согласия
на
распространение
персональных
данных
субъекта"
},
"requireReason": {
"type": "string",
"description": "Причина
обязательного
указания
условия
в
запросе
согласия
на
распротранение
персональных
данных
субъекта"
}
},
"required": [
"sysname"
]
}
},
"sites": {
"type": "array",
"description": "Перечень
информационных
ресурсов
оператора
для
распространения
персональных
данных
субъекта
в
рамках
согласия",
"items": {
"properties": {
"url": {
"type": "string",
"description": "Ссылка
на
страницу
информационного
ресурса
для
распространения
персональных
данных
субъекта"
},
"description": {
36
"type": "string",
"description": "Описание
информационного
ресурса
оператора
для
распространения
персональных
данных
субъекта"
},
"require": {
"type": "boolean",
"description": "Признак
обязательного
указания
информационного
ресурса
для
распространения
персональных
данных
субъекта
в
запросе
согласия"
}
},
"required": [
"url"
]
}
}
},
"required": [
"sysname",
"purposes",
"actions",
"scopes"
]
}
}
Заполнение атрибутов «sites», «terms» обязательно при запросе согласия с
мнемоникой только PERS_DATA_EXT. При выдаче и отзыве согласия в том числе
обязательна передача атрибутов «sites», «terms», «forbiddens». Для согласий с другой
мнемоникой массивы по атрибутам «sites», «terms», «forbiddens» всегда передаются
пустыми, их заполнение необязательно.
Блок «Информационные ресурсы оператора для распространения
персональных данных» - sites.
Блок содержит набор чекбоксов в разрезе указанных в запросе информационных
ресурсов и отображает их в соответствии с элементом «sites» JSON-объекта согласия
в параметре «permissions» сервиса авторизации с запросом согласия /aas/oauth2/ac.
Таблица
1
- Тип «Перечень информационных ресурсов оператора
для распространения данных пользователя» (ns2:sitesType)
37
Требования
Способ
№
Код поля
Описание поля
Комментарий
к заполнению
заполнения/Тип
1.
site
Информационный
1, обязательно
ns2:siteFullType
См. описание
ресурс
типа siteFullType
для распространения
данных пользователя
в рамках согласия
Таблица
2
- Тип «Информационный ресурс для распространения данных
пользователя в рамках согласия» (ns2:siteFullType)
Требования
Способ
№
Код поля
Описание поля
Комментарий
к заполнению
заполнения/Тип
1.
url
Ссылка
1, обязательно
ns2:urlType
Строка.
на информационный
Максимальная
ресурс оператора
длина значения
2000 символов
2.
description
Описание
0, необязательно
ns2:descriptionType
Максимальная
информационного
длина значения
ресурса оператора
2000 символов
3.
require
Признак
0, необязательно
ns2:requiredType
Принимает
обязательного
значения «true»
заполнения
или «false»
в запросе согласия
Если элемент «require» содержит значение «true», то чекбокс активен
и не редактируем, возможно указание описания информационного ресурса
в атрибуте «description».
Если элемент «require» содержит значение «false», то чекбокс неактивен
и редактируем пользователем.
Блок «Условия обработки данных оператором» - terms.
Блок содержит набор чекбоксов в разрезе указанных в запросе условий
и отображает их в соответствии с элементом «terms» JSON-объекта согласия в параметре
«permissions» сервиса авторизации с запросом согласия /aas/oauth2/ac.
38
Таблица
3
- Тип «Перечень условий обработки данных оператором»
(ns2:termsType)
Требования
Способ
№
Код поля
Описание поля
Комментарий
к заполнению
заполнения/Тип
1.
term
Условие обработки
1, обязательно
ns2:termFullType
См. описание
данных оператором
типа termFullType
в рамках согласия
Таблица 4 - Тип «Условие обработки данных оператором» (ns2:termFullType)
Требования
Способ
№
Код поля
Описание поля
Комментарий
к заполнению
заполнения/Тип
1.
sysname
Мнемоника
1, обязательно
ns2:sysnameType
Строка.
условия обработки
Максимальная
данных
длина значения
оператором
256 символов
2.
name
Наименование
1, обязательно
ns2:nameType
Строка.
условия обработки
Максимальная
данных
длина значения
оператором
150 символов
3.
require
Признак
0, необязательно
ns2:requiredType
Принимает
обязательного
значения «true»
заполнения
или «false»
в запросе согласия
4.
requireReason
Причина
0, необязательно
ns2:requireReasonType
Строка.
обязательного
Максимальная
условия
длина значения
512 символов
Если элемент «require» содержит значение «true», то чекбокс активен
и не редактируем, возможно указание причины в атрибуте «requireReason» со свободной
формулировкой.
Если элемент «require» содержит значение «false», то чекбокс неактивен
и редактируем пользователем.
39
Таблица
5
- Предоставляемые ЕСИА условия обработки данных (параметр
«terms»)
Мнемоника условия
№
обработки данных
Описание условия обработки данных
оператором
1.
NO_TRANSFER
Не разрешаю передавать
2.
INTERNET
Через Интернет
3.
LOCALNET
По внутренней сети организации
Блок «Действия с персональными данными» - forbiddens.
Блок содержит набор чекбоксов в соответствии элементам справочника действий с
персональными данными пользователя. Перечень разрешенных пользователем действий по
типу согласия на распространение общедоступных персональных данных субъекта
(PERS_DATA_EXT) передается в ответе по ВС «Запрос перечня согласий пользователя
ЕСИА, выданных организации» и REST (см. п.
4.2.3 «Получение всех согласий
пользователя, выданных организации, по идентификатору пользователя (oid)».
Таблица 6 - Тип «Перечень запретов пользователя на действия с данными третьим
лицам» (ns2:forbiddensType)
Требования
Способ
№
Код поля
Описание поля
Комментарий
к заполнению
заполнения/Тип
1.
forbidden
Запрет пользователя
1, обязательно
ns2:forbiddenFullType
См. описание
на действие
типа
с данными третьим
forbiddenFullType
лицам
Таблица 7 - Тип «Запрет пользователя на действие с данными третьим лицам»
(ns2:forbiddenFullType)
Требования
Способ
№
Код поля
Описание поля
Комментарий
к заполнению
заполнения/Тип
1.
sysname
Мнемоника запрета
1, обязательно
ns2:sysnameType
Строка.
пользователя
Максимальная
на действие
длина значения
с данными
256 символов
2.
name
Наименование
1, обязательно
ns2:nameType
Строка.
действия с данными
Максимальная
40
Требования
Способ
№
Код поля
Описание поля
Комментарий
к заполнению
заполнения/Тип
для запрета
длина значения
пользователем
150 символов
в рамках согласия
Таблица
8
- Справочник действий с персональными данными пользователя
(параметр «forbiddens»)
Мнемоника условия
№
обработки данных
Описание условия обработки данных
оператором
1.
COLLECTION
Сбор
2.
RECORD
Запись
3.
SYSTEMATIZATION
Систематизация
4.
ACCUMULATION
Накопление
5.
STORAGE
Хранение
6.
UPDATE
Обновление
7.
CHANGE
Изменение
8.
EXTRACTION
Извлечение
9.
USAGE
Использование
10.
DISSEMINATION
Распространение
11.
PROVIDE
Предоставление
12.
ACCESS
Доступ
13.
DEPERSONALIZATION
Обезличивание
14.
BLOCK
Блокирование
Примеры запросов:
1) Пример содержимого параметра «permissions» (Стандартный запрос согласия
пользователя от внешней организации) в запросе к OAuth2.0 ЕСИА метода
/aas/oauth2/ac:
[
{
"ogrn": 5340503212066,
"scopes": [
{
"sysname": "email"
}
],
"sysname": "CREDIT",
"purposes": [
{
"sysname": "CREDIT"
41
}
],
"actions": [
{
"sysname": "ALL_ACTIONS_TO_DATA"
}
],
"responsibleObject": "Иванов Иван Иванович",
"expire": 262800
}
]
2) Пример содержимого параметра «permissions» (Одновременная выдача
согласий для нескольких организаций) в запросе к OAuth2.0 ЕСИА метода
/aas/oauth2/ac:
[
{
"ogrn": 5340503212066,
"scopes": [
{
"sysname": "email"
}
],
"sysname": "CREDIT",
"purposes": [
{
"sysname": "CREDIT"
}
],
"actions": [
{
"sysname": "ALL_ACTIONS_TO_DATA"
}
],
"responsibleObject": "Иванов Иван Иванович",
"expire": 262800
},
{
"ogrn": 5340563375114,
"scopes": [
{
"sysname": "email"
}
42
],
"sysname": "CREDIT_CARD",
"purposes": [
{
"sysname": "CREDIT_CARD"
}
],
"actions": [
{
"sysname": "ALL_ACTIONS_TO_DATA"
}
],
"responsibleObject": "Иванов Иван Иванович",
"expire": 262800
}
]
3) Пример содержимого параметра «permissions» (Согласие на распространение
общедоступных персональных данных субъекта, только для согласия
с мнемоникой PERS_DATA_EXT) в запросе к OAuth2.0 ЕСИА метода
/aas/oauth2/ac:
[
{
"scopes" : [
{
"sysname" : "email_ext"
}
],
"sysname" : "PERS_DATA_EXT" ,
"purposes" : [
{
"sysname" : "PERS_DATA_EXT"
}
],
"actions" : [
{
"sysname" : "SHARE_DATA"
}
],
"sites" : [
{
"url" : "https://test.ru/" ,
43
"require" : true ,
"description" : "Страница соцсети"
},
{
"url" : "https://test2.ru/" ,
"require" : false,
"description" : "Страница соцсети"
}
],
"terms" : [
{
"sysname" : "LOCALNET" ,
"require" : true,
"requireReason" : "Причина условия"
},
{
"sysname" : "INTERNET" ,
"require" : false
}
],
"responsibleObject" : "Иванов Иван Иванович" ,
"expire" : 262800
}
]
4) Пример содержимого параметра «permissions» (для авторизации
в региональном электронном журнале и дневнике с помощью детских учетных
записей ЕСИА) в запросе к OAuth2.0 ЕСИА метода /aas/oauth2/ac:
[
{
"scopes": [
{
"sysname": "fullname"
},
{
"sysname": "birthdate"
},
{
"sysname": "snils"
},
{
"sysname": "id_doc"
},
{
"sysname": "contacts"
},
44
{
"sysname": "birth_cert_doc"
},
{
"sysname": "usr_reg_cxt"
},
{
"sysname": "kid_contacts"
},
{
"sysname": "kid_fullname"
},
{
"sysname": "kid_snils"
},
{
"sysname": "kid_birthdate"
},
{
"sysname": "kid_gender"
}
],
"sysname": "EDU_JOURNAL",
"purposes": [
{
"sysname": "EDU_JOURNAL"
}
],
"actions": [
{
"sysname": "ALL_ACTIONS_TO_DATA"
}
],
"responsibleObject": "Секретарь",
"expire": 26297460
}
]
Возможные коды ошибок:
ESIA-036701 = Не указана мнемоника типа согласия;
ESIA-036701 = Не найден тип согласия;
ESIA-036703 = Указанные скоупы выходят за рамки разрешенных для типа
согласия;
ESIA-036704 = Запрещено указывать скоупы для типа согласия;
ESIA-036705 = Необходимо указать хотя бы одно действие;
ESIA-036706 = Указанное действие не существует;
ESIA-036707 = Необходимо указать хотя бы одну цель;
45
ESIA-036716 = Указано некорректное время истечения срока действия согласия;
ESIA-036726 = Указанная цель не существует;
ESIA-036727 = Необходимо указать одну цель согласия;
ESIA-036746 = Возраст пользователя не удовлетворяет условию выдачи данного
типа согласия. Для каждого согласия настроен свой возрастной порог, с которого данное
согласие может быть выдано. Ошибка отображается в том случае, если принять решение
по согласию пытается пользователь младше настроенного возрастного порога.
4.2 Сервисы REST API ЕСИА для взаимодействия с платформой согласий
Актуальные механизмы интеграции с сервисами ЕСИА на базе подхода REST
описаны в «Методических рекомендациях по использованию ЕСИА» по ссылке:
Системе-клиенту доступны методы REST API для взаимодействия с платформой
согласий.
4.2.1 Получение всех доступных типов согласий из реестра согласий
Path: /esia-rs/api/public/v1/permissions
Тип запроса: GET
Параметры запроса:
pageIndex:
pageSize.
Требуемая область доступа (scope): usr_prm
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
системным маркером доступа.
Пример ответа:
{
"stateFacts": [
"Paginated",
"hasSize",
"EntityRoot",
"Firs65tPage"
],
"size": 2,
"pageSize": 2,
"pageIndex": 1,
46
"totalSize": 11,
"elements": [
{
"stateFacts": [
"Identifiable"
],
"id": 32,
"itSystemId": 7508541,
"sysname": "PERM_8",
"name": "Согласие 8",
"description": "Согласие 8",
"revokedOn": 1572004313,
"scopeMode": "LIMITED",
"createdOn": 1572001102,
"updatedOn": 1572004313,
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 2,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
"description": "Фамилия, имя и отчество, указанные в
вашей учетной записи",
"required": true
},
{
"stateFacts": [
"ReadOnly"
],
"sysname": "email",
"name": "Просмотр вашего адреса электронной почты",
"description": "Адрес электронной почты, указанный в
вашей учетной записи",
"required": false
}
]
}
47
},
{
"stateFacts": [
"Identifiable"
],
"id": 31,
"itSystemId": 7508541,
"sysname": "PERM_7",
"name": "Согласие 7",
"description": "Согласие 7",
"scopeMode": "LIMITED",
"createdOn": 1571999547,
"updatedOn": 1571999547,
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 2,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
"description": "Фамилия, имя и отчество, указанные в
вашей учетной записи",
"required": false
},
{
"stateFacts": [
"ReadOnly"
],
"sysname": "email",
"name": "Просмотр вашего адреса электронной почты",
"description": "Адрес электронной почты, указанный в
вашей учетной записи",
"required": false
}
]
}
}
]
48
}
Возможные коды ошибок:
Код HTTP 404:
ESIA-039870 = Выбранная информационная система не найдена
4.2.2 Получение конкретного типа согласия
Path: /esia-rs/api/public/v1/permissions/{id}
Тип запроса: GET
Требуемая область доступа (scope): usr_prm
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
системным маркером доступа.
Пример ответа:
{
"stateFacts": [
"EntityRoot",
"Identifiable"
],
"id": 32,
"itSystemId": 7508541,
"sysname": "PERM_8",
"name": "Согласие 8",
"description": "Согласие 8",
"revokedOn": 1572004313,
"scopeMode": "LIMITED",
"createdOn": 1572001102,
"updatedOn": 1572004313,
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 2,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
49
"description": "Фамилия, имя и отчество, указанные в вашей
учетной записи",
"required": true
},
{
"stateFacts": [
"ReadOnly"
],
"sysname": "email",
"name": "Просмотр вашего адреса электронной почты",
"description": "Адрес электронной почты, указанный в вашей
учетной записи",
"required": false
}
]
}
}
Возможные коды ошибок:
Код HTTP 404:
ESIA-036701 = Не найден тип согласия {0}
ESIA-039870 = Выбранная информационная система не найдена
4.2.3 Получение всех согласий пользователя, выданных организации,
по идентификатору пользователя (oid)
Path: /esia-rs/api/public/v1/prns/{prn_oid}/issued/permissions
Тип запроса: GET
Параметры запроса:
pageIndex;
pageSize.
Требуемая область доступа (scope): любой
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа (любого типа).
Пример ответа:
{
"stateFacts": [
"EntityRoot",
"hasSize"
],
"size": 3,
50
"elements": [
{
"stateFacts": [
"Identifiable"
],
"id": 30,
"personId": 7435533,
"orgId": 7413781,
"permissionId": 1,
"sysname": "PERS_DATA",
"name": "Согласие на доступ к персональным данным",
"description": "Согласие на доступ к персональным данным",
"orgShortName": "ОРГАНИЗАЦИЯ -783988581",
"ogrn": "1047702026701",
"orgAddress": "127434, Город Москва,Улица Дубки, д. 1, стр. 1",
"issuedOn": 1572020850,
"expiredOn": 1572042750,
"status": "A",
"createdOn": 1572020850,
"updatedOn": 1572020850,
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
"description": "Фамилия, имя и отчество, указанные в
вашей учетной записи"
}
]
},
"purposes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "CREDIT",
"name": "Выдачи кредита"
}
]
},
"actions": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "ALL_ACTIONS_TO_DATA",
"name": "Обработка и изменение персональных данных"
51
}
]
}
},
{
"stateFacts": [
"Identifiable"
],
"id": 27,
"personId": 7435533,
"orgId": 7413781,
"permissionId": 33,
"sysname": "PERM_9",
"name": "Согласие 9",
"description": "Согласие 9",
"orgShortName": "ОРГАНИЗАЦИЯ -783988581",
"ogrn": "1047702026701",
"orgAddress": "127434, Город Москва,Улица Дубки, д. 1, стр. 1",
"responsibleObject": "Петров Петр Петрович",
"issuedOn": 1572020850,
"expiredOn": 1603555445,
"sessionId": "9979b075-43dd-41c2-bec4-0db0452243ba",
"status": "A",
"createdOn": 1572015602,
"updatedOn": 1572019445,
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
"description": "Фамилия, имя и отчество, указанные в
вашей учетной записи"
}
]
},
"purposes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "CREDIT",
"name": "Выдачи кредита"
}
]
},
"actions": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
52
"stateFacts": [
"ReadOnly"
],
"sysname": "ALL_ACTIONS_TO_DATA",
"name": "Обработка и изменение персональных данных"
}
]
}
},
{
"stateFacts": [
"Identifiable"
],
"id": 24,
"personId": 7435533,
"orgId": 7413781,
"permissionId": 35,
"sysname": "PERM_11",
"name": "Согласие 11",
"description": "Согласие 11",
"orgShortName": "ОРГАНИЗАЦИЯ -783988581",
"ogrn": "1047702026701",
"orgAddress": "127434, Город Москва,Улица Дубки, д. 1, стр. 1",
"status": "W",
"createdOn": 1572006785,
"updatedOn": 1572006785,
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
"description": "Фамилия, имя и отчество, указанные в
вашей учетной записи"
}
]
},
"purposes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "CREDIT",
"name": "Выдачи кредита"
}
]
},
"actions": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
53
{
"stateFacts": [
"ReadOnly"
],
"sysname": "ALL_ACTIONS_TO_DATA",
"name": "Обработка и изменение персональных данных"
}
]
}
}
]
}
Описание основных параметров:
id - уникальный номер согласия пользователя;
personId - уникальный идентификатор пользователя;
status - текущий статус согласия. В данном REST передается информация
только по выданным согласиям (статус A) и отозванным согласиям (статус D);
permissionId - уникальный номер типа согласия;
sysname - уникальная мнемоника типа согласия;
name - наименование типа согласия;
purposes - цель типа согласия.
Возможные коды ошибок:
Код HTTP 404:
ESIA-035000 = Пользователь не найден
ESIA-039870 = Выбранная информационная система не найдена
Примечание:
Если во входном параметре метода указан OID учетной записи
несовершеннолетнего пользователя, а также выдано от его родителя согласие
«Предоставление услуги «Электронный дневник школьника» (EDU_JORNAL) на данные
указанного несовершеннолетнего, то данное согласие отобразится в ответе. Дополнительно
передаются значения по атрибутам kidId и kidInfo.
Пример ответа:
{
"stateFacts": [
"EntityRoot",
"hasSize"
],
"size": 3,
"elements": [
{
"stateFacts": [
"Identifiable"
],
54
"id": 30,
"personId": 7435533,
"orgId": 7413781,
"permissionId": 1,
"sysname": "PERS_DATA",
"name": "Согласие на доступ к персональным данным",
"description": "Согласие на доступ к персональным данным",
"orgShortName": "ОРГАНИЗАЦИЯ -783988581",
"ogrn": "1047702026701",
"orgAddress": "127434, Город Москва,Улица Дубки, д. 1, стр. 1",
"issuedOn": 1572020850,
"expiredOn": 1572042750,
"status": "A",
"createdOn": 1572020850,
"updatedOn": 1572020850,
"signatureStatus": "ISSUED",
"kidId": 86321969,
"kidInfo": {
"kidFullname": "Ручкин Лука Петрович",
"kidBirthdate": 1507928400},
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
"description": "Фамилия, имя и отчество, указанные в
вашей учетной записи"
}
]
},
"purposes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "CREDIT",
"name": "Выдачи кредита"
}
]
},
"actions": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "ALL_ACTIONS_TO_DATA",
55
"name": "Обработка и изменение персональных данных"
}
]
}
}]}
4.2.4 Получение
согласия
пользователя,
выданного
организации,
по идентификатору согласия
Path: /esia-rs/api/public/v1/prns/{prn_oid}/issued/permissions/{id}
Тип запроса: GET
Требуемая область доступа (scope): любой
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа (любого типа).
Пример ответа:
{
"stateFacts": [
"EntityRoot",
"Identifiable"
],
"id": 30,
"personId": 7435533,
"orgId": 7413781,
"permissionId": 1,
"sysname": "PERS_DATA",
"name": "Согласие на доступ к персональным данным",
"description": "Согласие на доступ к персональным данным",
"orgShortName": "ОРГАНИЗАЦИЯ -783988581",
"ogrn": "1047702026701",
"orgAddress": "127434, Город Москва,Улица Дубки, д. 1, стр. 1",
"issuedOn": 1572020850,
"expiredOn": 1572042750,
"status": "A",
"createdOn": 1572020850,
"updatedOn": 1572020850,
"scopes": {
"stateFacts": [
"hasSize"
],
"size": 1,
56
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "fullname",
"name": "Просмотр вашей фамилии, имени и отчества",
"description": "Фамилия, имя и отчество, указанные в вашей
учетной записи"
}
]
},
"purposes": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "CREDIT",
"name": "Выдачи кредита"
}
]
},
"actions": {
"stateFacts": [
"hasSize"
],
"size": 1,
"elements": [
{
"stateFacts": [
"ReadOnly"
],
"sysname": "ALL_ACTIONS_TO_DATA",
"name": "Обработка и изменение персональных данных"
}
]
}
}
57
Описание основных параметров:
id - уникальный номер согласия пользователя;
personId - уникальный идентификатор пользователя;
status - текущий статус согласия. В данном REST передается информация
только по выданным согласиям (статус A) и отозванным согласиям (статус D);
permissionId - уникальный номер типа согласия;
sysname - уникальная мнемоника типа согласия;
name - наименование типа согласия;
purposes - цель типа согласия.
Возможные коды ошибок:
Код HTTP 404:
ESIA-035000 = Пользователь не найден
ESIA-039870 = Выбранная информационная система не найдена
ESIA-036710 = Согласие не найдено
4.2.5 Получение архива с подписанным согласием пользователя, выданного
организации, по идентификатору согласия
Path: /esia-rs/api/public/v1/prns/{prn_oid}/issued/permissions/{id}/archive
Тип запроса: GET
Требуемая область доступа (scope): usr_prm
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа (любого типа).
Пример ответа: Архив с подписанным согласием.
Возможные коды ошибок:
Код HTTP 401:
ESIA-005013 = SecurityErrorEnum.expiredToken
Код HTTP 403:
ESIA-005029 = SecurityErrorEnum.scopeNotAllowed
Код HTTP 404:
ESIA-036710 = Согласие не найдено
ESIA-036729 = Архив с подписанным согласием не может быть получен,
т.к. произошла ошибка на этапе выгрузки архива в хранилище
58
ESIA-020027 = ПЭП не найдена
4.2.6 Получение всех архивов с подписанными согласиями пользователя,
выданных организации, по идентификатору пользователя (OID)
Path: /esia-rs/api/public/v1/prns/{prn_oid}/issued/permissions/archive
Тип запроса: GET
Требуемая область доступа (scope): usr_prm
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа (любого типа).
Пример ответа: Архив с архивами, в которых содержатся подписанные согласия.
Возможные коды ошибок:
Код HTTP 401:
ESIA-005013 = SecurityErrorEnum.expiredToken
Код HTTP 403:
ESIA-005029 = SecurityErrorEnum.scopeNotAllowed
Код HTTP 404:
ESIA-020027 = ПЭП не найдена.
4.3 Уведомление потребителей платформы согласий
Реализован механизм и соответствующая модель данных для отправки
уведомлений о событиях платформы согласий в ИС организаций
- потребителей
платформы (организаций, запрашивающих и получающих согласия пользователей),
предоставляющий возможность передачи в ИС атрибутов события платформы согласий,
в том числе - идентификатора согласия и связанного с согласием идентификатора
гражданина - пользователя ЕСИА.
В платформе согласий предусмотрена возможность отправки запросов на REST-
сервисы (методы) ИС организаций-потребителей платформы согласий в соответствии
с моделью данных, описывающей атрибутивный состав события платформы согласий.
Тип события платформы согласий ЕСИА, в виде символьной мнемоники-кода
события, возможные значения:
PermissionOperationEnum.claimPermission - запрос согласия;
PermissionOperationEnum.issuePermission - выдача гражданином согласия;
59
PermissionOperationEnum.refusePermission
- отказ гражданина от выдачи
согласия;
PermissionOperationEnum.revokePermission - отзыв гражданином согласия;
идентификатор (OID) учетной записи гражданина - пользователя ЕСИА,
которому был направлен запрос согласия/которым было выдано
согласие/которым было отказано в выдаче согласия/который отозвал согласие;
идентификатор сессии (необязательный атрибут события) - идентификатор,
предназначенный
для
хранения
служебной
информации
о запрошенном/выданном согласии;
идентификатор согласия в реестре согласий.
Представленный атрибутивный состав события платформы согласий определят
структуру тела (JSON) запроса на REST-сервис информационной системы организации:
eventType : string - источник события, для платформы согласий всегда равен
permissionsEvent;
opType : string - тип события платформы согласий (см. описание выше);
oid : string - идентификатор (OID) учетной записи пользователя ЕСИА
(см. описание выше);
sessionId : string - идентификатор сессии, необязательный атрибут события;
issPrmId : integer - идентификатор согласия в реестре согласий (см. описание
выше).
Пример JSON тела запроса:
{
"eventType": "permissionsEvent",
"opType": "PermissionOperationEnum.issuePermission",
"oid": "1000031415",
"sessionId": "9979b075-43dd-41c2-bec4-0db0452243ba",
"issPrmId": 27
}
Для получения уведомлений в описанном выше формате в ИС организации-
потребителя платформы согласий необходимо реализовать REST-метод, удовлетворяющий
условиям:
публичный доступ, т.е., метод доступен для запроса со стороны внешний ИС
(например, доступен для использования извне со стороны внешнего
балансировщика ИС);
тип HTTP запроса - POST;
60
URL метода - произвольный, на усмотрение владельца ИС организации,
прием в теле запроса JSON в соответствии с описанным выше форматом;
ответ на запрос метода: с HTTP кодом 200 OK.
Взаимодействие между платформой согласий и REST-сервисом ИС организации-
потребителя осуществляется по протоколу HTTPS, в ИС организации-потребителя должен
быть установлен SSL-сертификат, удовлетворяющий следующим требованиям:
сертификат выпущен одним из доверенных Центров Сертификации на рынке
SSL-сертификатов, использование самовыпущенных SSL-сертификатов
не допускается;
алгоритм шифрования: RSA.
В Технологическом портале ЕСИА (далее
- Техпортал) уполномоченный
сотрудник организации-потребителя платформы согласий должен указать URL-адрес
REST-сервиса (метода) информационной системы организации для приема уведомлений
от платформы согласий.
Указанные действия в Техпортале может выполнять уполномоченный сотрудник
организации-потребителя платформы согласий, учетная запись в ЕСИА которого
удовлетворяет следующим требованиям:
сотрудник является руководителем организации или администратором
профиля организации в ЕСИА;
сотрудник включен в группу доступа «Технологический портал» Единой
системы идентификации и аутентификации.
Примечание: данные настройки выполняются в профиле организации в ЕСИА -
руководитель организации может назначить администратором профиля своей организации
и включить в группу доступа «Технологический портал» ЕСИА любого сотрудника -
участника организации.
Раздел Техпортала «Оповещения» предназначен для настройки механизмов
рассылки уведомлений о событиях некоторых сервисов ЕСИА, используемых
зарегистрированными ИС организаций. Доступ к указанным настройкам осуществляется
на вкладке «Оповещения» страницы «Управление сервисами» раздела Техпортала
«Сервисы» (рисунок 2).
61
Рисунок 2 - Настройка механизмов рассылки уведомлений сервисов ЕСИА
В группе настроек «Адрес сервиса для приема уведомлений от платформы
согласий» предоставляется возможность указания или редактирования ранее указанного
URL-адреса REST-сервиса (метода), реализованного в ИС организации, на который будут
направляться запросы с передачей в теле запроса атрибутов событий платформы согласий.
Ввод и последующее редактирование URL-адреса REST-сервиса (метода) ИС для приема
уведомлений платформы согласий осуществляется на форме «Данные для оповещения»
(рисунок 3), отображаемой при нажатии соответствующей кнопки «+Добавить адрес»
(рисунок 2).
Рисунок 3 - Ввод или редактирование URL-адреса REST-сервиса ИС организации
для приема уведомлений о событиях платформы согласий ЕСИА
62
5 Получение данных Цифрового профиля пользователя
В рамках эксперимента потребителям предоставляется доступ к данным
пользователя при наличии действующего согласия посредством REST API. Актуальные
механизмы интеграции с сервисами ЕСИА на базе подхода REST описаны
в «Методических
рекомендациях
по использованию
ЕСИА»
по
ссылке:
пользователей подробно описаны в п. 3.
5.1 Методы REST API для получения сведений пользователя
Актуальные механизмы интеграции с сервисами ЕСИА на базе подхода REST
описаны в «Методических рекомендациях по использованию ЕСИА» по ссылке:
ИС-клиенту доступны перечисленные ниже методы REST API для получения
сведений пользователя.
5.1.1 Получение основных сведений о гражданине
Path: /digital/api/public/{version}/pso/{oid}
Тип запроса: GET
Назначение: получение основной информации о гражданине по идентификатору
пользователя (oid).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя.
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
информации, информация предоставляется со следующими scope:
fullname;
birthdate;
birthplace;
gender;
snils;
inn;
addresses (получение адреса временной регистрации возможно только
с версией метода v2);
63
mobile;
email.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель со всеми параметрами в случае успеха4:
{
"oid": "1077131562",
"firstName": "Дмитрий",
"middleName": "Андреевич",
"lastName": "Лаптев",
"snils": "204-585-302 46",
"inn": "403956183997",
"gender": "M",
"birthDate": "21.11.1985",
"birthPlace": "Бишкенк",
"mobilePhone": "+7(905)6578090",
"homeAddress":{
"addressStr": "Кемеровская Область, Таштагольский Район, Шерегеш Поселок
городского типа",
"region": "23",
"flat": "пом.419",
"countryId": "RUS",
"house": "43Ke",
"frame": "2Lk",
"zipCode": "394000",
"building": "2f",
"street": "Советская Улица",
"fiasCode": "720b25da-f43e-4204-9013-3cb06be3e9e4"
},
"trusted": true
}
5.1.2 Получение коллекции ссылок на документы определенного типа
Path: /digital/api/public/{version}/pso/{oid}/docs/{doc_type}
Тип запроса: GET
Назначение: получение коллекции документов гражданина по идентификатору
пользователя (oid) и типу документа (doc_type).
4 Параметр «snils» может передаваться в форматах: «ХХХ - ХХХ -ХХХ ХХ» (строка, где Х - символы
десятичных цифр 0…9) или «***-***-ХХХ ХХ» (строка, первые шесть цифр - в виде звездочек)
64
Параметры запроса:
version - версия API (текущая версия -v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа.
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель со всеми параметрами в случае успеха:
[
{
"id": "91899952b06c4cc89746d38b2c8c72f3",
"relevance": "actual",
"type": "MARRIED_CERT"
},
{
"id": "3a340bafae204f7e84ae71af2f8c0743",
"relevance": "actual",
"type": "MARRIED_CERT"
}
]
Для типа документа INCOME_REFERENCE (Справка о доходах и суммах налога
физического лица (форма 2-НДФЛ)) дополнительно указывается параметр year - год,
за который успешно получена справка 2-НДФЛ в ведомстве:
[
{
"id": "91899952b06c4cc89746d38b2c8c72f3",
"relevance": "actual",
"year": "2017",
"type": "INCOME_REFERENCE"
},
{
"id": "3a340bafae204f7e84ae71af2f8c0743",
"relevance": "actual",
"year": "2019",
"type": "INCOME_REFERENCE"
}
]
65
Для типа документа DIGITAL_EDUC_DOC (Цифровой документ об образовании
пользователя версии 1.0.1) в ответе метода в случае успеха возвращается следующая модель
данных:
{
"snils": "767-751-063 44",
"oid": "1077386021",
"type": "digital_educ_doc",
"departmentDoc": "Рособрнадзор",
"status": "verified_by_request",
"eduDocumentLinks": [
{
"id": "7ca89d82-4a2a-4931-966b-8ad30799d611",
"version": 1,
"createdOn": "2021-06-20",
"updatedOn": "2021-06-20",
"digitalDocId": 12345672,
"rDocNumber": 12345678901234567890,
"docName": "Аттестат об общем образовании",
"levelEdu": "общее образование",
"startYear": 2010,
"finishYear": 2021,
"orgName": "Школа номер 1020 города Москва"
},
{
"id": "7ca89d82-4a2a-4931-966b-8ad30799d612",
"version": 1,
"createdOn": "2021-06-20",
"updatedOn": "2021-06-20",
"digitalDocId": 12345673,
"rDocNumber": 12345678901234567890,
"docName": Аттестат о среднем общем образовании,
"levelEdu": среднее общее образование,
"startYear": 2010,
"finishYear": 2022,
"orgName": "Школа номер 1020 города Москва"
}
]
}
}
В случае отсутствия данных для типа документа DIGITAL_EDUC_DOC (Цифровой
документ об образовании пользователя версии 1.0.1) по указанному пользователю, в ответе
метода возвращается HTTP Status
404 Not Found и сообщение вида
«Данные для указанного пользователя не найдены».
Для типа документа DIGITAL_EDUC_DOC_V2 (Цифровой документ
об образовании пользователя версии 2.0.6) в ответе метода в случае успеха возвращается
следующая модель данных:
{
"snils": "767-751-063 44",
"type": "DIGITAL_EDUC_DOC_V2",
"departmentDoc": "Рособрнадзор",
"status": "verified_by_request",
66
"eduDocumentLinks": [
{
"id": "d586ab21-53c7-4d78-92e5-2721f0edd2dd",
"version": 1,
"createdOn": "2022-11-23T10:27:47.146",
"updatedOn": "2022-11-23T10:27:47.146",
"docName": "Аттестат о среднем общем образовании с отличием",
"levelEdu": "среднее общее образование",
"finishYear": "2022",
"orgName": "444 школа",
"status": "Действительный",
"rDocNumber": "07700000000001"
},
{
"id": "d0940eff-524c-477e-bc43-e8ace2f67cb1",
"version": 1,
"createdOn": "2022-11-23T10:35:12.077",
"updatedOn": "2022-11-23T10:35:12.077",
"docName": "Диплом бакалавра с отличием",
"levelEdu": "бакалавриат",
"finishYear": "2022",
"orgName": "Московский государственный технический университет
имени Н.Э.Баумана (национальный исследовательский университет)",
"status": "Действительный",
"rDocNumber": "07700000000000"
}
]
}
В случае отсутствия данных для типа документа DIGITAL_EDUC_DOC_V2
(Цифровой документ об образовании пользователя версии
2.0.6) по указанному
пользователю, в ответе метода возвращается HTTP Status 404 Not Found и сообщение вида
«Данные для указанного пользователя не найдены».
5.1.3 Получение сведений определенного документа
Path: /digital/api/public/{version}/pso/{oid}/docs/{doc_type}/{id}
Тип запроса: GET
Назначение: получение сведений документа гражданина по идентификатору
пользователя (oid), типу документа (doc_type) и идентификатору документа (id).
67
Параметры запроса:
version - версия API (текущая версия - v1). Для документа «Сведения
о состоянии индивидуального страхового счета застрахованного лица»
(ILS_PFR) доступна вторая версия (v2) API;
oid - уникальный идентификатор пользователя;
doc_type - тип документа;
id - уникальный идентификатор документа.
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель со всеми параметрами в случае успеха.
Перечень параметров, которые возвращаются по каждому типу документа
(doc_type), приведен в разделе 5.2.
5.1.4 Получение сведений документа в определенном формате (XML
или PDF)
Path: /digital/api/public/{version}/pso/{oid}/docs/{doc_type}/{id}/{fileType}
Тип запроса: GET
Назначение: получение сведений документа гражданина в определенном формате
(fileType) по идентификатору пользователя (oid), типу документа (doc_type)
и идентификатору документа (id).
Метод доступен для следующих типов документов:
INCOME_REFERENCE (справка о доходах и суммах налога физического лица
(форма 2-НДФЛ));
PENSION_REFERENCE (справка о назначенных пенсиях и социальных
выплатах на дату);
ELECTRONIC_WORKBOOK (сведения о трудовой деятельности
застрахованного лица в системе обязательного пенсионного страхования);
FAMILY_ASSETS (сведения о выписке из регистра сертификатов
материнского капитала).
Параметры запроса:
version - версия API (текущая версия - v1);
68
oid - уникальный идентификатор пользователя;
doc_type - тип документа;
id - уникальный идентификатор документа;
fileType - тип файла (XML или PDF).
Требуемая область доступа (scope): ndfl_person
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель, у которой в массиве files будет
приведены только файлы указанного в запросе типа и файл подписи к нему в случае успеха.
5.1.5 Получение сведений определенного документа
Для типов документов DIGITAL_EDUC_DOC (Цифровой документ
об образовании пользователя версии 1.0.1) и DIGITAL_EDUC_DOC_V2 (Цифровой
документ об образовании пользователя версии 2.0.6) запрос для получения данных
документа указанного типа и идентификатором ID у пользователя с идентификатором OID
имеет следующий вид:
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/{id}
Тип запроса: GET
Назначение: получение данных документа типа doc_type и идентификатором ID
у пользователя с идентификатором OID.
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа (digital_educ_doc или digital_educ_doc_v2);
id - уникальный идентификатор документа.
Требуемая область доступа (scope): digital_educ_doc.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Перечень параметров, которые возвращаются по каждому типу документа
(doc_type), приведен в разделе 5.2.
5.1.6 Получение сведений всех документов, определенного типа
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}
69
Тип запроса: GET
Назначение: получение сведений всех документов гражданина по идентификатору
пользователя (oid) и типу документа (doc_type).
Для некоторых типов документов также реализована возможность их получения
в том виде, в котором они были получены от ведомства (см. п. 5.1.8).
Параметры запроса:
version - версия API (текущая версия - v1). Для документов «Сведения
о состоянии индивидуального страхового счета застрахованного лица»
(ILS_PFR), «Справка о доходах и суммах налога физического лица (форма
2-НДФЛ)» (INCOME_REFERENCE), «История выданных гражданину РФ
паспортов (PASSPORT_HISTORY) доступна вторая версия (v2) API.
Для запроса типа документа PASSPORT_HISTORY рекомендуется
использовать вторую версию (v2) API;
oid - уникальный идентификатор пользователя;
doc_type - тип документа;
extended - признак расширенной модели данных (может быть указан только
в отношении свидетельств о браке и разводе). Если указан extended=true,
то тогда в ответе вернется информация о соответствующей записи АГС
(при наличии).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель со всеми параметрами в случае успеха
(приведен пример для документа «Свидетельство о заключении брака»):
[
{
"oid": "1000376121",
"id": "9717eee3-47fa-42de-a1c7-1f52e08a2387",
"version": 1,
"createdOn": 1582187411649,
"updatedOn": 1582187411649,
"receiptDocDate": 1582187411649,
"relevance": "actual",
"status": "unverified",
70
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Орган записи актов гражданского состояния",
"series": "CXI-ОРТТ",
"number": "545454",
"issuedBy": "загс",
"issueDate": "01.01.2010",
"actNo": "999",
"actDate": "01.01.2010",
"type": "MARRIED_CERT"
},
{
"oid": "1000376121",
"id": "92528138-f675-4fb0-9c84-28a4ee864cea",
"version": 1,
"createdOn": 1582192223736,
"updatedOn": 1582192223736,
"receiptDocDate": 1582192223736,
"relevance": "actual",
"status": "unverified",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Орган записи актов гражданского состояния",
"series": "CXI-ОРТТ",
"number": "911999",
"issuedBy": "загс",
"issueDate": "01.01.2015",
"actNo": "999",
"actDate": "01.01.2015",
"type": "MARRIED_CERT"
},
{
"oid": "1000376121",
"id": "47a882fc-1f91-4503-8539-9f37a4f1b3f3",
"version": 1,
"createdOn": 1582192270471,
71
"updatedOn": 1582192270471,
"receiptDocDate": 1582192270471,
"relevance": "actual",
"status": "unverified",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Орган записи актов гражданского состояния",
"series": "CXI-ОРТТ",
"number": "921999",
"issuedBy": "загс",
"issueDate": "01.01.2018",
"actNo": "999",
"actDate": "01.01.2018",
"type": "MARRIED_CERT"
}
]
Если на момент вызова метода сведения документа запрошены в ведомстве,
но ответ от ведомства еще не поступил, будут возвращены идентификаторы пользователя
ЕСИА и запроса сведений в ведомстве, например:
{
"oid": "1000376121",
"requestId": "3222232"
}
В этом случае следует дать время на получение ответа от ведомства и повторить
запрос.
Для типа документа INCOME_REFERENCE (Справка о доходах и суммах налога
физического лица (форма 2-НДФЛ)) дополнительно указывается параметр year - год,
за который успешно получена справка 2-НДФЛ в ведомстве.
В случае, если у пользователя нет информации по следющим сведениям:
FID_BRTH_CERT,
OLD_BRTH_CERT,
RF_BRTH_CERT,
MARRIED_CERT,
DIVORCE_CERT,
NAME_CHANGE_CERT,
FATHERHOOD_CERT,
DIGITAL_EDUC_DOC, DIGITAL_EDUC_DOC_V2, то в ответе на запрос вернется ошибка
404.
Перечень параметров, которые возвращаются по каждому типу документа
(doc_type), приведены в разделе 5.2.
72
5.1.7 Получение сведений документа в определенном формате (XML
или PDF)
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/{fileType}
Тип запроса: GET
Назначение: получение данных всех документов в формате только XML или PDF.
Сервис доступен для типов документов INCOME_REFERENCE (Справка о доходах
и суммах налога физического лица (форма 2-НДФЛ)), PENSION_REFERENCE (Справка
о назначенных пенсиях и социальных выплатах на дату).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа;
fileType - тип файла (XML или PDF).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель со всеми параметрами в случае успеха,
при этом для каждого документа будет приведены только файлы указанного в запросе типа
и файл подписи к нему (при наличии).
5.1.8 Получение сведений документа в исходном виде
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/raw
Тип запроса: GET
Назначение: получение сведений документа гражданина в исходном виде
по идентификатору пользователя (oid) и типу документа (doc_type).
Сервис доступен для следующих типов документов:
DIGITAL_EDUC_DOC (данные цифровых документов об образовании версии
1.0.1);
DIGITAL_EDUC_DOC_V2 (данные цифровых документов об образовании
версии 2.0.6);
DISABLED_PERSON (сведения об инвалидности);
73
ILS_PFR (сведения о состоянии индивидуального страхового счета
застрахованного лица);
PAYOUT_INCOME (сведения о доходах физического лица и о выплатах
страховых взносов, произведенных в пользу физического лица);
SELF_EMPLOYED (сведения о статусе самозанятого);
VEHICLE_INFO (выписка о транспортном средстве по владельцу);
GIBDD_DRIVER_LICENSE (сведения о водительском удостоверении,
полученнном из ГИБДД).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа (DIGITAL_EDUC_DOC, DIGITAL_EDUC_DOC_V2,
DISABLED_PERSON, ILS_PFR, PAYOUT_INCOME, SELF_EMPLOYED,
VEHICLE_INFO, GIBDD_DRIVER_LICENSE).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель со всеми параметрами в случае успеха
(приведен пример для документа «Выписка о ТС по владельцу»):
{
"oid": "1077130925",
"id": "1ab0a427-48e9-47f7-ad10-6b58ff3d75e0",
"version": 1,
"createdOn": 1616081460770,
"updatedOn": 1616081460770,
"receiptDocDate": 1616081460770,
"validateDateDoc": 1616081460601,
"relevance": "actual",
"status": "verified_by_request",
"departmentDoc": "Управление ГИБДД ГУ МВД России",
"nameDoc": "Выписка о ТС по владельцу",
"content": "PD94b…..JzPg==",
"type": "VEHICLE_INFO"
}
74
В случае, если сведение запрошено в ведомстве и ответ еще не поступил,
возвращается идентификатор этого запроса и идентификатор пользователя (OID).
С помощью идентификатора запроса осуществляется процесс обработки персональных
данных. Для возможности получения сведения о выписки транспортого средства
по владельцу необходимо обновить запрос.
Для типа документа DIGITAL_EDUC_DOC (Данные цифровых документов
об образовании версии 1.0.1) в случае успеха в ответе метода возвращается следующая
модель:
{
"relevance": "actual",
"oid": "1077386021",
"type": "DIGITAL_EDUC_DOC",
"departmentDoc": "Рособрнадзор",
"status": "verified_by_request",
"eduDocuments": [
{
"id": "bd2faae5-fcba-4e64-9726-0529caf0bd57",
"version": 1,
"createdOn": 1649227850719,
"updatedOn": 1649227850719,
"receiptDocDate": 1649227850719,
"content": "PG5zjNNl1...W5mbz4K"
},
{
"id": "ae3ba655-91c4-414a-ba93-a1ca78a1df35",
"version": 1,
"createdOn": 1649227949920,
"updatedOn": 1649227949920,
"receiptDocDate": 1649227949920,
"content": "PG5zMT...bz4K"
}
]
}
Для типа документа DIGITAL_EDUC_DOC_V2 (Данные цифровых документов
об образовании версии 2.0.6) в случае успеха в ответе метода возвращается следующая
модель:
{
"relevance": "actual",
"snils": "767-751-063 44",
75
"type": "DIGITAL_EDUC_DOC_V2",
"departmentDoc": "Рособрнадзор",
"status": "verified_by_request",
"eduDocuments": [
{
"id": "d586ab21-53c7-4d78-92e5-2721f0edd2dd",
"version": 1,
"createdOn": "2022-11-23T10:27:47.146",
"updatedOn": "2022-11-23T10:27:47.146",
"receiptDocDate": "2022-11-23T10:27:47.146",
"status": "Действительный",
"content": "PG5zMTpEaWdpdGFsRG9...Pgo="
},
{
"id": "d0940eff-524c-477e-bc43-e8ace2f67cb1",
"version": 1,
"createdOn": "2022-11-23T10:35:12.077",
"updatedOn": "2022-11-23T10:35:12.077",
"receiptDocDate": "2022-11-23T10:35:12.077",
"status": "Действительный",
"content": "PG5zMTpEaWdpdGFs...g=="
}
]
}
Для типа документа GIBDD_DRIVER_LICENSE (сведения о водительском
удостоверении, полученнном из ГИБДД) в случае успеха в ответе метода возвращается
следующая модель:
{
"oid": "1077496446",
"id": "1a5c3369-da72-4f91-a9f7-66582a1427ed",
"version": 1,
"createdOn": 1662460922607,
"updatedOn": 1662460922607,
"receiptDocDate": 1662460922607,
"validateDateDoc": 1662460922469,
"relevance": "actual",
"status": "verified_by_request",
"departmentDoc": "Управление ГИБДД ГУ МВД России",
"nameDoc": "Сведения о выданных водительских удостоверениях граждан",
"content": "PD94b...URMPg0K",
"type": "GIBDD_DRIVER_LICENSE"
}
76
В случае, если документы по указанному идентификатору пользователя
отсутствуют в БД ЕСИА, тогда в ответе возвращается HTTP Status Code: 404 и сообщение
вида «Данные для указанного пользователя не найдены».
Перечень параметров, которые возвращаются по каждому типу документа
(doc_type), приведен в разделе 5.2.
5.1.9 Получение сведений документа в исходном виде по идентификатору
документа
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/raw/{id}
Тип запроса: GET
Назначение: получение сведений документа гражданина в исходном виде
по идентификатору пользователя (oid), типу (doc_type) и идентификатору документа (id).
Сервис доступен для следующих типов документов:
DIGITAL_EDUC_DOC (данные цифровых документов об образовании вресии
1.0.1);
DIGITAL_EDUC_DOC_V2 (данные цифровых документов об образовании
версии 2.0.6).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type
-
тип
документа
(DIGITAL_EDUC_DOC,
DIGITAL_EDUC_DOC_V2).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка или модель со всеми параметрами в случае успеха.
Для типа документа DIGITAL_EDUC_DOC (Данные цифровых документов
об образовании версии 1.0.1) в случае успеха в ответе метода возвращается следующая
модель:
{
"oid": "76775106344",
"relevance": "actual",
77
"status": "verified_by_request",
"departmentDoc": "Рособрнадзор",
"type": "DIGITAL_EDUC_DOC",
"eduDocuments": [
{
"id": "7ca89d82-4a2a-4931-966b-8ad30799d61a",
"version": 1,
"createdOn": "2021-06-20",
"updatedOn": "2021-06-20",
"receiptDocDate": "2021-06-20",
"content": "PD94bWwgdmV...m8+",
}
]
}
Для типа документа DIGITAL_EDUC_DOC_V2 (Данные цифровых документов
об образовании версии 2.0.6) в случае успеха в ответе метода возвращается следующая
модель:
{
"relevance": "actual",
"snils": "767-751-063 44",
"type": "DIGITAL_EDUC_DOC_V2",
"departmentDoc": "Рособрнадзор",
"status": "verified_by_request",
"eduDocuments": [
{
"id": "d0940eff-524c-477e-bc43-e8ace2f67cb1",
"version": 1,
"createdOn": "2022-11-23T10:35:12.077",
"updatedOn": "2022-11-23T10:35:12.077",
"receiptDocDate": "2022-11-23T10:35:12.077",
"status": "Действительный",
"content": "PG5zMTpEaWdpdGF...0luZm8+Cg=="
}
]
}
В случае, если документ по указанному идентификатору отсутствует в БД ЕСИА,
тогда в ответе возвращается HTTP Status Code:
404 и сообщение вида «Данные
для указанного пользователя не найдены».
78
5.1.10 Получение списка ссылок на файлы, полученные от ведомства,
детализирующие документы данного типа у гражданина
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/extraction
Тип запроса: GET
Назначение: получение списка ссылок на файлы, детализирующие документы
данного типа в виде, полученном от ведомства, по идентификатору пользователя (oid)
и типу (doc_type).
Сервис доступен для следующих типов документов:
REG_REALESTATE (файлы выписок из ЕГРН по ОН, принадлежащим
данному пользователю).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа (REG_REALESTATE).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка 501 в случае, если функциональность отключена,
либо признак запущенного запроса данных у Росреестра в случае, если данных до сих пор
не было, либо они устарели, либо список ссылок на файлы в случае успеха.
Для типа документа REG_REALESTATE (выписки об ОН из ЕГРН):
в случае успеха в ответе метода возвращается следующая структура:
{
“id”: “3aede387-2dc6-3444-9b25-ff60149c3f50”,
“oid”: 1077376541,
“updatedOn”: 1642672691,
“status”: “verified_by_request”,
“relevance”: “actual”,
“departmentDoc”: “Росреестр”,
“version”: 1,
“type”: “REG_REALESTATE”,
“fileLinks”: [
79
/REG_REALESTATE/3aede387-2dc6-3444-9b25-ff60149c3f50/file"",
/REG_REALESTATE/74887D03-8B01-4F4D-A28D-B40EE5D020BA/file"
]
}
в случае, если данных нет, либо они устарели, возвращается структура
примерно следующего вида (предполагающая, что при повторном запросе
через несколько минут аналогичным запросом можно будет получить данные
по существу):
{
“oid”: 1077376541,
“requestId”: 4642099
}
5.1.11 Получение ссылки на файл, полученный от ведомства,
детализирующий данный документ
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/{doc_id}/extraction
Тип запроса: GET
Назначение: получение ссылки на файлы, детализирующие указанный документ
в виде, полученном от ведомства, по идентификатору пользователя (oid), типу (doc_type)
и идентификатору документа (doc_id).
Сервис доступен для следующих типов документов:
REG_REALESTATE (файл выписки из ЕГРН для указанного ОН).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа (REG_REALESTATE);
doc_id - идентификатор документа (информации об ОН пользователя).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка 501 в случае, если функциональность отключена,
либо ошибка 404 в случае отсутствия данных, либо список ссылок на файлы в случае
успеха.
80
Для типа документа REG_REALESTATE (выписки об ОН из ЕГРН) в случае успеха
в ответе метода возвращается следующая структура:
{
“id”: “3aede387-2dc6-3444-9b25-ff60149c3f50”,
“oid”: 1077376541,
“updatedOn”: 1642672691,
“status”: “verified_by_request”,
“relevance”: “actual”,
“departmentDoc”: “Росреестр”,
“version”: 1,
“type”: “REG_REALESTATE”,
“fileLinks”: [
/REG_REALESTATE/804DE599-1EC9-4340-B043-0E7115AD3F69/file
]
}
5.1.12 Получение файла, полученного от ведомства, детализирующего данный
документ
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/{doc_id}/file
Тип запроса: GET
Назначение: получение файла, детализирующего указанный документ в виде,
полученном от ведомства, по идентификатору пользователя (oid), типу (doc_type)
и идентификатору документа (doc_id).
Сервис доступен для следующих типов документов:
REG_REALESTATE (файл выписки из ЕГРН для указанного ОН, возвращается
в формате XML).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа (REG_REALESTATE);
doc_id - идентификатор документа (информации об ОН пользователя).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
81
Ответ: возвращается ошибка 501 в случае, если функциональность отключена,
либо ошибка 404 в случае отсутствия данных, либо непосредственно файл в случае успеха.
5.1.13 Получение всех файлов, полученных от ведомства, детализирующих
документы данного типа для данного гражданина
Path: /digital/api/public/{version}/pso/{oid}/doc/{doc_type}/file
Тип запроса: GET
Назначение: получение файла архива, содержащего все файлы, детализирующие
документы гражданина по данному типу документа, в виде, полученном от ведомства,
по идентификатору пользователя (oid) и типу (doc_type).
Сервис доступен для следующих типов документов:
REG_REALESTATE (файлы выписок из ЕГРН всех ОН гражданина,
возвращается в формате ZIP).
Параметры запроса:
version - версия API (текущая версия - v1);
oid - уникальный идентификатор пользователя;
doc_type - тип документа (REG_REALESTATE).
Требуемая область доступа (scope): в зависимости от запрашиваемого типа
документа.
Авторизация: указать в заголовке запроса поле «Authorization» с полученным
маркером доступа, содержащим информацию о действующим согласии.
Ответ: возвращается ошибка 501 в случае, если функциональность отключена,
либо ошибка 404 в случае отсутствия данных, либо непосредственно файл архива в случае
успеха.
5.2 Данные документов
5.2.1 Паспорт гражданина РФ
Модель документа «Паспорт гражданина РФ» приведена в таблице 9.
Таблица 9 - Паспорт гражданина РФ
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
82
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
actual;
expired;
invalid
5.
series
Серия документа
обязательно
Строка
6.
number
Номер документа
обязательно
Строка
7.
issueDate
Дата выдачи документа
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
8.
type
Тип документа
обязательно
Для
паспорта
РФ
принимает
значение
RF_PASSPORT
9.
departmentDoc
Ведомство, к которому относится
необязательно
Строка
документ
10.
receiptDocDate
Дата и время получения документа
необязательно
Задается как количество
в формате TIMESTAMP
миллисекунд,
прошедших
с 00:00:00 UTC 1 января
1970 года
11.
validateDateDoc
Дата и время валидации документа
необязательно
Задается как количество
в формате TIMESTAMP
миллисекунд,
прошедших
с 00:00:00 UTC 1 января
1970 года
12.
lastName
Фамилия пользователя
обязательно
Строка
13.
firstName
Имя пользователя
обязательно
Строка
14.
middleName
Отчество пользователя
необязательно
Строка
15.
gender
Половая принадлежность
обязательно
Принимает значения:
M - мужской пол;
F - женский пол
16.
birthDate
Дата рождения
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
83
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
17.
birthplace
Место рождения
необязательно
Строка
18.
issuedBy
Кем выдан паспорт
необязательно
Строка
19.
issueId
Код подразделения
обязательно
Строка
Пример ответа на запрос паспорта гражданина РФ:
{
"oid": "1000376121",
"id": "67664",
"receiptDocDate": 1576835468000,
"validateDateDoc": 1576835468000,
"relevance": "actual",
"status": "verified_by_validate",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
"birthPlace": "Курская область",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Главное управление №1 по вопросам миграции МВД России",
"series": "0001",
"number": "393393",
"issueId": "145854",
"issuedBy": "РОВД 89",
"issueDate": "17.07.2009",
"type": "RF_PASSPORT"
}
5.2.2 История выданных паспортов
Модель документа «История выданных паспортов» приведена в таблице 10.
Таблица 10 - История выданных паспортов
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
84
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
actual;
expired;
invalid
5.
departmentDoc
Ведомство, к которому относится
необязательно
Строка
документ
6.
receiptDocDate
Дата
и
время
получения
необязательно
Задается как количество
документа
в
формате
миллисекунд, прошедших
TIMESTAMP
с
00:00:00 UTC 1 января
1970 года
7.
validateDateDoc
Дата
и
время
валидации
необязательно
Задается как количество
документа
в
формате
миллисекунд, прошедших
TIMESTAMP
с
00:00:00 UTC 1 января
1970 года
8.
version
Версия документа
обязательно
Строка
9.
createdOn
Дата и время создания документа
обязательно
Задается как количество
миллисекунд, прошедших
с
00:00:00 UTC 1 января
1970 года
10.
updatedOn
Дата и время обновления
обязательно
Задается как количество
документа
миллисекунд, прошедших
с
00:00:00 UTC 1 января
1970 года
11.
lastName
Фамилия пользователя
обязательно
Строка
12.
firstName
Имя пользователя
обязательно
Строка
13.
middleName
Отчество пользователя
необязательно
Строка
14.
birthDate
Дата рождения
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
15.
error
Мнемоника ошибки
необязательно
Строка.
Возвращается
вместо
истории
паспортов
в случае
возникновения
ошибок
16.
errorUpdateOn
Дата и время получения ошибки
необязательно
Задается как количество
миллисекунд, прошедших
с
00:00:00 UTC 1 января
1970 года. Возвращается
85
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
вместо истории паспортов
в случае
возникновения
ошибок
По каждому выданному паспорту возвращаются следующие данные (пп. 17 - 24)
17.
series
Серия документа
необязательно
Строка
18.
number
Номер документа
обязательно
Строка
19.
issueDate
Дата выдачи документа
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
20.
issuedBy
Кем выдан паспорт
необязательно
Строка
21.
issueId
Код подразделения
необязательно
Строка
22.
passportType
Тип паспорта
обязательно
Принимает значения:
RF_PASSPORT
(паспорт гражданина
РФ);
FRGN_PASS
(заграничный паспорт);
USSR_PASSPORT
(паспорт СССР)
23.
passportStatus
Статус паспорта
обязательно
Принимает значения:
valid (Действителен);
invalid (Не
действителен);
noInformation
(Сведениями
по заданным
реквизитам
не располагаем)
24.
invalidityReason
Причина недействительности
необязательно
Принимает значения:
expired (истек срок
действия);
replaced
(заменен
на новый);
withViolation (выдан
с нарушением);
inSearch (в розыске);
destroyed
(изъят,
уничтожен);
ownerDeath (в связи
со смертью владельца);
86
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
technicalDefect
(технический брак);
lost (утрачен)
При выполнении отправки запроса в МВД для получения/обновления истории выданных паспортов
возвращаются следующие данные (пп. 25 - 26)
25.
oid
Идентификатор пользователя
обязательно
Строка
26.
requestId
Номер запроса, отправленного
обязательно
Строка
в
МВД
России
для
получения/обновления
истории выданных паспортов
Пример ответа на запрос истории паспортов:
{
"oid": "10031415",
"id": "91899952b06c4cc89746d38b2c8c72f3",
"status": "verified_by_validate",
"departmentDoc": "ГУВМ МВД России",
"receiptDocDate": "1574237502",
"validateDateDoc": "1574237613",
"version": 1,
"createdOn": 1582187411649,
"updatedOn": 1582187411649,
"firstName": "Мария",
"middleName": "Петровна",
"lastName": "Менделеева",
"birthDate": "02.09.2000",
"history": [
{
"passportType": "RF_PASSPORT",
"series": "65 02",
"number": "650230",
"issueDate": "02.09.2000",
"issuedBy": "Гагаринским отделением милиции №5 по г. Москве МВД
России",
"issueId": "503-078",
"passportStatus": "invalid",
"invalidityReason": "replaced"
},
{
"passportType": "FRGN_PASS",
87
"series": "12",
"number": "3444444",
"issueDate": "09.02.2018",
"issuedBy": "ФМС 404",
"passportStatus": "valid"
}
]
}
Пример ответа при отправке запроса в МВД России для получения/обновления
истории паспортов:
{
"oid": "10031415",
"requestId": "2325834"
}
Пример ответа при получении ошибки в процессе запроса историии паспортов
в МВД России:
{
"oid": "10031415",
"id": "91899952b06c4cc89746d38b2c8c72f3",
"status": "verified_by_validate",
"departmentDoc": "ГУВМ МВД России",
"receiptDocDate": "1574237502",
"validateDateDoc": "1574237613",
"version": 1,
"createdOn": 1582187411649,
"updatedOn": 1582187411649,
"firstName": "Мария",
"middleName": "Петровна",
"lastName": "Менделеева",
"birthDate": "02.09.2000",
"error": "DocHistoryError",
"errorUpdatedOn": 1624373989862,
}
Пример ответа с ошибкой при попытке актуализации ранее полученной истории
паспортов:
{
"oid": "10031415",
"id": "91899952b06c4cc89746d38b2c8c72f3",
"status": "verified_by_validate",
"departmentDoc": "ГУВМ МВД России",
"receiptDocDate": "1574237502",
"validateDateDoc": "1574237613",
88
"version": 1,
"createdOn": 1582187411649,
"updatedOn": 1582187411649,
"firstName": "Мария",
"middleName": "Петровна",
"lastName": "Менделеева",
"birthDate": "02.09.2000",
"error": "DocHistoryError",
"errorUpdatedOn": 1624373989862,
"history": [
{
"passportType": "RF_PASSPORT",
"series": "65 02",
"number": "650230",
"issueDate": "02.09.2000",
"issuedBy": "Гагаринским отделением милиции №5 по г. Москве МВД
России",
"issueId": "503-078",
"passportStatus": "invalid",
"invalidityReason": "replaced"
},
{
"passportType": "FRGN_PASS",
"series": "12",
"number": "3444444",
"issueDate": "09.02.2018",
"issuedBy": "ФМС 404",
"passportStatus": "valid"
}
]
}
5.2.3 Документ иностранного гражданина, удостоверяющий личность
на территории РФ
Модель документа «Документ иностранного гражданина, удостоверяющий
личность на территории РФ» приведена в таблице 11.
89
Таблица 11 - Документ иностранного гражданина,
удостоверяющий личность
на территории РФ
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
actual;
expired;
invalid
5.
type
Тип документа
обязательно
Для документа иностранного
гражданина
принимает
значение FID_DOC
6.
department
Ведомство,
к
которому
необязательно
Строка
Doc
относится документ
7.
receiptDoc
Дата и время получения
необязательно
Задается
как
количество
Date
документа
в
формате
миллисекунд,
прошедших
TIMESTAMP
с 00:00:00 UTC 1 января 1970
года
8.
validateDa
Дата и время валидации
необязательно
Задается
как
количество
teDoc
документа
в
формате
миллисекунд,
прошедших
TIMESTAMP
с 00:00:00 UTC 1 января 1970
года
9.
lastName
Фамилия пользователя
обязательно
Строка
10.
firstName
Имя пользователя
обязательно
Строка
11.
middleNa
Отчество пользователя
необязательно
Строка
me
12.
gender
Половая принадлежность
обязательно
Принимает значения:
M - мужской пол;
F - женский пол
13.
birthDate
Дата рождения
обязательно
Дата в формате: ДД.ММ.ГГГГ
14.
birthplace
Место рождения
необязательно
Строка
15.
series
Серия документа
необязательно
Строка
16.
number
Номер документа
обязательно
Строка
90
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
17.
issueDate
Дата выдачи документа
обязательно
Дата в формате: ДД.ММ.ГГГГ
Пример ответа на запрос документа иностранного гражданина, удостоверяющего
личность на территории РФ:
{
"oid": "1077096702",
"id": "100941",
"receiptDocDate": 1576591537000,
"validateDateDoc": 1576591537000,
"relevance": "actual",
"status": "verified_by_validate",
"lastName": "Кинэн",
"firstName": "Мэйнард",
"middleName": "Джеймс",
"birthPlace": "врн",
"gender": "M",
"birthDate": "01.01.1990",
"departmentDoc": "Главное управление №1 по вопросам миграции МВД
России",
"series": "01236541",
"number": "12332131",
"issueDate": "01.01.2010",
"type": "FID_DOC"
}
5.2.4 Водительское удостоверение
Модель документа «Водительское удостоверение» приведена в таблице 12.
Таблица 12 - Водительское удостоверение
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
91
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
actual;
expired;
invalid
5.
series
Серия документа
обязательно
Строка
6.
number
Номер документа
обязательно
Строка
7.
issueDate
Дата выдачи документа
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
8.
type
Тип документа
обязательно
Для
водительского
удостоверения
принимает
значение
RF_DRIVING_LICENSE
9.
departmentDoc
Ведомство,
к
которому
необязательно
Строка
относится документ
10.
receiptDocDate
Дата и время получения
необязательно
Задается как количество
документа
в
формате
миллисекунд,
TIMESTAMP
прошедших
с 00:00:00 UTC 1 января
1970 года
11.
validateDateDoc
Дата и время валидации
необязательно
Задается как количество
документа
в
формате
миллисекунд,
TIMESTAMP
прошедших
с 00:00:00 UTC 1 января
1970 года
12.
lastName
Фамилия пользователя
обязательно
Строка
13.
firstName
Имя пользователя
обязательно
Строка
14.
middleName
Отчество пользователя
необязательно
Строка
15.
birthDate
Дата рождения
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
16.
birthplace
Место рождения
обязательно
Строка
17.
countryName
Страна выдачи ВУ
необязательно
Строка
18.
issuedBy
Кем выдано удостоверение
обязательно
Строка
19.
expiryDate
Действителен до
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
20.
experience
Водительский стаж (год
необязательно
Год в формате: xxxx (где
выдачи первых прав)
x - символы десятичных
цифр 0…9)
21.
categories
Категории
необязательно
Массив,
возможные
значения:
А (Мотоциклы);
92
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
А1
(Легкие
мотоциклы);
В
(Легковые
автомобили,
небольшие грузовики
(до 3,5 тонн));
ВE
(Легковые
автомобили
с прицепом);
В1 (Трициклы);
С
(Грузовые
автомобили
(от 3,5 тонн));
СE
(Грузовые
автомобили
с прицепом);
С1
(Средние
грузовики (от
3,5
до 7,5 тонн));
С1E
(Средние
грузовики
с прицепом);
D (Автобусы)
DE (Автобусы
с прицепом);
D1
(Небольшие
автобусы);
D1E
(Небольшие
автобусы
с прицепом);
М (Мопеды);
Tm (Трамваи);
Tb (Троллейбусы)
Пример ответа на запрос водительского удостоверения:
{
"oid": "1000376121",
"id": "102515",
"receiptDocDate": 1580805248205,
93
"relevance": "actual",
"status": "unverified",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
"birthPlace": "Курская область",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Управление ГИБДД ГУ МВД России",
"series": "00АА",
"number": "123456",
"issueDate": "11.02.2017",
"expiryDate": "10.02.2024",
"type": "RF_DRIVING_LICENSE"
}
5.2.5 Заграничный паспорт
Модель документа «Заграничный паспорт» приведена в таблице 13.
Таблица 13 - Заграничный паспорт
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
actual;
expired;
invalid
5.
series
Серия документа
обязательно
Строка
6.
number
Номер документа
обязательно
Строка
7.
issueDate
Дата выдачи документа
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
8.
type
Тип документа
обязательно
Для
заграничного
паспорта
принимает
значение FRGN_PASS
94
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
9.
departmentDoc
Ведомство, к которому относится
необязательно
Строка
документ
10.
receiptDocDate
Дата
и
время
получения
необязательно
Задается
как
документа
в
формате
количество
TIMESTAMP
миллисекунд,
прошедших
с 00:00:00 UTC 1 января
1970 года
11.
validateDateDoc
Дата
и
время
валидации
необязательно
Задается
как
документа
в
формате
количество
TIMESTAMP
миллисекунд,
прошедших
с 00:00:00 UTC 1 января
1970 года
12.
lastName
Фамилия пользователя
обязательно
Строка
13.
firstName
Имя пользователя
обязательно
Строка
14.
middleName
Отчество пользователя
необязательно
Строка
15.
gender
Половая принадлежность
обязательно
Принимает значения:
M - мужской пол;
F - женский пол
16.
birthDate
Дата рождения
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
17.
birthplace
Место рождения
необязательно
Строка
18.
issuedBy
Кем выдан паспорт
необязательно
Строка
19.
latinLastName
Фамилия на латинском
обязательно
Строка
20.
latinFirstName
Имя на латинском
обязательно
Строка
21.
expiryDate
Действителен до
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
Пример ответа на запрос заграничного паспорта:
{
"oid": "1000376121",
"id": "102517",
"receiptDocDate": 1580805292000,
"validateDateDoc": 1580805292000,
"relevance": "actual",
"status": "verified_by_validate",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
95
"birthPlace": "Курская область",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Главное управление №1 по вопросам миграции МВД России",
"series": "12",
"number": "3444444",
"issuedBy": "ФНС",
"issueDate": "09.02.2018",
"expiryDate": "20.02.2027",
"latinFirstName": "PETROV",
"latinLastName": "IVAN",
"type": "FRGN_PASS"
}
5.2.6 Свидетельство о рождении - другая страна
Модель документа «Свидетельство о рождении - другая страна» приведена
в таблице 14.
Таблица 14 - Свидетельство о рождении - другая страна
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
actual;
expired;
invalid
5.
departmentDoc
Ведомство, к которому относится
необязательно
Строка
документ
6.
receiptDocDate
Дата и время получения документа
необязательно
Задается как количество
в формате TIMESTAMP
миллисекунд,
прошедших
с 00:00:00 UTC 1 января
1970 года
96
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
7.
type
Тип документа
обязательно
Для
свидетельства
о рождении (другая
страна)
принимает
значение
FID_BRTH_CERT
8.
lastName
Фамилия пользователя
обязательно
Строка
9.
firstName
Имя пользователя
обязательно
Строка
10.
middleName
Отчество пользователя
необязательно
Строка
11.
gender
Половая принадлежность
обязательно
Принимает значения:
M - мужской пол;
F - женский пол
12.
birthDate
Дата рождения
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
13.
birthplace
Место рождения
обязательно
Строка
14.
series
Серия документа
обязательно
Строка
15.
number
Номер документа
обязательно
Строка
16.
issueDate
Дата выдачи свидетельства
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
17.
issuedBy
Кем выдано свидетельство
обязательно
Строка
Пример ответа на запрос свидетельства о рождении - другая страна:
{
"oid": "1077096702",
"id": "100943",
"receiptDocDate": 1576592256732,
"relevance": "actual",
"status": "unverified",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Алексеевич",
"birthPlace": "Уганда",
"gender": "M",
"birthDate": "01.01.1990",
"departmentDoc": "Орган записи актов гражданского состояния",
"series": "112123",
"number": "123123",
"issuedBy": "загс",
"issueDate": "01.01.2010",
"type": "FID_BRTH_CERT"
}
97
5.2.7 Свидетельство о рождении - СССР
Модель документа «Свидетельство о рождении - СССР» приведена в таблице 15.
Таблица 15 - Свидетельство о рождении - СССР
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
actual;
expired;
invalid
5.
departmentDoc
Ведомство, к которому относится
необязательно
Строка
документ
6.
receiptDocDate
Дата и время получения документа в
необязательно
Задается
формате TIMESTAMP
как
количество
миллисекунд,
прошедших
с 00:00:00 UTC 1 января
1970 года
7.
type
Тип документа
обязательно
Для
свидетельства
о рождении (СССР)
принимает
значение
OLD_BRTH_CERT
8.
lastName
Фамилия пользователя
обязательно
Строка
9.
firstName
Имя пользователя
обязательно
Строка
10.
middleName
Отчество пользователя
необязательно
Строка
11.
gender
Половая принадлежность
обязательно
Принимает значения:
M - мужской пол;
F - женский пол
12.
birthDate
Дата рождения
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
13.
birthplace
Место рождения
обязательно
Строка
14.
series
Серия документа
обязательно
Строка
98
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
15.
number
Номер документа
обязательно
Строка
16.
issueDate
Дата выдачи документа
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
17.
issuedBy
Кем выдано свидетельство
обязательно
Строка
18.
actNo
Номер актовой записи
необязательно
Строка
Пример ответа на запрос свидетельства о рождении - СССР:
{
"oid": "1000376121",
"id": "106596",
"receiptDocDate": 1582187913199,
"relevance": "actual",
"status": "unverified",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
"birthPlace": "Курская область",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Орган записи актов гражданского состояния",
"series": "ХХIII",
"number": "123123",
"issuedBy": "ЗАГС г. Уренгой",
"issueDate": "03.01.1990",
"actNo": "1231231",
"type": "OLD_BRTH_CERT"
}
5.2.8 Свидетельство о рождении - Россия
Модель документа «Свидетельство о рождении - Россия» приведена в таблице 16.
Таблица 16 - Свидетельство о рождении - Россия
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
99
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
verified_by_request;
verified_by_push;
unverified
4.
relevance
Релевантность документа
обязательно
Принимает значения:
actual;
expired;
invalid
5.
type
Тип документа
обязательно
Для
свидетельства
о рождении (Россия)
принимает
значение
RF_BRTH_CERT
6.
departmentD
Ведомство, к которому относится
необязательно
Строка
oc
документ
7.
receiptDocD
Дата и время получения документа
необязательно
Задается
ate
в формате TIMESTAMP
как
количество
миллисекунд,
прошедших
с 00:00:00 UTC 1 января
1970 года
8.
lastName
Фамилия пользователя
обязательно
Строка
9.
firstName
Имя пользователя
обязательно
Строка
10.
middleName
Отчество пользователя
необязательно
Строка
11.
gender
Половая принадлежность
обязательно
Принимает значения:
M - мужской пол;
F - женский пол
12.
birthDate
Дата рождения
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
13.
birthplace
Место рождения
обязательно
Строка
14.
series
Серия документа
обязательно
Строка
15.
number
Номер документа
обязательно
Строка
16.
issueDate
Дата выдачи документа
обязательно
Дата
в
формате:
ДД.ММ.ГГГГ
17.
issuedBy
Полное наименование органа ЗАГС,
обязательно
Строка
которым произведена государственная
регистрация АГС
18.
actNo
Номер записи АГС
обязательно
Строка
19.
actDate
Дата составления записи АГС
необязательно
Дата
в
формате:
ДД.ММ.ГГГГ
100
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
20.
actNo2018
Номер
актовой
записи,
необязательно
Строка
зарегистрированной
до 01.10.2018
Пример ответа на запрос свидетельства о рождении - Россия:
{
"oid": "1000376121",
"id": "106595",
"receiptDocDate": 1582187827445,
"relevance": "actual",
"status": "unverified",
"lastName": "Петров",
"firstName": "Иван",
"middleName": "Сергеевич",
"birthPlace": "Курская область",
"gender": "M",
"birthDate": "23.06.1989",
"departmentDoc": "Орган записи актов гражданского состояния",
"series": "XIII-ИК",
"number": "123123",
"issuedBy": "Центральный ЗАГС Нижнего Новгорода",
"issueDate": "11.12.2014",
"actNo": "999888",
"type": "RF_BRTH_CERT"
}
5.2.9 Свидетельство о заключении брака
Модель документа «Свидетельство о заключении брака» приведена в таблице 17.
Таблица 17 - Свидетельство о заключении брака
Требования
№
Код поля
Описание поля
Комментарий
к заполнению
1.
oid
Идентификатор пользователя
обязательно
Строка
2.
id
Уникальный
идентификатор
обязательно
Строка
документа
3.
status
Статус достоверности
обязательно
Принимает значения:
verified_by_validate;
verified_by_request;
verified_by_push;
содержание .. 1 2 ..
////////////////////////////////////////// |
||
|
|
|