H2H

Создание запроса на регистрацию бенефициара

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

beneficiaries

Описание

Метод позволяет зарегистрировать бенефициара (контрагента с признаком isBeneficiary = TRUE) в системе.

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

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
accountNumber
stringrequired

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

type
stringrequired

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

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

Признак налогового резидента США

foreignTaxResident
booleanrequired

Признак иностранного налогового резидента

financialActivities
booleanoptional

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

countryOfTaxResidence
stringrequired

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

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

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

objectoptional

Персональные данные. Заполняется только для бенефициаров физ. лиц и ИП

inn
stringoptional

ИНН. Поле обязательно для бенефициаров резидентов и нерезидентов ИП

firstName
stringrequired

Имя

middleName
stringoptional

Отчество

lastName
stringrequired

Фамилия

citizenship
stringrequired

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

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

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

birthPlace
stringrequired

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

snils
stringoptional

СНИЛС. Поле обязательно для бенефициаров-резидентов

phoneNumber
stringoptional

Телефон

email
stringoptional

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

array of objectsrequired

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

type
stringrequired

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

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

Адрес

country
stringrequired

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

array of objectsoptional

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

type
stringrequired

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

  • •
    PASSPORT - паспорт РФ;
  • •
    BIRTH_CERTIFICATE - свидетельство о рождении;
  • •
    MILITARY_ID_SOLDIER - военный билет солдата;
  • •
    PASSPORT_USSR - паспорт гражданина СССР;
  • •
    OFFICER_IDENTITY_CARD - удостоверение личности военнослужащего;
  • •
    DIPLOMATIC_PASSPORT_RU - дипломатический паспорт гражданина РФ;
  • •
    SEAMAN_IDENTITY_CARD - удостоверение личности моряка (паспорт моряка);
  • •
    MILITARY_ID_RESERVE - военный билет офицера запаса;
  • •
    TEMPORARY_ID_RU - временное удостоверение личности гражданина РФ;
  • •
    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;
  • •
    ID_CARD - ID карта. Передаётся, если citizenship не равен RU
serial
stringoptional

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

number
stringrequired

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

issueDate
stringrequired

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

expireDate
stringoptional

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

division
stringoptional

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

organization
stringrequired

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

array of objectsrequired

Электронная подпись УЛ клиента

base64Encoded
stringrequired

Значение электронной подписи, закодированное в Base64

signatureType
stringrequired

Тип электронной подписи. Возможные значения:

  • •
    RSA - RSA;
  • •
    KEP - КЭП
Пример запроса
Язык 
1curl --location 'https://baas.alfabank.ru/api/na/jp/v1/beneficiaries' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data-raw '{
6  "accountNumber": "40817810306050000000",
7  "type": "FL_RESIDENT",
8  "taxResidentUS": false,
9  "foreignTaxResident": false,
10  "financialActivities": false,
11  "countryOfTaxResidence": "RU",
12  "name": "Акционерное общество «Ромашка»",
13  "registrationDate": "2026-05-28",
14  "inn": "0123456789",
15  "kpp": "0123456789",
16  "ogrn": "0123456789101",
17  "personalInformation": {
18    "inn": "112233445566",
19    "firstName": "Иван",
20    "middleName": "Иванoвич",
21    "lastName": "Иванов",
22    "citizenship": "RU",
23    "birthDate": "2000-03-02",
24    "birthPlace": "Г. Иркутск",
25    "snils": 12345678910
26  },
27  "phoneNumber": "79130000011",
28  "email": "IvanovIvan@mail.ru",
29  "addresses": [
30    {
31      "type": "REGISTRATION_ADDRESS",
32      "address": "ул. Максима Горького 55",
33      "country": "RU"
34    }
35  ],
36  "documents": [
37    {
38      "type": "PASSPORT",
39      "serial": "6953",
40      "number": "987435",
41      "issueDate": "2022-03-02",
42      "expireDate": "2022-03-02",
43      "division": "123-321",
44      "organization": "ОВД Иркутской области по Г. Иркутску по Октябрьскому району"
45    }
46  ],
47  "digestSignatures": [
48    {
49      "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
50      "signatureType": "RSA"
51    }
52  ]
53}'
Параметры ответа
Пример ответа 202 (Accepted) 
1{
2  "requestId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "status": "COMPLETE"
4}
BODY
атрибут
описание
requestId
stringrequired

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

status
stringrequired

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

  • •
    PENDING - запрос в процессе обработки;
  • •
    FAILED - обработка запроса завершилась ошибкой;
  • •
    COMPLETE - обработка запроса завершилась успешно
Пример ответа 202 (Accepted) 
1{
2  "requestId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "status": "COMPLETE"
4}
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}
Нет тела ответа
Получение статуса запросаСоздание запроса на изменение информации о бенефициаре