ym88659208ym87991671
Область сведений и атрибуты | Документация для разработчиков

Область сведений и атрибуты

Обновлено 20 декабря 2023

Область сведений (Scope)

При регистрации Приложения Партнера совместно с менеджером определяется состав области сведений (scope), который будет доступен Приложению Партнера после авторизации пользователя.

Существует два вида разрешений, которые включаются в состав scope:

  • Атрибуты (claim) - это параметры Клиента - пользователя и его организации. Сведения об атрибутах включаются в ответ на вызов ресурсов /user-info, /client-info. Например, если в scope включены атрибуты: inn, orgKpp, name, то в ответ запрос /user-info вернется JWT токен содержащий JSON объект, в который, помимо обязательных системных параметров, будут включены данные атрибуты.

Пример

{
"name": "Иванов Игнат Петрович",
"orgKpp": "364785221",
"inn": "1259733247"
}

Полный перечень доступных для включения в scope атрибутов см. в разделе Область сведений и атрибуты.

Описание по работе с ресурсом /user-info и форматом ответа см. в разделе User-info.

  • Операции - это группы ресурсов API, которые могут быть вызваны Приложением Партнера через SberBuisnessAPI. Например, если в scope включена операция PAYROLL, то Приложение Партнера сможет вызвать следующие API:

    • POST /v1/payrolls;

    • GET /v1/payrolls/{externalId}/state;

    • GET /v1/payrolls/{externalId}.

    От лица пользователя, чей Access Token был получен при авторизации в СберБизнес ID.

Полный перечень доступных для включения в scope операций см. в разделе Операции и URL для вызова Sber Api.

Атрибуты (claim)

Таблица содержит полный перечень атрибутов, которые могут быть включены в запрашиваемую область сведений (scope).

Наименование атрибута (claim)Описание

accounts

Счет, БИК, корреспондентский счет компании

Пример возвращаемого ответа:

"accounts": [ { "corrAccountNumber": "30101810400000000225", "accountNumber": "26812810325210000156", "bic": "044525225" }, { "corrAccountNumber": "30101810400000000225", "accountNumber": "86112810623000546644", "bic": "044525225" } ]

activityType

Вид деятельности

Пример возвращаемого ответа:

"activityType": { "code": "94", "name": "Животноводство" }

branch

Информация о подразделении

Пример возвращаемого ответа:

"branch": { "name": "Публичное акционерное общество \"Сбербанк России\"", "address": null, "code": null }

buyOnCreditMmb

Признак возможности покупки в кредит на сайте партнера (Малый и Микро Бизнес)

Пример возвращаемого ответа:

"buyOnCreditMmb": false

creditLineAvailableSum

Сумма действующей ВКЛ (Возобновляемой кредитной линией)

Пример возвращаемого ответа:

"creditLineAvailableSum": "3.14"            

dboContracts

Договоры обслуживания организации

Пример возвращаемого ответа:

"dboContracts": [ { "number": "406c158a-1f9d-40a4-9df1-2dcc9a440792", "date": "2021-09-10", "financeBlock": false }

hasActiveCreditLine

Признак наличия у клиента действующей ВКЛ (Возобновляемой кредитной линией)

Пример возвращаемого ответа:

"hasActiveCreditLine": false            

industry

Отрасль организации

Пример возвращаемого ответа:

"industry": { "code": 16, "name": "Лизинг" }            

inn

ИНН

Пример возвращаемого ответа:

"inn": "0102573875"           

offerSmartCredit

Предодобренные предложения по смарт-кредитам

Пример возвращаемого ответа:

"offerSmartCredit": false           

orgActualAddress

Адрес местонахождения компании

Пример возвращаемого ответа:

"orgActualAddress": "141002, RUSSIAN FEDERATION, Московская область, Мытищинский, г.Долгопрудный, ул.Мира, д.1, кв.325"          

orgBusinessSegment

Бизнес-сегмент

Пример возвращаемого ответа:

"orgBusinessSegment": "1"         

orgBusinessSegmentName

Сегмент

Пример возвращаемого ответа:

"orgBusinessSegmentName": "Микро"         

orgFullName

Полное наименование компании

Пример возвращаемого ответа:

"orgFullName": "Открытое акционерное общество \"Тестовая организация СберБизнес ID\"         

orgJuridicalAddress

Почтовый адрес компании

Пример возвращаемого ответа:

"orgJuridicalAddress": "141002, RUSSIAN FEDERATION, Московская область, Мытищинский, г.Долгопрудный, ул.Мира, д.1, кв.325"        

orgKpp

КПП

Пример возвращаемого ответа:

"orgKpp": "577145884"        

orgLawForm

Организационно-правовая форма (полное наименование)

Пример возвращаемого ответа:

"orgLawForm": "Открытое акционерное общество"        

orgLawFormShort

Организационно-правовая форма (принятое сокращение)

Пример возвращаемого ответа:

"orgLawFormShort": "ОАО"        

OrgName

Сокращенное наименование организации

Пример возвращаемого ответа:

"OrgName": "ОАО \"Тест СберБизнес ID\""        

orgOgrn

ОГРН

Пример возвращаемого ответа:

"orgOgrn": "5186069854119"        

orgOkpo

ОКПО

Пример возвращаемого ответа:

"orgOkpo": "00040778"        

orgOktmo

ОКТМО

Пример возвращаемого ответа:

"orgOktmo": "40321000000"        

orgUnconfirmed

Признак «Неподтвержденная организация»

Пример возвращаемого ответа:

"orgUnconfirmed": false       

regDateINN

Дата регистрации ИНН

Пример возвращаемого ответа:

"regDateINN": "2020-01-20"       

regDateOGRN

Дата регистрации ОГРН

Пример возвращаемого ответа:

"regDateOGRN": "2020-01-20"       

resident

Признак «резидент/нерезидент»

Пример возвращаемого ответа:

"resident": true      

summOfferSmartCredit

Сумма предодобренного предложения по смарт-кредитам

Пример возвращаемого ответа:

"summOfferSmartCredit": 0      

terBank

Территориальный банк

Пример возвращаемого ответа:

"terBank": "Московский Банк Сбербанка РФ"     

email

Адрес электронной почты

Пример возвращаемого ответа:

"email": "avangard@sbbid.ru"     

nonClient

Признак «Неклиент»

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

Пример возвращаемого ответа:

"nonClient": false     

HashOrgId

Хэш идентификатора организации (orgId)

Пример возвращаемого ответа:

"HashOrgId": "378250884741d092b15be6ac84372b8a51e96947dd5a7005534cfe63d491e658"     

individualExecutiveAgency

Признак ЕИО (Единоличный исполнительный орган)

Пример возвращаемого ответа:

"individualExecutiveAgency": 1     

isCorpCardHolder

Признак наличия у клиента бизнес-карты

Пример возвращаемого ответа:

"isCorpCardHolder": false     

name

Фамилия Имя Отчество

Пример возвращаемого ответа:

"name": "Иванов Игнат Петрович"     

offerExpirationDate

Дата окончания срока действия согласия (оферты)

Пример возвращаемого ответа:

"offerExpirationDate": "2022-03-09T09:25:51+0300"     

phone_number

Номер телефона

Пример возвращаемого ответа:

"phone_number": "75555555555"     

tbIdentCode

Код территориального банка

Пример возвращаемого ответа:

"tbIdentCode": "38"     

userPosition

Должность

Пример возвращаемого ответа:

"userPosition": "Главный специалист"     

userRoles

Роли пользователя

Пример возвращаемого ответа:

"userRoles": [ "bankClient", "specialistStructuralDeposit" ]     

userSignatureType

Тип подписи

Пример возвращаемого ответа:

"userSignatureType": "Единственная подпись"   

userCryptoType

Тип криптографии

Пример возвращаемого ответа:

"userCryptoType": "SMS"   

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