Информация об организации

Обновлено 30 августа 2023

Авторизация

Для обращения к ресурсу необходимо отправлять запрос на:

• Текущий тестовый контур https://edupirfintech.sberbank.ru:9443

• Новый тестовый контур https://iftfintech.testsbi.sberbank.ru:9443

• Промышленный контур https://fintech.sberbank.ru:9443

Получение расширенной информации

Ресурс /v1/client-info позволяет Партнеру получить расширенную информацию об организации клиента и ее счетах (если клиент дал согласие на доступ к своим данным см. Сервис авторизации-SberBusiness ID), которая может включить в себя следующие данные:

• сокращенное наименование организации;
• полное наименование организации клиента;
• счета организации клиента, доступные партнеру для запроса выписок и создания платежных документов;
• признак резидента;
• ОГРН;
• ИНН;
• ОКПО;
• ОКАТО;
• полный адрес организации.

Сокращенную информацию о клиенте можно получить через запрос пользовательских данных (ресурс /v1/oauth/user-info). Информация по счетам клиента передается только в том в случае, когда при подписании оферты клиент в явном виде указал номера счетов, по которым разрешает передачу информации. В текущей версии SberBusinessAPI сервис возвращает информацию только по расчетным счетам клиента.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения информации необходимо отправить GET-запрос (/v1/client-info), в котором передать авторизационный токен к данным пользователя (accessToken).

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_CLIENT_ACCOUNTS.

Модель запроса

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации клиента, полученный через SSO Пример: Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1

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

curl -X GET --header 'Accept: application/json' --header 
'Authorization: Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/client-info'

Модель ответа

Наименование	Описание
ClientInfo
accounts (Array[Account], optional)	Счета организации клиента, доступные партнеру
addresses (Array[Address], optional)	Адреса (все заведенные для клиента)
branch (Branch, optional)	Информация о подразделении
cardNum (string, optional)	Номер таможенной карты
dboContracts (Array[DboContract], optional)	Договоры обслуживания организации
fullName (string, optional)	Полное наименование организации
inn (string, optional)	ИНН / КИО
kpps (Array[string], optional)	КПП (все заведенные для организации клиента)
offerSmartCredit (boolean, optional)	Предодобренные предложения по смарт-кредитам
ogrn (string, optional)	ОГРН
okato (string, optional)	ОКАТО
okpo (string, optional)	ОКПО
orgBusinessSegment (string, optional)	Бизнес-сегмент
orgBusinessSegmentName (string, optional)	Наименование бизнес-сегмента
orgCrmId (string, optional)	Идентификатор организации в CRM
orgForm (string, optional)	Организационно-правовая форма организации клиента
orgGuid (string, optional)	Глобальный идентификатор организации
orgId (integer, optional)	Идентификатор организации в СББОЛ
orgIndustryInfo (OrgIndustry, optional)	Информация об отрасли организации
orgKindActivityInfo (OrgKindActivity, optional)	Информация о виде деятельности организации
orgPprbId (integer, optional)	Идентификатор организации в ППРБ
orgRegDateINN (string, optional)	Дата регистрации ИНН
orgRegDateOGRN (string, optional)	Дата регистрации ОГРН
resident (boolean, optional)	Признак 'резидент / нерезидент'
shortName (string, optional)	Сокращенное наименование организации
summOfferSmartCredit (integer, optional)	Сумма предодобренного предложения по смарт-кредитам
territorialBank (string, optional)	Территориальный банк клиента
Account
bic (string, optional)	БИК банка, где открыт счет
blockedQueuesInfo (Array[AccountBlockInfo], optional)	Приостановления операций по счету выше очередности (блокировки по очередности)
blockedSumQueuesInfo (Array[AccountBlockInfo], optional)	Приостановления операций по счету выше очередности на сумму
blockedSums (Array[AccountBlockInfo], optional)	Заблокированные (арестованные) суммы на счете
business (boolean, optional)	Признак бизнес-счета
businessNewType (boolean, optional)	Признак бизнес-счета 'нового' типа
cdiAcptDocQnt (integer, optional)	Содержит информацию о расчетных документах, ожидающих акцепта. Количество документов
cdiAcptDocSum (number, optional)	Содержит информацию о расчетных документах, ожидающих акцепта. Сумма документов
cdiCart2DocQnt (integer, optional)	Содержит информацию о расчетных документах, помещенных в картотеку к счету 90902 (картотека 2). Количество документов
cdiCart2DocSum (number, optional)	Содержит информацию о расчетных документах, помещенных в картотеку к счету 90902 (картотека 2). Сумма документов
cdiPermDocQnt (integer, optional)	Содержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Количество документов
cdiPermDocSum (number, optional)	Содержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Сумма документов
closeDate (string, optional)	Дата закрытия счета
comment (string, optional)	Примечание
creditBlocked (boolean, optional)	Признак полной блокировки счета по кредиту
creditBlockedBeginDate (string, optional)	Дата начала действия ограничения
creditBlockedCause (string, optional)	Основание ареста
creditBlockedEndDate (string, optional)	Дата снятия ограничения
creditBlockedInitiator (string, optional)	Наименование органа, наложившего арест
creditBlockedTaxAuthorityCode (string, optional)	Код налогового органа, наложившего арест
currencyCode (string, optional)	Цифровой код валюты счета
dbo (boolean, optional)	Признак обслуживания в ДБО
debitBlocked (boolean, optional)	Признак полной блокировки счета по дебету
debitBlockedBeginDate (string, optional)	Дата начала действия ограничения
debitBlockedCause (string, optional)	Основание ареста
debitBlockedEndDate (string, optional)	Дата снятия ограничения
debitBlockedInitiator (string, optional)	Наименование органа, наложившего арест
debitBlockedTaxAuthorityCode (string, optional)	Код налогового органа, наложившего арест
minBalance (number, optional)	Минимальный поддерживаемый (неснижаемый) остаток на счете
mode (string, optional)	Режим работы счета = [STANDART, FORBIDDEN_RECEIVING, ONLY_RECEIVING]
name (string, optional)	Наименование счета
notDelay (boolean, optional)	Признак возможности проведения неотложных платежей
number (string, optional)	Номер счета (20 сиволов)
openDate (string, optional)	Дата открытия счета
overdraft (number, optional)	Сумма общего лимита овердрафта в валюте счета
passive (boolean, optional)	Признак пассивности счета
state (string, optional)	Состояние счета = [OPEN, BLOCKED, CLOSED]
type (string, optional)	Тип счета = [assuranceRegistration, calculated, transit, specialTransit, budget, loan, deposit]
urgent (boolean, optional)	Признак возможности проведения срочных платежей
Address
area (string, optional)	Район
building (string, optional)	Строение, корпус
city (string, optional)	Город
comment (string, optional)	Примечание
country (string, optional)	Цифровой код страны
flat (string, optional)	Квартира
fullAddress (string, optional)	Адрес
house (string, optional)	Дом
region (string, optional)	Субъект или регион
settlement (string, optional)	Населенный пункт
settlementType (string, optional)	Тип населенного пункта
street (string, optional)	Улица
type (string, optional)	Наименование типа адреса
zip (string, optional)	Индекс
Branch
address (string, optional)	Адрес подразделения
code (string, optional)	Номер подразделения
name (string, optional)	Наименование подразделения
DboContract
date (string, optional)	Дата заключения договора ДБО
financeBlock (boolean, optional)	Признак финансовой блокировки
number (string, optional)	Номер заключенного договора ДБО
OrgIndustry
code (integer, optional)	Код отрасли
name (string, optional)	Наименование отрасли
OrgKindActivity
code (integer, optional)	Код вида деятельности
name (string, optional)	Наименование вида деятельности
AccountBlockInfo
beginDate (string, optional)	Дата начала действия ограничения
blockedQueues (integer, optional)	Наибольшая разрешенная очередность платежей (от 1 до 5). Указывается, если есть блокировка по очередности. Пример значение 3 означает, что заблокированы очередности 4 - 6
cause (string, optional)	Основание ареста
endDate (string, optional)	Дата снятия ограничения
initiator (string, optional)	Наименование органа, наложившего арест
sum (number, optional)	Заблокированная (арестованная) сумма на счете
taxAuthorityCode (string, optional)	Код налогового органа, наложившего арест

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

{
   "shortName":"ООО \"ТО-Партнер-105-01\"",
   "fullName":"Общество с ограниченной ответственностью ТО-Партнер-105-01\"",
   "inn":"7715961051",
   "orgForm":"Общество с ограниченной ответственностью",
   "accounts":[
      {
         "number":"40702810038120042645",
         "name":"ООО \"ТО-Партнер-105-01\"",
         "currencyCode":"810",
         "bic":"044525225",
         "type":"calculated",
         "passive":true,
         "openDate":"2000-01-01",
         "closeDate":null,
         "state":"OPEN",
         "mode":"STANDART",
         "dbo":true,
         "business":false,
         "businessNewType":false,
         "notDelay":false,
         "urgent":false,
         "minBalance":null,
         "overdraft":null,
         "comment":null,
         "cdiPermDocQnt":2,
         "cdiPermDocSum":"790.00",
         "cdiAcptDocQnt":null,
         "cdiAcptDocSum":null,
         "cdiCart2DocQnt":null,
         "cdiCart2DocSum":null,
         "debitBlocked":false,
         "debitBlockedCause":null,
         "debitBlockedInitiator":null,
         "debitBlockedTaxAuthorityCode":null,
         "debitBlockedBeginDate":null,
         "debitBlockedEndDate":null,
         "creditBlocked":false,
         "creditBlockedCause":null,
         "creditBlockedInitiator":null,
         "creditBlockedTaxAuthorityCode":null,
         "creditBlockedBeginDate":null,
         "creditBlockedEndDate":null,
         "blockedSums":[  

         ],
         "blockedQueuesInfo":[
            
         ],
         "blockedSumQueuesInfo":[
            
         ]
      },
      {
         "number":"40702810338303983276",
         "name":"ООО \"ТО-Партнер-105-01\"",
         "currencyCode":"810",
         "bic":"044525225",
         "type":"calculated",
         "passive":true,
         "openDate":"2000-01-01",
         "closeDate":null,
         "state":"OPEN",
         "mode":"STANDART",
         "dbo":true,
         "business":false,
         "businessNewType":false,
         "notDelay":false,
         "urgent":false,
         "minBalance":null,
         "overdraft":null,
         "comment":null,
         "cdiPermDocQnt":null,
         "cdiPermDocSum":null,
         "cdiAcptDocQnt":null,
         "cdiAcptDocSum":null,
         "cdiCart2DocQnt":null,
         "cdiCart2DocSum":null,
         "debitBlocked":false,
         "debitBlockedCause":null,
         "debitBlockedInitiator":null,
         "debitBlockedTaxAuthorityCode":null,
         "debitBlockedBeginDate":null,
         "debitBlockedEndDate":null,
         "creditBlocked":false,
         "creditBlockedCause":null,
         "creditBlockedInitiator":null,
         "creditBlockedTaxAuthorityCode":null,
         "creditBlockedBeginDate":null,
         "creditBlockedEndDate":null,
         "blockedSums":[
            
         ],
         "blockedQueuesInfo":[
            
         ],
         "blockedSumQueuesInfo":[
            
         ]
      },
      {
         "number":"40702840938403407174",
         "name":"ООО \"ТО-Партнер-105-01\"",
         "currencyCode":"840",
         "bic":"044525225",
         "type":"calculated",
         "passive":true,
         "openDate":"2000-01-01",
         "closeDate":null,
         "state":"OPEN",
         "mode":"STANDART",
         "dbo":true,
         "business":false,
         "businessNewType":false,
         "notDelay":false,
         "urgent":false,
         "minBalance":null,
         "overdraft":null,
         "comment":null,
         "cdiPermDocQnt":2,
         "cdiPermDocSum":"790.00",
         "cdiAcptDocQnt":null,
         "cdiAcptDocSum":null,
         "cdiCart2DocQnt":null,
         "cdiCart2DocSum":null,
         "debitBlocked":false,
         "debitBlockedCause":null,
         "debitBlockedInitiator":null,
         "debitBlockedTaxAuthorityCode":null,
         "debitBlockedBeginDate":null,
         "debitBlockedEndDate":null,
         "creditBlocked":false,
         "creditBlockedCause":null,
         "creditBlockedInitiator":null,
         "creditBlockedTaxAuthorityCode":null,
         "creditBlockedBeginDate":null,
         "creditBlockedEndDate":null,
         "blockedSums":[
            
         ],
         "blockedQueuesInfo":[
            
         ],
         "blockedSumQueuesInfo":[
            
         ]
      },
      {
         "number":"40702840138737314908",
         "name":"ООО \"ТО-Партнер-105-01\"",
         "currencyCode":"840",
         "bic":"044525225",
         "type":"calculated",
         "passive":true,
         "openDate":"2000-01-01",
         "closeDate":null,
         "state":"OPEN",
         "mode":"STANDART",
         "dbo":true,
         "business":false,
         "businessNewType":false,
         "notDelay":false,
         "urgent":false,
         "minBalance":null,
         "overdraft":null,
         "comment":null,
         "cdiPermDocQnt":null,
         "cdiPermDocSum":null,
         "cdiAcptDocQnt":null,
         "cdiAcptDocSum":null,
         "cdiCart2DocQnt":null,
         "cdiCart2DocSum":null,
         "debitBlocked":false,
         "debitBlockedCause":null,
         "debitBlockedInitiator":null,
         "debitBlockedTaxAuthorityCode":null,
         "debitBlockedBeginDate":null,
         "debitBlockedEndDate":null,
         "creditBlocked":false,
         "creditBlockedCause":null,
         "creditBlockedInitiator":null,
         "creditBlockedTaxAuthorityCode":null,
         "creditBlockedBeginDate":null,
         "creditBlockedEndDate":null,
         "blockedSums":[
            
         ],
         "blockedQueuesInfo":[
            
         ],
         "blockedSumQueuesInfo":[
            
         ]
      }
   ],
   "kpps":[
      "770701001"
   ]
}                

Список доступных атрибутов

Наименование	Описание
terBank	Наименование территориального банка
sbbol	Признак использования "Дизайн СББОЛ 3.0"
resident	Признак является ли организация "резидент/нерезидент"
orgOktmo	ОКТМО организации
orgOkpo	ОКПО организации
orgOgrn	ОГРН организации
orgKpp	КПП организации
orgJuridicalAddress	Юридический адрес организации
orgId	Идентификатор организации в СББОЛ
orgGuid	Глобальный идентификатор организации
orgFullName	Название компании
orgBusinessSegment	Бизнес-сегмент организации
orgActualAddress	Фактический адрес компании
inn	ИНН организации
dboContracts	Договоры обслуживания организации
accounts	Счет, БИК
shortName	Сокращенное название компании
buyOnCreditMmb	Признак возможности покупки в кредит на сайте партнера
orgLawFormShort	Организационно-правовая форма (принятое сокращение)
branch	Сокращенные наименования подразделений, адреса подразделений, номера подразделений
orgIndustryInfo	Отрасль организации
orgRegDateINN	Дата регистрации ИНН
orgRegDateOGRN	Дата регистрации ОГРН
orgKindActivityInfo	Информация о виде деятельности организации
orgBusinessSegmentName	Наименование бизнес-сегмента
hasActiveCreditLine	Наличие активной кредитной линии у клиента
creditLineAvailableSum	Сумма остатка действующей кредитной линии

Коды возврата

Код возврата	Описание кода возврата	Причина возникновения
200	OK
	Успешный код возврата
400	DESERIALIZATION_FAULT
	Неверный формат запроса	Неверный формат запроса
401	UNAUTHORIZED
	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token
403	ACTION_ACCESS_EXCEPTION
	Операция не может быть выполнена: доступ к ресурсу запрещен	У пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope
		У пользователя отсутствует оферта с внешним сервисом
500	UNKNOWN_EXCEPTION
	Внутренняя ошибка сервера
503	UNAVAILABLE_RESOURCE_EXCEPTION
	Сервис временно недоступен	Проводятся технические работы