H2H

Получение списка бенефициаров номинального счёта

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

beneficiaries

Описание

Метод позволяет получить список бенефициаров номинального счёта.

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

application/json

QUERY
Атрибут
Описание
limit
integeroptional

Количество объектов на одной странице

offset
integeroptional

Количество объектов в списке, которые необходимо пропустить

accountNumber
stringrequired

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

type
stringrequired

Тип бенефициара. Возможные значения:

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

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

middleName
stringoptional

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

lastName
stringoptional

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

inn
stringoptional

ИНН. Может состоять либо из 10 цифр (для юридических лиц), либо из 12 цифр (для физических лиц и ИП)

kpp
stringoptional

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

name
stringoptional

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

ogrn
stringoptional

Основной государственный регистрационный номер. Заполняется только для бенефициаров с типом UL_RESIDENT

isVpr
booleanoptional

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

  • •
    true - является выгодоприобретателем;
  • •
    false - не является выгодоприобретателем
isActive
booleanoptional

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

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

Дата выборки

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

Данные пагинации

limit
numberoptional

Количество записей на одной странице

offset
numberoptional

Количество записей в списке, которые были пропущены

totalCount
numberoptional

Общее количество записей

accountNumber
stringoptional

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

date
stringoptional

Дата выборки

array of objectsoptional

Информация о бенефициарах

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