Создать заявку

/api/v1/credit-applications

POST

https://secured-openapi.tbank.ru/api/v1/credit-applications

Метод для создания заявок на ипотеку.

Авторизация

Security

Bearer API Token

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

RPS

Ограничение — 20 запросов в секунду

Scopes

Методы для создания и управления заявками на ипотеку → Создание и управление заявками на кредитные продукты для партнеров

Запрос

Header parameters

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Request body schema application/json

Required

data

Array of objects ()

Requirements: >= 1 items, <= 1 items

Данные по заявке.

Required

meta

Object

Метаданные.

Required

brokerId

String

Requirements: Value must match regular expression ^[a-z]{1}[0-9a-zA-Z]{0,35}$

Идентификатор ПО партнера.

pointId

String

Requirements: Value must match regular expression ^[a-z]{1}[0-9a-zA-Z]{0,35}$

Идентификатор точки продаж партнера.

Required

processId

String

Requirements: Value must match regular expression ^[a-z]{1}[0-9a-zA-Z]{0,35}$

Идентификатор схемы обработки заявки.

personId

String

Requirements: Value must match regular expression ^[a-z]{1}[0-9a-zA-Z]{0,35}$

Идентификатор физического лица — агента, который создал заявку от лица заявителя.

Required

contents

Array of objects ()

Requirements: <= 1000 items

Параметры заявки.

anyOf

MOD1

Required

entity

String

Requirements: [root]

Корневая часть заявки.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор.

MOD3

Required

entity

String

Requirements: [requestedCondition]

Предлагаемые условия.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности.

Required

links

Array of objects ()

Requirements: <= 1000 items

Связанные параметры. Обозначают отношение агрегации.

Required

role

String

Requirements: [partOf]

Роль.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

Required

maxOffersNumber

Number<integer>

Requirements: >= 1 and <= 100

Максимальное количество возвращаемых объектов.

productGroup

String

Requirements: [loan]

Внешний идентификатор группы продуктов.

productType

String

Requirements: [mortgage]

Внешний идентификатор типа продукта в группе.

productSubType

String

Requirements: [refin]

Внешний идентификатор подтипа продукта.

productName

String

Requirements: [standard, family]

Внешнее наименование продукта.

productsId

Array of objects ()

Requirements: <= 1000 items

Внешние идентификаторы продуктов.

Required

productId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Внешний идентификатор продукта.

downPayment

Object

Максимальный размер первоначального взноса.

Required

amount

String

Requirements: Value must match regular expression ^[+-]?([0-9]{1,20}([.][0-9]{0,2})?|[.][0-9]{1,2})$

Сумма.

Required

currency

String

Requirements: [RUB]

Валюта.

Required

durationMin

Object

Минимальный срок.

Required

duration

String

Requirements: Value must match regular expression ^([0-9]{1,20}([.][0-9]{0,5})?|[.][0-9]{1,5})$

Величина срока.

Required

durationUnit

String

Requirements: [month]

Единица измерения срока.

amountMin

Object

Минимальная запрашиваемая сумма.

Required

amount

String

Requirements: Value must match regular expression ^[+-]?([0-9]{1,20}([.][0-9]{0,2})?|[.][0-9]{1,2})$

Сумма.

Required

currency

String

Requirements: [RUB]

Валюта.

rateMax

String

Requirements: Value must match regular expression ^(-?\d{1,4}){1}(\.\d{1,4}){0,1}$

Максимальная запрашиваемая ставка в процентах годовых.

MOD4

Required

entity

String

Requirements: [offeredCondition]

Предложенные условия.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности.

Required

links

Array of objects ()

Requirements: <= 1000 items

Связанные параметры. Обозначают отношение агрегации.

Required

role

String

Requirements: [partOf]

Роль.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

Required

productId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Внешний идентификатор продукта.

Required

status

String

Requirements: [chooseOffer, switchToBankOnlineChannel, activated, declined]

Этап обработки заявки:

• chooseOffer — зарезервировано под использование в будущем;
• switchToBankOnlineChannel — продолжение действий в онлайн-канале банка;
• activated — активация продукта;
• declined — прекращение работы по заявке.

Required

offerEndAt

String<date-time>

Время, до которого действует предложение.

amountMin

Object

Минимальная сумма предлагаемого продукта.

Required

amount

String

Requirements: Value must match regular expression ^[+-]?([0-9]{1,20}([.][0-9]{0,2})?|[.][0-9]{1,2})$

Сумма.

Required

currency

String

Requirements: [RUB]

Валюта.

Required

amountMax

Object

Максимальная сумма предлагаемого продукта.

Required

amount

String

Requirements: Value must match regular expression ^[+-]?([0-9]{1,20}([.][0-9]{0,2})?|[.][0-9]{1,2})$

Сумма.

Required

currency

String

Requirements: [RUB]

Валюта.

durationMin

Object

Минимальный срок действия предлагаемого продукта.

Required

duration

String

Requirements: Value must match regular expression ^([0-9]{1,20}([.][0-9]{0,5})?|[.][0-9]{1,5})$

Величина срока.

Required

durationUnit

String

Requirements: [month]

Единица измерения срока.

Required

durationMax

Object

Максимальный срок действия предлагаемого продукта.

Required

duration

String

Requirements: Value must match regular expression ^([0-9]{1,20}([.][0-9]{0,5})?|[.][0-9]{1,5})$

Величина срока.

Required

durationUnit

String

Requirements: [month]

Единица измерения срока.

paymentMax

Object

Максимальный размер платежа предлагаемого продукта.

Required

amount

String

Requirements: Value must match regular expression ^[+-]?([0-9]{1,20}([.][0-9]{0,2})?|[.][0-9]{1,2})$

Сумма.

Required

currency

String

Requirements: [RUB]

Валюта.

deeplink

String<url>

Диплинк.

MOD5

Required

entity

String

Requirements: [offeredConditionRate]

Условия предлагаемой процентной ставки.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности.

Required

links

Array of objects ()

Requirements: <= 1000 items

Связанные параметры. Обозначают отношение агрегации.

Required

role

String

Requirements: [partOf]

Роль.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

Required

type

String

Requirements: [interestRate, increasedRate]

Вид ставки:

• interestRate — стандартная процентная ставка, которая будет отражена в договоре на предоставление продукта;
• increasedRate — процентная ставка, которая будет отражена в договоре вместо стандартной процентной ставки: если клиент откажется от опций продукта, предусмотренных для стандартной ставки.

Required

value

String

Requirements: Value must match regular expression ^(-?\d{1,4}){1}(\.\d{1,4}){0,1}$

Величина ставки в процентах.

Required

unitOfPeriod

String

Requirements: [year]

Период, с которым соотносится величина ставки.

Required

calculationFrequency

String

Requirements: [month]

Период расчета процентов для предлагаемого продукта.

MOD6

Required

entity

String

Requirements: [participant]

Участник сделки.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности.

Required

links

Array of objects ()

Requirements: <= 1000 items

Параметры, связанные с участниками.

oneOf

MOD1

Required

role

String

Requirements: [partOf]

Роль.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

MOD2

Required

role

String

Requirements: [applicant, owner]

Название специальной роли, которая используется в объекте Участник.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

citizenship

String

Requirements: [RU]

Гражданство.

birthDate

String<date>

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

education

String

Requirements: [higher, incompleteHigher, academicDegree, secondarySpecial, secondHigher]

Образование.

Required

firstName

String

Requirements: <= 50 characters, Value must match regular expression ^[^\s]+(\s+[^\s]+)*$

Имя.

Required

lastName

String

Requirements: <= 50 characters, Value must match regular expression ^[^\s]+(\s+[^\s]+)*$

Фамилия.

middleName

String

Requirements: <= 50 characters, Value must match regular expression ^[^\s]+(\s+[^\s]+)*$

Отчество.

maritalStatus

String

Requirements: [widow, divorced, marriedUnofficial, marriedOfficial, single, separated]

Семейное положение.

placeOfBirth

String

Requirements: <= 200 characters

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

MOD7

Required

entity

String

Requirements: [financialInformation]

Финансовая информация.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности.

Required

links

Array of objects ()

Requirements: <= 1000 items

Связанные параметры. Обозначают отношение агрегации.

Required

role

String

Requirements: [partOf]

Роль.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

Required

direction

String

Requirements: [income]

Отток или приток активов.

Required

type

String

Requirements: [personalTotal]

Тип движения активов.

Required

amount

Object

Величина актива.

Required

amount

String

Requirements: Value must match regular expression ^[+-]?([0-9]{1,20}([.][0-9]{0,2})?|[.][0-9]{1,2})$

Сумма.

Required

currency

String

Requirements: [RUB]

Валюта.

Required

duration

Object

Период, к которому приведена величина актива.

Required

duration

String

Requirements: Value must match regular expression ^([0-9]{1,20}([.][0-9]{0,5})?|[.][0-9]{1,5})$

Величина срока.

Required

durationUnit

String

Requirements: [month]

Единица измерения срока.

MOD9

Required

entity

String

Requirements: [docContent]

Часть содержимого документа.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности.

Required

links

Array of objects ()

Requirements: <= 1000 items

Связанные параметры. Обозначают отношение агрегации.

Required

role

String

Requirements: [partOf]

Роль.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

Required

partNumber

Number<integer>

Requirements: >= 1 and <= 1000

Номер части содержимого файла.

Required

file

String<base64>

Часть документа, закодированная в base64.

Required

mimeType

String

Requirements: [application/pdf, image/png, image/jpeg]

MIME-тип файла.

fileName

String

Requirements: <= 255 characters, Value must match regular expression ^[^<>:;,?"*|\\\/]+$

Имя файла.

fileHash

String

Requirements: <= 1024 characters

Хэш файла.

fileHashAlgorithm

String

Requirements: <= 50 characters

Алгоритм хэширования.

MOD11

Required

entity

String

Requirements: [address]

Адрес.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности.

Required

links

Array of objects ()

Requirements: <= 1000 items

Связанные параметры. Обозначают отношение агрегации.

oneOf

MOD1

Required

role

String

Requirements: [partOf]

Роль.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

MOD2

Required

role

String

Requirements: [registrationAddress, residenceAddress, objectAddress]

Название специальной роли, которая используется в объекте Адрес.

Required

contentId

String

Requirements: Value must match regular expression ^[0-9a-zA-Z]{1}[0-9a-zA-Z-]{0,34}[0-9a-zA-Z]{1}$

Идентификатор сущности, на которую указывает ссылка.

Required

country

String

Requirements: <= 120 characters

Страна.

zipCode

String

Requirements: <= 15 characters

Почтовый индекс.

Required

state

String

Requirements: <= 120 characters

Наименование и тип субъекта Российской Федерации.

area

String

Requirements: <= 120 characters

Область или округ.

city

String

Requirements: <= 120 characters

Город.

settlement

String

Requirements: <= 120 characters

Населенный пункт.

Required

street

String

Requirements: <= 120 characters

Улица.

construction

String

Requirements: <= 30 characters

Номер строения.

corpus

String

Requirements: <= 30 characters

Корпус.

Required

building

String

Requirements: <= 30 characters

Номер/обозначение здания.

flat

String

Requirements: <= 15 characters

Номер/обозначение квартиры.

Ответ

201

Заявка создана

400

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

401

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

403

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

422

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

429

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

500

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

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

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

Loading...