ym88659208ym87991671
client-info-get | Документация для разработчиков

Получение информации о компании

Alt text /fintech/api/v1/client-info

Запрос позволяет получить расширенную информацию об организации пользователя и ее счетах (если пользователь дал согласие на доступ к своим данным см. Сервис авторизации СберБизнес ID.

Для получения информации необходимо отправить GET-запрос /fintech/api/v1/client-info с токеном доступа (access_token) пользователя в параметре Authorization заголовка.

В параметре scope ссылки авторизации пользователя должен быть указан сервис GET_CLIENT_ACCOUNTS для получения доступа к этому запросу.


Перечень доступных данных зависит от claims (атрибуты), которые были включены в ссылку авторизации пользователя.


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

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

Request

/fintech/api/v1/client-info
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
ClientInfo {
  accountsarray[Account]optionalСчета организации клиента, доступные партнеру,
  addressesarray[Address]optionalАдреса (все заведенные для клиента),
  branchBranchoptionalИнформация о подразделении,
  dboContractsarray[DboContract]optionalДоговоры обслуживания организации,
  fullNamestringoptionalПолное наименование организации,
  innstringoptionalИНН / КИО,
  kppsarray[string]optionalКПП (все заведенные для организации клиента),
  ogrnstringoptionalОГРН,
  okatostringoptionalОКАТО,
  okpostringoptionalОКПО,
  orgFormstringoptionalОрганизационно-правовая форма организации клиента,
  orgKindActivityInfoOrgKindActivityoptionalИнформация о виде деятельности организации,
  orgPprbIdintegeroptionalИдентификатор организации в ППРБ,
  orgRegDateINNstringoptionalДата регистрации ИНН,
  orgRegDateOGRNstringoptionalДата регистрации ОГРН,
  residentbooleanoptionalПризнак 'резидент / нерезидент',
  shortNamestringoptionalСокращенное наименование организации,
  territorialBankstringoptionalТерриториальный банк клиента
}
Account {
  bicstringoptionalБИК банка, где открыт счет,
  blockedQueuesInfoarray[AccountBlockInfo]optionalПриостановления операций по счету выше очередности (блокировки по очередности),
  blockedSumQueuesInfoarray[AccountBlockInfo]optionalПриостановления операций по счету выше очередности на сумму,
  blockedSumsarray[AccountBlockInfo]optionalЗаблокированные (арестованные) суммы на счете,
  businessbooleanoptionalПризнак бизнес-счета,
  cdiAcptDocQntintegeroptionalСодержит информацию о расчетных документах, ожидающих акцепта. Количество документов,
  cdiAcptDocSumnumberoptionalСодержит информацию о расчетных документах, ожидающих акцепта. Сумма документов,
  cdiCart2DocQntintegeroptionalСодержит информацию о расчетных документах, помещенных в картотеку к счету 90902 (картотека 2). Количество документов,
  cdiCart2DocSumnumberoptionalСодержит информацию о расчетных документах, помещенных в картотеку к счету 90902 (картотека 2). Сумма документов,
  cdiPermDocQntintegeroptionalСодержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Количество документов,
  cdiPermDocSumnumberoptionalСодержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Сумма документов,
  closeDatestringoptionalДата закрытия счета,
  commentstringoptionalПримечание,
  creditBlockedbooleanoptionalПризнак полной блокировки счета по кредиту,
  creditBlockedBeginDatestringoptionalДата начала действия ограничения,
  creditBlockedCausestringoptionalОснование ареста,
  creditBlockedEndDatestringoptionalДата снятия ограничения,
  currencyCodestringoptionalЦифровой код валюты счета,
  dbobooleanoptionalПризнак обслуживания в ДБО,
  debitBlockedbooleanoptionalПризнак полной блокировки счета по дебету,
  debitBlockedBeginDatestringoptionalДата начала действия ограничения,
  debitBlockedCausestringoptionalОснование ареста,
  debitBlockedEndDatestringoptionalДата снятия ограничения,
  minBalancenumberoptionalМинимальный поддерживаемый (неснижаемый) остаток на счете,
  namestringoptionalНаименование счета,
  notDelaybooleanoptionalПризнак возможности проведения неотложных платежей,
  numberstringoptionalНомер счета (20 сиволов),
  openDatestringoptionalДата открытия счета,
  statestringoptionalСостояние счета = [OPEN, BLOCKED, CLOSED],
  typestringoptionalТип счета = [assuranceRegistration, calculated, transit, specialTransit, budget, loan, deposit],
  urgentbooleanoptionalПризнак возможности проведения срочных платежей
}
Address {
  areastringoptionalРайон,
  buildingstringoptionalСтроение, корпус,
  citystringoptionalГород,
  commentstringoptionalПримечание,
  countrystringoptionalЦифровой код страны,
  flatstringoptionalКвартира,
  fullAddressstringoptionalАдрес,
  housestringoptionalДом,
  regionstringoptionalСубъект или регион,
  settlementstringoptionalНаселенный пункт,
  settlementTypestringoptionalТип населенного пункта,
  streetstringoptionalУлица,
  typestringoptionalНаименование типа адреса,
  zipstringoptionalИндекс
}
Branch {
  addressstringoptionalАдрес подразделения,
  codestringoptionalНомер подразделения,
  namestringoptionalНаименование подразделения
}
DboContract {
  datestringoptionalДата заключения договора ДБО,
  numberstringoptionalНомер заключенного договора ДБО
}
OrgKindActivity {
  codeintegeroptionalКод вида деятельности,
  namestringoptionalНаименование вида деятельности
}
AccountBlockInfo {
  beginDatestringoptionalДата начала действия ограничения,
  blockedQueuesintegeroptionalНаибольшая разрешенная очередность платежей (от 1 до 5). Указывается, если есть блокировка по очередности. Пример значение 3 означает, что заблокированы очередности 4 - 6,
  causestringoptionalОснование ареста,
  endDatestringoptionalДата снятия ограничения,
  initiatorstringoptionalНаименование органа, наложившего арест,
  sumnumberoptionalЗаблокированная (арестованная) сумма на счете,
  taxAuthorityCodestringoptionalКод налогового органа, наложившего арест
}
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
Некорректное значение Access TokenУказан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция GET_CLIENT_ACCOUNTS. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
429 (Too Many Requests)
CauseMessageDescription
TOO_MANY_REQUESTSПревышен лимит запросов. Повторите операцию позже.Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее
НаименованиеТипОбязательностьОписание
Notice{
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.