На Схеме взаимодействия обозначен как «17. Запрос ПД клиента».
Параметры запроса
Для успешного выполнения запроса необходимо использовать сертификат, полученый при регистрации приложения на портале Сбер ID , по нашей документации.
Back-end партнера инициирует запрос в back-end банка на получение профиля клиента. Тип запроса - GET.
Пример запроса:
Пример
- Тестовый стенд
- ПРОМ
curl --request GET \
--url https://oauth-ift.sber.ru/ru/prod/sberbankid/v2.1/userinfo \
--header 'authorization: Bearer DC3641EC-A0C1-F61A-B2DE-A331C0B2E20F' \
--header 'x-introspect-rquid:L4hE5nH3wB5lC6sP0bO7bA666yM5bH5h'
curl --request GET \
--url https://oauth.sber.ru/ru/prod/sberbankid/v2.1/userinfo \
--header 'authorization: Bearer DC3641EC-A0C1-F61A-B2DE-A331C0B2E20F' \
--header 'x-introspect-rquid:L4hE5nH3wB5lC6sP0bO7bA666yM5bH5h'
Описание полей запроса на получение профиля клиента
№ п/п | Наименование поля | Заголовок/поле | Описание | Обязательность поля |
---|---|---|---|---|
1 | Authorization | Заголовок | Полученный ранее access_token , см. Ответ на запрос access token и Id token.В начало необходимо добавить «Bearer», например: Bearer DC3641EC-A0C1-F61A-B2DE-A331C0B2E20F | Да |
2 | x-introspect-rquid | Заголовок | Уникальный идентификатор сообщения, «length=32 и pattern=([0-9][a-f][A-F])32)», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(https://ru.wikipedia.org/wiki/UUID ), убрав из результата разделители «-». | Да |
Параметры ответа
При успешной проверке запроса, Банк формирует ответ, содержащий данные клиента, и возвращает его в ответе типа HTTP 200 OK. Ниже приведен пример сообщения.
Важно!
Если по клиенту в банке нет запрошенных данных или клиент запретил передачу этих данных, то данный скоуп в ответе будет отсутствовать
- При запросе неразрешенных данному партнеру скоупов будет возвращена ошибка invalid_scope
Ответ содержит JSON-объект, в котором находятся запрошенные данные пользователя.
{
"sub": "2db933f8184f1f525a338b04e7ac1218a432f",
"family_name": "Фамилия",
"given_name": "Имя",
"middle_name": "Отчество",
"birthdate": "01.01.2001",
"identification": {
"series": "9999",
"number": "112233",
"issued_by": "Кем выдан",
"issued_date": "2001-01-01",
"code": "000-000"
},
"inn": {
"number": "771400000000"
},
"snils": {
"number": "999 999 999 99"
},
"driving_license": {
"number": "9999999999"
},
"priority_doc": {
"series": "9999",
"number": "112233",
"issued_by": "Кем выдан",
"issued_date": "2001-01-01",
"code": "000-000",
"type": 1
},
"international_passport": {
"series": "Z9999",
"number": "999999",
"issued_by": "Кем выдан",
"issued_date": "2001-01-01",
"planned_end_date": "2001-01-01"
},
"sts": {
"number": "12345678"
},
"phone_number": "+7 (903) 1111111",
"email": "qwer@qwer.ru",
"gender": 1,
"is_company_employee": false,
"citizenship": {
"country_code": "Код страны",
"country_name": "Наименование страны"
},
"place_of_birth": "Место рождения",
"address": {
"full_address": "Полный адрес",
"fias_code": "Идентификационный код объекта по ФИАС",
"post_index": "Почтовый индекс",
"country": "Страна",
"region": "Регион",
"district": "Район",
"city": "Город",
"settlement": "Населенный пункт",
"street": "Название улицы",
"house": "Дом",
"building": "Строение",
"bulk": "Корпус",
"apartment": "Квартира"
},
"address_of_actual_residence": {
"full_address": "Полный адрес",
"fias_code": "Идентификационный код объекта по ФИАС",
"post_index": "Почтовый индекс",
"country": "Страна",
"region": "Регион",
"district": "Район",
"city": "Город",
"settlement": "Населенный пункт",
"street": "Название улицы",
"house": "Дом",
"building": "Строение",
"bulk": "Корпус",
"apartment": "Квартира"
},
"address_reg": {
"full_address": "Полный адрес",
"fias_code": "Идентификационный код объекта по ФИАС",
"post_index": "Почтовый индекс",
"country": "Страна",
"region": "Регион",
"district": "Район",
"city": "Город",
"settlement": "Населенный пункт",
"street": "Название улицы",
"house": "Дом",
"building": "Строение",
"bulk": "Корпус",
"apartment": "Квартира"
},
"work_address": {
"full_address": "Полный адрес",
"fias_code": "Идентификационный код объекта по ФИАС",
"post_index": "Почтовый индекс",
"country": "Страна",
"region": "Регион",
"district": "Район",
"city": "Город",
"settlement": "Населенный пункт",
"street": "Название улицы",
"house": "Дом",
"building": "Строение",
"bulk": "Корпус",
"apartment": "Квартира"
},
"delivery_address": {
"full_address": "Полный адрес",
"fias_code": "Идентификационный код объекта по ФИАС",
"post_index": "