H2H

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

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

beneficiaries

Описание

Метод позволяет получить информацию о бенефициаре по beneficiaryId.

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

application/json

PATH
Атрибут
Описание
beneficiaryId
stringrequired

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

Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "accountNumber": "40817810306050000000",
4  "type": "FL_RESIDENT",
5  "personalInformation": {
6    "inn": "112233445566",
7    "firstName": "Иван",
8    "middleName": "Иванoвич",
9    "lastName": "Иванов",
10    "citizenship": "RU",
11    "birthDate": "2000-03-02",
12    "birthPlace": "Г. Иркутск",
13    "snils": 12345678910
14  },
15  "countryOfTaxResidence": "RU",
16  "phoneNumber": "79130000011",
17  "email": "IvanovIvan@mail.ru",
18  "addresses": [
19    {
20      "type": "REGISTRATION_ADDRESS",
21      "address": "ул. Пушкина 55",
22      "index": "123456",
23      "region_code": "77",
24      "uin": "550e8400-e29b-41d4-a716-446655440000",
25      "municipal_district": {
26        "type_code": 1,
27        "name": "Ленинский муниципальный район"
28      },
29      "settlement": {
30        "type_code": 1,
31        "name": "Городское поселение Ленинское"
32      },
33      "locality": {
34        "type": "город",
35        "name": "Ленинск"
36      },
37      "planning_structure": {
38        "type": "микрорайон",
39        "name": "Центральный"
40      },
41      "street_network": {
42        "type": "улица",
43        "name": "Ленина"
44      },
45      "buildings": [
46        {
47          "type": "дом",
48          "name": "3"
49        }
50      ],
51      "building_premises": {
52        "type": "квартира",
53        "name": "42"
54      },
55      "flat_premises": {
56        "type": "комната",
57        "name": "гостиная"
58      }
59    }
60  ],
61  "documents": [
62    {
63      "type": "PASSPORT",
64      "serial": "6953",
65      "number": "987435",
66      "issueDate": "2022-03-02",
67      "expireDate": "2022-03-02",
68      "division": "123-321",
69      "organization": "ОВД Иркутской области по Г. Иркутску по Октябрьскому району"
70    }
71  ],
72  "name": "Акционерное общество «Ромашка»",
73  "registrationDate": "2026-05-28",
74  "inn": "0123456789",
75  "kpp": "0123456789",
76  "ogrn": "0123456789101",
77  "isActive": true,
78  "actualizationDateExpire": "2026-05-28",
79  "balances": [
80    {
81      "walletType": "MAIN",
82      "freeBalance": 10,
83      "heldBalance": 10
84    }
85  ],
86  "isBeneficiary": true,
87  "isVpr": true
88}
BODY
атрибут
описание
beneficiaryId
stringoptional

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

accountNumber
stringoptional

Номер номинального счёта

type
stringoptional

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

  • •
    FL_RESIDENT - физ. лицо, резидент;
  • •
    FL_NONRESIDENT - физ. лицо, нерезидент;
  • •
    UL_RESIDENT - юр. лицо, резидент;
  • •
    UL_NONRESIDENT - юр. лицо, нерезидент;
  • •
    IP_RESIDENT - ИП, резидент;
  • •
    IP_NONRESIDENT - ИП, нерезидент
objectoptional

Персональные данные. Возвращается только для бенефициаров, являющихся физическими лицами и ИП

inn
stringoptional

ИНН

firstName
stringoptional

Имя

middleName
stringoptional

Отчество

lastName
stringoptional

Фамилия

citizenship
stringoptional

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

  • •
    RU - РФ;
  • •
    BY - Беларусь;
  • •
    AM - Армения;
  • •
    KZ - Казахстан;
  • •
    KG - Киргизия
birthDate
stringoptional

Дата рождения

birthPlace
stringoptional

Место рождения

snils
stringoptional

СНИЛС

countryOfTaxResidence
stringoptional

Страна налогового резидентства. Код страны в формате ISO 3166-1 alpha-2

phoneNumber
stringoptional

Телефон

email
stringoptional

Адрес электронной почты

array of objectsoptional

Адрес бенефициара

type
stringoptional

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

  • •
    REGISTRATION_ADDRESS - адрес регистрации;
  • •
    RESIDENCE_ADDRESS - адрес регистрации по месту пребывания;
  • •
    LEGAL_ENTITY_ADDRESS - адрес юр.лица
address
stringoptional

Полный адрес

index
stringoptional

Почтовый индекс

region_code
stringoptional

Код региона

uin
stringoptional

Уникальный идентификатор адреса

objectoptional

Муниципальный район

type_code
integeroptional

Тип муниципального района

name
stringoptional

Название муниципального района

objectoptional

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

type_code
integeroptional

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

name
stringoptional

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

objectoptional

Населенная местность

type
stringoptional

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

name
stringoptional

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

objectoptional

Планировочная структура

type
stringoptional

Тип планировочной структуры

name
stringoptional

Название планировочной структуры

objectoptional

Элемент улично-дорожной сети

type
stringoptional

Тип элемента улично-дорожной сети

name
stringoptional

Название элемента улично-дорожной сети

array of objectsoptional

Здание/сооружение

type
stringoptional

Тип здания/сооружения

name
stringoptional

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

objectoptional

Тип помещения в здании

type
stringoptional

Тип помещения в здании

name
stringoptional

Номер/название помещения

objectoptional

Тип помещения в квартире

type
stringoptional

Тип помещения в квартире

name
stringoptional

Название помещения

array of objectsoptional

Документы. Для резидентов обязательный документ - PASSPORT. Для нерезидентов с гражданством BY достаточно одного документа с типом FOREIGN_PASSPORT. Для остальных нерезидентов обязательно не менее 2 документов

type
stringoptional

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

  • •
    PASSPORT - паспорт РФ;
  • •
    FOREIGN_PASSPORT - паспорт иностранного гражданина. Передаётся, если citizenship равен BY, AM, KZ, KG;
  • •
    RESIDENCE_PERMIT - вид на жительство, подтверждающий право проживания на территории РФ. Передаётся, если citizenship равен AM, KZ, KG;
  • •
    RESIDENCE_CERTIFICATE - документ, удостоверяющий проживание на территории РФ. Передаётся, если citizenship равен AM, KZ, KG;
  • •
    MIGRATION_CARD - миграционная карта, подтверждающая право проживания на территории РФ. Передаётся, если citizenship равен AM, KZ, KG
serial
stringoptional

Серия документа

number
stringoptional

Номер документа

issueDate
stringoptional

Дата выдачи документа

expireDate
stringoptional

Дата истечения документа

division
stringoptional

Код подразделения, выдавшего документ

organization
stringoptional

Орган, выдавший документ

name
stringoptional

Наименование организации. Возвращается только для бенефициаров с типом UL_RESIDENT или UL_NONRESIDENT

registrationDate
stringoptional

Дата регистрации. Возвращается только для бенефициаров с типом UL_RESIDENT или UL_NONRESIDENT

inn
stringoptional

ИНН. Возвращается только для бенефициаров с типом UL_RESIDENT или UL_NONRESIDENT. Для физ. лиц и ИП ИНН возвращается в объекте personalInformation

kpp
stringoptional

КПП. Возвращается только для бенефициаров с типом UL_RESIDENT

ogrn
stringoptional

Основной государственный регистрационный номер

isActive
booleanoptional

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

  • •
    true - активен;
  • •
    false - деактивирован
actualizationDateExpire
stringoptional

Дата, после которой данные считаются неактуальными

array of objectsoptional

Балансы бенефициара

walletType
stringoptional

Тип кошелька. Принимает возможные значения:

  • •
    MAIN - основной кошелек;
  • •
    TAX - налоговый кошелек
freeBalance
integeroptional

Свободные денежные средства в рублях

heldBalance
integeroptional

Захолдированные денежные средства в рублях

isBeneficiary
booleanoptional

Признак бенефициара. Принимает возможные значения:

  • •
    true - является бенефициаром;
  • •
    false - является универсальным реципиентом
isVpr
booleanoptional

Признак ВПР. Принимает возможные значения:

  • •
    true - является выгодоприобретателем;
  • •
    false - не является выгодоприобретателем
Пример ответа 200 (OK) 
1{
2  "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "accountNumber": "40817810306050000000",
4  "type": "FL_RESIDENT",
5  "personalInformation": {
6    "inn": "112233445566",
7    "firstName": "Иван",
8    "middleName": "Иванoвич",
9    "lastName": "Иванов",
10    "citizenship": "RU",
11    "birthDate": "2000-03-02",
12    "birthPlace": "Г. Иркутск",
13    "snils": 12345678910
14  },
15  "countryOfTaxResidence": "RU",
16  "phoneNumber": "79130000011",
17  "email": "IvanovIvan@mail.ru",
18  "addresses": [
19    {
20      "type": "REGISTRATION_ADDRESS",
21      "address": "ул. Пушкина 55",
22      "index": "123456",
23      "region_code": "77",
24      "uin": "550e8400-e29b-41d4-a716-446655440000",
25      "municipal_district": {
26        "type_code": 1,
27        "name": "Ленинский муниципальный район"
28      },
29      "settlement": {
30        "type_code": 1,
31        "name": "Городское поселение Ленинское"
32      },
33      "locality": {
34        "type": "город",
35        "name": "Ленинск"
36      },
37      "planning_structure": {
38        "type": "микрорайон",
39        "name": "Центральный"
40      },
41      "street_network": {
42        "type": "улица",
43        "name": "Ленина"
44      },
45      "buildings": [
46        {
47          "type": "дом",
48          "name": "3"
49        }
50      ],
51      "building_premises": {
52        "type": "квартира",
53        "name": "42"
54      },
55      "flat_premises": {
56        "type": "комната",
57        "name": "гостиная"
58      }
59    }
60  ],
61  "documents": [
62    {
63      "type": "PASSPORT",
64      "serial": "6953",
65      "number": "987435",
66      "issueDate": "2022-03-02",
67      "expireDate": "2022-03-02",
68      "division": "123-321",
69      "organization": "ОВД Иркутской области по Г. Иркутску по Октябрьскому району"
70    }
71  ],
72  "name": "Акционерное общество «Ромашка»",
73  "registrationDate": "2026-05-28",
74  "inn": "0123456789",
75  "kpp": "0123456789",
76  "ogrn": "0123456789101",
77  "isActive": true,
78  "actualizationDateExpire": "2026-05-28",
79  "balances": [
80    {
81      "walletType": "MAIN",
82      "freeBalance": 10,
83      "heldBalance": 10
84    }
85  ],
86  "isBeneficiary": true,
87  "isVpr": true
88}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
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}
Нет тела ответа
Получение списка бенефициаров номинального счётаСоздание запроса на проверку бенефициара