Новости 
База знаний 
Документация 
Форум 
ЛК УВ 
Назад
Дата актуализации 28.01.2026
Актуальные механизмы интеграции с сервисами ЕСИА на базе подхода REST описаны в «Методических рекомендациях по использованию ЕСИА».
Вашей ИС доступны методы REST API для взаимодействия с платформой согласий.
Получение всех доступных типов согласий из реестра согласий
|
Тип запроса |
GET |
|
Path |
/esia-rs/api/public/v1/permissions |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным системным маркером доступа |
|
Параметры запроса |
- pageIndex; - pageSize |
|
Требуемая область доступа (scope) |
usr_prm |
|
Возможные коды ошибок |
Код HTTP 404: ESIA-039870 = Выбранная информационная система не найдена |
Пример ответа
|
{ "stateFacts": [ "Paginated", "hasSize", "EntityRoot", "Firs65tPage" ], "size": 2, "pageSize": 2, "pageIndex": 1, "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 } ] } }, { "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 } ] } } ] } |
Получение конкретного типа согласия
|
Тип запроса |
GET |
|
Path |
/esia-rs/api/public/v1/permissions/{id} |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным системным маркером доступа |
|
Требуемая область доступа (scope) |
usr_prm |
|
Возможные коды ошибок |
Код HTTP 404: - ESIA-036701 = Не найден тип согласия {0} - ESIA-039870 = Выбранная информационная система не найдена |
Пример ответа
|
{ "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": "Просмотр вашей фамилии, имени и отчества", "description": "Фамилия, имя и отчество, указанные в вашей учетной записи", "required": true }, { "stateFacts": [ "ReadOnly" ], "sysname": "email", "name": "Просмотр вашего адреса электронной почты", "description": "Адрес электронной почты, указанный в вашей учетной записи", "required": false } ] } } |
Получение всех согласий пользователя, выданных организации, по идентификатору пользователя (oid)
|
Тип запроса |
GET |
|
Path |
/esia-rs/api/public/{version}/prns/{prn_oid}/issued/permissions |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным маркером доступа (любого типа) |
|
Параметры запроса |
- version – версия API (текущая версия — v1). Для запроса согласий пользователя, выданных организации доступна вторая версия (v2) API; - oid – уникальный идентификатор пользователя |
|
Требуемая область доступа (scope) |
любая |
|
Возможные коды ошибок |
Код HTTP 404: - ESIA-035000 = Пользователь не найден; - ESIA-039870 = Выбранная информационная система не найдена. |
Пример ответа
|
{ "stateFacts": [ "EntityRoot", "hasSize" ], "size": 3, "elements": [ { "stateFacts": [ "Identifiable" ], "id": 575148, "personId": 86654548, "kidId": 86321969, "subjOid": 2080044531, "orgId": 7413781, "permissionId": 3113, "sysname": "DIGITAL_OFFER", "name": "Согласие на отправку Цифровым профилем запросов в ведомства на получение и последующее хранение и обновление ваших персональных данных в личном кабинете на портале Госуслуг", "description": "Согласие на отправку Цифровым профилем запросов в ведомства на получение и последующее хранение и обновление ваших персональных данных в личном кабинете на портале Госуслуг", "orgShortName": "МИНЦИФРЫ РОССИИ", "ogrn": "1047702026701", "orgAddress": "455013, Челябинская область, 2 у МАГНИТОГОРСКИЙ, Г МАГНИТОГОРСК, УЛ ЛАЗНИКА, 19, кв. ОФИС 1", "issuedOn": 1711009721, "expiredOn": 3288857321, "status": "D", "createdOn": 1711009721, "updatedOn": 1712129958, "signatureId": "a00136bd-1734-4525-becb-1453a40ae947", "signatureStatus": "ISSUED", "scopes": { "stateFacts": [ "hasSize" ], "size": 41, "elements": [ { "stateFacts": [ "ReadOnly" ], "sysname": "ils_doc", "name": "ИЛС ПФР", "description": "Сведения о состоянии индивидуального страхового счета застрахованного лица", "orgGroup": "Социальный фонд России" }, { "stateFacts": [ "ReadOnly" ], "sysname": "history_passport_doc", "name": "Просмотр вашего паспортного досье", "description": "Сведения о ранее выданных документах, удостоверяющих личность", "orgGroup": "Министерство внутренних дел Российской Федерации" }, { "stateFacts": [ "ReadOnly" ], "sysname": "org_data", "name": "Просмотр выписки из ЕГРЮЛ", "description": "Выписка из Единого государственного реестра юридических лиц по запросам органов государственной власти (полные, открытые)", "orgGroup": "Федеральная налоговая служба Российской Федерации" }, { "stateFacts": [ "ReadOnly" ], "sysname": "vehicle_reg_cert_doc", "name": "Просмотр сведений о ваших транспортных средствах", "description": "Сведения о ваших транспортных средствах", "orgGroup": "Министерство внутренних дел Российской Федерации" }, { "stateFacts": [ "ReadOnly" ], "sysname": "drivers_licence_doc", "name": "Просмотр данных вашего водительского удостоверения", "description": "Сведения о водительском удостоверении (страна выдачи, серия, номер, дата выдачи и прекращения действия, орган, выдавший водительское удостоверение, разрешенные категории вождения)", "orgGroup": "Министерство внутренних дел Российской Федерации" }, { "stateFacts": [ "Identifiable" ], "id": 27, "personId": 7435533, "orgId": 7413781, "subjOid": 2080044530, "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": [ { "stateFacts": [ "ReadOnly" ], "sysname": "ALL_ACTIONS_TO_DATA", "name": "Обработка и изменение персональных данных" } ] } }, { "stateFacts": [ "Identifiable" ], "id": 24, "personId": 7435533, "orgId": 7413781, "subjOid": 2080044530, "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": [ { "stateFacts": [ "ReadOnly" ], "sysname": "ALL_ACTIONS_TO_DATA", "name": "Обработка и изменение персональных данных" } ] } } ] } |
Описание основных параметров:
- id – уникальный номер согласия пользователя;
- personId – уникальный идентификатор пользователя;
- subjOid – идентификатор субъекта согласия (получение идентификатора субъекта согласия возможно только с версией метода v2);
- status – текущий статус согласия. В данном REST передается информация только по выданным согласиям (статус A) и отозванным согласиям (статус D);
- permissionId – уникальный номер типа согласия;
- sysname – уникальная мнемоника типа согласия;
- name – наименование типа согласия;
- purposes – цель типа согласия.
Примечание:
Если во входном параметре метода указан OID учетной записи несовершеннолетнего пользователя, а также выдано от его родителя согласие «Предоставление услуги «Электронный дневник школьника» (EDU_JORNAL) на данные указанного несовершеннолетнего, то данное согласие отобразится в ответе. Дополнительно передаются значения по атрибутам kidId и kidInfo.
Пример ответа
|
{ "stateFacts": [ "EntityRoot", "hasSize" ], "size": 3, "elements": [ { "stateFacts": [ "Identifiable" ], "id": 30, "personId": 7435533, "orgId": 7413781, "subjOid": 2080044531, "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", "name": "Обработка и изменение персональных данных" } ] } }]} |
Получение согласия пользователя, выданного организации, по идентификатору согласия
|
Тип запроса |
GET |
|
Path |
/esia-rs/api/public/{version}/prns/{prn_oid}/issued/permissions/{id} |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным маркером доступа (любого типа) |
|
Параметры запроса |
- version – версия API (текущая версия — v1). Для запроса согласий пользователя, выданных организации доступна вторая версия (v2) API; - oid – уникальный идентификатор пользователя; - id – идентификатор согласия |
|
Требуемая область доступа (scope) |
любая |
|
Возможные коды ошибок |
Код HTTP 404: - ESIA-035000 = Пользователь не найден; - ESIA-039870 = Выбранная информационная система не найдена. |
Пример ответа
|
{ "stateFacts": [ "EntityRoot", "hasSize" ], "size": 3, "elements": [ { "stateFacts": [ "Identifiable" ], "id": 575148, "personId": 86654548, "kidId": 86321969, "subjOid": 2080044531, "orgId": 7413781, "permissionId": 3113, "sysname": "DIGITAL_OFFER", "name": "Согласие на отправку Цифровым профилем запросов в ведомства на получение и последующее хранение и обновление ваших персональных данных в личном кабинете на портале Госуслуг", "description": "Согласие на отправку Цифровым профилем запросов в ведомства на получение и последующее хранение и обновление ваших персональных данных в личном кабинете на портале Госуслуг", "orgShortName": "МИНЦИФРЫ РОССИИ", "ogrn": "1047702026701", "orgAddress": "455013, Челябинская область, 2 у МАГНИТОГОРСКИЙ, Г МАГНИТОГОРСК, УЛ ЛАЗНИКА, 19, кв. ОФИС 1", "issuedOn": 1711009721, "expiredOn": 3288857321, "status": "D", "createdOn": 1711009721, "updatedOn": 1712129958, "signatureId": "a00136bd-1734-4525-becb-1453a40ae947", "signatureStatus": "ISSUED", "scopes": { "stateFacts": [ "hasSize" ], "size": 41, "elements": [ { "stateFacts": [ "ReadOnly" ], "sysname": "ils_doc", "name": "ИЛС ПФР", "description": "Сведения о состоянии индивидуального страхового счета застрахованного лица", "orgGroup": "Социальный фонд России" }, { "stateFacts": [ "ReadOnly" ], "sysname": "history_passport_doc", "name": "Просмотр вашего паспортного досье", "description": "Сведения о ранее выданных документах, удостоверяющих личность", "orgGroup": "Министерство внутренних дел Российской Федерации" }, { "stateFacts": [ "ReadOnly" ], "sysname": "org_data", "name": "Просмотр выписки из ЕГРЮЛ", "description": "Выписка из Единого государственного реестра юридических лиц по запросам органов государственной власти (полные, открытые)", "orgGroup": "Федеральная налоговая служба Российской Федерации" }, { "stateFacts": [ "ReadOnly" ], "sysname": "vehicle_reg_cert_doc", "name": "Просмотр сведений о ваших транспортных средствах", "description": "Сведения о ваших транспортных средствах", "orgGroup": "Министерство внутренних дел Российской Федерации" }, { "stateFacts": [ "ReadOnly" ], "sysname": "drivers_licence_doc", "name": "Просмотр данных вашего водительского удостоверения", "description": "Сведения о водительском удостоверении (страна выдачи, серия, номер, дата выдачи и прекращения действия, орган, выдавший водительское удостоверение, разрешенные категории вождения)", "orgGroup": "Министерство внутренних дел Российской Федерации" }, { "stateFacts": [ "Identifiable" ], "id": 27, "personId": 7435533, "orgId": 7413781, "subjOid": 2080044530, "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": [ { "stateFacts": [ "ReadOnly" ], "sysname": "ALL_ACTIONS_TO_DATA", "name": "Обработка и изменение персональных данных" } ] } }, { "stateFacts": [ "Identifiable" ], "id": 24, "personId": 7435533, "orgId": 7413781, "subjOid": 2080044530, "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": [ { "stateFacts": [ "ReadOnly" ], "sysname": "ALL_ACTIONS_TO_DATA", "name": "Обработка и изменение персональных данных" } ] } } ] } |
Описание основных параметров:
- id – уникальный номер согласия пользователя;
- personId – уникальный идентификатор пользователя;
- subjOid – идентификатор субъекта согласия (получение идентификатора субъекта согласия возможно только с версией метода v2);
- status – текущий статус согласия. В данном REST передается информация только по выданным согласиям (статус A) и отозванным согласиям (статус D);
- permissionId – уникальный номер типа согласия;
- sysname – уникальная мнемоника типа согласия;
- name – наименование типа согласия;
- purposes – цель типа согласия.
Примечание:
Если во входном параметре метода указан OID учетной записи несовершеннолетнего пользователя, а также выдано от его родителя согласие «Предоставление услуги «Электронный дневник школьника» (EDU_JORNAL) на данные указанного несовершеннолетнего, то данное согласие отобразится в ответе. Дополнительно передаются значения по атрибутам kidId и kidInfo.
Пример ответа
|
{ "stateFacts": [ "EntityRoot", "hasSize" ], "size": 3, "elements": [ { "stateFacts": [ "Identifiable" ], "id": 30, "personId": 7435533, "orgId": 7413781, "subjOid": 2080044531, "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", "name": "Обработка и изменение персональных данных" } ] } }]} |
Получение архива с подписанным согласием пользователя, выданного организации, по идентификатору согласия
|
Тип запроса |
GET |
|
Path |
/esia-rs/api/public/v1/prns/{prn_oid}/issued/permissions/{id}/archive |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным маркером доступа (любого типа) |
|
Требуемая область доступа (scope) |
usr_prm |
|
Возможные коды ошибок |
Код HTTP 401: ESIA-005013 = SecurityErrorEnum.expiredToken Код HTTP 403: ESIA-005029 = SecurityErrorEnum.scopeNotAllowed Код HTTP 404: - ESIA-036710 = Согласие не найдено; - ESIA-036729 = Архив с подписанным согласием не может быть получен, т.к. произошла ошибка на этапе выгрузки архива в хранилище; - ESIA-020027 = ПЭП не найдена. |
|
Пример ответа |
Архив с подписанным согласием |
Получение всех архивов с подписанными согласиями пользователя, выданных организации, по идентификатору пользователя (OID)
|
Тип запроса |
GET |
|
Path |
/esia-rs/api/public/v1/prns/{prn_oid}/issued/permissions/archive |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным маркером доступа (любого типа) |
|
Требуемая область доступа (scope) |
usr_prm |
|
Возможные коды ошибок |
Код HTTP 401: ESIA-005013 = SecurityErrorEnum.expiredToken Код HTTP 403: ESIA-005029 = SecurityErrorEnum.scopeNotAllowed Код HTTP 404: ESIA-020027 = ПЭП не найдена |
|
Пример ответа |
Архив с архивами, в которых содержатся подписанные согласия |
