Войти

Методы REST API для получения сведений о пользователе

Дата актуализации 26.01.2026

В рамках эксперимента вы можете получить доступ к данным пользователя через REST API при наличии действующего согласия.

В статье перечислены все методы REST API, доступные вашей ИС для получения сведений о пользователе.
Не все перечисленные методы REST API можно применить к конкретному документу

Какие методы REST API можно применить к конкретному документу смотрите в разделах:

  • Сведения из МВД
  • Сведения из загсов
  • Сведения из СФР
  • Сведения из ФНС
  • Сведения из других ведомств.

Методы REST API, доступные вашей ИС для получения сведений о пользователе:

Для авторизации укажите в заголовке запроса поле «Authorization» с полученным маркером доступа.

Маркер доступа содержит информацию о действующем согласии

Метод

Тип запроса

Path

Назначение

Получение основных сведений о гражданине

GET

/digital/api/public/{version}/pso/{oid}

Получение основной информации по идентификатору пользователя (oid)

Получение сведений всех документов, определенного типа

GET

/digital/api/public/{version}/pso/{oid}/doc/{doc_type}

Получение сведений всех документов гражданина по идентификатору пользователя (oid) и типу документа (doc_type).

Для некоторых типов документов также реализована возможность их получения в том виде, в котором они были получены от ведомства

Получение сведений документа в исходном виде

GET

/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/raw

Получение сведений документа гражданина в исходном виде по идентификатору пользователя (oid) и типу документа (doc_type)

Получение списка ссылок на файлы, полученные от ведомства, детализирующие документы данного типа у гражданина

GET

/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/extraction

Получение списка ссылок на файлы, детализирующие документы данного типа в виде, полученном от ведомства, по идентификатору пользователя (oid) и типу (doc_type).

Сервис доступен для документа типа «REG_REALESTATE» (файлы выписок из ЕГРН по объектам недвижимости, принадлежащим данному пользователю)

Получение ссылки на файл, полученный от ведомства, детализирующий данный документ

GET

/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/{doc_id}/extraction

Получение ссылки на файлы, детализирующие указанный документ в виде, полученном от ведомства, по идентификатору пользователя (oid), типу (doc_type) и идентификатору документа (doc_id).

Сервис доступен для документа типа «REG_REALESTATE» (файл выписки из ЕГРН для указанного объекта недвижимости)

Получение файла, полученного от ведомства, детализирующего данный документ

GET

/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/{doc_id}/file

Получение файла, детализирующего указанный документ в виде, полученном от ведомства, по идентификатору пользователя (oid), типу (doc_type) и идентификатору документа (doc_id).

Сервис доступен для документа типа «REG_REALESTATE» (файл выписки из ЕГРН для указанного объекта недвижимости, возвращается в формате XML)

Получение всех файлов, полученных от ведомства, детализирующих документы данного типа для данного гражданина

GET

/digital/api/public/{version}/pso/{oid}/doc/{doc_type}/file

Получение файла архива, содержащего все файлы, детализирующие документы гражданина по данному типу документа, в виде, полученном от ведомства, по идентификатору пользователя (oid) и типу (doc_type).
Сервис доступен для документа типа «REG_REALESTATE» (файлы выписок из ЕГРН всех объектах недвижимости гражданина, возвращается в формате ZIP)

Будет полезно:

Актуальные механизмы интеграции с сервисами ЕСИА на базе подхода REST описаны в «Методических рекомендациях по использованию ЕСИА».
Как запросить согласие у пользователя.
Авторизуйтесь, чтобы оставить комментарий к статье