/premiuminfo

Назначение

Метод позволяет получить данные профиля пользователя в соответствии с набором scope, использованном в запросе авторизации.

Если передаваемая в ответе информация содержит ПДн физического лица, то она подлежат шифрованию согласно RFC 7516. По умолчанию используется JWE. По запросу тип контента может быть изменен на NestedJWT.

Запрос

Метод: POST
Endpoint: https://idgw.mobileid.mts.ru/oidc/premiuminfo
Авторизация: Bearer {access_token}

Заголовки

ПараметрОписаниеПример
AuthorizationТип авторизации и данные пользователяBearer 483e0943-b599-44cd-8daa-1850c1247263

Параметры запроса

Нет параметров запроса.

Пример запроса

POST https://idgw.mobileid.mts.ru/oidc/premiuminfo
Authorization: Bearer 483e0943-b599-44cd-8daa-1850c1247263

Успешный ответ

Внимание: В описании ответа представлено описание параметров исходного json, который в ряде случаев выступает в качестве payload в составе JWE или NestedJWT.

Если ответ метода предусматривает передачу не только sub и phonenumber, то в body будет передан сам JWE или NestedJWT, как показано в примерах.

Заголовки

ПараметрОписаниеПример
X-Mobileid-Request-IdУникальный идентификатор запроса. Используется в рамках оказания технической поддержки0a1f42a5307e6d7435b6a20a1cbf8c78
X-Mobileid-Transaction-IdУникальный идентификатор транзакции. Используется в рамках оказания технической поддержки0b4f8e2d-2040-4e65-b404-055af6625e7e
X-ClaimsПеречень атрибутов, которые предоставлены в ответе[“sub”,”phone_number”]
Content-TypeТип передаваемого контента. В зависимости от состава ПДн может быть использован application/jwt или application/jsonapplication/json

Параметры ответа

ПараметрОписаниеОбязательныйПример
subУникальный идентификатор абонентаДа7a716210-f2bf-47b2-ad9c-e6bff1d731a4
phone_numberНомер телефонаНет79000000000
given_nameИмяНетИван
middle_nameОтчествоНетИванович
family_nameФамилияНетИванов
addressАдрес регистрации. Формат: “Индекс,Город,Улица,Дом,Квартира”Нет123456,Москва,Проспект Мира,1,1
sexПол. Формат: “М” или “Ж”НетМ
birthdateДата рождения. Формат: “ГГГГ-ММ-ДД”Нет1999-01-30
birthplaceМесто рожденияНетМосква
national_identifierНомер документа удостоверяющего личностьНет1234 567890
national_identifier_authorityНаименование органа, выдавшего документ, удостоверяющий личностьНетУМФС г. Москвы
national_identifier_authority_codeКод подразделенияНет111-222
national_identifier_dateДата выдачи документа, удостоверяющего личность. Формат: “ГГГГ-ММ-ДД”Нет2005-01-30
emailЭлектронный адресНетmail@example.com
tax_idИНННет770000000000
document_typeТип документа, удостоверяющего личностьНетПаспорт гражданина РФ

Пример успешного ответа c ПДн

HTTP 200
X-Mobileid-Request-Id: 0a1f42a5307e6d7435b6a20a1cbf8c78
X-Mobileid-Transaction-Id: 0b4f8e2d-2040-4e65-b404-055af6625e7e
X-Claims: ["sub","phone_number","given_name","middle_name","family_name"]
Content-Type: application/jwt
eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ...OKOaw

Пример успешного ответа без ПДн

HTTP 200
X-Mobileid-Request-Id: 0a1f42a5307e6d7435b6a20a1cbf8c78
X-Mobileid-Transaction-Id: 0b4f8e2d-2040-4e65-b404-055af6625e7e
X-Claims: ["sub","phone_number"]
Content-Type: application/json
{
"sub": "7a716210-f2bf-47b2-ad9c-e6bff1d731a4",
"phone_number": "79000000000"
}

Сообщения об ошибках

Заголовки

ПараметрОписаниеПример
Content-TypeТип передаваемого контента. Всегда application/jsonapplication/json
X-Mobileid-ErrorКатегория ошибкиinvalid_token
X-Mobileid-Request-IdУникальный идентификатор запроса. Используется в рамках оказания технической поддержки0a1f42a5307e6d7435b6a20a1cbf8c78
X-Mobileid-Transaction-IdУникальный идентификатор транзакции. Используется в рамках оказания технической поддержки0b4f8e2d-2040-4e65-b404-055af6625e7e

Параметры

ПараметрОбязательныйОписаниеПример
errorДаКатегория ошибкиinvalid_token
error_descriptionДаОписание ошибкиinvalid access token

Пример ответа с ошибкой

HTTP 400
Content-Type: application/json
X-Mobileid-Request-Id: 0a1f42a5307e6d7435b6a20a1cbf8c78
X-Mobileid-Error: invalid_token
{
"error": "invalid_token",
"error_description": "invalid access token"
}

Негативные сценарии и используемые значения error и error_description

СценарийHTTP-кодErrorError_description
Не валидный access_token400invalid_tokeninvalid access token
Заголовок authorization отсутствует или имеет пустое значение400invalid_tokenaccess token is missing
Номер принадлежит корпоративному абоненту403access_deniedsubscriber has business profile
У оператора отсутствуют данные для формирования значения обязательного параметра (по умолчанию не проверяется)403access_deniedempty mandatory premiuminfo claims
Тип документа, удостоверяющего личность, не соответствует “Паспорт гражданина РФ” (по умолчанию не проверяется)403premiuminfo_errorwrong document type present
Внутренний сбой приложения500server_errorinternal Server Error
Сервис недоступен (разные причины)503temporarily_unavailableservice is not available