Создать бенефициара

/api/v1/nominal-accounts/beneficiaries

POST

https://secured-openapi.tbank.ru/api/v1/nominal-accounts/beneficiaries

Метод создаёт бенефициара и возвращает его с ID, который нужен для дальнейшей работы.

Ограничение на использование метода — 10 запросов в секунду.

Чтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage — Управление номинальными счетами.

Заполняемые данные будут отличаться в зависимости от типа бенефициара — например, физическое лицо-резидент или физическое лицо-нерезидент. Примеры данных по каждому из типов приведены ниже.

Авторизация

Security

Bearer API Token

MTLS-сертификат

Запрос

Header parameters

Required

Idempotency-Key

String<uuid>

Ключ идемпотентности. Подробнее.

Request body schema application/json

oneOf

BeneficiaryFlNonresidentRequest

Required

type

String

Requirements: [FL_RESIDENT, FL_NONRESIDENT, UL_RESIDENT, UL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT, LITE_CONTACT]

Тип бенефициара:

• FL_RESIDENT — физическое лицо, резидент.
• FL_NONRESIDENT — физическое лицо, нерезидент.
• UL_RESIDENT — юридическое лицо, резидент.
• UL_NONRESIDENT — юридическое лицо, нерезидент.
• IP_RESIDENT — ИП, резидент.
• IP_NONRESIDENT — ИП, нерезидент.
• LITE_CONTACT — лёгкий контакт.

Required

firstName

String

Имя.

middleName

String

Отчество.

Required

lastName

String

Фамилия.

Required

isSelfEmployed

Boolean

Самозанятый.

Required

birthDate

String<date>

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

birthPlace

String

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

Required

citizenship

String

Requirements: Value must match regular expression ^([A-Z]{2})$

Гражданство. Код страны в формате ISO 3166-1 alpha-2.

phoneNumber

String

Requirements: Value must match regular expression ^((\+[0-9])([0-9]){6,14})$

Номер телефона. phoneNumber или email обязателен к заполнению.

email

String

Электронная почта. phoneNumber или email обязателен к заполнению.

Required

documents

Array of objects ()

Requirements: >= 1 items

Документы. Обязательно — минимум 2.

В большинстве случаев основной документ нерезидента РФ — FOREIGN_PASSPORT. Второй документ — любой из документов, подтверждающих право на пребывание в РФ. Подробнее о документах.

Для нерезидентов с гражданством BY достаточно одного документа с типом FOREIGN_PASSPORT.

oneOf

Contract

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

ContractGPD

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

DiplomaticPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassportOfForeignCitizens

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

MigrationCard

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

OfficialPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

Passport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

organization

String

Кем выдан.

Required

division

String

Requirements: Value must match regular expression ^(\d{3}-\d{3})$

Код подразделения.

Patent

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

ResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

TemporaryResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Visa

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Required

addresses

Array of objects ()

Requirements: >= 1 items

Адреса.

Required

type

String

Requirements: [POSTAL_ADDRESS, REGISTRATION_ADDRESS, RESIDENCE_ADDRESS, LEGAL_ENTITY_ADDRESS, OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS]

Тип адреса. Для типов FL_RESIDENT, FL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT обязателен один из адресов:

• REGISTRATION_ADDRESS — адрес регистрации по месту жительства;
• RESIDENCE_ADDRESS — адрес регистрации по месту пребывания.

Для типов UL_RESIDENT, UL_NONRESIDENT обязательно передавать LEGAL_ENTITY_ADDRESS — адрес юридического лица.

Required

address

String

Requirements: <= 256 characters

Адрес.

inn

String

Requirements: Value must match regular expression ^(\d{12})$

ИНН.

BeneficiaryFlResidentRequest

Required

type

String

Requirements: [FL_RESIDENT, FL_NONRESIDENT, UL_RESIDENT, UL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT, LITE_CONTACT]

Тип бенефициара:

• FL_RESIDENT — физическое лицо, резидент.
• FL_NONRESIDENT — физическое лицо, нерезидент.
• UL_RESIDENT — юридическое лицо, резидент.
• UL_NONRESIDENT — юридическое лицо, нерезидент.
• IP_RESIDENT — ИП, резидент.
• IP_NONRESIDENT — ИП, нерезидент.
• LITE_CONTACT — лёгкий контакт.

Required

firstName

String

Имя.

middleName

String

Отчество.

Required

lastName

String

Фамилия.

Required

isSelfEmployed

Boolean

Самозанятый.

Required

birthDate

String<date>

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

birthPlace

String

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

Required

citizenship

String

Requirements: Value must match regular expression ^([A-Z]{2})$

Гражданство. Код страны в формате ISO 3166-1 alpha-2.

phoneNumber

String

Requirements: Value must match regular expression ^((\+[0-9])([0-9]){6,14})$

Номер телефона. Номер телефона или электронная почта обязательны к заполнению.

email

String

Электронная почта. Номер телефона или электронная почта обязательны к заполнению.

Required

documents

Array of objects ()

Requirements: >= 1 items

Документы. Обязательный тип для физического лица-резидента — PASSPORT.

oneOf

Contract

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

ContractGPD

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

DiplomaticPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassportOfForeignCitizens

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

MigrationCard

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

OfficialPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

Passport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

organization

String

Кем выдан.

Required

division

String

Requirements: Value must match regular expression ^(\d{3}-\d{3})$

Код подразделения.

Patent

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

ResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

TemporaryResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Visa

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Required

addresses

Array of objects ()

Requirements: >= 1 items

Адреса

Required

type

String

Requirements: [POSTAL_ADDRESS, REGISTRATION_ADDRESS, RESIDENCE_ADDRESS, LEGAL_ENTITY_ADDRESS, OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS]

Тип адреса. Для типов FL_RESIDENT, FL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT обязателен один из адресов:

• REGISTRATION_ADDRESS — адрес регистрации по месту жительства;
• RESIDENCE_ADDRESS — адрес регистрации по месту пребывания.

Для типов UL_RESIDENT, UL_NONRESIDENT обязательно передавать LEGAL_ENTITY_ADDRESS — адрес юридического лица.

Required

address

String

Requirements: <= 256 characters

Адрес.

inn

String

Requirements: Value must match regular expression ^(\d{12})$

ИНН

snils

String

Requirements: Value must match regular expression ^(\d{11})$

СНИЛС

BeneficiaryIpNonresidentRequest

Required

type

String

Requirements: [FL_RESIDENT, FL_NONRESIDENT, UL_RESIDENT, UL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT, LITE_CONTACT]

Тип бенефициара:

• FL_RESIDENT — физическое лицо, резидент.
• FL_NONRESIDENT — физическое лицо, нерезидент.
• UL_RESIDENT — юридическое лицо, резидент.
• UL_NONRESIDENT — юридическое лицо, нерезидент.
• IP_RESIDENT — ИП, резидент.
• IP_NONRESIDENT — ИП, нерезидент.
• LITE_CONTACT — лёгкий контакт.

Required

firstName

String

Имя.

middleName

String

Отчество.

Required

lastName

String

Фамилия.

Required

birthDate

String<date>

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

birthPlace

String

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

Required

citizenship

String

Requirements: Value must match regular expression ^([A-Z]{2})$

Гражданство. Код страны в формате ISO 3166-1 alpha-2.

phoneNumber

String

Requirements: Value must match regular expression ^((\+[0-9])([0-9]){6,14})$

Номер телефона. phoneNumber или email обязателен к заполнению.

email

String

Электронная почта. phoneNumber или email обязателен к заполнению.

Required

documents

Array of objects ()

Requirements: >= 1 items

Документы. Обязательно — минимум 2 документа. Основной документ нерезидента РФ в большинстве случаев — FOREIGN_PASSPORT. Второй документ — любой из документов, подтверждающих право на пребывание в РФ. Подробнее о документах.

Для нерезидентов с гражданством BY достаточно 1 документа с типом FOREIGN_PASSPORT

oneOf

Contract

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

ContractGPD

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

DiplomaticPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassportOfForeignCitizens

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

MigrationCard

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

OfficialPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

Passport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

organization

String

Кем выдан.

Required

division

String

Requirements: Value must match regular expression ^(\d{3}-\d{3})$

Код подразделения.

Patent

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

ResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

TemporaryResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Visa

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Required

addresses

Array of objects ()

Requirements: >= 1 items

Адреса.

Required

type

String

Requirements: [POSTAL_ADDRESS, REGISTRATION_ADDRESS, RESIDENCE_ADDRESS, LEGAL_ENTITY_ADDRESS, OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS]

Тип адреса. Для типов FL_RESIDENT, FL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT обязателен один из адресов:

• REGISTRATION_ADDRESS — адрес регистрации по месту жительства;
• RESIDENCE_ADDRESS — адрес регистрации по месту пребывания.

Для типов UL_RESIDENT, UL_NONRESIDENT обязательно передавать LEGAL_ENTITY_ADDRESS — адрес юридического лица.

Required

address

String

Requirements: <= 256 characters

Адрес.

Required

registrationDate

String<date>

Дата регистрации.

Required

inn

String

Requirements: Value must match regular expression ^(\d{12})$

ИНН.

ogrn

String

Requirements: Value must match regular expression ^(\d{15})$

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

BeneficiaryIpResidentRequest

Required

type

String

Requirements: [FL_RESIDENT, FL_NONRESIDENT, UL_RESIDENT, UL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT, LITE_CONTACT]

Тип бенефициара:

• FL_RESIDENT — физическое лицо, резидент.
• FL_NONRESIDENT — физическое лицо, нерезидент.
• UL_RESIDENT — юридическое лицо, резидент.
• UL_NONRESIDENT — юридическое лицо, нерезидент.
• IP_RESIDENT — ИП, резидент.
• IP_NONRESIDENT — ИП, нерезидент.
• LITE_CONTACT — лёгкий контакт.

Required

firstName

String

Имя.

middleName

String

Отчество.

Required

lastName

String

Фамилия.

Required

birthDate

String<date>

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

birthPlace

String

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

Required

citizenship

String

Requirements: Value must match regular expression ^([A-Z]{2})$

Гражданство. Код страны в формате ISO 3166-1 alpha-2.

phoneNumber

String

Requirements: Value must match regular expression ^((\+[0-9])([0-9]){6,14})$

Номер телефона. phoneNumber или email обязателен к заполнению.

email

String

Электронная почта. phoneNumber или email обязателен к заполнению.

Required

documents

Array of objects ()

Requirements: >= 1 items

Документы. Для ИП резидента обязателен тип PASSPORT.

oneOf

Contract

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

ContractGPD

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

DiplomaticPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

ForeignPassportOfForeignCitizens

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

MigrationCard

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

OfficialPassport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

organization

String

Кем выдан.

Passport

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

organization

String

Кем выдан.

Required

division

String

Requirements: Value must match regular expression ^(\d{3}-\d{3})$

Код подразделения.

Patent

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

ResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

serial

String

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

Required

number

String

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

Required

date

String<date>

Дата выдачи.

expireDate

String<date>

Дата истечения.

TemporaryResidencePermit

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Visa

Required

type

String

Requirements: [PASSPORT, FOREIGN_PASSPORT, FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS, OFFICIAL_PASSPORT, DIPLOMATIC_PASSPORT, MIGRATION_CARD, TEMPORARY_RESIDENCE_PERMIT, VISA, RESIDENCE_PERMIT, CONTRACT, CONTRACT_GPD, PATENT]

Тип документа.

Required

number

String

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

Required

date

String<date>

Дата выдачи.

Required

expireDate

String<date>

Дата истечения.

Required

addresses

Array of objects ()

Requirements: >= 1 items

Адреса.

Required

type

String

Requirements: [POSTAL_ADDRESS, REGISTRATION_ADDRESS, RESIDENCE_ADDRESS, LEGAL_ENTITY_ADDRESS, OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS]

Тип адреса. Для типов FL_RESIDENT, FL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT обязателен один из адресов:

• REGISTRATION_ADDRESS — адрес регистрации по месту жительства;
• RESIDENCE_ADDRESS — адрес регистрации по месту пребывания.

Для типов UL_RESIDENT, UL_NONRESIDENT обязательно передавать LEGAL_ENTITY_ADDRESS — адрес юридического лица.

Required

address

String

Requirements: <= 256 characters

Адрес.

Required

registrationDate

String<date>

Дата регистрации.

Required

inn

String

Requirements: Value must match regular expression ^(\d{12})$

ИНН.

ogrn

String

Requirements: Value must match regular expression ^(\d{15})$

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

BeneficiaryLiteContactRequest

Required

type

String

Requirements: [FL_RESIDENT, FL_NONRESIDENT, UL_RESIDENT, UL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT, LITE_CONTACT]

Тип бенефициара:

• FL_RESIDENT — физическое лицо, резидент.
• FL_NONRESIDENT — физическое лицо, нерезидент.
• UL_RESIDENT — юридическое лицо, резидент.
• UL_NONRESIDENT — юридическое лицо, нерезидент.
• IP_RESIDENT — ИП, резидент.
• IP_NONRESIDENT — ИП, нерезидент.
• LITE_CONTACT — лёгкий контакт.

BeneficiaryUlNonresidentRequest

Required

type

String

Requirements: [FL_RESIDENT, FL_NONRESIDENT, UL_RESIDENT, UL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT, LITE_CONTACT]

Тип бенефициара:

• FL_RESIDENT — физическое лицо, резидент.
• FL_NONRESIDENT — физическое лицо, нерезидент.
• UL_RESIDENT — юридическое лицо, резидент.
• UL_NONRESIDENT — юридическое лицо, нерезидент.
• IP_RESIDENT — ИП, резидент.
• IP_NONRESIDENT — ИП, нерезидент.
• LITE_CONTACT — лёгкий контакт.

Required

name

String

Наименование организации.

phoneNumber

String

Requirements: Value must match regular expression ^((\+[0-9])([0-9]){6,14})$

Номер телефона. phoneNumber или email обязателен к заполнению.

email

String

Электронная почта. phoneNumber или email обязателен к заполнению.

Required

addresses

Array of objects ()

Requirements: >= 1 items

Адреса.

Required

type

String

Requirements: [POSTAL_ADDRESS, REGISTRATION_ADDRESS, RESIDENCE_ADDRESS, LEGAL_ENTITY_ADDRESS, OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS]

Тип адреса. Для типов FL_RESIDENT, FL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT обязателен один из адресов:

• REGISTRATION_ADDRESS — адрес регистрации по месту жительства;
• RESIDENCE_ADDRESS — адрес регистрации по месту пребывания.

Для типов UL_RESIDENT, UL_NONRESIDENT обязательно передавать LEGAL_ENTITY_ADDRESS — адрес юридического лица.

Required

address

String

Requirements: <= 256 characters

Адрес.

nza

String

Номер записи об аккредитации.

Required

registrationDate

String<date>

Дата регистрации.

Required

registrationNumber

String

Номер регистрации.

opf

String

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

inn

String

Requirements: Value must match regular expression ^(\d{10})$

ИНН.

kio

String

Код иностранной организации. Обязателен, если ИНН не задан.

BeneficiaryUlResidentRequest

Required

type

String

Requirements: [FL_RESIDENT, FL_NONRESIDENT, UL_RESIDENT, UL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT, LITE_CONTACT]

Тип бенефициара:

• FL_RESIDENT — физическое лицо, резидент.
• FL_NONRESIDENT — физическое лицо, нерезидент.
• UL_RESIDENT — юридическое лицо, резидент.
• UL_NONRESIDENT — юридическое лицо, нерезидент.
• IP_RESIDENT — ИП, резидент.
• IP_NONRESIDENT — ИП, нерезидент.
• LITE_CONTACT — лёгкий контакт.

name

String

Наименование организации.

phoneNumber

String

Requirements: Value must match regular expression ^((\+[0-9])([0-9]){6,14})$

Номер телефона. phoneNumber или email обязателен к заполнению.

email

String

Электронная почта. phoneNumber или email обязателен к заполнению.

addresses

Array of objects ()

Адреса.

Required

type

String

Requirements: [POSTAL_ADDRESS, REGISTRATION_ADDRESS, RESIDENCE_ADDRESS, LEGAL_ENTITY_ADDRESS, OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS]

Тип адреса. Для типов FL_RESIDENT, FL_NONRESIDENT, IP_RESIDENT, IP_NONRESIDENT обязателен один из адресов:

• REGISTRATION_ADDRESS — адрес регистрации по месту жительства;
• RESIDENCE_ADDRESS — адрес регистрации по месту пребывания.

Для типов UL_RESIDENT, UL_NONRESIDENT обязательно передавать LEGAL_ENTITY_ADDRESS — адрес юридического лица.

Required

address

String

Requirements: <= 256 characters

Адрес.

registrationDate

String<date>

Дата регистрации.

opf

String

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

Required

inn

String

Requirements: Value must match regular expression ^(\d{10})$

ИНН.

ogrn

String

Requirements: Value must match regular expression ^(\d{13})$

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

Ответ

201

Created

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Получить консультацию по интеграции

Loading...