B2BH2H

Получение профиля организации

Песочница
GET https://sandbox.alfabank.ru/api/jp/v2/customer-info
Пром
GET https://baas.alfabank.ru/api/jp/v2/customer-info
Scope

customer

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Пример запроса
Язык 
1curl --location 'https://baas.alfabank.ru/api/jp/v2/customer-info' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "organizationId": "bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732",
3  "fullName": "Общество с ограниченной ответственностью \"Ромашка\"",
4  "shortName": "ООО \"Ромашка\"",
5  "inn": "114693784",
6  "organizationForm": {
7    "fullName": "Общество с ограниченной ответственностью",
8    "shortName": "ООО",
9    "type": "2014",
10    "code": "12300"
11  },
12  "kpps": [
13    "2427920",
14    "2427920"
15  ],
16  "ogrn": "1020203094163",
17  "okpo": "41294456",
18  "okved": "71.12",
19  "type": "LEGAL",
20  "phone": "79099876543",
21  "email": "client@example.com",
22  "category": "BANK",
23  "rsadr": "testtest.ru",
24  "status": "ACTIVE",
25  "registrationDate": "2000-01-23T04:56:07.000+00:00",
26  "addresses": [
27    {
28      "type": "FACT_FULL",
29      "area": "Тахтамукайский район",
30      "building": "1",
31      "city": "Майкоп",
32      "country": "643",
33      "flat": "123",
34      "fullAddress": "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3",
35      "house": "3",
36      "region": "Республика Адыгея",
37      "settlement": "Майкоп",
38      "settlementType": "г.",
39      "street": "улица Депутатская",
40      "zip": "385600",
41      "fiasCode": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
42    }
43  ],
44  "accounts": [
45    {
46      "number": "40702810002300001935",
47      "type": "PAYMENT",
48      "typeName": "Расчётный счёт",
49      "openDate": "2021-10-07",
50      "currencyCode": "810",
51      "transitAccountNumber": "40702978904100000001",
52      "specConditions": [
53        {
54          "code": "AI12",
55          "description": "Нельзя дебетовать",
56          "value": false
57        },
58        {
59          "code": "AI11",
60          "description": "Нельзя кредитовать",
61          "value": false
62        },
63        {
64          "code": "AI14",
65          "description": "Клиент закрыт",
66          "value": false
67        },
68        {
69          "code": "AI17",
70          "description": "Счёт заблокирован",
71          "value": true
72        },
73        {
74          "code": "AI20",
75          "description": "Неактивный счёт",
76          "value": false
77        },
78        {
79          "code": "AI30",
80          "description": "Счёт закрыт",
81          "value": false
82        },
83        {
84          "code": "AI47",
85          "description": "Внутренний счёт",
86          "value": false
87        },
88        {
89          "code": "AI82",
90          "description": "Дебетование ограничено",
91          "value": false
92        },
93        {
94          "code": "AI83",
95          "description": "Электронная картотека",
96          "value": false
97        },
98        {
99          "code": "AI87",
100          "description": "Бумажная разновалютная картотека",
101          "value": false
102        }
103      ],
104      "clientName": "Наименование",
105      "amountBalance": 810000,
106      "amountTotal": 100000,
107      "amountHolds": 100,
108      "amountOverdraftOwnFunds": 0.8008281904610115,
109      "amountOverdraftLimit": 100000,
110      "blockedSums": [
111        {
112          "num": "112233",
113          "beginDate": "2020-10-23",
114          "cause": "Неисполнение требования об уплате налога, сбора, пени, штрафа № 53228 от 05.11.2019 г",
115          "initiator": "Межрайонная ИФНС России № 51 по г. Москве",
116          "sum": "988800",
117          "blockType": "PARTIAL_BALANCE_BLOCK"
118        }
119      ],
120      "bank": {
121        "bic": "044525593",
122        "correspondentAccountNumber": "30101810200000000593"
123      }
124    }
125  ]
126}
HEADERS
Атрибут
Описание
x-traceid
stringoptional

Идентификатор трассировки запроса

BODY
атрибут
описание
organizationId
stringoptional

Идентификатор организации

fullName
stringoptional

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

shortName
stringoptional

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

inn
stringoptional

ИНН

objectoptional

Организационно-правовая форма

fullName
stringoptional

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

shortName
stringoptional

Краткое наименование ОПФ

type
stringoptional

Тип ОПФ

code
stringoptional

Код ОПФ

kpps
array of stringsoptional

Список КПП организации

ogrn
stringoptional

ОГРН

okpo
stringoptional

ОКПО

okved
stringoptional

ОКВЭД

type
stringoptional

Тип организации. Принимает возможные значения:

  • •
    LEGAL - ЮЛ;
  • •
    INDIVIDUAL - ИП
phone
stringoptional

Контактный телефон клиента

email
stringoptional

Электронная почта клиента

category
stringoptional

Категория организации. Принимает возможные значения:

  • •
    BANK - банк;
  • •
    FINANCIAL - финансовая;
  • •
    OTHER - другая
rsadr
stringoptional

Адрес интернет-ресурса организации

status
stringoptional

Статус организации. Принимает возможные значения:

  • •
    ACTIVE - действующая;
  • •
    LIQUIDATING - ликвидируется;
  • •
    LIQUIDATED - ликвидирована;
  • •
    BANKRUPT - банкротство;
  • •
    REORGANIZING - в процессе присоединения к другому юридическому лицу, с последующей ликвидацией
registrationDate
stringoptional

Дата регистрации организации

array of objectsoptional

Адреса клиента

type
stringoptional

Тип адреса. Принимает возможные значения:

  • •
    LEGAL_FULL - полный юридический адрес;
  • •
    FACT_FULL - полный фактический адрес
area
stringoptional

Район

building
stringoptional

Строение, корпус

city
stringoptional

Город

country
stringoptional

Числовой код страны

flat
stringoptional

Квартира

fullAddress
stringoptional

Адрес

house
stringoptional

Дом

region
stringoptional

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

settlement
stringoptional

Населённый пункт

settlementType
stringoptional

Тип населённого пункта

street
stringoptional

Улица

zip
stringoptional

Индекс

fiasCode
stringoptional

Код ФИАС

array of objectsoptional

Расчётные счета. Информация по закрытым/заблокированным счетам не возвращается

number
stringoptional

Номер счёта

type
stringoptional

Тип счёта. Принимает возможные значения:

  • •
    PAYMENT - расчётный счёт;
  • •
    TRANSIT - транзитный счёт;
  • •
    DEPOSIT - депозитный счёт;
  • •
    DEPOSIT_INDIVIDUAL - депозитный счёт для ИП;
  • •
    TAX - налоговая копилка;
  • •
    CREDIT_CARD - кредитная карта;
  • •
    NOTARY_DEPOSIT - депозитный счёт для нотариуса;
  • •
    CORPORATE_CARD - счёт покрытия по корпоративным картам;
  • •
    LORO - счёт лоро
typeName
stringoptional

Наименование типа счёта. Принимает возможные значения: Расчётный счёт, Транзитный счёт, Депозитный счёт, Депозитный счёт для ИП, Налоговая копилка, Кредитная карта, Депозитный счёт для нотариуса, Счёт покрытия по корпоративным картам, Счёт лоро

openDate
stringoptional

Дата открытия счёта

currencyCode
stringoptional

Цифровой код валюты

transitAccountNumber
stringoptional

Парный транзитный счёт

array of objectsoptional

Спецусловия по счёту

code
stringoptional

Код спецусловия. Принимает возможные значения:

  • •
    AI12 - нельзя дебетовать;
  • •
    AI11 - нельзя кредитовать;
  • •
    AI14 - клиент закрыт;
  • •
    AI17 - счёт заблокирован;
  • •
    AI20 - неактивный счёт;
  • •
    AI30 - счёт закрыт;
  • •
    AI47 - внутренний счёт;
  • •
    AI82 - дебетование ограничено;
  • •
    AI83 - электронная картотека;
  • •
    AI87 - бумажная разновалютная картотека
description
stringoptional

Описание спецусловия

value
booleanoptional

Текущее значение. Принимает возможные значения:

  • •
    true - выполняется условие, прописанное в code;
  • •
    false - не выполняется условие, прописанное в code
clientName
stringoptional

Клиентское наименование счёта в рублях (или в валюте счёта)

amountBalance
numberoptional

Текущий остаток по счёту в рублях (или в валюте счёта)

amountTotal
numberoptional

Сумма доступных средств (без учёта овердрафта) в рублях (или в валюте счёта)

amountHolds
numberoptional

Сумма зарезервированных средств (холды) в рублях (или в валюте счёта)

amountOverdraftOwnFunds
numberoptional

Собственные средства в рублях (или в валюте счёта)

amountOverdraftLimit
numberoptional

Доступный лимит средств в рублях (или в валюте счёта)

array of objectsoptional

Заблокированные (арестованные) суммы на счёте

num
stringoptional

Номер решения

beginDate
stringoptional

Дата начала действия ограничения

cause
stringoptional

Основание ареста

initiator
stringoptional

Наименование органа, наложившего арест

sum
stringoptional

Заблокированная (арестованная) сумма на счёте

blockType
stringoptional

Бухгалтерский режим, к которому относится данное решение. Принимает возможные значения:

  • •
    OUTGOING_LIMITATION - полная блокировка;
  • •
    PARTIAL_BALANCE_BLOCK - блокировка части баланса
objectoptional

Информация о банке, где выпущен счёт

bic
stringoptional

БИК банка, где открыт счёт

correspondentAccountNumber
stringoptional

Номер корреспондентского счёта

Пример ответа 200 (OK) 
1{
2  "organizationId": "bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732",
3  "fullName": "Общество с ограниченной ответственностью \"Ромашка\"",
4  "shortName": "ООО \"Ромашка\"",
5  "inn": "114693784",
6  "organizationForm": {
7    "fullName": "Общество с ограниченной ответственностью",
8    "shortName": "ООО",
9    "type": "2014",
10    "code": "12300"
11  },
12  "kpps": [
13    "2427920",
14    "2427920"
15  ],
16  "ogrn": "1020203094163",
17  "okpo": "41294456",
18  "okved": "71.12",
19  "type": "LEGAL",
20  "phone": "79099876543",
21  "email": "client@example.com",
22  "category": "BANK",
23  "rsadr": "testtest.ru",
24  "status": "ACTIVE",
25  "registrationDate": "2000-01-23T04:56:07.000+00:00",
26  "addresses": [
27    {
28      "type": "FACT_FULL",
29      "area": "Тахтамукайский район",
30      "building": "1",
31      "city": "Майкоп",
32      "country": "643",
33      "flat": "123",
34      "fullAddress": "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3",
35      "house": "3",
36      "region": "Республика Адыгея",
37      "settlement": "Майкоп",
38      "settlementType": "г.",
39      "street": "улица Депутатская",
40      "zip": "385600",
41      "fiasCode": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
42    }
43  ],
44  "accounts": [
45    {
46      "number": "40702810002300001935",
47      "type": "PAYMENT",
48      "typeName": "Расчётный счёт",
49      "openDate": "2021-10-07",
50      "currencyCode": "810",
51      "transitAccountNumber": "40702978904100000001",
52      "specConditions": [
53        {
54          "code": "AI12",
55          "description": "Нельзя дебетовать",
56          "value": false
57        },
58        {
59          "code": "AI11",
60          "description": "Нельзя кредитовать",
61          "value": false
62        },
63        {
64          "code": "AI14",
65          "description": "Клиент закрыт",
66          "value": false
67        },
68        {
69          "code": "AI17",
70          "description": "Счёт заблокирован",
71          "value": true
72        },
73        {
74          "code": "AI20",
75          "description": "Неактивный счёт",
76          "value": false
77        },
78        {
79          "code": "AI30",
80          "description": "Счёт закрыт",
81          "value": false
82        },
83        {
84          "code": "AI47",
85          "description": "Внутренний счёт",
86          "value": false
87        },
88        {
89          "code": "AI82",
90          "description": "Дебетование ограничено",
91          "value": false
92        },
93        {
94          "code": "AI83",
95          "description": "Электронная картотека",
96          "value": false
97        },
98        {
99          "code": "AI87",
100          "description": "Бумажная разновалютная картотека",
101          "value": false
102        }
103      ],
104      "clientName": "Наименование",
105      "amountBalance": 810000,
106      "amountTotal": 100000,
107      "amountHolds": 100,
108      "amountOverdraftOwnFunds": 0.8008281904610115,
109      "amountOverdraftLimit": 100000,
110      "blockedSums": [
111        {
112          "num": "112233",
113          "beginDate": "2020-10-23",
114          "cause": "Неисполнение требования об уплате налога, сбора, пени, штрафа № 53228 от 05.11.2019 г",
115          "initiator": "Межрайонная ИФНС России № 51 по г. Москве",
116          "sum": "988800",
117          "blockType": "PARTIAL_BALANCE_BLOCK"
118        }
119      ],
120      "bank": {
121        "bic": "044525593",
122        "correspondentAccountNumber": "30101810200000000593"
123      }
124    }
125  ]
126}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - Неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request) 
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized) 
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent;
  • •
    insufficient_privileges - у пользователя нет прав на просмотр информации об организации;
  • •
    access_denied - доступ к счёту запрещён
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden) 
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found) 
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error) 
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа

Отправьте письмо на alfa_api@alfabank.ru, указав следующие данные:

  1. 1.
    client_id.
  2. 2.
    Дата и время запроса с указанием часового пояса.
  3. 3.
    Метод и URI запроса.
  4. 4.
    Заголовки и тело запроса.
  5. 5.
    Полученная ошибка и заголовки ответа, включая X-TraceId.
  6. 6.
    IP-адрес, с которого был отправлен запрос.
Получение профиля организацииКак это работает