Дата актуализации 24.04.2026
|
Назначение |
Получение сведений всех документов гражданина по идентификатору пользователя (oid) и типу документа (doc_type) |
|
Тип запроса |
GET |
|
Path |
{host}/digital/api/public/commercial/{version}/pso/{oid}/doc/ELECTRONIC_WORKBOOK |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным маркером доступа, содержащим информацию о действующем согласии |
|
Параметры запроса в path |
– version – версия API (текущая версия – v1); – oid – уникальный идентификатор пользователя; – doc_type – ELECTRONIC_WORKBOOK |
| Параметры запроса в query |
– permissionId - идентификатор выданного согласия пользователя ЕСИА для внешней ИС; – test={id}, где id – порядковый номер тестового ответа для конкретного сведения. |
| Модель документа | Сведения об ЭТК |
| Примеры base64 | Скачать |
Curl
|
--location 'https://esia-portal1.test.gosuslugi.ru/digital/api/public/commercial/v1/pso/2080039927/doc/ELECTRONIC_WORKBOOK?permissionId=125478596' --header 'Authorization: Bearer token' |
Примеры ответов:
Пример ответа - Запрос сведений в СФР
|
{ |
Пример ответа с данными
|
{ "oid": "2080039927", "id": "0c0918cb-a1d0-4e05-84b6-b71a3778ac3b", "apiVersion": "v1", "version": 1, "createdOn": 1764784441783, "updatedOn": 1764784441783, "receiptDocDate": 1764784441783, "validateDateDoc": 1626448277503, "relevance": "actual", "status": "verified_by_request", "xmlFile": { "file": "Выписка в XML, закодированная в формате BASE64"}, "pdfFile": { "file": "Выписка в PDF, закодированная в формате BASE64"}, "statement": { "continuationDate": "20.10.2020" }, "events": [ { "organization": { "orgName": "АКЦИОНЕРНОЕ ОБЩЕСТВО ", "regNumber": "060-050-009942", "inn": "5047053920", "kpp": "504701001" }, "uuid": "40efe480-eab2-4da8-9e95-b8d24b657c7f", "date": "11.11.2019", "type": 1, "position": "Аналитик", "isPartTimeJob": false, "division": "Отдел аналитики Департамента архитектуры и аналитики ", "reason": [ { "document": "Приказ", "date": "11.11.2019", "number": "1954" } ] }, { "organization": { "orgName": "АКЦИОНЕРНОЕ ОБЩЕСТВО", "regNumber": "060-050-009942", "inn": "5047053920", "kpp": "504701001" }, "uuid": "2e77e05c-9102-4d5b-bb5b-ed961e61566a", "date": "02.07.2020", "type": 2, "position": "Аналитик", "isPartTimeJob": false, "division": "Отдел аналитики и проектирования ", "reason": [ { "document": "Приказ", "date": "02.07.2020", "number": "649/67" } ] } ], "type": "ELECTRONIC_WORKBOOK" } |
Пример ответа - Ошибка при запросе в СФР
|
{ |
Пример ответа - нет согласия пользователя
|
{ "oid": "2080039927", "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/ELECTRONIC_WORKBOOK?test=1&permissionId=125478596' --header 'Authorization: Bearer token' |
| Параметр | Описание |
| ?test=1 | ЭТК по гражданину с записями в электронной трудовой книжке за последние два года |