Дата актуализации 24.04.2026
|
Назначение |
Получение сведений всех документов гражданина по идентификатору пользователя (oid) и типу документа (doc_type) |
|
Тип запроса |
GET |
|
Path |
/{host}/digital/api/public/commercial/{version}/pso/{oid}/doc/PASSPORT_HISTORY |
|
Авторизация |
Указать в заголовке запроса поле «Authorization» с полученным маркером доступа, содержащим информацию о действующем согласии |
|
Параметры запроса в path |
– version – версия API (текущая версия v2); – oid – уникальный идентификатор пользователя; – doc_type – PASSPORT_HISTORY; - test={id}, где id – порядковый номер тестового ответа для конкретного сведения. |
| Параметры запроса в query | – permissionId - идентификатор выданного согласия пользователя ЕСИА для внешней ИС |
| Модель документа | История выданных паспортов |
Curl
|
--location 'https://esia-portal1.test.gosuslugi.ru/digital/api/public/commercial/v2/pso/1077132659/doc/PASSPORT_HISTORY?permissionId=214585964' --header 'Authorization: Bearer token' |
Примеры ответов:
Пример ответа- запрос досье в МВД
|
{ |
Пример ответа - нет согласия пользователя
|
{ |
Пример ответа - паспортное досье (только действующий паспорт)
|
[ |
Пример ответа - паспортное досье
|
[ |
Пример ответа - ошибка
|
[ |
Пример ответа - нет согласия пользователя
|
{ "oid": "2080151820", "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/v2/pso/1077132659/doc/PASSPORT_HISTORY?test=1&permissionId=214585964' --header 'Authorization: Bearer token' |
| Параметр | Описание |
| ?test=1 | Три вида паспорта с различными причинами недействительности |