ym88659208ym87991671
Шаг 3. Запрос получение данных пользователя | Документация для разработчиков

Шаг 3. Запрос получения данных пользователя

Обновлено 24 ноября 2023

На Схеме взаимодействия обозначен как «17. Запрос ПД клиента».

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

Back-end партнера инициирует запрос в back-end банка на получение профиля клиента. Тип запроса - GET.

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

Пример

curl --request GET \   
--url https://oauth-psi.sber.ru/ru/prod/sberbankid/v2.1/userinfo \
--header 'authorization: Bearer DC3641EC-A0C1-F61A-B2DE-A331C0B2E20F' \
--header 'x-ibm-client-id: 5e76680a-6344-4978-8ee4-5ff6370695ddd' \
--header 'x-introspect-rquid:L4hE5nH3wB5lC6sP0bO7bA666yM5bH5h'

Описание полей  запроса на получение профиля клиента

№   п/пНаименование поляЗаголовок/полеОписаниеОбязательность поля 
1AuthorizationЗаголовокПолученный ранее access_token, см. Ответ на запрос access token и Id token.В начало необходимо добавить «Bearer», например: Bearer DC3641EC-A0C1-F61A-B2DE-A331C0B2E20FДа
2x-introspect-rquidЗаголовокУникальный идентификатор сообщения, «maxLength=32 и pattern=([0-9][a-f][A-F]){32})», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(https://ru.wikipedia.org/wiki/UUID), убрав из результата разделители «-».Да
3X-IBM-Client-IDЗаголовокИдентификатор системы партнера, полученный партнером в Личном кабинете после регистрации приложения.Да

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

При успешной проверке запроса, Банк формирует ответ, содержащий данные клиента, и возвращает его в ответе типа 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": "Почтовый индекс",
"country": "Страна",
"region": "Регион",
"district": "Район",
"city": "Город",
"settlement": "Населенный пункт",
"street": "Название улицы",
"house": "Дом",
"building": "Строение",
"bulk": "Корпус",
"apartment": "Квартира"
},
"verified": true,
"previous_family_name": "Предыдущая фамилия",
"previous_given_name": "Предыдущее имя",
"previous_middle_name": "Предыдущее отчество",
"job_title": "Должность",
"place_of_work": "Наименование организации (место работы)",
"marital_status": {
"code": 1,
"description": "Описание"
},
"education": {
"code": 1,
"description": "Описание"
},
"is_self_employed": false,
"previous_identification": {
"series": "9999",
"number": "112233",
"issued_by": "Кем выдан",
"issued_date": "2001-01-01",
"code": "000-000"
}
}

Описание полей данных пользователя

Наименование поляОписаниеПример
subНеизменный уникальный идентификатор клиента, передаваемый внешним потребителям."sub":"e327493e-979a-461f-9ca5-edfab9d6fbab"
family_nameФамилия"family_name":"Фамилия"
given_nameИмя"given_name":"Имя"
middle_nameОтчество"middle_name":"Отчество"
birthdateДата рождения (формат ГГГГ-ММ-ДД) "birthdate":"0000-00-00"
identificationПолные данные паспорта: серия,номер,орган, выдавший паспорт,дата выдачи паспорта (формат ГГГГ-ММ-ДД),код подразделения

"identification":{

"series":"00 00",

"number":"000000",

"issued_by":"Орган выдавший документ",

"issued_date":"0000-00-00",

"code":"000-000"

}

innИНН номер

"inn":{

"number":"0000000"

}

snilsСНИЛС номер

"snils":{

"number":"0000000"

}

phone_numberНомер телефона"phone_number":"+7 (000) 000000”
emailАдрес электронной почты"email":“personal@mail.ru
genderПол: 1 – мужчина; 2 – женщина;"gender":1,
driving_licenseНомер водительского удостоверения

"driving_license":{

"number":"111111"

}

international_passportЗаграничный паспорт гражданина РФ:серия документа (формат 00 00),номер документа(формат 000000),кем выдан, дата выдачи (формат ГГГГ-ММ-ДД),дата окончания (формат ГГГГ-ММ-ДД),имя,фамилия

"international_passport":{

"series":"777",

"number":"333",

"issued_by":"рога и копыта",

"issued_date":"1981-01-01",

"planned_end_date":"1999-02-01",

"name":"name",

"surname":"surname"

}

priority_docДанные документа, удостоверяющего личность:тип,серия документа (формат 00 00),номер документа (формат 000000),кем выдан, дата выдачи (формат ГГГГ-ММ-ДД),код. Выводится один документ в соответствии со списком приоритетов:Паспорт РФ, Загранпаспорт гражданина РФ, Военный билет, Паспорт моряка, Временное удостоверение, Паспорт иностранного граданина, Вид на жительство иностранного гражданина

"priority_doc":{

"type":17,

"series":"777",

"number":"333",

"issued_by":"рога и копыта",

"issued_date":"1981-01-01",

"code":"adasd"

}

citizenshipГражданство: последняя по актуальности страна гражданства (наименование на русском языке) и ее код (ОКСМ, буквенное обозначение – Альфа-3)

"citizenship":{

"country_code":"countryCode",

"country_name":"countryName"

}

place_of_birthМесто рождения – город рождения клиента (текстовое поле, не кодируется)"place_of_birth":”Nsk”
address_regАдрес регистрации: полный адрес, код ФИАС, почтовый индекс, страна, регион, район, город, поселение, улица, дом, строение, корпус, квартира

"address_reg":{

"full_address":"fullAddress",

"fias_code":"fiasCode",

"post_index":"postIndex",

"country":"country",

"region":"region",

"district":"district",

"city":"city",

"settlement":"settlement",

"street":"street",

"house":"house",

"building":"building",

"bulk":"bulk",

"apartment":"apartment"

}

work_addressРабочий адрес: полный адрес, код ФИАС, почтовый индекс, страна, регион, район, город, поселение, улица, дом, строение, корпус, квартира

"work_address":{

"full_address":"fullAddress",

"fias_code":"fiasCode",

"post_index":"postIndex",

"country":"country",

"region":"region",

"district":"district",

"city":"city",

"settlement":"settlement",

"street":"street",

"house":"house",

"building":"building",

"bulk":"bulk",

"apartment":"apartment"

}

address_of_actual_residenceАдрес места жительства/доставки: полный адрес,код ФИАС,почтовый индекс,страна,регион,район,город,поселение,улица,дом,строение,корпус,квартира

"address_of_actual_residence":{

"full_address":"fullAddress",

"fias_code":"fiasCode",

"post_index":"postIndex",

"country":"country",

"region":"region",

"district":"district",

"city":"city",

"settlement":"settlement",

"street":"street",

"house":"house",

"building":"building",

"bulk":"bulk",

"apartment":"apartment"

}

delivery_addressАдрес для доставки: полный адрес,код ФИАС,почтовый индекс,страна,регион,район,город,поселение,улица,дом,строение,корпус,квартира

"delivery_address":{

"full_address":"fullAddress",

"fias_code":"fiasCode",

"post_index":"postIndex",

"country":"country",

"region":"region",

"district":"district",

"city":"city",

"settlement":"settlement",

"street":"street",

"house":"house",

"building":"building",

"bulk":"bulk",

"apartment":"apartment"

}

verifiedПризнак верифицированности пользователя"verified":true,
is_company_employee Признак сотрудника ПАО "Сбербанк""is_company_employee":true,
stsНомер СТС

"sts":{

"number":"00 00 00000"

}

is_self_employedПризнак самозанятого, true - самозанятый, false - нет"is_self_employed":true
previous_identificationРеквизиты ранее выданного паспорта гражданина РФ: Серия документа, Номер документа, Кем выдан, Дата выдачи

"previous_identification":{

"series":"00 00",

"number":"000 000",

"issued_by":"Орган выдавший документ",

"issued_date":"0000-00-00"

}

previous_family_nameПредыдущая фамилия"previous_family_name":"Фамилия"
previous_given_nameПредыдущее имя"previous_given_name":"Имя"
previous_middle_nameПредыдущее отчество"previous_middle_name":"Отчество"
educationСведения об образовании:Код + описание,начальное,среднее,среднее специальное,высшее,магистратура и пр.

"education":{

"code":"1",

"description":"начальное"

}

place_of_workНаименование организации(место работы)"place_of_work": "место работы",
job_titleНаименование должности"job_title": "должность"
marital_statusСемейное положение:Код + описание,холост,женат,разведен,вдовец/ вдова,раздельное проживание,гражданский брак и пр.

"marital_status":{

"code":"1",

"description":"холост"

}

ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.