B2BH2H

Получение данных ЮЛ в СБП

Песочница
GET https://sandbox.alfabank.ru/api/jp/v1/legal
Пром
GET https://baas.alfabank.ru/api/jp/v1/legal
Scope

sbp_terminals_reg

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

application/json

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/jp/v1/legal' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "legalId": "LA0000004756",
3  "lastName": null,
4  "firstName": null,
5  "middleName": null,
6  "name": "ООО \"ТехноНИКОЛЬ-Строительные Системы\"",
7  "type": "ООО",
8  "inn": "7706812159",
9  "kpp": "770501001",
10  "ogrn": "1147746831352",
11  "contractNumber": "СБПС2В-20200911",
12  "contractDate": "2020-09-11",
13  "status": "2",
14  "address": {
15    "zip": "125362",
16    "country": "RU",
17    "region": "45",
18    "settlementType": "г.",
19    "settlement": "Москва",
20    "streetType": "ул.",
21    "street": "Подмосковная",
22    "house": "21"
23  },
24  "accounts": [
25    {
26      "memberId": "600000000015",
27      "accountNumber": "40201810100000012345",
28      "type": "LegalAct",
29      "forB2C": "1"
30    }
31  ],
32  "merchants": [
33    {
34      "merchantId": "MA0000002752",
35      "status": "2"
36    }
37  ]
38}
BODY
атрибут
описание
legalId
stringoptional

Регистрационный номер ЮЛ в СБП

lastName
stringoptional

Фамилия

firstName
stringoptional

Имя

middleName
stringoptional

Отчество

name
stringoptional

Наименование ЮЛ

type
stringoptional

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

inn
stringoptional

ИНН ЮЛ

kpp
stringoptional

КПП ЮЛ (отсутствует в случае ИП)

ogrn
stringoptional

ОГРН ЮЛ

contractNumber
stringoptional

Номер договора на обслуживание

contractDate
stringoptional

Дата заключения договора на обслуживание

status
stringoptional

Код текущего статуса ЮЛ. Принимает возможные значения:

  • •
    1 - новый;
  • •
    2 - зарегистрирован;
  • •
    3 - на удаление;
  • •
    4 - запрошена регистрация
objectoptional

Информация о фактическом адресе

zip
stringoptional

Индекс

country
stringoptional

Код страны

region
stringoptional

Код региона по ОКТМО (первые два символа)

settlementType
stringoptional

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

settlement
stringoptional

Наименование населённого пункта

streetType
stringoptional

Тип улицы

street
stringoptional

Наименование улицы

house
stringoptional

Номер дома

array of objectsoptional

Информация о счетах ЮЛ

memberId
stringoptional

Идентификатор Банка участника СБП

accountNumber
stringoptional

Номер счёта

type
stringoptional

Тип счёта

forB2C
stringoptional

Признак счёта для отправки переводов B2C

array of objectsoptional

Данные о торгово-сервисных предприятиях (ТСП), связанных с ЮЛ

merchantId
stringoptional

Регистрационный номер ТСП в СБП

status
stringoptional

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

  • •
    1 - новый;
  • •
    2 - зарегистрирован;
  • •
    3 - на удаление
Пример ответа 200 (OK)
1{
2  "legalId": "LA0000004756",
3  "lastName": null,
4  "firstName": null,
5  "middleName": null,
6  "name": "ООО \"ТехноНИКОЛЬ-Строительные Системы\"",
7  "type": "ООО",
8  "inn": "7706812159",
9  "kpp": "770501001",
10  "ogrn": "1147746831352",
11  "contractNumber": "СБПС2В-20200911",
12  "contractDate": "2020-09-11",
13  "status": "2",
14  "address": {
15    "zip": "125362",
16    "country": "RU",
17    "region": "45",
18    "settlementType": "г.",
19    "settlement": "Москва",
20    "streetType": "ул.",
21    "street": "Подмосковная",
22    "house": "21"
23  },
24  "accounts": [
25    {
26      "memberId": "600000000015",
27      "accountNumber": "40201810100000012345",
28      "type": "LegalAct",
29      "forB2C": "1"
30    }
31  ],
32  "merchants": [
33    {
34      "merchantId": "MA0000002752",
35      "status": "2"
36    }
37  ]
38}
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
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}
Нет тела ответа