H2H

Создание запроса на изменение информации о бенефициаре

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

beneficiaries

Описание

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

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

application/json

Content-Type
stringrequired

application/json

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

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

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

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

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

Налоговый резидент США

foreignTaxResident
booleanoptional

Иностранный налоговый резидент

financialActivities
booleanoptional

Признак осуществления финансовой деятельности

сountryOfTaxResidence
stringoptional

Страна налогового резидентства по стандарту ISO 3166-1 alpha-2

ogrn
stringoptional

ОГРН

name
stringoptional

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

registrationDate
stringoptional

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

objectoptional

Обновленные персональные данные. Заполняется для бенефициаров с типом FL_RESIDENT

firstName
stringoptional

Имя

middleName
stringoptional

Отчество

lastName
stringoptional

Фамилия

birthDate
stringoptional

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

birthPlace
stringoptional

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

phoneNumber
stringoptional

Телефон

email
stringoptional

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

array of objectsoptional

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

type
stringrequired

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

  • •
    REGISTRATION_ADDRESS - адрес регистрации;
  • •
    LEGAL_ENTITY_ADDRESS - адрес юр.лица
address
stringrequired

Адрес

array of objectsoptional

Паспорт гражданина РФ. Заполняется если citizenship равен RU

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
stringrequired

Серия паспорта РФ

number
stringrequired

Номер паспорта РФ

issueDate
stringrequired

Дата выдачи паспорта

division
stringrequired

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

organization
stringrequired

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

isActive
booleanoptional

Статус активности бенефициара

array of objectsrequired

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

base64Encoded
stringrequired

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

signatureType
stringrequired

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

  • •
    RSA - RSA;
  • •
    KEP - КЭП
Пример запроса
Язык 
1curl --location --globoff --request PUT 'https://baas.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data-raw '{
6  "type": "FL_RESIDENT",
7  "taxResidentUS": false,
8  "foreignTaxResident": false,
9  "financialActivities": false,
10  "сountryOfTaxResidence": "RU",
11  "ogrn": "0123456789101",
12  "name": "Акционерное общество «Ромашка»",
13  "registrationDate": "2026-05-28",
14  "personalInformation": {
15    "firstName": "Иван",
16    "middleName": "Иванoвич",
17    "lastName": "Иванов",
18    "birthDate": "2000-03-02",
19    "birthPlace": "Г. Иркутск"
20  },
21  "phoneNumber": "79130000011",
22  "email": "IvanovIvan@mail.ru",
23  "addresses": [
24    {
25      "type": "REGISTRATION_ADDRESS",
26      "address": "ул. Максима Горького 55"
27    }
28  ],
29  "documents": [
30    {
31      "type": "PASSPORT",
32      "serial": "6953",
33      "number": "987435",
34      "issueDate": "2022-03-02",
35      "division": "123-321",
36      "organization": "ОВД Иркутской области по Г. Иркутску по Октябрьскому району"
37    }
38  ],
39  "isActive": true,
40  "digestSignatures": [
41    {
42      "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
43      "signatureType": "RSA"
44    }
45  ]
46}'
Параметры ответа
Пример ответа 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}
Нет тела ответа
Создание запроса на регистрацию бенефициараПолучение списка бенефициаров номинального счёта