Регистрация заявки от агрегатора
/opportunities
https://tacq-tom.tcsbank.ru/tom-bpm/api/v1/public/opportunities
Метод для регистрации компании, мерчанта или терминала.
Запрос
Header parameters
Required
authorization
String
Значение заполняется по шаблону {PartnerId}+':'+Base64(HMAC-SHA512({SecretKey}, UTF-8-Encoding-Of(Date)))
, где:
-
PartnerId
— системный код партнера; -
SecretKey
— ключ в текстовом формате, сформированный на стороне Т-Банка.
Required
date
String
Дата в формате ISO 8601:2004 — YYYY-MM-DDThh:mm:ss±hh:mm
.
Request body schema application/json
Required
company
Object (TomCompanyDto)
Информация о компании.
Required
company
Object (TomCompanyDto)
Информация о компании.
activityDescription
String
Requirements: <= 1000 characters
Описание предоставляемых услуг компании.
companyType
String
Организационно-правовая форма в виде аббревиатуры — ООО, ИП, АНО и другие.
Required
decisionMakerInfo
Object (TomContactDto)
Связанное контактное лицо.
Required
decisionMakerInfo
Object (TomContactDto)
Связанное контактное лицо.
Required
birthDate
String<date>
Дата рождения связанного контактного лица согласно паспорту.
birthPlace
String
Место рождения связанного контактного лица согласно паспорту.
Required
citizenship
String
Requirements: <= 10 characters
Гражданство связанного контактного лица — наименование страны.
Required
documents
Array of objects ()
Документы.
Required
documents
Array of objects ()
Документы.
departmentCode
String
Requirements: <= 10 characters
, Value must match regular expression \d{3}-\d{3}
Код подразделения. Заполняется для типа документа ПАСПОРТ
.
Required
exemplars
Array of objects ()
Экземпляр документа.
Required
exemplars
Array of objects ()
Экземпляр документа.
comment
String
Requirements: <= 1500 characters
Комментарий к экземпляру документа.
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
Required
bucketName
String
Название корзины в S3.
Required
objectFormat
String
Requirements: [GIF
, JPEG
, JPG
, PDF
, PNG
, TIF
, TIFF
]
Расширение файла.
Required
objectKey
String
Ключ файла-документа в S3.
Required
typeId
String
Requirements: [ALL_PAGES
, CEO_OFFICE_TERM
, EDS
, ELECTRONIC_DOCUMENT
, ELECTRONIC_WITH_EDS
, FIRST_PAGE
, MAIN_SPREAD_AND_REGISTRATION
, MAIN_SPREAD_PAGE
, ORIGINAL
, OTHER
, PASSPORT_HISTORY_SPREAD
, PHOTO
, REGISTRATION_PAGE
, SECOND_PAGE
, TAX_STAMP
, TITLE_PAGE
]
Тип экземпляра документа согласно справочнику.
issueDate
String<date>
Дата выдачи документа.
issuerInstitute
String
Requirements: <= 250 characters
Наименование органа, выдавшего документ.
number
String
Requirements: <= 50 characters
Серия и номер паспорта, без разделителей.
Required
typeId
String
Requirements: [ACCOUNT_PROFILE_DATA
, ACT_CONFIRMATION_STRUCTURE_KOU
, AGGREGATOR_JOINING_APPLICATION
, ANOTHER_BANK_ACCOUNT_STATEMENT
, APPOINTMENT_NOTARY
, ARBITRATION_CERTIFICATE
, BO_ACCEPT
, BUSINESS_MODEL
, CHECKS
, CLOSE_APPLICATION
, CONFIRMATION_HMB_COMPOSITION
, CUSTOMER_PHOTO
, DOCUMENT_FOR_STAY_IN_RF
, EGRUL_CHANGE_LIST
, EGRUL_STATEMENT
, FINANCIAL_STATEMENTS
, FOREIGN_PASSPORT
, FOREIGN_PUBLIC_OFFICIAL_CERTIFICATE
, FOUNDERS_DECISION_PROTOCOL
, FULL_PD_BO
, GUARANTEE_LETTER
, INFORMATION
, INN
, JOB_ORDER
, JOINING_APPLICATION
, LAWYER_CERTIFICATE
, LEASE_CONTRACT
, LICENSE
, LOCATION_CONFIRMATION
, MARRIAGE_CERTIFICATE
, MIGRATION_CARD_VISA
, NOTICE_OF_ESTABLISHMENT_LAWYER_OFFICE
, OFFICE
, OGRN
, OTHER
, PASSPORT
, PASSPORT_VALIDITY_CERTIFICATE
, POWER_OF_ATTORNEY_SIGNING
, SHAREHOLDERS_EXCERPT
, SNILS
, TAX_RETURN
, TEMPORARY_REGISTRATION
, USTAV
, USTAV_CHANGE_LIST
]
Тип документа согласно справочнику.
String
Адрес электронной почты связанного контактного лица.
Required
extPersonId
String
Requirements: <= 36 characters
Идентификатор связанного контактного лица в системе учета партнера — внешний по отношению к банку.
Required
firstName
String
Requirements: <= 50 characters
Имя связанного контактного лица.
Required
lastName
String
Requirements: <= 50 characters
Фамилия связанного контактного лица.
middleName
String
Requirements: <= 50 characters
Отчество связанного контактного лица.
Required
phone
String
Requirements: Value must match regular expression ^(\+7)[\d]{10}$
Номер телефона связанного контактного лица.
Required
registrationAddress
Object (TomAddressDto)
Адрес.
Required
registrationAddress
Object (TomAddressDto)
Адрес.
apartment
String
Requirements: <= 20 characters
Номер квартиры или офиса.
block
String
Requirements: <= 20 characters
Номер корпуса.
building
String
Requirements: <= 20 characters
Номер строения.
city
String
Requirements: <= 50 characters
Наименование города. Обязателен к заполнению, если не передается settlement
.
Required
country
String
Requirements: >= 3 characters
and <= 3 characters
, Value must match regular expression ^\d{3}$
Трехсимвольный цифровой код государства по ISO 3166-1. Например, код для государства Российская Федерация — 643
.
district
String
Requirements: <= 50 characters
Район с типом/префиксом.
fiasId
String
Requirements: <= 50 characters
Идентификатор адреса по ФИАС.
house
String
Requirements: <= 20 characters
Номер дома.
kladrId
String
Requirements: <= 50 characters
Код адреса по КЛАДР.
Required
postalCode
String
Requirements: non-empty
and <= 6 characters
Почтовый индекс.
Required
region
String
Requirements: non-empty
and <= 50 characters
Регион с типом/префиксом.
Required
result
String
Requirements: non-empty
and <= 300 characters
Результирующий адрес одной строкой.
settlement
String
Requirements: <= 100 characters
Регион с типом/префиксом. Обязателен к заполнению, если не передается city
.
street
String
Requirements: <= 150 characters
Улица с типом/префиксом.
Required
type
String
Requirements: [FACTUAL
, JURIDICAL
, REGISTRATION
]
Тип адреса:
FACTUAL
— фактический адрес расположения объекта (торговой точки).JURIDICAL
— юридический адрес регистрации объекта (компании).REGISTRATION
— адрес регистрации субъекта: персоны ЕИО, связанного контакта компании.
documents
Array of objects ()
Документы.
documents
Array of objects ()
Документы.
departmentCode
String
Requirements: <= 10 characters
, Value must match regular expression \d{3}-\d{3}
Код подразделения. Заполняется для типа документа ПАСПОРТ
.
Required
exemplars
Array of objects ()
Экземпляр документа.
Required
exemplars
Array of objects ()
Экземпляр документа.
comment
String
Requirements: <= 1500 characters
Комментарий к экземпляру документа.
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
Required
bucketName
String
Название корзины в S3.
Required
objectFormat
String
Requirements: [GIF
, JPEG
, JPG
, PDF
, PNG
, TIF
, TIFF
]
Расширение файла.
Required
objectKey
String
Ключ файла-документа в S3.
Required
typeId
String
Requirements: [ALL_PAGES
, CEO_OFFICE_TERM
, EDS
, ELECTRONIC_DOCUMENT
, ELECTRONIC_WITH_EDS
, FIRST_PAGE
, MAIN_SPREAD_AND_REGISTRATION
, MAIN_SPREAD_PAGE
, ORIGINAL
, OTHER
, PASSPORT_HISTORY_SPREAD
, PHOTO
, REGISTRATION_PAGE
, SECOND_PAGE
, TAX_STAMP
, TITLE_PAGE
]
Тип экземпляра документа согласно справочнику.
issueDate
String<date>
Дата выдачи документа.
issuerInstitute
String
Requirements: <= 250 characters
Наименование органа, выдавшего документ.
number
String
Requirements: <= 50 characters
Серия и номер паспорта, без разделителей.
Required
typeId
String
Requirements: [ACCOUNT_PROFILE_DATA
, ACT_CONFIRMATION_STRUCTURE_KOU
, AGGREGATOR_JOINING_APPLICATION
, ANOTHER_BANK_ACCOUNT_STATEMENT
, APPOINTMENT_NOTARY
, ARBITRATION_CERTIFICATE
, BO_ACCEPT
, BUSINESS_MODEL
, CHECKS
, CLOSE_APPLICATION
, CONFIRMATION_HMB_COMPOSITION
, CUSTOMER_PHOTO
, DOCUMENT_FOR_STAY_IN_RF
, EGRUL_CHANGE_LIST
, EGRUL_STATEMENT
, FINANCIAL_STATEMENTS
, FOREIGN_PASSPORT
, FOREIGN_PUBLIC_OFFICIAL_CERTIFICATE
, FOUNDERS_DECISION_PROTOCOL
, FULL_PD_BO
, GUARANTEE_LETTER
, INFORMATION
, INN
, JOB_ORDER
, JOINING_APPLICATION
, LAWYER_CERTIFICATE
, LEASE_CONTRACT
, LICENSE
, LOCATION_CONFIRMATION
, MARRIAGE_CERTIFICATE
, MIGRATION_CARD_VISA
, NOTICE_OF_ESTABLISHMENT_LAWYER_OFFICE
, OFFICE
, OGRN
, OTHER
, PASSPORT
, PASSPORT_VALIDITY_CERTIFICATE
, POWER_OF_ATTORNEY_SIGNING
, SHAREHOLDERS_EXCERPT
, SNILS
, TAX_RETURN
, TEMPORARY_REGISTRATION
, USTAV
, USTAV_CHANGE_LIST
]
Тип документа согласно справочнику.
String
Requirements: Value must match regular expression ^[0-9a-zA-Zа-яА-ЯёЁ+_.-]+@[0-9a-zA-Zа-яА-ЯёЁ.-]+.[0-9a-zA-Zа-яА-ЯёЁ]{2,}$
Адрес электронной почты, закрепленный за компанией.
Required
extCompanyId
String
Идентификатор компании в рамках учета система партнера — внешний по отношению к банку.
fullName
String
Requirements: <= 150 characters
Полное наименование компании без сокращений.
Required
inn
String
Requirements: Value must match regular expression ^(\d{10}|\d{12})$
ИНН компании.
kindOfActivity
String
Requirements: <= 50 characters
Код основного вида экономической деятельности компании согласно ОКВЭД — Общероссийский классификатор видов экономической деятельности.
kpp
String
Requirements: Value must match regular expression \d{9}
Код причины постановки на учет (КПП).
legalAddress
Object
Юридический адрес.
legalAddress
Object
Юридический адрес.
apartment
String
Requirements: <= 20 characters
Номер квартиры или офиса.
block
String
Requirements: <= 20 characters
Номер корпуса.
building
String
Requirements: <= 20 characters
Номер строения.
city
String
Requirements: <= 50 characters
Наименование города. Обязателен к заполнению, если не передается settlement
.
Required
country
String
Requirements: >= 3 characters
and <= 3 characters
, Value must match regular expression ^\d{3}$
Трехсимвольный цифровой код государства по ISO 3166-1. Например, код для государства Российская Федерация — 643
.
district
String
Requirements: <= 50 characters
Район с типом/префиксом.
fiasId
String
Requirements: <= 50 characters
Идентификатор адреса по ФИАС.
house
String
Requirements: <= 20 characters
Номер дома.
kladrId
String
Requirements: <= 50 characters
Код адреса по КЛАДР.
Required
postalCode
String
Requirements: non-empty
and <= 6 characters
Почтовый индекс.
Required
region
String
Requirements: non-empty
and <= 50 characters
Регион с типом/префиксом.
Required
result
String
Requirements: non-empty
and <= 300 characters
Результирующий адрес одной строкой.
settlement
String
Requirements: <= 100 characters
Регион с типом/префиксом. Обязателен к заполнению, если не передается city
.
street
String
Requirements: <= 150 characters
Улица с типом/префиксом.
Required
type
String
Requirements: [FACTUAL
, JURIDICAL
, REGISTRATION
]
Тип адреса:
FACTUAL
— фактический адрес расположения объекта (торговой точки).JURIDICAL
— юридический адрес регистрации объекта (компании).REGISTRATION
— адрес регистрации субъекта: персоны ЕИО, связанного контакта компании.
Required
merchants
Array of objects ()
Информация о мерчанте.
Required
merchants
Array of objects ()
Информация о мерчанте.
address
Object (TomAddressDto)
Адрес.
address
Object (TomAddressDto)
Адрес.
apartment
String
Requirements: <= 20 characters
Номер квартиры или офиса.
block
String
Requirements: <= 20 characters
Номер корпуса.
building
String
Requirements: <= 20 characters
Номер строения.
city
String
Requirements: <= 50 characters
Наименование города. Обязателен к заполнению, если не передается settlement
.
Required
country
String
Requirements: >= 3 characters
and <= 3 characters
, Value must match regular expression ^\d{3}$
Трехсимвольный цифровой код государства по ISO 3166-1. Например, код для государства Российская Федерация — 643
.
district
String
Requirements: <= 50 characters
Район с типом/префиксом.
fiasId
String
Requirements: <= 50 characters
Идентификатор адреса по ФИАС.
house
String
Requirements: <= 20 characters
Номер дома.
kladrId
String
Requirements: <= 50 characters
Код адреса по КЛАДР.
Required
postalCode
String
Requirements: non-empty
and <= 6 characters
Почтовый индекс.
Required
region
String
Requirements: non-empty
and <= 50 characters
Регион с типом/префиксом.
Required
result
String
Requirements: non-empty
and <= 300 characters
Результирующий адрес одной строкой.
settlement
String
Requirements: <= 100 characters
Регион с типом/префиксом. Обязателен к заполнению, если не передается city
.
street
String
Requirements: <= 150 characters
Улица с типом/префиксом.
Required
type
String
Requirements: [FACTUAL
, JURIDICAL
, REGISTRATION
]
Тип адреса:
FACTUAL
— фактический адрес расположения объекта (торговой точки).JURIDICAL
— юридический адрес регистрации объекта (компании).REGISTRATION
— адрес регистрации субъекта: персоны ЕИО, связанного контакта компании.
Required
bankAccount
Object (TomBankAccountDto)
Информация о банковском счете.
Required
bankAccount
Object (TomBankAccountDto)
Информация о банковском счете.
Required
bankName
String
Requirements: <= 100 characters
Наименование банка.
Required
bic
String
Requirements: Value must match regular expression \d{9}
БИК банка — банковский идентификационный код.
corrAccount
String
Requirements: Value must match regular expression ^\d{20}$
Номер корреспондентского счета банка.
Required
currentAccount
String
Requirements: Value must match regular expression ^\d{20}$
Номер расчетного счета получателя в банке.
kpp
String
Requirements: Value must match regular expression \d{9}
КПП банка — код причины постановки банка как организации на учет в ФНС РФ.
buildType
String
Requirements: [BEAUTY_SALON
, CAR_SERVICE
, CATERING_POINT
, DELIVERY_POINT
, DWELLING
, HOTEL
, MEDICAL_CENTER
, OFFICE
, OTHER
, PRODUCTION_FACILITY
, SHOP
, SPORT_CENTER
, WAREHOUSE
]
Тип помещения торговой точки.
documents
Array of objects ()
Документы.
documents
Array of objects ()
Документы.
departmentCode
String
Requirements: <= 10 characters
, Value must match regular expression \d{3}-\d{3}
Код подразделения. Заполняется для типа документа ПАСПОРТ
.
Required
exemplars
Array of objects ()
Экземпляр документа.
Required
exemplars
Array of objects ()
Экземпляр документа.
comment
String
Requirements: <= 1500 characters
Комментарий к экземпляру документа.
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
Required
bucketName
String
Название корзины в S3.
Required
objectFormat
String
Requirements: [GIF
, JPEG
, JPG
, PDF
, PNG
, TIF
, TIFF
]
Расширение файла.
Required
objectKey
String
Ключ файла-документа в S3.
Required
typeId
String
Requirements: [ALL_PAGES
, CEO_OFFICE_TERM
, EDS
, ELECTRONIC_DOCUMENT
, ELECTRONIC_WITH_EDS
, FIRST_PAGE
, MAIN_SPREAD_AND_REGISTRATION
, MAIN_SPREAD_PAGE
, ORIGINAL
, OTHER
, PASSPORT_HISTORY_SPREAD
, PHOTO
, REGISTRATION_PAGE
, SECOND_PAGE
, TAX_STAMP
, TITLE_PAGE
]
Тип экземпляра документа согласно справочнику.
issueDate
String<date>
Дата выдачи документа.
issuerInstitute
String
Requirements: <= 250 characters
Наименование органа, выдавшего документ.
number
String
Requirements: <= 50 characters
Серия и номер паспорта, без разделителей.
Required
typeId
String
Requirements: [ACCOUNT_PROFILE_DATA
, ACT_CONFIRMATION_STRUCTURE_KOU
, AGGREGATOR_JOINING_APPLICATION
, ANOTHER_BANK_ACCOUNT_STATEMENT
, APPOINTMENT_NOTARY
, ARBITRATION_CERTIFICATE
, BO_ACCEPT
, BUSINESS_MODEL
, CHECKS
, CLOSE_APPLICATION
, CONFIRMATION_HMB_COMPOSITION
, CUSTOMER_PHOTO
, DOCUMENT_FOR_STAY_IN_RF
, EGRUL_CHANGE_LIST
, EGRUL_STATEMENT
, FINANCIAL_STATEMENTS
, FOREIGN_PASSPORT
, FOREIGN_PUBLIC_OFFICIAL_CERTIFICATE
, FOUNDERS_DECISION_PROTOCOL
, FULL_PD_BO
, GUARANTEE_LETTER
, INFORMATION
, INN
, JOB_ORDER
, JOINING_APPLICATION
, LAWYER_CERTIFICATE
, LEASE_CONTRACT
, LICENSE
, LOCATION_CONFIRMATION
, MARRIAGE_CERTIFICATE
, MIGRATION_CARD_VISA
, NOTICE_OF_ESTABLISHMENT_LAWYER_OFFICE
, OFFICE
, OGRN
, OTHER
, PASSPORT
, PASSPORT_VALIDITY_CERTIFICATE
, POWER_OF_ATTORNEY_SIGNING
, SHAREHOLDERS_EXCERPT
, SNILS
, TAX_RETURN
, TEMPORARY_REGISTRATION
, USTAV
, USTAV_CHANGE_LIST
]
Тип документа согласно справочнику.
Required
String
Requirements: Value must match regular expression ^[0-9a-zA-Zа-яА-ЯёЁ+_.-]+@[0-9a-zA-Zа-яА-ЯёЁ.-]+.[0-9a-zA-Zа-яА-ЯёЁ]{2,}$
Адрес электронной почты торговой точки.
Required
extShopId
String
Идентификатор торговой точки в системе учета партнера — внешний по отношению к банку.
Required
fee
Object (TomFeeDto)
Комиссия.
Required
fee
Object (TomFeeDto)
Комиссия.
Required
amount
Object (TomAmountDto)
Размер комиссии.
Required
amount
Object (TomAmountDto)
Размер комиссии.
Required
fixed
Number<double>
Фиксированный размер комиссии в валюте для схемы типа fix
или hybrid
.
Required
percentage
Number<double>
Requirements: <= 99.99
Размер комиссии в % от суммы операции для схемы типа percentage
или hybrid
.
currency
Integer<int32>
Requirements: >= 1
and <= 999
Валюта комиссии. Трехзначный код валюты согласно стандарту ISO 4217. Рубли — 643
.
groupId
String
Наименование группового условия по комиссии. Заполняется при использовании специальных групповых условий по комиссии.
Required
type
String
Requirements: [FIX
, HYBRID
, PERCENT
]
Тип условия расчета комиссии.
Required
nameEng
String
Requirements: <= 20 characters
, Value must match regular expression ^[A-Z-a-z0-9 !\"#\$%\&\'\(\)\*\+,\-\./:;<\[\\\]\^\_\'=>\?@\{\|\}~]+$
Наименование торговой точки на английском языке, транслитерированное.
nameRus
String
Requirements: <= 100 characters
Наименование торговой точки на русском языке, как на вывеске.
Required
phone
String
Телефонный номер торговой точки.
Required
terminals
Array of objects ()
Терминал.
Required
terminals
Array of objects ()
Терминал.
accessibilityCode
String
Requirements: non-empty
and <= 30 characters
Код адаптивного решения для людей с инвалидностью. В параметре можно передать одно или несколько двузначных чисел. Если передаете несколько чисел, используйте разделитель ;
без пробелов.
deviceConfigType
String
Requirements: [CASHIER
, CLIENT
]
Тип конфигурации платежного устройства:
CASHIER
— ТСП кассир;CLIENT
— ТСП клиент.
deviceManufacturer
String
Requirements: <= 50 characters
Производитель устройства оплаты.
deviceSoftware
String
Requirements: <= 50 characters
Название программного обеспечения устройства.
Required
mcc
String
Requirements: <= 4 characters
, Value must match regular expression ^\d{4}$
МСС (Merchant Category Code), соответствующий деятельности торговой точки.
paymReaderManufacturer
String
Requirements: <= 50 characters
Производитель внешнего считывателя бесконтактных платежей. Если его нет, укажите ОТСУТСТВУЕТ
.
paymReaderModel
String
Requirements: <= 50 characters
Модель внешнего считывателя бесконтактных платежей.
Required
serialNumber
String
Requirements: non-empty
and <= 50 characters
Серийный номер терминала.
Required
type
String
Requirements: <= 50 characters
, [RETAIL
, VENDING
]
Тип терминала:
RETAIL
— используется при торговле с участием продавца;VENDING
— используется при торговле с устройства самообслуживания — вендингового аппарата.
paymentType
String
Requirements: [POS
, MPOS
, SOFTPOS
]
Default: POS
Тип технологии оплаты:
POS
(point-of-sale) — традиционный тип, терминал;mPOS
(mobile POS) — гибридный тип, использующий мобильное устройство и специальный приемник карт;SoftPOS
(software POS) — программный тип технологии, использующий только мобильное устройство для приема платежа.
Поле необязательное. Если значение не передано, по умолчанию устанавливается тип технологии оплаты POS
.
Required
ogrn
String
Requirements: Value must match regular expression ^(\d{13}|\d{15})$
Основной государственный регистрационный номер компании (ОГРН).
phone
String
Основной телефонный контакт компании.
registrationAuthorityName
String
Requirements: <= 150 characters
Налоговый орган, зарегистрировавший компанию.
registrationDate
String<date>
Дата регистрации компании.
registrationLocation
String
Requirements: <= 100 characters
Место государственной регистрации компании.
relatedCounterparties
Object (TomRelatedCounterpartiesDto)
Связанные контрагенты.
relatedCounterparties
Object (TomRelatedCounterpartiesDto)
Связанные контрагенты.
legalEntities
Array of objects ()
Юридические лица.
legalEntities
Array of objects ()
Юридические лица.
Required
companyType
String
ОПФ связанной компании.
documents
Array of objects ()
Документы.
documents
Array of objects ()
Документы.
departmentCode
String
Requirements: <= 10 characters
, Value must match regular expression \d{3}-\d{3}
Код подразделения. Заполняется для типа документа ПАСПОРТ
.
Required
exemplars
Array of objects ()
Экземпляр документа.
Required
exemplars
Array of objects ()
Экземпляр документа.
comment
String
Requirements: <= 1500 characters
Комментарий к экземпляру документа.
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
Required
bucketName
String
Название корзины в S3.
Required
objectFormat
String
Requirements: [GIF
, JPEG
, JPG
, PDF
, PNG
, TIF
, TIFF
]
Расширение файла.
Required
objectKey
String
Ключ файла-документа в S3.
Required
typeId
String
Requirements: [ALL_PAGES
, CEO_OFFICE_TERM
, EDS
, ELECTRONIC_DOCUMENT
, ELECTRONIC_WITH_EDS
, FIRST_PAGE
, MAIN_SPREAD_AND_REGISTRATION
, MAIN_SPREAD_PAGE
, ORIGINAL
, OTHER
, PASSPORT_HISTORY_SPREAD
, PHOTO
, REGISTRATION_PAGE
, SECOND_PAGE
, TAX_STAMP
, TITLE_PAGE
]
Тип экземпляра документа согласно справочнику.
issueDate
String<date>
Дата выдачи документа.
issuerInstitute
String
Requirements: <= 250 characters
Наименование органа, выдавшего документ.
number
String
Requirements: <= 50 characters
Серия и номер паспорта, без разделителей.
Required
typeId
String
Requirements: [ACCOUNT_PROFILE_DATA
, ACT_CONFIRMATION_STRUCTURE_KOU
, AGGREGATOR_JOINING_APPLICATION
, ANOTHER_BANK_ACCOUNT_STATEMENT
, APPOINTMENT_NOTARY
, ARBITRATION_CERTIFICATE
, BO_ACCEPT
, BUSINESS_MODEL
, CHECKS
, CLOSE_APPLICATION
, CONFIRMATION_HMB_COMPOSITION
, CUSTOMER_PHOTO
, DOCUMENT_FOR_STAY_IN_RF
, EGRUL_CHANGE_LIST
, EGRUL_STATEMENT
, FINANCIAL_STATEMENTS
, FOREIGN_PASSPORT
, FOREIGN_PUBLIC_OFFICIAL_CERTIFICATE
, FOUNDERS_DECISION_PROTOCOL
, FULL_PD_BO
, GUARANTEE_LETTER
, INFORMATION
, INN
, JOB_ORDER
, JOINING_APPLICATION
, LAWYER_CERTIFICATE
, LEASE_CONTRACT
, LICENSE
, LOCATION_CONFIRMATION
, MARRIAGE_CERTIFICATE
, MIGRATION_CARD_VISA
, NOTICE_OF_ESTABLISHMENT_LAWYER_OFFICE
, OFFICE
, OGRN
, OTHER
, PASSPORT
, PASSPORT_VALIDITY_CERTIFICATE
, POWER_OF_ATTORNEY_SIGNING
, SHAREHOLDERS_EXCERPT
, SNILS
, TAX_RETURN
, TEMPORARY_REGISTRATION
, USTAV
, USTAV_CHANGE_LIST
]
Тип документа согласно справочнику.
Required
extCompanyId
String
Requirements: <= 36 characters
Идентификатор компании в системе учета партнера — внешний по отношению к банку.
Required
inn
String
Requirements: Value must match regular expression ^(\d{10}|\d{12})$
ИНН компании.
Required
jurisdiction
String
Requirements: non-empty
and <= 50 characters
Код страны, в юрисдикции которой зарегистрирована связанная компания. Россия — 643
.
kpp
String
Requirements: Value must match regular expression \d{9}
Код причины постановки компании на учет (КПП).
ogrn
String
Requirements: Value must match regular expression ^(\d{13}|\d{15})$
Основной государственный регистрационный номер компании (ОГРН).
Required
relationType
String
Requirements: [BENEFICIARY
, FOUNDER
, SINGLE_EXECUTIVE
]
Тип связи с основной компанией.
shareOfOwnership
Number<double>
Requirements: <= 100
Доля владения капиталом основной компании в %.
Required
shortName
String
Requirements: <= 50 characters
Краткое наименование компании.
persons
Array of objects ()
Персоны.
persons
Array of objects ()
Персоны.
Required
birthDate
String<date>
Дата рождения.
birthPlace
String
Место рождения.
Required
citizenship
String
Гражданство (страна).
documents
Array of objects ()
Документы.
documents
Array of objects ()
Документы.
departmentCode
String
Requirements: <= 10 characters
, Value must match regular expression \d{3}-\d{3}
Код подразделения. Заполняется для типа документа ПАСПОРТ
.
Required
exemplars
Array of objects ()
Экземпляр документа.
Required
exemplars
Array of objects ()
Экземпляр документа.
comment
String
Requirements: <= 1500 characters
Комментарий к экземпляру документа.
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
s3DetailInfo
Object (TomS3DetailInfo)
Информация об объектном хранилище (S3).
Required
bucketName
String
Название корзины в S3.
Required
objectFormat
String
Requirements: [GIF
, JPEG
, JPG
, PDF
, PNG
, TIF
, TIFF
]
Расширение файла.
Required
objectKey
String
Ключ файла-документа в S3.
Required
typeId
String
Requirements: [ALL_PAGES
, CEO_OFFICE_TERM
, EDS
, ELECTRONIC_DOCUMENT
, ELECTRONIC_WITH_EDS
, FIRST_PAGE
, MAIN_SPREAD_AND_REGISTRATION
, MAIN_SPREAD_PAGE
, ORIGINAL
, OTHER
, PASSPORT_HISTORY_SPREAD
, PHOTO
, REGISTRATION_PAGE
, SECOND_PAGE
, TAX_STAMP
, TITLE_PAGE
]
Тип экземпляра документа согласно справочнику.
issueDate
String<date>
Дата выдачи документа.
issuerInstitute
String
Requirements: <= 250 characters
Наименование органа, выдавшего документ.
number
String
Requirements: <= 50 characters
Серия и номер паспорта, без разделителей.
Required
typeId
String
Requirements: [ACCOUNT_PROFILE_DATA
, ACT_CONFIRMATION_STRUCTURE_KOU
, AGGREGATOR_JOINING_APPLICATION
, ANOTHER_BANK_ACCOUNT_STATEMENT
, APPOINTMENT_NOTARY
, ARBITRATION_CERTIFICATE
, BO_ACCEPT
, BUSINESS_MODEL
, CHECKS
, CLOSE_APPLICATION
, CONFIRMATION_HMB_COMPOSITION
, CUSTOMER_PHOTO
, DOCUMENT_FOR_STAY_IN_RF
, EGRUL_CHANGE_LIST
, EGRUL_STATEMENT
, FINANCIAL_STATEMENTS
, FOREIGN_PASSPORT
, FOREIGN_PUBLIC_OFFICIAL_CERTIFICATE
, FOUNDERS_DECISION_PROTOCOL
, FULL_PD_BO
, GUARANTEE_LETTER
, INFORMATION
, INN
, JOB_ORDER
, JOINING_APPLICATION
, LAWYER_CERTIFICATE
, LEASE_CONTRACT
, LICENSE
, LOCATION_CONFIRMATION
, MARRIAGE_CERTIFICATE
, MIGRATION_CARD_VISA
, NOTICE_OF_ESTABLISHMENT_LAWYER_OFFICE
, OFFICE
, OGRN
, OTHER
, PASSPORT
, PASSPORT_VALIDITY_CERTIFICATE
, POWER_OF_ATTORNEY_SIGNING
, SHAREHOLDERS_EXCERPT
, SNILS
, TAX_RETURN
, TEMPORARY_REGISTRATION
, USTAV
, USTAV_CHANGE_LIST
]
Тип документа согласно справочнику.
String
Адрес электронной почты персоны.
Required
extPersonId
String
Идентификатор персоны в системе учета партнера — внешний по отношению к банку.
Required
firstName
String
Имя.
Required
lastName
String
Фамилия.
middleName
String
Отчество.
Required
phone
String
Телефонный номер персоны.
Required
registrationAddress
Object (TomAddressDto)
Адрес.
Required
registrationAddress
Object (TomAddressDto)
Адрес.
apartment
String
Requirements: <= 20 characters
Номер квартиры или офиса.
block
String
Requirements: <= 20 characters
Номер корпуса.
building
String
Requirements: <= 20 characters
Номер строения.
city
String
Requirements: <= 50 characters
Наименование города. Обязателен к заполнению, если не передается settlement
.
Required
country
String
Requirements: >= 3 characters
and <= 3 characters
, Value must match regular expression ^\d{3}$
Трехсимвольный цифровой код государства по ISO 3166-1. Например, код для государства Российская Федерация — 643
.
district
String
Requirements: <= 50 characters
Район с типом/префиксом.
fiasId
String
Requirements: <= 50 characters
Идентификатор адреса по ФИАС.
house
String
Requirements: <= 20 characters
Номер дома.
kladrId
String
Requirements: <= 50 characters
Код адреса по КЛАДР.
Required
postalCode
String
Requirements: non-empty
and <= 6 characters
Почтовый индекс.
Required
region
String
Requirements: non-empty
and <= 50 characters
Регион с типом/префиксом.
Required
result
String
Requirements: non-empty
and <= 300 characters
Результирующий адрес одной строкой.
settlement
String
Requirements: <= 100 characters
Регион с типом/префиксом. Обязателен к заполнению, если не передается city
.
street
String
Requirements: <= 150 characters
Улица с типом/префиксом.
Required
type
String
Requirements: [FACTUAL
, JURIDICAL
, REGISTRATION
]
Тип адреса:
FACTUAL
— фактический адрес расположения объекта (торговой точки).JURIDICAL
— юридический адрес регистрации объекта (компании).REGISTRATION
— адрес регистрации субъекта: персоны ЕИО, связанного контакта компании.
Required
relationType
String
Requirements: [BENEFICIARY
, FOUNDER
, SINGLE_EXECUTIVE
]
Тип связи персоны и компании:
BENEFICIARY
— бенефициар,SINGLE_EXECUTIVE
— ЕИО, Единоличный Исполнительный Орган.
shareOfOwnership
Number<double>
Requirements: <= 100
Доля владения капиталом основной компании в %.
Required
shortName
String
Requirements: <= 50 characters
Краткое наименование компании.
site
String
Requirements: Value must match regular expression (((https?)://)|(www\.))[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Основной веб-сайт компании.
sumOfRegisteredCapital
Number<double>
Сумма зарегистрированного капитала компании в рублях.
version
String
partnerId
Integer<int64>
Requirements: >= 1
Системный код партнера.
Ответ
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
Это полезный материал?