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

Обновлено 20 февраля 2025

GET

/v1/client-info

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

Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка.

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

Request {#request}

Header Parameters

Authorization
Authorization
required

Ответы

• 200
• 400
• 401
• 403
• 500
• 503

Успех

• application/json

• Схема
• Пример из схемы

Schema

shortName

string

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

fullName

string

Полное наименование организации

resident

boolean

Признак 'резидент / нерезидент'

ogrn

string

ОГРН

inn

string

ИНН / КИО

okpo

string

ОКПО

okato

string

ОКАТО

orgForm

string

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

territorialBank

string

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

orgPprbId

int64

Идентификатор организации в ППРБ

orgRegDateINN

string

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

orgRegDateOGRN

string

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

nonClient

boolean

Неклиент

orgUnconfirmed

boolean

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

eksEpkId

int64

Идентификатор организации в ЕКС

isCorpCardHolder

boolean

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

hasActiveCreditLine

boolean

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

creditLineAvailableSum

number

ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".

Сумма действующей ВКЛ.

branch object

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

name

string

Наименование подразделения

address

string

Адрес подразделения

code

string

Номер подразделения

orgKindActivityInfo object

Информация о виде деятельности организации

code

int64

Код вида деятельности

name

string

Наименование вида деятельности

addresses object[]
Адреса (все заведенные для клиента)
Array [
type
string
Наименование типа адреса
country
string
Цифровой код страны
zip
string
Индекс
region
string
Субъект или регион
area
string
Район
city
string
Город
settlementType
string
Тип населенного пункта
settlement
string
Населенный пункт
street
string
Улица
house
string
Дом
building
string
Строение, корпус
flat
string
Квартира
fullAddress
string
Адрес
]
accounts object[]
Счета организации клиента, доступные партнеру
Array [
number
string
Номер счета (20 сиволов)
name
string
Наименование счета
currencyCode
string
Цифровой код валюты счета
bic
string
БИК банка, где открыт счет
type
string
Возможные значения: [assuranceRegistration, calculated, transit, specialTransit, budget, loan, deposit]
Тип счета
openDate
date
Дата открытия счета
closeDate
date
Дата закрытия счета
state
string
Возможные значения: [OPEN, BLOCKED, RESERVED, CLOSED]
Состояние счета
dbo
boolean
Признак обслуживания в ДБО
business
boolean
Признак бизнес-счета
minBalance
number
ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".
Минимальный поддерживаемый (неснижаемый) остаток на счете.
cdiPermDocQnt
integer
Количество расчетных документов, ожидающих разрешения на проведение операции
cdiPermDocSum
number
ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".
Сумма расчетных документов, ожидающих разрешения на проведение операции.
cdiAcptDocQnt
integer
Количество расчетных документов, ожидающих акцепта
cdiAcptDocSum
number
ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".
Сумма расчетных документов, ожидающих акцепта.
cdiCart2DocQnt
integer
Количество расчетных документов, помещенных в картотеку к счету 90902 (картотека 2)
cdiCart2DocSum
number
ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".
Сумма расчетных документов, помещенных в картотеку к счету 90902 (картотека 2)
debitBlocked
boolean
Признак полной блокировки счета по дебету
debitBlockedCause
string
Основание ареста
debitBlockedBeginDate
date-time
Дата начала действия ограничения
debitBlockedEndDate
date-time
Дата снятия ограничения
creditBlocked
boolean
Признак полной блокировки счета по кредиту
creditBlockedCause
string
Основание ареста
creditBlockedBeginDate
date-time
Дата начала действия ограничения
creditBlockedEndDate
date-time
Дата снятия ограничения
blockedSums object[]
Заблокированные (арестованные) суммы на счете
Array [
sum
number
ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".
Заблокированная (арестованная) сумма на счете.
cause
string
Основание ареста
blockedQueues
integer
Наибольшая разрешенная очередность платежей (от 1 до 5). Указывается, если есть блокировка по очередности. Пример: значение 3 означает, что заблокированы очередности 4 - 6
beginDate
date-time
Дата начала действия ограничения
endDate
date-time
Дата снятия ограничения
]
blockedQueuesInfo object[]
Приостановления операций по счету выше очередности (блокировки по очередности)
Array [
sum
number
ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".
Заблокированная (арестованная) сумма на счете.
cause
string
Основание ареста
blockedQueues
integer
Наибольшая разрешенная очередность платежей (от 1 до 5). Указывается, если есть блокировка по очередности. Пример: значение 3 означает, что заблокированы очередности 4 - 6
beginDate
date-time
Дата начала действия ограничения
endDate
date-time
Дата снятия ограничения
]
blockedSumQueuesInfo object[]
Приостановления операций по счету выше очередности на сумму
Array [
sum
number
ВНИМАНИЕ. Фактически возвращаемое значение поля – "string". Для предотвращения возможных ошибок, выполните явную конвертацию значения из "string" в "number".
Заблокированная (арестованная) сумма на счете.
cause
string
Основание ареста
blockedQueues
integer
Наибольшая разрешенная очередность платежей (от 1 до 5). Указывается, если есть блокировка по очередности. Пример: значение 3 означает, что заблокированы очередности 4 - 6
beginDate
date-time
Дата начала действия ограничения
endDate
date-time
Дата снятия ограничения
]
]
kpps

string[]

КПП (все заведенные для организации клиента)

dboContracts object[]
Договоры обслуживания организации
Array [
number
string
Номер заключенного договора ДБО
date
date
Дата заключения договора ДБО
]

{
  "shortName": "string",
  "fullName": "string",
  "resident": true,
  "ogrn": "string",
  "inn": "string",
  "okpo": "string",
  "okato": "string",
  "orgForm": "string",
  "territorialBank": "string",
  "orgPprbId": 0,
  "orgRegDateINN": "string",
  "orgRegDateOGRN": "string",
  "nonClient": true,
  "orgUnconfirmed": true,
  "eksEpkId": 1,
  "isCorpCardHolder": false,
  "hasActiveCreditLine": true,
  "creditLineAvailableSum": 0,
  "branch": {
    "name": "Доп офис 1654",
    "address": "г.Москва, Кутузовский проспект, 34",
    "code": 138592
  },
  "orgKindActivityInfo": {
    "code": 0,
    "name": "string"
  },
  "addresses": [
    {
      "type": "string",
      "country": "string",
      "zip": "string",
      "region": "string",
      "area": "string",
      "city": "string",
      "settlementType": "string",
      "settlement": "string",
      "street": "string",
      "house": "string",
      "building": "string",
      "flat": "string",
      "fullAddress": "string"
    }
  ],
  "accounts": [
    {
      "number": "string",
      "name": "string",
      "currencyCode": "string",
      "bic": "string",
      "type": "assuranceRegistration",
      "openDate": "2024-07-29",
      "closeDate": "2024-07-29",
      "state": "OPEN",
      "dbo": true,
      "business": true,
      "minBalance": 0,
      "cdiPermDocQnt": 0,
      "cdiPermDocSum": 0,
      "cdiAcptDocQnt": 0,
      "cdiAcptDocSum": 0,
      "cdiCart2DocQnt": 0,
      "cdiCart2DocSum": 0,
      "debitBlocked": true,
      "debitBlockedCause": "string",
      "debitBlockedBeginDate": "2024-07-29T15:51:28.071Z",
      "debitBlockedEndDate": "2024-07-29T15:51:28.071Z",
      "creditBlocked": true,
      "creditBlockedCause": "string",
      "creditBlockedBeginDate": "2024-07-29T15:51:28.071Z",
      "creditBlockedEndDate": "2024-07-29T15:51:28.071Z",
      "blockedSums": [
        {
          "sum": 0,
          "cause": "string",
          "blockedQueues": 0,
          "beginDate": "2024-07-29T15:51:28.071Z",
          "endDate": "2024-07-29T15:51:28.071Z"
        }
      ],
      "blockedQueuesInfo": [
        {
          "sum": 0,
          "cause": "string",
          "blockedQueues": 0,
          "beginDate": "2024-07-29T15:51:28.071Z",
          "endDate": "2024-07-29T15:51:28.071Z"
        }
      ],
      "blockedSumQueuesInfo": [
        {
          "sum": 0,
          "cause": "string",
          "blockedQueues": 0,
          "beginDate": "2024-07-29T15:51:28.071Z",
          "endDate": "2024-07-29T15:51:28.071Z"
        }
      ]
    }
  ],
  "kpps": [
    "string"
  ],
  "dboContracts": [
    {
      "number": "14/2/000001",
      "date": "2018-12-31"
    }
  ]
}

Ошибка запроса

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Тип ошибки

referenceId

uuid

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
fields
string[]
Названия полей (при наличии связи с моделью)
]

{
  "cause": "string",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string",
  "checks": [
    {
      "level": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Неавторизован

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Тип ошибки

referenceId

uuid

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
fields
string[]
Названия полей (при наличии связи с моделью)
]

{
  "cause": "string",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string",
  "checks": [
    {
      "level": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Доступ запрещен

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Тип ошибки

referenceId

uuid

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
fields
string[]
Названия полей (при наличии связи с моделью)
]

{
  "cause": "string",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string",
  "checks": [
    {
      "level": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Внутренняя ошибка сервера

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Тип ошибки

referenceId

uuid

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
fields
string[]
Названия полей (при наличии связи с моделью)
]

{
  "cause": "string",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string",
  "checks": [
    {
      "level": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Сервис временно недоступен

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Тип ошибки

referenceId

uuid

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
fields
string[]
Названия полей (при наличии связи с моделью)
]

{
  "cause": "string",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string",
  "checks": [
    {
      "level": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Loading...

Loading...