/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/json | application/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 |
| Электронный адрес | Нет | 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/json | application/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-код | Error | Error_description |
|---|---|---|---|
| Не валидный access_token | 400 | invalid_token | invalid access token |
| Заголовок authorization отсутствует или имеет пустое значение | 400 | invalid_token | access token is missing |
| Номер принадлежит корпоративному абоненту | 403 | access_denied | subscriber has business profile |
| У оператора отсутствуют данные для формирования значения обязательного параметра (по умолчанию не проверяется) | 403 | access_denied | empty mandatory premiuminfo claims |
| Тип документа, удостоверяющего личность, не соответствует “Паспорт гражданина РФ” (по умолчанию не проверяется) | 403 | premiuminfo_error | wrong document type present |
| Внутренний сбой приложения | 500 | server_error | internal Server Error |
| Сервис недоступен (разные причины) | 503 | temporarily_unavailable | service is not available |