Дата актуализации 24.04.2026
|
Назначение |
Получение сведений всех документов гражданина по идентификатору пользователя (oid) и типу документа (doc_type) |
|
Тип запроса |
GET |
|
Path |
/digital/api/public/commercial/{version}/pso/{oid}/doc/PRE_RETIREMENT_AGE |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным маркером доступа, содержащим информацию о действующем согласии |
|
Параметры запроса в path |
– version – версия API (текущая версия – v1); – oid – уникальный идентификатор пользователя; – doc_type – PRE_RETIREMENT_AGE |
| Параметры запроса в query |
– permissionId - идентификатор выданного согласия пользователя ЕСИА для внешней ИС; – test={id}, где id – порядковый номер тестового ответа для конкретного сведения. |
| Модель документа | Сведения о статусе предпенсионера |
| Пример base64 | Скачать |
Curl
|
--location 'https://esia-portal1.test.gosuslugi.ru/digital/api/public/commercial/v1/pso/2181455350/doc/PRE_RETIREMENT_AGE?permissionId=125478596' --header 'Authorization: Bearer token' |
Примеры ответов:
Пример ответа с данными
|
{ "oid": "2181455350", "id": "4fd5b573-a53f-4b86-b762-bbda4c7d8de1", "apiVersion": "v1", "version": 1, "createdOn": 1764782692439, "updatedOn": 1764782692439, "receiptDocDate": 1764782692439, "validateDateDoc": 1008570647000, "relevance": "actual", "status": "verified_by_request", "departmentDoc": "Пенсионный фонд России", "preRetirementAgeInfo": [ { "typeOrg": "3", "preRetirementAge": true, "date": "09.07.2020", "dateFrom": "13.08.1957", "normDoc": { "nameDoc": "документ", "section": "14", "part": "1", "paragraph": "1", "subparagraph": "1" }, "xmlFile": { "link": { "objectId": 110000952632, "objectTypeId": 40, "mnemonic": "pre_rerement_age.xml" }, "file": "Выписка в XML, закодированная в формате BASE64" }, "pdfFile": { "link": { "objectId": 110000952632, "objectTypeId": 40, "mnemonic": "inclusion.pdf" }, "file": "Выписка в PDF, закодированная в формате BASE64" } } ], "type": "PRE_RETIREMENT_AGE" } |
Пример ответа - Запрос сведений в СФР
|
{ "oid": "2181455350", "requestId": "110000952632" } |
Пример ответа - Ошибка при запросе в СФР
|
{ "oid":"2181455350", "id":"973e98b3-a9de-47f8-acb2-b2f3e71ed19a", "version":1, "createdOn":1628603361116, "updatedOn":1628603361116, "receiptDocDate":1628603361116, "relevance":"actual", "departmentDoc":"Пенсионный фонд России", "error":"MksRequestErrorEnum.pfr.pre.retirement.age.status.doc.failed", "errorUpdatedOn":1628603361216, "type":"PRE_RETIREMENT_AGE" } |
Пример ответа - нет согласия пользователя
|
{ "oid": "2181455350", "statusDoc": "NO_CONSENT" } |
Пример ответа - ошибка 403 - заблокирован доступ к REST API
|
HTTP Status Code: 403 Forbiden { "message": "Доступ к данным ограничен. Необходимо снять ограничение доступа для коммерческой организации со стороны МЦ" } |
Тестирование
Также для сведений реализована возможность получения предопределенных, тестовых ответов, «заглушек» в интеграционной среде ЕСИА и ЦП (https://esia-portal1.test.gosuslugi.ru/). Для того, чтобы при вызове метода возвращались тестовые данные, необходимо дополнительно указывать в запросе параметр test={id}, где id – порядковый номер тестового ответа для конкретного сведенияCurl
|
--location 'https://esia-portal1.test.gosuslugi.ru/digital/api/public/commercial/v1/pso/2181502158/doc/PRE_RETIREMENT_AGE?test=1&permissionId=125478596' --header 'Authorization: Bearer token' |
| Параметр | Описание |
| ?test=1 | Отрицательный результат (т.е. гражданин не относится к категории граждан предпенсионного возраста) |
| ?test=2 | Положительный результат (т.е. гражданин относится к категории граждан предпенсионного возраста) |