¶ Предисловие
ПРИНЯТ И ВВЕДЕН в действие приказом Банка России от __ _____ 202_ года № ___ «О введении в действие стандарта СТО БР XXX xxx Банка России «Открытые программные интерфейсы. Подача заявки в кредитную организацию Спецификация API.
Настоящий Стандарт не может быть полностью или частично воспроизведен, тиражирован и распространен в качестве официального издания без разрешения Банка России.
¶ Введение
Стандарт содержит описание моделей данных и конечных точек АPI, предназначенных для подачи заявки в кредитную организацию на ипотечный продукт с финансовой площадки через Открытые программные интерфейсы.
¶ Область применения
Спецификация служит для организации обмена сообщениями, связанными с: - передачей заявки на получение предложения по финансовому продукту; - проверке статуса заявки; - получения предложения на приобретение финансового продукта.
Спецификация предназначена для:
- участников информационного обмена при получении финансового продукта Пользователем (кредитные организации и финансовые площадки);
- разработчиков информационного и программного обеспечения, информационных систем.
Положения настоящей Спецификации применяются совместно со следующими документами:
- СТО БР ФАПИ.СЕК-1.6-2024 Стандарт Банка России Безопасность финансовых (банковских) операций. Прикладные программные интерфейсы обеспечения безопасности финансовых сервисов на основе протокола OpenID (далее ФАПИ.СЕК).
- СТО БР ФАПИ.ПАОК-1.0-2024 Стандарт Банка России Безопасность финансовых (банковских) операций. Обеспечения безопасности финансовых сервисов при инициации OpenID Connect клиентом потока аутентификации по отдельному каналу(далее ФАПИ.ПАОК).
- СТО БР Открытые программные интерфейсы. Общие положения.
- СТО БР Открытые программные интерфейсы. Глоссарий.
- СТО БР Открытые программные интерфейсы. Общие требования к прикладным стандартам.
- СТО БР Открытые программные интерфейсы. Профиль для расширенного режима безопасности.
¶ Термины и определения
В Спецификации применяются термины и определения в соответствии со стандартами ФАПИ.СЕК, «Открытые программные интерфейсы. Общие положения», «Открытые программные интерфейсы. Глоссарий», а также следующие:
Финансовая площадка- Финансовая платформа, выполняющая роль СПУ и использующая Открытые программные интерфейсы для доступа к Поставщику услуг для предоставления финансовых Продуктов и услуг.Профиль клиента- набор учетных данных о Пользователе на Платформе.Продуктовый каталог- набор данных о Финансовых организациях - участниках Платформы и их Продуктах.Продукт- описание финансовой услуги, предоставляемой Финансовой организацией.Финансовая сделка- набор сущностей, хранящих информацию о сделке.Анкета пользователя- набор данных из профиля клиента для формирования Заявки на приобретение продукта.Заявка на предложение по продукту(Заявка) - Запрашиваемые условия на приобретение продукта и Анкета клиента для формирования предложения по продукту. Может быть разослана нескольким Поставщикам услуг - участникам платформы.Предложение по продукту- предварительный набор условий для Финансовой сделки по Заявке на предложение по продукту.Договор- набор документов по форме банка для подписания участниками.Оферта- фиксированный набор условий для сделки в рамках выбранного предложения.Подтверждение договора- набор данных, подтверждающих согласие (подпись) договора Пользователем.Клиент СПУ- Клиентский интерфейс приложения СПУ, выполняющий взаимодействие по протоколу OIDC.
¶ URI структура пути ресурса
Путь ресурса URI должен соответствовать следующей структуре:
[participant-path-prefix]/open-banking]/[version]/[resource-group]/[resource]/[resource-id]/[sub-resource]..
URI cтруктура пути ресурса состоит из следующих элементов:
[participant-path-prefix]– необязательный префикс ПУ;open-banking– постоянное значение "open-banking";[version]– версия API, выраженная в виде /v[major-version].[minor-version]/;[resource-group]- идентификатор группы конечных точек, в соответствии с ролью участника (указыватьpmsp- product management service provider);[resource]/[resource-id]– наименование ресурса и его идентификатор (например, /product-applications/1112345678).[sub-resource]- наименование подресурса (ресурса 2-го уровня).
ПУ должен использовать один и тот же participant-path-prefix и host name для всех своих ресурсов.
Примеры:
https://bank.ru/oapi-channel/open-banking/v1.3/pmsp/devices ¶ Уведомления о событиях
Настоящая спецификация не представляет методы асинхронного взаимодействия для извещения о событиях изменения ресурса. Участники на этапе пилота должны определить, каким образом будет проходить нотификация. Участники могут использовать предлагаемую пилотной Средой открытых программных интерфейсов Спецификация API (1.0.0) "Уведомления о событиях изменения ресурса" (https://api.openbankingrussia.ru/event-notifications-v1.0.0/).
¶ Общее описание процесса
Спецификация API определяет поток взаимодействия при получении информации о кредитной организации через сервис Среды Открытых программных интерфейсов.
¶ Возможные предварительные условия
- Поставщики услуг размещают у себя список финансовых Продуктов по категориям. Финансовая площадка определяет, какие Продукты надо загружать, и размещает их на своей витрине.
- Информация о Продуктах отображается Пользователю, и на основе неё он может сделать выбор, у какого Поставщика услуг можно приобрести Продукт и указать условия приобретения.
- Пользователь может без посещения витрины заходить на Финансовую площадку с целью получить от банков персональные предложения по ипотеке.
Пошаговое описание На рисунке 1 представлена диаграмма последовательности потока взаимодействия, включающая в себя ниже перечисленные шаги и действия.
Шаг 1: Выбор Продукта Пользователем (вне рамках взаимодействия по OpenAPI)
- Пользователь выбирает Ипотечный продукт на финансовой площадке, и перенаправляется для прохождения аутентификации в Цифровом профиле, подписывает согласия ПЭП ЕСИА (на обработку ПУ и запрос в БКИ).
- Финансовая площадка получает от Цифрового профиля данные Пользователя и вносит их в анкету. Часть данных, предназначенных для ручного заполнения, Пользователь вносит в анкету самостоятельно.
Шаг 2: Получение токена доступа
- Финансовая площадка инициирует установку защищенного соединения TLS с двухсторонней аутентификацией.
- Финансовая площадка, используя тип доступа client credentials, получает на сервере авторизации Поставщика услуг (кредитной организации) токен доступа (access token), который будет в дальнейшем использоваться для авторизации запросов к API на Сервере ресурсов Поставщика услуг.
Шаг 3: Создание Заявки на предложение по продукту
- Финансовая площадка инициирует установку защищенного соединения TLS с двухсторонней аутентификацией.
- Финансовая площадка с помощью запроса
POST /product-applicationsпередает Поставщику услуг информацию для создания Заявки на предложения по продукту (ProductApplication), содержащую Анкету Пользователя (CustomerData) и опционально запрашиваемые условия на приобретение Продукта (RequestedConditions). Это информирует Поставщика услуг о том, что Пользователь намерен получить Предложение по финансовому продукту. Для авторизации запроса используется access-token, полученный на Шаге 2. Поставщик услуг передает в ответе информацию о создании ресурса, содержащую его идентификатор (productApplicationId) и статус (productApplicationStatus).
Шаг 4: Получение статуса обработки Заявки на предложение по продукту
- Поставщик услуг обрабатывает полученную Заявку на предложение по продукту:
- Рассматривает анкетные данные Пользователя;
- Рассматривает запрашиваемые условия для приобретение Продукта;
- Готовит предварительное (или окончательное) Предложение по продукту с указанием срока действия, а также, в случае необходимости, дополнительные требования на получения Продукта (
Requirements). В противном случае Поставщик услуг формирует отказ в предоставлении Продукта и устанавливает статус Заявки (productApplicationStatus) «Rejected» с указанием причины отклонения. - В случае использования нотификаций, Поставщик услуг извещает Финансовую платформу об изменении статуса Заявки, используя запрос
POST /event-notifications(ResourceUpdateEvent: product-applications, URL/{productApplicationId}. - Финансовая площадка использует запрос
GET /product-applications/{productApplicationId}/product-application-detailsи получает обновленный статус Заявки на предложение по продукту.
Шаг 5: Получение Предложения по продукту или Отказ
- В случае получения Финансовой площадкой ответа, содержащего отказ (статус Заявки (
productApplicationStatus)«Rejected»), Финансовая платформа информирует Пользователя о причинах отказа и процесс считается завершенным. (дальнейшие действия не рассматриваются в рамках данной Спецификации). - В случае положительного рассмотрения Заявки Финансовая площадка получает список Предложений по продукту (
ProductOffer) по идентификатору ЗаявкиGET /product-applications/{productApplicationId}/product-offers. Предложений по продукту (ProductOffer) должен включать себя Одобренные условия на приобретение продукта (ApprovedConditions), если при создании Заявки на предложение по продукту включены Запрашиваемые условия на приобретение Продукта (RequestedConditions). В случае, если в Заявке на предложение по продукту была передана только Анкета пользователя, Поставщик услуг включает в Предложение по продукту информацию о множестве возможных условиях кредитования (LoanInterest). - Дополнительно Финансовая площадка может получать информацию по каждому Предложению по продукту по его идентификатору, полученному из предыдущего запроса
GET /product-offers/{productOfferId}
Финансовая площадка информирует Пользователя о полученных Предложениях по продукту их статусе и т.п. Дальнейших действиях (получение оферты или подписание договора - настоящей Спецификацией не рассматривается)
(Опционально) - Финансовая площадка может передать подписанные документы с помощью запроса POST /signed-documents Данный метод может применяться по договоренности между участниками и не является частью описанного процесса подачи заявки.
¶ Ресурсы, реализуемые в рамках пилота
¶ Заявка на предложение по продукту - ProductApplication.
Содержит запрашиваемые условия на приобретение Продукта и Анкету клиента для формироивания предложения по продукту.
¶ Ответ на Заявку - DataProductApplicationResponse. Полезная нагрузка ответа на при создании Заявки или получения ее статуса
¶ Предложение по продукту ProductOffer
Набор условия для финансовой сделки по Заявке на предложение по продукту
¶ Подписанный документ SignedDocument
Общее представление подписанных данных, передаваемых в неструктурированном электронном виде.
¶ Конечные точки
Спецификация API определяет следующие конечные точки
|
Наименование API |
Метод |
Обязательность |
Описание |
Метод авторизации |
|---|---|---|---|---|
|
Заявки на продукт - ProductApplication |
Да |
Создание Заявки на предложение по продукту |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
|
Заявки на продукт - ProductApplication |
Да |
Удаление Заявки на предложение по продукту |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
|
Заявки на продукт - ProductApplication |
Да |
Получение информации о Заявке на предложение по продукту по идентификатору |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
|
Заявки на продукт - ProductApplication |
|
Да |
Получение информации о статусе Заявки на предложение по продукту по идентификатору |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
Предложения по продукту - ProductOffer |
Да |
Удаление Предложения по продукту |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
|
Предложения по продукту - ProductOffer |
|
Да |
Список Предложений по продукту для определенной Заявки по ее идентификатору |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
Предложения по продукту - ProductOffer |
Да |
Получение информации о Предложение по продукту по его идентификатору |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
|
Подписанные документы - SignedDocument |
Да |
Передать подписанный документ. |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
|
|
Подписанные документы - SignedDocument |
Да |
Получить подписанный документ |
Client Credentials flow; scopes: offers: Получение информации, связанной с предложением о финансовом продукте |
¶ Product Application
¶ API - POST /product-applications
POST /product-applications¶ Тело запроса
¶ Параметры заголовка запроса
|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-idempotency-key |
(Нет) |
UUID; format: uuid |
Уникальный идентификатор запроса для поддержки идемпотентности. Обязательно для запросов POST к конечным точкам идемпотентного ресурса. Для других запросов не указывается. |
|
|
x-jws-signature |
(Да) |
String |
Отделяемая подпись полезной нагрузки в формате JWS |
|
¶ Тип ответа
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
201 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ API - DELETE /product-applications/{productApplicationId}
DELETE /product-applications/{productApplicationId}¶ Параметры path
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
204 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ API - GET /product-applications/{productApplicationId}
GET /product-applications/{productApplicationId}¶ Параметры path
¶ Тип ответа
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ API - GET /product-applications/{productApplicationId}/product-application-details
GET /product-applications/{productApplicationId}/product-application-details¶ Параметры path
¶ Тип ответа
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ Product Offer
¶ API - DELETE /product-offers/{productOfferId}
DELETE /product-offers/{productOfferId}¶ Параметры path
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
204 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ API - GET /product-applications/{productApplicationId}/product-offers
GET /product-applications/{productApplicationId}/product-offers¶ Параметры path
¶ Тип ответа
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ API - GET /product-offers/{productOfferId}
GET /product-offers/{productOfferId}¶ Параметры path
¶ Тип ответа
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ Signed Document
¶ API - POST /signed-documents
POST /signed-documents¶ Тело запроса
¶ Тип ответа
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
201 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ API - GET /signed-documents/{signedDocumentId}
GET /signed-documents/{signedDocumentId}¶ Параметры path
¶ Тип ответа
¶ Возвращаемые типы
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
404 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
¶ Модель данных
Спецификация API определяет типы и форматы данных, значения по умолчанию, перечисления и справочную информацию.
¶ Базовые объекты
¶ Общие типы данных
¶ ActiveOrHistoricCurrencyAndAmount
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
amount |
(Да) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
currency |
(Да) |
string |
Код валюты, соответствующий международному стандарту ISO 4217 |
/^[A-Z]{3,3}$/ |
¶ AdditionalServices
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
serviceIdentification |
(Нет) |
string |
Идентификатор услуги, связанной с продуктом, предназначенный для однозначного определения услуги в системе учета поставщика продукта |
/^[a-zA-Z0-9-]{1,40}$/ |
|
serviceType |
(Нет) |
string |
Название услуги/ предмета договора |
/^[\w\W]{1,40}$/ |
|
serviceName |
(Нет) |
string |
Наименование страховой программы |
/^[\w\W]{1,240}$/ |
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация о страховых программах |
/^[\w\W]{1,255}$/ |
|
FeesCharges |
(Нет) |
Информация о комиссиях и сборах, в том числе по тарифу обслуживания |
|
|
|
required |
(Нет) |
boolean |
Информация о возможности заемщика согласиться и (или) отказаться от дополнительных услуг/договоров |
|
|
costIncreaseInformation |
(Нет) |
string |
Информация о возможном увеличении суммы расходов заемщика в случае отказа от услуги |
/^[\w\W]{1,240}$/ |
¶ ConsentInformation
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
consentFlag |
(Нет) |
boolean |
Признак наличия согласия |
|
|
consentStartDate |
(Нет) |
string; format: date |
Дата получения согласия (YYYY-MM-DD) |
|
|
consentFile |
(Нет) |
string |
Согласие в формате base64 |
/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/ |
|
consentHash |
(Нет) |
string |
Хешкод согласия |
/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/ |
|
consentType |
(Нет) |
string |
Вид согласия |
/^[\w\W]{1,128}$/ |
|
esiaToken |
(Нет) |
string |
Документ ПЭП ЕСИА формате base64. PDF c id токеном, подтверждающий, что первичное согласие было подписано ПЭП ЕСИА. |
/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/ |
|
tppSignatureForEsiaToken |
(Нет) |
string |
Подпись Финансовой площадки для документа ПЭП ЕСИА в формате base64 |
/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/ |
|
tppSignatureLog |
(Нет) |
string |
Лог подписания Финансовой площадке документа ПЭП ЕСИА |
/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/ |
¶ ContactDetails
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
phoneNumber |
(Да) |
string |
Номер стационарного телефона |
/^((+7|7|8)([0-9]){7,10})$/ |
|
emailAddress |
(Нет) |
string; format: email |
Адрес электронной почты |
|
|
other |
(Нет) |
string |
Дополнительный текст в свободном формате |
/^[\w\W]{1,128}$/ |
¶ DataProductApplicationCreated
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
productApplicationId |
(Да) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Заявки на предложение по продукту |
|
|
creationDateTime |
(Нет) |
string; format: date-time |
Дата и время создания ресурса |
|
|
productApplicationStatus |
(Да) |
Статус Заявки на предложение по продукту |
|
|
|
statusUpdateDateTime |
(Да) |
string; format: date-time |
Дата и время обновления статуса ресурса |
|
|
StatusReasonInformation |
(Нет) |
Информация о причине статуса |
|
¶ DataProductApplicationRequest
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
ProductApplication |
(Да) |
Заявка на предложение по продукту |
|
¶ DataProductApplicationResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
productApplicationId |
(Да) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Заявки на предложение по продукту |
|
|
creationDateTime |
(Нет) |
string; format: date-time |
Дата и время создания ресурса |
|
|
productApplicationStatus |
(Да) |
Статус Заявки на предложение по продукту |
|
|
|
statusUpdateDateTime |
(Да) |
string; format: date-time |
Дата и время обновления статуса ресурса |
|
|
StatusReasonInformation |
(Нет) |
Информация о причине статуса |
|
|
|
ProductApplication |
(Нет) |
Заявка на предложение по продукту |
|
¶ DataProductOffersResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
ProductOffer |
(Да) |
Список Предложений по продукту |
|
¶ DataSignedDocumentReadResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
signedDocumentId |
(Да) |
string |
Идентификатор ресурса, связанный с переданным подписанным документом |
|
|
status |
(Да) |
Статус обработки подписанного документа |
|
|
|
statusUpdateDateTime |
(Нет) |
string; format: date-time |
Дата и время обновления статуса ресурса |
|
|
productApplicationId |
(Нет) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Заявки на предложение по продукту, связанный с передаваемым документом |
|
|
customerLeadId |
(Нет) |
string; format: uuid |
Уникальный и неизменный идентификатор Пользователя, кому принадлежит документ |
|
|
SignedDocument |
(Нет) |
Общее представление подписанных данных, передаваемых в неструктуированном электронном виде |
|
¶ DataSignedDocumentRequest
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
productApplicationId |
(Нет) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Заявки на предложение по продукту, связанный с передаваемым документом |
|
|
customerLeadId |
(Нет) |
string; format: uuid |
Уникальный и неизменный идентификатор Пользователя, кому принадлежит документ |
|
|
SignedDocument |
(Нет) |
Общее представление подписанных данных, передаваемых в неструктуированном электронном виде |
|
¶ DataSignedDocumentResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
signedDocumentId |
(Да) |
string |
Идентификатор ресурса, связанный с переданным подписанным документом |
|
|
status |
(Да) |
Статус обработки подписанного документа |
|
|
|
statusUpdateDateTime |
(Нет) |
string; format: date-time |
Дата и время обновления статуса ресурса |
|
|
productApplicationId |
(Нет) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Заявки на предложение по продукту |
|
|
customerLeadId |
(Нет) |
string; format: uuid |
Уникальный и неизменный идентификатор Пользователя |
|
¶ Document
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
type |
(Да) |
Тип документа |
|
|
|
customerDocumentSource |
(Нет) |
Источник документа |
|
|
|
comments |
(Нет) |
array[String] |
Коментарии для данного типа документа |
|
|
DocumentFiles |
(Да) |
Описание бизнес-правил для передачи сканов документов |
|
¶ DocumentFile
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
documentName |
(Нет) |
string |
Наименование документа |
/^[\w\W]{1,255}$/ |
|
fileName |
(Да) |
string |
файл-1234-1234-aa-12-scanf.pdf |
/^[а-яА-Яa-zA-Z0-9_-]{1,255}$/ |
|
contentType |
(Нет) |
string |
Формат представления документа или тип файла (расширение) |
/^[a-zA-Z0-9]{1,16}$/ |
|
content |
(Да) |
string |
Бинарное представление документа в формате base64 |
/^([A-Za-z0-9+]{1,30720000}={0,2})$/ |
¶ DocumentRequirement
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
required |
(Нет) |
boolean |
Обязательность для конкретного документа |
|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
type |
(Нет) |
Тип документа |
|
¶ DocumentRequirements
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
comments |
(Нет) |
string |
|
|
|
PassportRequirements |
(Нет) |
Информация о требованиях к документам, касающихся удостоверения личности |
|
|
|
FinanceDocumentsRequirements |
(Нет) |
Информация о требованиях к финансовым документам |
|
|
|
JobDocumentsRequirements |
(Нет) |
Информация о требованиях к документам, подтверждающим трудоустройство |
|
|
|
OtherDocumentsRequirements |
(Нет) |
Информация о требованиях к документам |
|
¶ EmploymentProfile
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
jobType |
(Да) |
Тип места работы |
|
|
|
employmentType |
(Да) |
Тип занятости |
|
|
|
positionCategory |
(Да) |
Тип занимаемой должности |
|
|
|
position |
(Да) |
string |
Название должности Пользователя |
/^[\w\W]{1,255}$/ |
|
Organisation |
(Нет) |
Информация об организации |
|
|
|
SalaryBank |
(Нет) |
Информация о кредитной организации |
|
|
|
jobExperienceLast |
(Да) |
integer |
Трудовой стаж на данном месте работы |
|
|
jobExperienceLastPeriod |
(Да) |
Единица измерения периода |
|
|
|
businessShare |
(Нет) |
integer |
Доля владения бизнесом в процентах |
|
|
hasIncomeFromDividends |
(Нет) |
boolean |
Получение дохода в виде дивидендов |
|
¶ EmploymentRequirements
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
employmentCategories |
(Да) |
Тип занятости |
|
|
|
incomeProof |
(Нет) |
boolean |
Признак необходимости подтверждения дохода | true -требуется подтверждение дохода; false - не требуется подтверждение дохода |
|
|
incomeAmount |
(Нет) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
jobExperience |
(Нет) |
string |
Минимальный трудовой стаж |
|
|
jobExperiencePeriod |
(Нет) |
Единица измерения периода |
|
|
|
jobExperienceLast |
(Нет) |
string |
Требования к продолжительности стажа на последнем месте работы |
|
|
jobExperienceLastPeriod |
(Нет) |
Единица измерения периода |
|
|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
¶ Expenses
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
expensesPeriod |
(Нет) |
Единица измерения периода |
|
|
|
Amount |
(Нет) |
Сумма денежных средств и код валюты |
|
|
|
expensesCode |
(Нет) |
Код вида расхода |
|
|
|
OtherExpensesType |
(Нет) |
Другой тип объекта |
|
¶ FinanceDocumentRequirement
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
required |
(Нет) |
boolean |
Обязательность для конкретного документа |
|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
type |
(Нет) |
Тип документа подтверждения дохода |
|
¶ FinanceDocumentRequirements
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
documentCount |
(Нет) |
integer |
Количество обязательных документов, подтверждающих финансовое положение. Обозначает минимальное количество документов среди обязательных или необязательных |
|
|
FinanceDocumentRequirement |
(Нет) |
Информация о требовании к финансовому документу |
|
¶ FullName
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
lastName |
(Да) |
string |
Фамилия |
|
|
firstName |
(Да) |
string |
Имя |
|
|
middleName |
(Нет) |
string |
Отчество |
|
¶ IdentificationType
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
schemeName |
(Да) |
Схема идентификации юридического или физического лица |
|
|
|
identification |
(Да) |
string |
Уникальный и однозначный идентификатор участника, присвоенный идентифицирующей организацией. |
/^[\w\W]{1,35}$/ |
¶ Income
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
incomePeriod |
(Да) |
Единица измерения периода |
|
|
|
Amount |
(Да) |
Сумма денежных средств и код валюты |
|
|
|
IncomeType |
(Нет) |
Информация о доходах |
|
|
|
solvencyProof |
(Нет) |
string |
Документ подтверждающий доход |
|
|
OtherIncomeType |
(Нет) |
Другой тип объекта |
|
¶ IncomeAndExpenses
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
IncomeInformation |
(Да) |
Информация об официальных доходах |
|
|
|
ExpensesInformation |
(Нет) |
Информация об текущих расходах |
|
¶ IncomeType
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
incomeSource |
(Нет) |
Тип места работы, привязанный к источнику дохода |
|
|
|
employmentType |
(Нет) |
Тип занятости |
|
¶ JobDocumentRequirement
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
required |
(Нет) |
boolean |
Обязательность для конкретного документа |
|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
type |
(Нет) |
Тип документа подтверждения занятости |
|
¶ JobDocumentRequirements
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
documentCount |
(Нет) |
integer |
Количество обязательных документов, подтверждающих трудоустройство. Обозначает минимальное количество документов среди обязательных или необязательных |
|
|
JobDocumentRequirement |
(Нет) |
Информация о требовании к документу, подтверждающему трудоустройство |
|
¶ JobExperience
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
jobExperience |
(Да) |
integer |
Общий трудовой стаж |
|
|
jobExperiencePeriod |
(Нет) |
Единица измерения периода |
|
¶ Links
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
self |
(Да) |
string; format: uri |
Текущая ссылка |
|
|
first |
(Нет) |
string; format: uri |
Первая ссылка |
|
|
prev |
(Нет) |
string; format: uri |
Предыдущая ссылка |
|
|
next |
(Нет) |
string; format: uri |
Следующая ссылка |
|
|
last |
(Нет) |
string; format: uri |
Последняя ссылка |
|
¶ LoanAmount
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
PrincipalLoanAmount |
(Да) |
Сумма денежных средств и код валюты |
|
|
|
TopUpAmount |
(Нет) |
Сумма денежных средств и код валюты |
|
¶ Meta
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
totalPages |
(Нет) |
integer; format: int32 |
Указывает на количество передаваемых страниц |
|
¶ MortgageDebitInterest
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
comments |
(Да) |
string |
Комментарии и описания |
/^[\w\W]{1,255}$/ |
|
unitOfPeriod |
(Да) |
Единица измерения периода |
|
|
|
interestRate |
(Да) |
string |
Процентная ставка поставщика продукта (рекламная ставка для использования на витрине) |
/^(-?\d{1,3}){1}(.\d{1,4}){0,1}$/ |
|
interestRateType |
(Нет) |
Типы процентных ставок, кроме базовых годовых, которые финансовые учреждения могут использовать для описания годовой и (или) дневной процентной ставки |
|
|
|
tierCurrency |
(Да) |
string |
Код валюты, соответствующий международному стандарту ISO 4217 |
/^[A-Z]{3,3}$/ |
|
tierValueMinimum |
(Да) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
tierValueMaximum |
(Да) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
tierValueMinTerm |
(Да) |
integer; format: int32 |
Минимальный срок, на которой применяется уровень процентной ставки |
|
|
minTermPeriod |
(Да) |
Единица измерения периода |
|
|
|
tierValueMaxTerm |
(Да) |
integer; format: int32 |
Максимальный срок, для которой применяется уровень процентной ставки |
|
|
maxTermPeriod |
(Да) |
Единица измерения периода |
|
|
|
calculationFrequency |
(Да) |
Частота применения операции в периоде времени |
|
¶ MortgageDebitInterestTierBandSet
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
tierBandMethod |
(Да) |
Виды процентной ставки |
|
|
|
comments |
(Нет) |
string |
Комментарии и описания для Пользователя, характеризующие группу процентных ставок |
/^[\w\W]{1,255}$/ |
|
LoanInterestTierBand |
(Да) |
Подробная информация о процентной ставке по кредиту |
|
|
|
TierBandSetEligibility |
(Нет) |
Ограничения на группу начисления процентов |
|
|
|
AdditionalServices |
(Нет) |
Дополнительные услуги, которые заемщик обязан заключить/приобрести в связи с получением займа |
|
¶ MortgageEligibility
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
name |
(Да) |
string |
Наименование, указанное для критериев приемлемости |
/^[\w\W]{1,350}$/ |
|
type |
(Да) |
Tип соответствия - параметры, с помощью которых группируются права на приобретения продукта |
|
|
|
amount |
(Нет) |
string |
Любые критерии приемлемости, требующие указания суммы или числа, например Минимальный возраст. |
/^(-?\d{1,14}){1}(.\d{1,4}){0,1}$/ |
|
indicator |
(Нет) |
boolean |
Любые критерии приемлемости, при которых значение может быть указано истинным или ложным значением. Резидент РФ - правда или ложь |
|
|
period |
(Нет) |
Единица измерения периода |
|
|
|
OtherEligibilityType |
(Нет) |
Другой тип объекта |
|
¶ MortgageFeeChargeDetail
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
feeType |
(Да) |
string |
Тип комиссии |
/^[\w\W]{1,80}$/ |
|
feeAmount |
(Нет) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
feeRate |
(Нет) |
string |
Ставка комиссии (% годовых) |
/^(-?\d{1,3}){1}(.\d{1,4}){0,1}$/ |
|
comments |
(Нет) |
string |
Комментарии и описания |
/^[\w\W]{1,350}$/ |
¶ OBRUError
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
errorCode |
(Да) |
Низкоуровневое описание ошибки. ПУ должен заполнить сообщение детальным описанием ошибки, не раскрывая конфиденциальную информацию. |
|
|
|
message |
(Да) |
string |
Описание ошибки |
/^[\w\W]{1,500}$/ |
|
path |
(Нет) |
string |
Путь к элементу с ошибкой в JSON объекте. Рекомендуемое, но не обязательное поле |
/^[\w\W]{1,500}$/ |
|
url |
(Нет) |
string; format: uri |
URL для помощи в устранении проблемы, Также через URL можно предоставлять дополнительную информацию |
|
¶ OBRUErrorResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
code |
(Да) |
string |
Высокоуровневый текстовый код ошибки, необходимый для классификации |
/^[a-zA-Z0-9-]{1,40}$/ |
|
id |
(Нет) |
string |
Уникальный идентификатор ошибки, для целей аудита, в случае неизвестных / не классифицированных ошибок |
/^[a-zA-Z0-9-]{1,40}$/ |
|
message |
(Да) |
string |
Краткое сообщение об ошибке. Например, «что-то не так с предоставленными параметрами запроса» |
/^[\w\W]{1,500}$/ |
|
Errors |
(Да) |
Контейнер с ошибкой |
|
¶ OfferDetails
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
creditProgram |
(Да) |
string |
Программа кредитования |
|
|
approveDateEnd |
(Да) |
string; format: date |
Дата окончания положительного решения (YYYY-MM-DD) |
/^\d{4}-\d{2}-\d{2}$/ |
|
ApprovedAmount |
(Да) |
Сумма денежных средств и код валюты |
|
|
|
ApprovedAmountMax |
(Нет) |
Сумма денежных средств и код валюты |
|
|
|
approvedloanPeriod |
(Да) |
integer |
Срок кредит кредитования |
|
|
approvedLoanPeriodUnit |
(Да) |
Единица измерения периода |
|
|
|
approvedFirstPayment |
(Нет) |
string |
Первоначальный взнос от, в % |
|
|
ApprovedMonthlyPayment |
(Нет) |
Сумма денежных средств и код валюты |
|
|
|
conditions |
(Нет) |
string |
Отлагательные условия (if available) |
|
|
approvedLoanRate |
(Да) |
string |
Одобренная ставка по кредиту |
/^(-?\d{1,3}){1}(.\d{1,4}){0,1}$/ |
|
managerFirstName |
(Нет) |
string |
Имя персонального менеджера на стороне банка (if available) |
|
|
managerLastName |
(Нет) |
string |
Фамилия персонального менеджера на стороне банка (if available) |
|
|
managerMiddleName |
(Нет) |
string |
Отчество персонального менеджера на стороне банка (if available) |
|
|
managerPhone |
(Нет) |
string |
Телефон персонального менеджера на стороне банка (if available) |
/^(+\d{1,2}\s?)?(\d{3})\s?\d{3}-\d{4}$/ |
|
lkz |
(Нет) |
string |
Ссылка для перехода в личный кабинет заемщика на стороне банка (if available) |
|
¶ Organisation
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
companyActivity |
(Нет) |
string |
Сфера деятельности организации |
/^[\w\W]{1,255}$/ |
|
name |
(Да) |
string |
Наименование организации |
/^[\w\W]{1,160}$/ |
|
Identification |
(Да) |
Идентификация организации |
|
|
|
postalAddress |
(Нет) |
string |
Строка адреса |
/^[\w\W]{1,140}$/ |
|
ContactDetails |
(Нет) |
Контактная информация |
|
|
|
taxSystem |
(Нет) |
Система налогообложения |
|
¶ OrganizationIdentification
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
name |
(Да) |
string |
Наименование организации |
/^[\w\W]{1,160}$/ |
|
OrganizationIdentification |
(Да) |
Идентификация юридического лица. |
|
¶ OrganizationIdentificationType
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
schemeName |
(Да) |
Схема идентификации юридического лица |
|
|
|
identification |
(Да) |
string |
Уникальный и однозначный идентификатор участника, присвоенный идентифицирующей организацией. |
/^[\w\W]{1,35}$/ |
¶ OtherDocumentRequirements
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
documentCount |
(Нет) |
integer |
Количество обязательных других документов |
|
|
DocumentRequirement |
(Нет) |
Информация о требовании к остальным документам. Для каждого типа требования type допускается только один элемент otherRequirement |
|
¶ OtherTypeCode
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
code |
(Нет) |
string |
Код идентификации объекта или краткое наименование |
/^[\w\W]{1,35}$/ |
|
name |
(Да) |
string |
Наименование, ассоциированное с кодом |
/^[\w\W]{1,70}$/ |
|
description |
(Да) |
string |
Описание применения кода |
/^[\w\W]{1,350}$/ |
¶ Passport
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
serial |
(Да) |
string |
4 цифры серии паспорта гражданина РФ, запрещен ввод всех значений "0" |
/\d{4}/ |
|
number |
(Да) |
string |
6 цифр номера паспорта гражданина РФ, запрещен ввод всех значений "0" |
/\d{6}/ |
|
issueDate |
(Да) |
string; format: date |
Дата без указания таймзоны |
/\d{4}-\d{2}-\d{2}/ |
|
issueAuthorityCode |
(Да) |
string |
Код подразделения |
|
|
issueAuthorityName |
(Нет) |
string |
Кем выдан |
|
¶ PassportDocumentRequirements
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
PassportRequirement |
(Нет) |
Информация о требовании к документу, удостоверяющему личность |
|
¶ PersonData
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
leadId |
(Нет) |
string; format: uuid |
Уникальный и неизменный идентификатор Пользователя, связанного с заявкой |
|
|
personRole |
(Да) |
Тип отношения к заявке |
|
|
|
isFinancial |
(Да) |
boolean |
Участвует доходами в сделке |
|
|
PersonIdentification |
(Да) |
Информация об участнике, используемая для идентификации юридического или физического лица |
|
|
|
RegistrationAddress |
(Да) |
Почтовый адрес |
|
|
|
ResidenceAddress |
(Да) |
Почтовый адрес |
|
|
|
PersonProfile |
(Да) |
Информация о профиле клиента |
|
|
|
CurrentPassport |
(Да) |
Описание бизнес-правил для заполнения паспортных данных |
|
|
|
PreviousPassport |
(Нет) |
Описание бизнес-правил для заполнения паспортных данных |
|
|
|
ConsentInformations |
(Нет) |
Информация о согласиях |
|
|
|
PersonDocuments |
(Нет) |
Описание бизнес-правил для отправки документов |
|
|
|
EsiaInformations |
(Нет) |
Исходные данные из ЦП |
|
¶ PersonData_EsiaInformations_inner
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
documentType |
(Да) |
string |
Вид документа |
/^[а-яА-Яa-zA-Z0-9_-]{1,255}$/ |
|
content |
(Да) |
string |
Документ в формате base64 |
/^([A-Za-z0-9+]*={0,2})$/ |
¶ PersonIdentification
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
FullName |
(Да) |
Используется для заполнения данных ФИО клиента |
|
|
|
countryOfResidence |
(Нет) |
string |
Код страны в формате ISO 3166-1 alpha-2 |
/^[A-Z]{2,2}$/ |
|
placeOfBirth |
(Нет) |
string |
Место рождения |
/^[\w\W]{1,128}$/ |
|
birthDate |
(Да) |
string; format: date |
Дата рождения |
|
|
Identification |
(Да) |
Идентификация юридического или физического лица. |
|
|
|
ContactDetails |
(Да) |
Контактная информация |
|
¶ PersonProfile
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
gender |
(Да) |
Пол |
|
|
|
maritalStatus |
(Да) |
Семейное положение |
|
|
|
hasMarriageContract |
(Нет) |
boolean |
До сделки предоставлю нотариальное согласие или брачный договор |
|
|
childrenNumber |
(Нет) |
string |
Количество детей до 18 лет |
|
|
childrenBirthDate |
(Нет) |
string; format: date |
Дата рождения ребенка (YYYY-MM-DD) |
|
|
childrenBirthDateSecond |
(Нет) |
string; format: date |
Дата рождения второго ребенка (YYYY-MM-DD) |
|
|
isChildrenWithDisability |
(Нет) |
boolean |
Ребенок с инвалидностью |
|
|
countDependents |
(Нет) |
integer |
Количество лиц на иждивении (в том числе неработающие супруги) |
|
|
education |
(Да) |
Образование |
|
|
|
EmploymentProfile |
(Да) |
Информация о месте работы |
|
|
|
JobExperience |
(Нет) |
Информация об общем опыте работы |
|
|
|
IncomeAndExpenses |
(Да) |
Информация о ежемесячных доходах и расходах |
|
¶ PostalAddress
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
addressType |
(Нет) |
Тип адреса |
|
|
|
addressLine |
(Нет) |
array[String] |
Строка адреса |
|
|
streetName |
(Нет) |
string |
Наименование улицы или проспекта |
/^[\w\W]{1,70}$/ |
|
buildingNumber |
(Нет) |
string |
Номер, который определяет положение здания на улице |
/^[\w\W]{1,16}$/ |
|
postCode |
(Нет) |
string |
Почтовый индекс |
/^[\w\W]{6,16}$/ |
|
townName |
(Нет) |
string |
Наименование населённого пункта или территории, находящейся вне границ поселений |
/^[\w\W]{1,35}$/ |
|
countrySubDivision |
(Нет) |
string |
Наименование и тип субъекта Российской Федерации |
/^[\w\W]{1,35}$/ |
|
country |
(Нет) |
string |
Код страны в формате ISO 3166-1 alpha-2 |
/^[A-Z]{2,2}$/ |
¶ ProductApplication
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
allowMultiOffer |
(Нет) |
boolean |
Указывает возможность возвращать множественное предложение по одной Заявке на продукт |
|
|
RequestedConditions |
(Нет) |
Запрашиваемые условия на приобретение продукта |
|
|
|
CustomerData |
(Да) |
Анкеты (заемщик/созаемщик/поручитель) связанные с Заявкой |
|
¶ ProductApplicationCreated
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка ответа ресурса Заявки на предложение по продукту |
|
|
|
Links |
(Нет) |
Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. |
|
|
|
Meta |
(Нет) |
Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. |
|
¶ ProductApplicationRequest
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка ресурса Заявка на предложение по продукту |
|
¶ ProductApplicationResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка ответа ресурса Заявки на предложение по продукту |
|
|
|
Links |
(Нет) |
Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. |
|
|
|
Meta |
(Нет) |
Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. |
|
¶ ProductApplicationStatusResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка ответа статуса Заявки на предложение по продукту |
|
|
|
Links |
(Нет) |
Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. |
|
|
|
Meta |
(Нет) |
Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. |
|
¶ ProductApplicationStatusResponse_Data
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
productApplicationId |
(Да) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Заявки на предложение по продукту |
|
|
creationDateTime |
(Нет) |
string; format: date-time |
Дата и время создания ресурса |
|
|
productApplicationStatus |
(Да) |
Статус Заявки на предложение по продукту |
|
|
|
statusUpdateDateTime |
(Да) |
string; format: date-time |
Дата и время обновления статуса ресурса |
|
|
StatusReasonInformation |
(Нет) |
Информация о причине статуса |
|
¶ ProductOffer
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
productOfferId |
(Да) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Предложения по продукту |
|
|
creationDateTime |
(Нет) |
string; format: date-time |
Дата и время создания Предложение по продукту |
|
|
productOfferStatus |
(Да) |
Статус Предложения по продукту |
|
|
|
statusUpdateDateTime |
(Нет) |
string; format: date-time |
Дата и время обновления статуса Предложение по продукту |
|
|
StatusReasonInformation |
(Нет) |
Информация о причине статуса |
|
|
|
productApplicationId |
(Нет) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса Заявки на предложение по продукту |
|
|
productId |
(Нет) |
string |
Уникальный идентификатор, присвоенный финансовым учреждением внутри компании каждому из банковских продуктов |
|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
|
startDateTime |
(Нет) |
string; format: date-time |
Дата и время начала предложения |
|
|
endDateTime |
(Нет) |
string; format: date-time |
Дата и время окончания действия предложения |
|
|
promoCode |
(Нет) |
string |
Промокод для получения специальных условий |
|
|
ApprovedConditions |
(Нет) |
Детальные условия |
|
|
|
LoanInterest |
(Нет) |
Условия кредитования, содержащие подробную информацию о процентных ставках для кредитных продуктов по группам |
|
|
|
applicationUri |
(Нет) |
string |
URL-адрес, по которому можно найти документацию по предложению |
|
|
Requirements |
(Нет) |
Описание требований и ограничений на получение продукта |
|
|
|
SupplementaryData |
(Нет) |
Дополнительная информация, которая не может быть записана в структурированных полях и/или любом другом конкретном блоке. Представляет собой JSON объект, схема которого согласуется между участниками взаимодействия и публикуется на портале ППД |
|
¶ ProductOfferResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Предложения по продукту |
|
|
|
Links |
(Нет) |
Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. |
|
|
|
Meta |
(Нет) |
Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. |
|
¶ ProductOffersResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка ресурса Предложения по продукту |
|
|
|
Links |
(Нет) |
Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. |
|
|
|
Meta |
(Нет) |
Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. |
|
¶ RequestedConditions
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
creditType |
(Нет) |
Вид ипотеки |
|
|
|
objectType |
(Нет) |
Тип недвижимости |
|
|
|
creditProgram |
(Нет) |
string |
Программа кредитования |
|
|
purchaseFromDeveloper |
(Нет) |
boolean |
Готов рассмотреть покупку у застройщика |
|
|
city |
(Да) |
string |
Город покупки/нахождения недвижимости |
|
|
initialCity |
(Да) |
string |
Город подачи заявки |
|
|
AssetsAmount |
(Нет) |
Сумма денежных средств и код валюты |
|
|
|
DownPayment |
(Нет) |
Сумма денежных средств и код валюты |
|
|
|
LoanRefinancedBalance |
(Нет) |
Сумма денежных средств и код валюты |
|
|
|
loanIssueDate |
(Нет) |
string; format: date |
Дата выдачи рефинансируемого кредита |
|
|
isMaternityCapital |
(Нет) |
boolean |
Будет использован материнский капитал |
|
|
maternityCapital |
(Нет) |
Сумма денежных средств и код валюты |
|
|
|
isPreviouslyRefinanced |
(Нет) |
boolean |
Ипотека ранее рефинансировалась |
|
|
PreviouslyBank |
(Нет) |
string |
Наименование банка, в котором оформен текущий кредит в случае рефинансирования |
|
|
loanPeriod |
(Нет) |
integer |
Период кредитования |
|
|
loanPeriodUnit |
(Нет) |
Единица измерения периода |
|
|
|
LoanAmount |
(Нет) |
Сумма кредита |
|
|
|
PledgeAddress |
(Нет) |
Почтовый адрес |
|
¶ Requirements
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
EmploymentRequirements |
(Нет) |
Ограничения по информации о трудоустройстве |
|
|
|
DocumentRequirements |
(Нет) |
Требования к документам для одобрения получения продукта у поставщика |
|
|
|
OtherTypeRequirements |
(Нет) |
Другие нестандартные требования |
|
¶ Signature
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
signatureType |
(Нет) |
Тип подписи |
|
|
|
value |
(Да) |
string |
Подпись данных в base64 |
|
¶ Signatures
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Signature |
(Нет) |
Описание сущности электронной подписи |
|
¶ SignedDocument
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
signedData |
(Да) |
string |
Подписанные данные в base64 |
|
|
Signatures |
(Нет) |
Список электронных подписей |
|
¶ SignedDocumentReadResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка ответа на запрос подписанного документа по идентификатору ресурса |
|
|
|
Links |
(Нет) |
Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. |
|
|
|
Meta |
(Нет) |
Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. |
|
¶ SignedDocumentRequest
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка при передаче подписанного документа |
|
¶ SignedDocumentResponse
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Полезная нагрузка ответа на запрос передачи подписанного документа |
|
|
|
Links |
(Нет) |
Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. |
|
|
|
Meta |
(Нет) |
Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. |
|
¶ StatusReasonInformation
|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
reason |
(Нет) |
Код причины статуса |
|
|
|
additionalInformation |
(Нет) |
string |
Текстовое описание причины присвоения статуса |
|
|
comments |
(Нет) |
string |
Комментарии, дополнительная информация |
|
¶ SupplementaryData
¶ Справочники и типы данных
¶ Введение
В рамках текущей спецификации определены статические типы данных в виде кодов, и динамические типы данных, представляющие собой расширяемый список значений. В случае необходимости Поставщик услуг может расширить список значений динамических данных, опубликовав информацию на портале разработчиков. Значения динамических типов данных располагаются в соответствующих пространствах имен, для идентификации источника, использующего расширение. Стандартные динамические значения представлены в данном стандарте и с префиксом RU.CBR. При добавлении собственных значений в справочники участники помещают такие значения в пространство имен, состоящее из двухбуквенного кода страны (код ISO 3166-1 Alpha-2), наименование организации в виде кода и значения справочного кода, разделенных между собой точкой, например:
¶ Типы данных, представленных в виде кодов
¶ AddressTypeCode
Тип адреса
|
Значение |
Описание |
|---|---|
Business |
Адрес, указанный в едином государственном реестре юридических лиц |
Correspondence |
Адрес для корреспонденции |
DeliveryTo |
Адрес доставки |
MailTo |
Почтовый ящик |
POBox |
Абонентский ящик |
Postal |
Фактический/почтовый адрес местонахождения юридического лица |
Residential |
Адрес постоянной регистрации физического лица (прописка) |
Statement |
Адрес временной регистрации физического лица (регистрация временного пребывания) |
¶ CreditType
Вид ипотеки
|
Значение |
Описание |
|---|---|
Purchase |
Покупка |
Refin |
Рефинансирование |
Pledge |
Под залог имеющейся недвижимости |
¶ DocumentSource
Источник документа
|
Значение |
Описание |
|---|---|
CustomerUpload |
Загружено клиентом |
DigitalProfile |
Из цифрового профиля |
¶ DocumentStatus
Статус обработки подписанного документа
|
Значение |
Описание |
|---|---|
Processing |
В обработке |
Rejected |
Отклонен |
Revoked |
Отработан и более не используется в процессе |
Expired |
Документ не актуален по истечению срока давности |
Accepted |
Документ принят для обработки |
¶ DocumentType
Тип документа
|
Значение |
Описание |
|---|---|
Personal |
Личные документы |
Registration |
Документы о регистрации |
Military |
Военные документы |
FamilyStatus |
Документы о семейном положении |
Children |
Документы о детях |
OtherDocuments |
Прочие документы |
Payroll |
Справка о заработной плате |
BankStatement |
Выписка по банковскому счету |
BankCertificate |
Справка из банка |
PensionBalance |
Справка о пенсионных накоплениях |
PensionCertificate |
Пенсионное удостоверение |
PensionStatement |
Выписка из пенсионного фонда |
OrganizationPensionCertificate |
Справка о пенсии от организации |
TaxReturnCopy |
Копия налоговой декларации |
AccountingBookCopy |
Копия книги учёта доходов и расходов |
DocumentPaymentTaxesCopy |
Копия документов об уплате налогов |
ActivityDescription |
Описание деятельности |
BalanceSheetCopy |
Копия бухгалтерского баланса |
IncomeStatementCopy |
Копия отчёта о финансовых результатах |
TaxReturnsSpecialTaxRegimesCopy |
Копия налоговых деклараций по специальным режимам |
NotificationApplicationSpecialTaxRegimeCopy |
Копия уведомления о применении специального налогового режима |
BanksCertificateAboutTurnover |
Справка из банка об оборотах |
ProfessionalIncomeTaxCertificate |
Справка о налоге на профессиональный доход |
NonStatePensionPaymentNotification |
Уведомление о выплате негосударственной пенсии |
ThreeNdfl |
Декларация 3-НДФЛ |
FreeFormCertificate |
Справка в свободной форме |
PayrollDp |
Справка о заработной плате (дополнительная) |
PensionCertificateDp |
Пенсионное удостоверение (дополнительное) |
PfrStatementDp |
Выписка из ПФР (дополнительная) |
EmploymentHistory |
Трудовая книжка |
JobContract |
Трудовой договор |
JobCertificate |
Справка с места работы |
NotesOnEgripEgrul |
Выписки из ЕГРИП/ЕГРЮЛ |
EgripEgrulCertificate |
Свидетельство ЕГРИП/ЕГРЮЛ |
StatutesCopy |
Копия устава |
FoundationAgreementCopy |
Копия учредительного договора |
OrderManagerCopy |
Копия приказа о назначении руководителя |
RegistrationCertificate |
Свидетельство о регистрации |
LawyersRegisterNotes |
Выписка из реестра адвокатов |
EmploymentProof |
Подтверждение занятости |
AppointmentNotaryOrder |
Приказ о назначении нотариуса |
ElectronicEmploymentHistoryDp |
Электронная трудовая книжка (дополнительная) |
Snils |
СНИЛС |
Inn |
ИНН |
DriverLicense |
Водительское удостоверение |
InternationalPassport |
Загранпаспорт |
MilitaryCertificate |
Военный билет |
ServiceCertificate |
Служебное удостоверение |
ClientPhoto |
Фотография клиента |
ClientPhotoWithPassport |
Фотография клиента с паспортом |
¶ DocumentType2
Тип документа
|
Значение |
Описание |
|---|---|
Passport |
Паспорт гражданина РФ |
ForeignPassport |
Паспорт Иностранного Гражданина |
InternationalPassport |
Загранпаспорт |
MilitaryCertificate |
Удостоверение Личности Военнослужащего |
DriverLicense |
Водительское Удостоверение |
ServiceCertificate |
Служебное Удостоверение |
¶ Education
Образование
|
Значение |
Описание |
|---|---|
HighSchool |
Среднее образование |
UnfinishedHighSchool |
Незаконченное среднее образование |
College |
Среднее специальное образование |
HigherEducation |
Высшее образование |
UnfinishedHigherEducation |
Незаконченное высшее образование |
TwoAndMoreHigherEducations |
Два и более высших образований |
PHD |
Ученая степень |
¶ EligibilityType
Tип соответствия - параметры, с помощью которых группируются права на приобретения продукта
|
Значение |
Описание |
|---|---|
NewCustomersOnly |
Продукт доступен только новым клиентам |
MinimumAge |
Минимальный возраст для получения продукта |
MaximumAge |
Максимальный возраст для получения продукта |
BusinessOnly |
Только для малого и среднего бизнеса |
CreditScoring |
Для прошедших кредитных скоринг |
ExistingCustomers |
Для клиентов кредитной организации |
IdAndV |
Для идентифицированных клиентов |
Mortgage |
Клиент должен иметь ипотеку в кредитной организации |
NoArrearsOnLoan |
Продукт недоступен для клиента, имеющего задолженность по кредиту |
NoCustomerInArrears |
Продукт недоступен для клиента с какой-либо просроченной задолженностью |
StartUp |
На открытие малого и среднего бизнеса |
Turnover |
Ограничено по уровню оборота компании |
MinimumBalanceAmont |
По минимальной сумме остатка |
MinimumTotalDebit |
По минимальной сумме списания |
MinimumTotalCredit |
По минимальной сумме начисления |
jobExperience |
По продолжительности стажа |
jobExperienceLast |
По продолжительности стажа на последнем месте работы |
Other |
Использовать OtherEligibilityType для любых не охваченных критериев соответствия |
¶ EmploymentType
Тип занятости
|
Значение |
Описание |
|---|---|
Employee |
Наемный работник |
IndividualEntrepreneur |
Индивидуальный предприниматель |
BusinessOwner |
Собственник бизнеса |
SelfEmployed |
Самозанятый |
Pensioner |
Пенсионер |
¶ ExpensesCode
Код вида расхода
|
Значение |
Описание |
|---|---|
ЕХOT |
Другой вид расхода |
¶ FamilyStatus
Семейное положение
|
Значение |
Описание |
|---|---|
Single |
Не женат |
Married |
Женат |
Divorced |
В разводе |
Cohabitate |
Сожитель |
Widow |
Вдова/вдовец |
¶ FinanceDocumentType
Тип документа подтверждения дохода
|
Значение |
Описание |
|---|---|
Payroll |
Справка о заработной плате |
BankStatement |
Выписка по банковскому счету |
BankCertificate |
Справка из банка |
PensionBalance |
Справка о пенсионных накоплениях |
PensionCertificate |
Пенсионное удостоверение |
PensionStatement |
Выписка из пенсионного фонда |
OrganizationPensionCertificate |
Справка о пенсии от организации |
TaxReturnCopy |
Копия налоговой декларации |
AccountingBookCopy |
Копия книги учёта доходов и расходов |
DocumentPaymentTaxesCopy |
Копия документов об уплате налогов |
ActivityDescription |
Описание деятельности |
BalanceSheetCopy |
Копия бухгалтерского баланса |
IncomeStatementCopy |
Копия отчёта о финансовых результатах |
TaxReturnsSpecialTaxRegimesCopy |
Копия налоговых деклараций по специальным режимам |
NotificationApplicationSpecialTaxRegimeCopy |
Копия уведомления о применении специального налогового режима |
BanksCertificateAboutTurnover |
Справка из банка об оборотах |
ProfessionalIncomeTaxCertificate |
Справка о налоге на профессиональный доход |
NonStatePensionPaymentNotification |
Уведомление о выплате негосударственной пенсии |
ThreeNdfl |
Декларация 3-НДФЛ |
FreeFormCertificate |
Справка в свободной форме |
PayrollDp |
Справка о заработной плате (дополнительная) |
PensionCertificateDp |
Пенсионное удостоверение (дополнительное) |
PfrStatementDp |
Выписка из ПФР (дополнительная) |
¶ FrequencyType
Частота применения операции в периоде времени
|
Значение |
Описание |
|---|---|
Daily |
Ежедневно |
Weekly |
Еженедельно |
Monthly |
Ежемесячно |
Quarterly |
Поквартально |
Yearly |
Ежегодно |
PerOccurrence |
По возникновению события |
Never |
Не установлено ограничение по времени |
Other |
Другое |
¶ Gender
Пол
|
Значение |
Описание |
|---|---|
Male |
Мужской |
Female |
Женский |
¶ IncomeSource
Тип места работы, привязанный к источнику дохода
|
Значение |
Описание |
|---|---|
PrincipalPlaceWork |
Основное место работы |
PartTimeJob |
По совместительству |
Other |
Другое |
¶ InterestRateType
Типы процентных ставок, кроме базовых годовых, которые финансовые учреждения могут использовать для описания годовой и (или) дневной процентной ставки
|
Значение |
Описание |
|---|---|
INBR |
Процентная ставка, связанная с процентной ставкой ЦБ РФ |
INFR |
Фиксированная процентная ставка |
INGR |
Процентная ставка без учета налоговых выплат |
INLR |
Базовая процентная ставка поставщика финансовой услуги |
INNE |
Процентная ставка с учетом налоговых выплат |
INOT |
Другой тип процентной ставки |
¶ JobDocumentType
Тип документа подтверждения занятости
|
Значение |
Описание |
|---|---|
EmploymentHistory |
Трудовая книжка |
JobContract |
Трудовой договор |
JobCertificate |
Справка с места работы |
NotesOnEgripEgrul |
Выписки из ЕГРИП/ЕГРЮЛ |
EgripEgrulCertificate |
Свидетельство ЕГРИП/ЕГРЮЛ |
StatutesCopy |
Копия устава |
FoundationAgreementCopy |
Копия учредительного договора |
OrderManagerCopy |
Копия приказа о назначении руководителя |
RegistrationCertificate |
Свидетельство о регистрации |
LawyersRegisterNotes |
Выписка из реестра адвокатов |
EmploymentProof |
Подтверждение занятости |
AppointmentNotaryOrder |
Приказ о назначении нотариуса |
ElectronicEmploymentHistoryDp |
Электронная трудовая книжка (дополнительная) |
¶ OBRUErrorResponseErrorCode
Низкоуровневое описание ошибки. ПУ должен заполнить сообщение детальным описанием ошибки, не раскрывая конфиденциальную информацию.
|
Код ошибки |
HTTP статус |
Описание |
|---|---|---|
RU.CBR.Field.Expected |
400 |
Если поля передаются парой (ключ-значение) и значение не было передано. В поле path должен передаваться путь к ожидаемому полю (например, ErrorResponse.Errors.path == “AccountResponse.Data.Account.AccountDetails.identification”). Например, для допустимого значения поля «schemeName» должно передаваться соответствующее значение идентификатора в поле «identification». |
RU.CBR.Field.Invalid |
400 |
В поле указано недопустимое значение или длина предоставленного значения превышает соответствующую максимальную длину поля в домене ПУ. Ссылка на недопустимое поле должна быть указана в поле path (например, ErrorResponse.Errors.path == “AccountResponse.Data.Account.AccountDetails.schemeName”). В поле URL может быть ссылка на веб-страницу, объясняющую правильное поведение. |
RU.CBR.Field.InvalidDate |
400 |
Указана неверная дата. Например, когда ожидается будущая дата, а указана дата в прошлом или текущая дата. Ссылка на недопустимое поле должна быть указана в поле path. |
RU.CBR.Field.Missing |
400 |
Обязательное поле, необходимое для API, отсутствует в полезной нагрузке. Данный код ошибки можно использовать, если ошибка еще не определена при проверке RU.CBR.Resource.InvalidFormat. |
RU.CBR.Header.Invalid |
400 |
В элементе заголовка HTTP указано неверное значение. Элемент заголовка HTTP должен быть указан в элементе пути. |
RU.CBR.Header.Missing |
400 |
Обязательный элемент HTTP-заголовка не был предоставлен. Элемент заголовка HTTP должен быть указан в элементе path. |
RU.CBR.Resource.InvalidFormat |
400 |
Json-схема полезной нагрузки не соответствует конечной точке. Например, конечная точка POST /account-consents вызывается с полезной нагрузкой JSON, которая не может быть проанализирована в классе ConsentRequest. |
RU.CBR.Resource.NotFound |
400 |
Ресурс с указанным идентификатором не существует или не может быть обработан (в том числе неприемлемый формат или значение идентификатора ресурса). |
RU.CBR.Resource.NotCreated |
400 |
Ресурс с указанным идентификатором еще не создан и не может быть передан в ответном сообщении. Для асинхронных вызовов. |
RU.CBR.Rules.AfterCutOffDateTime |
400 |
Ресурс согласия или ресурс платежа запрашиваются после даты CutOffDateTime. |
RU.CBR.Signature.Invalid |
400 |
Заголовок подписи x-jws-signature был проанализирован и имеет действительный заголовок JOSE, соответствующий спецификации. Но сама подпись не может быть проверена. |
RU.CBR.Signature.InvalidClaim |
400 |
Заголовок JOSE в элементе x-jws-signature имеет одно или несколько утверждений (claim) с недопустимым значением. |
RU.CBR.Signature.MissingClaim |
400 |
Заголовок JOSE в элементе x-jws-signature имеет одно или несколько обязательных утверждений, которые не указаны. |
RU.CBR.Signature.Malformed |
400 |
x-jws-signature в заголовке запроса была искажена и не могла быть проанализирована как допустимый JWS. |
RU.CBR.Signature.Missing |
400 |
Запрос API предполагает x-jws-signature в заголовке, но элемент отсутствовал. |
RU.CBR.Unsupported.AccountIdentifier |
400 |
Идентификатор счета не поддерживается для данной схемы. Элемент path должен быть заполнен путем к элементу accountIdentifier. |
RU.CBR.Unsupported.LocalInstrument |
400 |
Указанный localInstrument не поддерживается ПУ. Элемент path должен быть заполнен путем к элементу localInstrument. |
RU.CBR.Operation.Unprocessable |
400 |
Операция по извлечению ресурса не может быть выполнена или недопустима. |
RU.CBR.Authenticate.InvalidScope |
403 |
Предъявленный токен доступа не содержит область действия ("scope") необходимую для доступа к ресурсу. |
RU.CBR.Authenticate.InvalidConsent |
403 |
Отказано доступу к ресурсу с указанным идентификатором, так как согласие Пользователя отсутствует или не корректно. |
RU.CBR.Authenticate.SuspiciousActivityDetected |
403 |
Доступ к ресурсу приостановлен по причине выявления подозрения на мошеннические действия. |
RU.CBR.Rules.ResourceAlreadyExists |
409 |
Ресурс с такими же параметрами уже существует. |
RU.CBR.UnexpectedError |
5xx |
Данный код ошибки можно использовать при возникновении непредвиденной ошибки. |
¶ ObjectType
Тип недвижимости
|
Значение |
Описание |
|---|---|
ApartmentNew |
Апартаменты в новостройке |
ApartmentSecondary |
Апартаменты на вторичном рынке |
CommercialNew |
Коммерческая недвижимость в новостройке |
CommercialSecondary |
Коммерческая недвижимость на вторичном рынке |
FlatNew |
Квартира в новостройке |
FlatSecondary |
Квартира на вторичном рынке |
HouseNew |
Строительство дома |
HouseSecondary |
Готовый дом с землей |
LandPlot |
Земельный участок |
HouseNewWithLandPlot |
Строительство дома с земельным участком |
Room |
Комната |
lastShare |
Последняя доля в квартире (lastShare) |
GarageSecondary |
Гараж/машино-место/кладовка |
GarageNew |
Гараж или машино-место в новостройке |
¶ OrganizationIdentificationCode
Схема идентификации юридического лица
|
Значение |
Описание |
|---|---|
RU.CBR.TXID |
Используется в случае идентификационной схемы ИНН/КИО |
RU.CBR.LEI |
Код организации в соответствии с ISO 17442 |
RU.CBR.TAXT |
КПП |
RU.CBR.OGRN |
ОГРН |
RU.CBR.OKPO |
ОКПО |
¶ PartyIdentificationCode
Схема идентификации юридического или физического лица
|
Значение |
Описание |
|---|---|
RU.CBR.TXID |
Используется в случае идентификационной схемы ИНН/КИО |
RU.CBR.LEI |
Код организации в соответствии с ISO 17442 |
RU.CBR.PASP |
Номер паспорта |
RU.CBR.CLID |
Другой идентификатор |
RU.CBR.QRST |
Идентификатор в виде QR - кода |
RU.CBR.TAXT |
КПП |
RU.CBR.OGRN |
ОГРН |
RU.CBR.SNILS |
СНИЛС |
RU.CBR.PAN |
Идентификатор платежной карты |
RU.CBR.MTEL |
Номер мобильного телефона |
RU.CBR.BBAN |
Идентификатор банковского счета |
¶ PeriodUnit
Единица измерения периода
|
Значение |
Описание |
|---|---|
Second |
Секунда |
Minute |
Минута |
Hour |
Час |
Day |
День |
Week |
Неделя |
Month |
Месяц |
Quarter |
Квартал |
HalfYear |
Полугодие |
Year |
Год |
AcademicTerm |
Академическая единица |
¶ PersonRole
Тип отношения к заявке
|
Значение |
Описание |
|---|---|
Borrower |
Заемщик |
Coborrower |
Созаемщик |
Guarantor |
Поручитель |
¶ ProductApplicationStatus
Статус Заявки на предложение по продукту
|
Значение |
Описание |
|---|---|
Pending |
Поступила на обработку |
DecisionProcessing |
В обработке |
BorrowerCorrection |
Требуется доработка по заемщику |
BorrowerApproved |
Одобрена |
LoanIssued |
Кредит выдан |
Expired |
Истек срок решения |
Rejected |
Отклонена |
Revoked |
Отозвана Пользователем |
PledgeApproved |
Залог одобрен |
AssetDoccumentSigning |
Подписание КОД (Кредитно-обеспечительная документация) |
¶ ProductOfferStatus
Статус Предложения по продукту
|
Значение |
Описание |
|---|---|
Pending |
Поступила на обработку |
Processing |
В обработке |
AssetApproved |
Залог одобрен |
LoanApproved |
Кредит одобрен |
LoanUssued |
Кредит выдан |
Expired |
Истек срок решения |
Rejected |
Отклонено Пользователем |
Revoked |
Отозвано |
¶ SignatureType
Тип подписи. Возможные значения
|
Значение |
Описание |
|---|---|
CUSTOMER |
Клиент |
PLATFORM |
Платформа |
PROVIDER |
Провайдер |
¶ StatusReasonCode
Код причины статуса
|
Значение |
Описание |
|---|---|
Cancelled |
Отменено |
¶ TaxSystem
Система налогообложения
|
Значение |
Описание |
|---|---|
OSNO |
Общая (базовая) система налогообложения |
USN |
Упрощённая система налогообложения |
ESXN |
Единый сельскохозяйственный налог |
PSN |
Патентная система налогообложения |
NPD |
Налог на профессиональный доход |
AUSN |
Автоматическая система налогообложения |
¶ TierBandMethod
Виды процентной ставки
|
Значение |
Описание |
|---|---|
Floated |
Плавающая процентная ставка, подлежит периодическому пересмотру по мере изменения остатка / задолженности |
Tiered |
Многоуровневая процентная ставка, определяет фиксированное значения процентов для определенного уровня / диапазона остатка / задолженности |
Fixed |
Фиксированная процентная ставка, подразумевает неизменную на протяжении всего периода соглашения процентную величину |
¶ jobType
Тип места работы
|
Значение |
Описание |
|---|---|
PrincipalPlaceWork |
Основное место работы |
PartTimeJob |
По совместительству |
¶ positionCategory
Тип занимаемой должности
|
Значение |
Описание |
|---|---|
Head |
Руководитель организации |
HeadDivision |
Руководитель подразделения |
Expert |
Cпециалист |
CivilServant |
Госслужащий |
Military |
Военнослужащий |
NotQualifiedEmployee |
Сотрудник без квалификации |
¶ Примеры использования
¶ Управление заявками в кредитную организацию
¶ Авторизация запроса
Для создания заявки на предложение по продукту СПУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать offers).
¶ Создание заявки на предложение по продукту
Вызов POST /product-applications позволяет инициировать Заявку на предложение по продукту от Финансовой площадки к Поставщику услуг.
¶ Запрос
POST /product-applications HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d
x-idempotency-key: 550e8400-e29b-41d4-a716-446655440000
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Accept: application/json
{
"Data": {
"ProductApplication": {
"allowMultiOffer": true,
"RequestedConditions": {
"creditType": "Purchase",
"objectType": "FlatSecondary",
"creditProgram": "30-Year Fixed",
"purchaseFromDeveloper": true,
"city": "Мойгород",
"initialCity": "Мойгород",
"AssetsAmount": {
"amount": "200.00",
"currency": "RUB"
},
"DownPayment": {
"amount": "200.00",
"currency": "RUB"
},
"LoanRefinancedBalance": {
"amount": "200.00",
"currency": "RUB"
},
"loanIssueDate": "2024-12-06",
"isMaternityCapital": true,
"maternityCapital": {
"amount": "200.00",
"currency": "RUB"
},
"isPreviouslyRefinanced": true,
"PreviouslyBank": "АО МойБанк",
"loanPeriod": 1,
"loanPeriodUnit": "Month",
"LoanAmount": {
"PrincipalLoanAmount": {
"amount": "200.00",
"currency": "RUB"
},
"TopUpAmount": {
"amount": "200.00",
"currency": "RUB"
}
},
"PledgeAddress": {
"addressType": "Postal",
"addressLine": [
"Адрес в виде строки",
"вторая часть строки адреса"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
}
},
"CustomerData": [
{
"leadId": "95791e79-0f2d-47de-a5e0-df034b28574a",
"personRole": "Borrower",
"isFinancial": true,
"PersonIdentification": {
"FullName": {
"lastName": "string",
"firstName": "string",
"middleName": "string"
},
"countryOfResidence": "RU",
"placeOfBirth": "Ставропольский край, Георгивский район",
"birthDate": "2001-06-05",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240240"
}
],
"ContactDetails": {
"phoneNumber": "79251230000",
"emailAddress": "support@example.ru",
"other": "Дополнительная контактная информация"
}
},
"RegistrationAddress": {
"addressType": "Postal",
"addressLine": [
"Адрес в виде строки",
"вторая часть строки адреса"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"ResidenceAddress": {
"addressType": "Postal",
"addressLine": [
"Адрес в виде строки",
"вторая часть строки адреса"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"PersonProfile": {
"gender": "Male",
"maritalStatus": "Single",
"hasMarriageContract": true,
"childrenNumber": "2",
"childrenBirthDate": "2019-08-24",
"childrenBirthDateSecond": "2019-08-24",
"isChildrenWithDisability": true,
"countDependents": 0,
"education": "HighSchool",
"EmploymentProfile": [
{
"jobType": "PrincipalPlaceWork",
"employmentType": "Employee",
"positionCategory": "Expert",
"position": "string",
"Organisation": {
"companyActivity": "string",
"name": "Наименование организации",
"Identification": [
{}
],
"postalAddress": "Адрес в виде строки",
"ContactDetails": {},
"taxSystem": "OSNO"
},
"SalaryBank": {
"name": "Наименование организации или физического лица",
"OrganizationIdentification": [
null
]
},
"jobExperienceLast": 3,
"jobExperienceLastPeriod": "Month",
"businessShare": 21,
"hasIncomeFromDividends": true
}
],
"JobExperience": {
"jobExperience": 12,
"jobExperiencePeriod": "Month"
},
"IncomeAndExpenses": {
"IncomeInformation": [
{
"incomePeriod": "Month",
"Amount": {},
"IncomeType": {},
"solvencyProof": "Справка 2-НДФЛ",
"OtherIncomeType": {}
}
],
"ExpensesInformation": [
{
"expensesPeriod": "Month",
"Amount": {},
"expensesCode": "ЕХOT",
"OtherExpensesType": {}
}
]
}
},
"CurrentPassport": {
"serial": "string",
"number": "string",
"issueDate": "2019-08-24",
"issueAuthorityCode": "string",
"issueAuthorityName": "string"
},
"PreviousPassport": {
"serial": "string",
"number": "string",
"issueDate": "2019-08-24",
"issueAuthorityCode": "string",
"issueAuthorityName": "string"
},
"ConsentInformations": [
{
"consentFlag": true,
"consentStartDate": "2019-08-24",
"consentFile": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0",
"consentHash": "7a48a391ab99161cec000b4d4e6962474d536bbf",
"consentType": "string",
"esiaToken": "ERFBddU8y0LDQvdC4NC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0",
"tppSignatureForEsiaToken": "YDQvtCQWERFBdLTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQFzZTY0",
"tppSignatureLog": "0QWERFBddU8y0LDQLTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQFzZTY0"
}
],
"PersonDocuments": [
{
"type": "Personal",
"customerDocumentSource": "CustomerUpload",
"comments": [
"Комментарии к документу"
],
"DocumentFiles": [
{
"documentName": "Паспорт",
"fileName": "string",
"contentType": "PDF",
"content": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0"
}
]
}
],
"EsiaInformations": [
{
"documentType": "string",
"content": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0"
}
]
}
]
}
}
}
¶ Ответ
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Content-Type: application/json
{
"Data": {
"productApplicationId": "OFFER-01-df034b28574a",
"creationDateTime": "2019-08-24T14:15:22Z",
"productApplicationStatus": "Rejected",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"StatusReasonInformation": {
"reason": "Cancelled",
"additionalInformation": "Повторное обращение",
"comments": [
"Информация для клиента"
]
}
},
"Links": {
"self": "https://sb.example.ru/v1.3/example?page=1",
"first": "https://sb.example.ru/v1.3/example?page=1",
"prev": "https://sb.example.ru/v1.3/example?page=1",
"next": "https://sb.example.ru/v1.3/example?page=1",
"last": "https://sb.example.ru/v1.3/example?page=1"
},
"Meta": {
"totalPages": 1
}
}
¶ Получение информации о Заявке на предложение по продукту по идентификатору
¶ Запрос
GET /product-applications/{productApplicationId}/ HTTP/1.1
Authorization: Bearer Az90SAOJklae
productApplicationId: APPLICATION-01-df034b28574a
Accept: application/json
¶ Ответ
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Content-Type: application/json
{
"Data": {
"productApplicationId": "OFFER-01-df034b28574a",
"creationDateTime": "2019-08-24T14:15:22Z",
"productApplicationStatus": "Rejected",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"StatusReasonInformation": {
"reason": "Cancelled",
"additionalInformation": "Повторное обращение",
"comments": [
"Информация для клиента"
]
},
"ProductApplication": {
"allowMultiOffer": true,
"RequestedConditions": {
"creditType": "Purchase",
"objectType": "FlatSecondary",
"creditProgram": "30-Year Fixed",
"purchaseFromDeveloper": true,
"city": "Мойгород",
"initialCity": "Мойгород",
"AssetsAmount": {
"amount": "200.00",
"currency": "RUB"
},
"DownPayment": {
"amount": "200.00",
"currency": "RUB"
},
"LoanRefinancedBalance": {
"amount": "200.00",
"currency": "RUB"
},
"loanIssueDate": "2024-12-06",
"isMaternityCapital": true,
"maternityCapital": {
"amount": "200.00",
"currency": "RUB"
},
"isPreviouslyRefinanced": true,
"PreviouslyBank": "АО МойБанк",
"loanPeriod": 1,
"loanPeriodUnit": "Month",
"LoanAmount": {
"PrincipalLoanAmount": {
"amount": "200.00",
"currency": "RUB"
},
"TopUpAmount": {
"amount": "200.00",
"currency": "RUB"
}
},
"PledgeAddress": {
"addressType": "Postal",
"addressLine": [
"Адрес в виде строки",
"вторая часть строки адреса"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
}
},
"CustomerData": [
{
"leadId": "95791e79-0f2d-47de-a5e0-df034b28574a",
"personRole": "Borrower",
"isFinancial": true,
"PersonIdentification": {
"FullName": {
"lastName": "string",
"firstName": "string",
"middleName": "string"
},
"countryOfResidence": "RU",
"placeOfBirth": "Ставропольский край, Георгивский район",
"birthDate": "2001-06-05",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240240"
}
],
"ContactDetails": {
"phoneNumber": "79251230000",
"emailAddress": "support@example.ru",
"other": "Дополнительная контактная информация"
}
},
"RegistrationAddress": {
"addressType": "Postal",
"addressLine": [
"Адрес в виде строки",
"вторая часть строки адреса"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"ResidenceAddress": {
"addressType": "Postal",
"addressLine": [
"Адрес в виде строки",
"вторая часть строки адреса"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"PersonProfile": {
"gender": "Male",
"maritalStatus": "Single",
"hasMarriageContract": true,
"childrenNumber": "2",
"childrenBirthDate": "2019-08-24",
"childrenBirthDateSecond": "2019-08-24",
"isChildrenWithDisability": true,
"countDependents": 0,
"education": "HighSchool",
"EmploymentProfile": [
{
"jobType": "PrincipalPlaceWork",
"employmentType": "Employee",
"positionCategory": "Expert",
"position": "string",
"Organisation": {
"companyActivity": "string",
"name": "Наименование организации",
"Identification": [
{}
],
"postalAddress": "Адрес в виде строки",
"ContactDetails": {},
"taxSystem": "OSNO"
},
"SalaryBank": {
"name": "Наименование организации или физического лица",
"OrganizationIdentification": [
null
]
},
"jobExperienceLast": 3,
"jobExperienceLastPeriod": "Month",
"businessShare": 21,
"hasIncomeFromDividends": true
}
],
"JobExperience": {
"jobExperience": 12,
"jobExperiencePeriod": "Month"
},
"IncomeAndExpenses": {
"IncomeInformation": [
{
"incomePeriod": "Month",
"Amount": {},
"IncomeType": {},
"solvencyProof": "Справка 2-НДФЛ",
"OtherIncomeType": {}
}
],
"ExpensesInformation": [
{
"expensesPeriod": "Month",
"Amount": {},
"expensesCode": "ЕХOT",
"OtherExpensesType": {}
}
]
}
},
"CurrentPassport": {
"serial": "string",
"number": "string",
"issueDate": "2019-08-24",
"issueAuthorityCode": "string",
"issueAuthorityName": "string"
},
"PreviousPassport": {
"serial": "string",
"number": "string",
"issueDate": "2019-08-24",
"issueAuthorityCode": "string",
"issueAuthorityName": "string"
},
"ConsentInformations": [
{
"consentFlag": true,
"consentStartDate": "2019-08-24",
"consentFile": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0",
"consentHash": "7a48a391ab99161cec000b4d4e6962474d536bbf",
"consentType": "string",
"esiaToken": "ERFBddU8y0LDQvdC4NC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0",
"tppSignatureForEsiaToken": "YDQvtCQWERFBdLTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQFzZTY0",
"tppSignatureLog": "0QWERFBddU8y0LDQLTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQFzZTY0"
}
],
"PersonDocuments": [
{
"type": "Personal",
"customerDocumentSource": "CustomerUpload",
"comments": [
"Комментарии к документу"
],
"DocumentFiles": [
{
"documentName": "Паспорт",
"fileName": "string",
"contentType": "PDF",
"content": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0"
}
]
}
],
"EsiaInformations": [
{
"documentType": "string",
"content": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0"
}
]
}
]
}
},
"Links": {
"self": "https://sb.example.ru/v1.3/example?page=1",
"first": "https://sb.example.ru/v1.3/example?page=1",
"prev": "https://sb.example.ru/v1.3/example?page=1",
"next": "https://sb.example.ru/v1.3/example?page=1",
"last": "https://sb.example.ru/v1.3/example?page=1"
},
"Meta": {
"totalPages": 1
}
}
¶ Удаление Заявки на предложение по продукту
¶ Запрос
DELETE /product-applications/{productApplicationId}/ HTTP/1.1
Authorization: Bearer Az90SAOJklae
productApplicationId: APPLICATION-01-df034b28574a
¶ Ответ
HTTP/1.1 204
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
¶ Получение информации о статусе Заявки на предложение по продукту по идентификатору
¶ Запрос
GET /product-applications/{productApplicationId}/product-application-details HTTP/1.1
Authorization: Bearer Az90SAOJklae
productApplicationId: APPLICATION-01-df034b28574a
Accept: application/json
¶ Ответ
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Content-Type: application/json
{
"Data": {
"productApplicationId": "OFFER-01-df034b28574a",
"creationDateTime": "2019-08-24T14:15:22Z",
"productApplicationStatus": "Rejected",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"StatusReasonInformation": {
"reason": "Cancelled",
"additionalInformation": "Повторное обращение",
"comments": [
"Информация для клиента"
]
}
},
"Links": {
"self": "https://sb.example.ru/v1.3/example?page=1",
"first": "https://sb.example.ru/v1.3/example?page=1",
"prev": "https://sb.example.ru/v1.3/example?page=1",
"next": "https://sb.example.ru/v1.3/example?page=1",
"last": "https://sb.example.ru/v1.3/example?page=1"
},
"Meta": {
"totalPages": 1
}
}
¶ Предложения по продукту
¶ Список Предложений по продукту для определенной Заявки по ее идентификатору
¶ Запрос
GET /product-applications/{productApplicationId}/product-offers HTTP/1.1
Authorization: Bearer Az90SAOJklae
productApplicationId: APPLICATION-01-df034b28574a
Accept: application/json
¶ Ответ
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Content-Type: application/json
{
"Data": {
"ProductOffer": [
{
"productOfferId": "OFFER-01-df034b28574a",
"creationDateTime": "2019-08-24T14:15:22Z",
"productOfferStatus": "Rejected",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"StatusReasonInformation": {
"reason": "Cancelled",
"additionalInformation": "Повторное обращение",
"comments": [
"Информация для клиента"
]
},
"productApplicationId": "OFFER-01-df034b28574a",
"productId": "string",
"comments": [
"Информация для клиента"
],
"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z",
"promoCode": "string",
"ApprovedConditions": {
"creditProgram": "30-Year Fixed",
"approveDateEnd": "2023-09-30",
"ApprovedAmount": {
"amount": "200.00",
"currency": "RUB"
},
"ApprovedAmountMax": {
"amount": "200.00",
"currency": "RUB"
},
"approvedloanPeriod": 1,
"approvedLoanPeriodUnit": "Month",
"approvedFirstPayment": "20",
"ApprovedMonthlyPayment": {
"amount": "200.00",
"currency": "RUB"
},
"conditions": "Low-interest rate for the first year",
"approvedLoanRate": "14.00",
"managerFirstName": "Alex",
"managerLastName": "Johnson",
"managerMiddleName": "Michael",
"managerPhone": "+7 (123) 456-7890",
"lkz": "https://bank.example.com/lkz"
},
"LoanInterest": [
{
"tierBandMethod": "Fixed",
"comments": "Комментарии и описания для Пользователя, характеризующие группу процентных ставок",
"LoanInterestTierBand": [
{
"comments": "Ограниченный срок предложения",
"interestRate": "12.0",
"interestRateType": "INFR",
"tierCurrency": "RUB",
"tierValueMinimum": "3000000.00",
"tierValueMaximum": "100000000.00",
"tierValueMinTerm": 5,
"minTermPeriod": "Year",
"tierValueMaxTerm": 9,
"maxTermPeriod": "Year",
"calculationFrequency": "Monthly",
"unitOfPeriod": "Year"
},
{
"comments": "Наиболее выгодная ставка",
"interestRate": "10.0",
"interestRateType": "INFR",
"tierCurrency": "RUB",
"tierValueMinimum": "3000000.00",
"tierValueMaximum": "100000000.00",
"tierValueMinTerm": 10,
"minTermPeriod": "Year",
"tierValueMaxTerm": 20,
"maxTermPeriod": "Year",
"calculationFrequency": "Monthly",
"unitOfPeriod": "Year"
}
],
"TierBandSetEligibility": [
{
"name": "Привлечение клиентов",
"type": "NewCustomersOnly",
"indicator": true
},
{
"name": "Минимальный возраст",
"type": "MinimumAge",
"amount": "21"
},
{
"name": "Максимальный возраст",
"type": "MaximumAge",
"amount": "70"
},
{
"name": "Стаж работы на последнем месте (лет)",
"type": "jobExperienceLast",
"amount": "1"
},
{
"name": "Проживание и гражданство",
"type": "Other",
"indicator": true,
"OtherEligibilityType": {
"name": "Регистрация по месту жительства",
"description": "Требуется постоянная регистрация на территории РФ"
}
}
],
"AdditionalServices": {
"serviceIdentification": "INS-01-asdf-01",
"serviceType": "Страхование",
"serviceName": "Страхование жизни и здоровья",
"comments": "string",
"FeesCharges": [
{
"feeType": "Ежемесячный страховой взнос % от суммы займа",
"feeRate": "2"
},
{
"feeType": "Ежемесячная оплата услуги",
"feeAmount": "240.00"
}
],
"required": true,
"costIncreaseInformation": "+ 2% к процентной ставке/ полной стоимости займа в случае отказа от личного страхования"
}
}
],
"applicationUri": "https://mybank.ru/products/credit-card/applay",
"Requirements": {
"EmploymentRequirements": {
"employmentCategories": "Employee",
"incomeProof": true,
"incomeAmount": "200.00",
"jobExperience": "12",
"jobExperiencePeriod": "Month",
"jobExperienceLast": "3",
"jobExperienceLastPeriod": "Month",
"comments": [
"Информация для клиента"
]
},
"DocumentRequirements": {
"comments": [
"Все документы должны быть представлены в 2 экземплярах"
],
"PassportRequirements": {
"comments": [
"Информация для клиента"
],
"PassportRequirement": [
{
"required": true,
"comments": [
null
],
"type": "Passport"
}
]
},
"FinanceDocumentsRequirements": {
"comments": [
"Информация для клиента"
],
"documentCount": 1,
"FinanceDocumentRequirement": [
{
"required": true,
"comments": [
null
],
"type": "Payroll"
}
]
},
"JobDocumentsRequirements": {
"comments": [
"Информация для клиента"
],
"documentCount": 1,
"JobDocumentRequirement": [
{
"required": true,
"comments": [
null
],
"type": "EmploymentHistory"
}
]
},
"OtherDocumentsRequirements": {
"comments": [
"Информация для клиента"
],
"documentCount": 1,
"DocumentRequirement": [
{
"required": true,
"comments": [
null
],
"type": "Passport"
}
]
}
},
"OtherTypeRequirements": [
{
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
}
]
},
"SupplementaryData": {}
}
]
},
"Links": {
"self": "https://sb.example.ru/v1.3/example?page=1",
"first": "https://sb.example.ru/v1.3/example?page=1",
"prev": "https://sb.example.ru/v1.3/example?page=1",
"next": "https://sb.example.ru/v1.3/example?page=1",
"last": "https://sb.example.ru/v1.3/example?page=1"
},
"Meta": {
"totalPages": 1
}
}
¶ Получение информации о Предложение по продукту по его идентификатору
¶ Запрос
GET /product-offers/{productOfferId}/ HTTP/1.1
Authorization: Bearer Az90SAOJklae
productOfferId: OFFER-01-df034b28574a
Accept: application/json
¶ Ответ
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Content-Type: application/json
{
"Data": {
"productOfferId": "OFFER-01-df034b28574a",
"creationDateTime": "2019-08-24T14:15:22Z",
"productOfferStatus": "Rejected",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"StatusReasonInformation": {
"reason": "Cancelled",
"additionalInformation": "Повторное обращение",
"comments": [
"Информация для клиента"
]
},
"productApplicationId": "OFFER-01-df034b28574a",
"productId": "string",
"comments": [
"Информация для клиента"
],
"startDateTime": "2019-08-24T14:15:22Z",
"endDateTime": "2019-08-24T14:15:22Z",
"promoCode": "string",
"ApprovedConditions": {
"creditProgram": "30-Year Fixed",
"approveDateEnd": "2023-09-30",
"ApprovedAmount": {
"amount": "200.00",
"currency": "RUB"
},
"ApprovedAmountMax": {
"amount": "200.00",
"currency": "RUB"
},
"approvedloanPeriod": 1,
"approvedLoanPeriodUnit": "Month",
"approvedFirstPayment": "20",
"ApprovedMonthlyPayment": {
"amount": "200.00",
"currency": "RUB"
},
"conditions": "Low-interest rate for the first year",
"approvedLoanRate": "14.00",
"managerFirstName": "Alex",
"managerLastName": "Johnson",
"managerMiddleName": "Michael",
"managerPhone": "+7 (123) 456-7890",
"lkz": "https://bank.example.com/lkz"
},
"LoanInterest": [
{
"tierBandMethod": "Fixed",
"comments": "Комментарии и описания для Пользователя, характеризующие группу процентных ставок",
"LoanInterestTierBand": [
{
"comments": "Ограниченный срок предложения",
"interestRate": "12.0",
"interestRateType": "INFR",
"tierCurrency": "RUB",
"tierValueMinimum": "3000000.00",
"tierValueMaximum": "100000000.00",
"tierValueMinTerm": 5,
"minTermPeriod": "Year",
"tierValueMaxTerm": 9,
"maxTermPeriod": "Year",
"calculationFrequency": "Monthly",
"unitOfPeriod": "Year"
},
{
"comments": "Наиболее выгодная ставка",
"interestRate": "10.0",
"interestRateType": "INFR",
"tierCurrency": "RUB",
"tierValueMinimum": "3000000.00",
"tierValueMaximum": "100000000.00",
"tierValueMinTerm": 10,
"minTermPeriod": "Year",
"tierValueMaxTerm": 20,
"maxTermPeriod": "Year",
"calculationFrequency": "Monthly",
"unitOfPeriod": "Year"
}
],
"TierBandSetEligibility": [
{
"name": "Привлечение клиентов",
"type": "NewCustomersOnly",
"indicator": true
},
{
"name": "Минимальный возраст",
"type": "MinimumAge",
"amount": "21"
},
{
"name": "Максимальный возраст",
"type": "MaximumAge",
"amount": "70"
},
{
"name": "Стаж работы на последнем месте (лет)",
"type": "jobExperienceLast",
"amount": "1"
},
{
"name": "Проживание и гражданство",
"type": "Other",
"indicator": true,
"OtherEligibilityType": {
"name": "Регистрация по месту жительства",
"description": "Требуется постоянная регистрация на территории РФ"
}
}
],
"AdditionalServices": {
"serviceIdentification": "INS-01-asdf-01",
"serviceType": "Страхование",
"serviceName": "Страхование жизни и здоровья",
"comments": "string",
"FeesCharges": [
{
"feeType": "Ежемесячный страховой взнос % от суммы займа",
"feeRate": "2"
},
{
"feeType": "Ежемесячная оплата услуги",
"feeAmount": "240.00"
}
],
"required": true,
"costIncreaseInformation": "+ 2% к процентной ставке/ полной стоимости займа в случае отказа от личного страхования"
}
}
],
"applicationUri": "https://mybank.ru/products/credit-card/applay",
"Requirements": {
"EmploymentRequirements": {
"employmentCategories": "Employee",
"incomeProof": true,
"incomeAmount": "200.00",
"jobExperience": "12",
"jobExperiencePeriod": "Month",
"jobExperienceLast": "3",
"jobExperienceLastPeriod": "Month",
"comments": [
"Информация для клиента"
]
},
"DocumentRequirements": {
"comments": [
"Все документы должны быть представлены в 2 экземплярах"
],
"PassportRequirements": {
"comments": [
"Информация для клиента"
],
"PassportRequirement": [
{
"required": true,
"comments": [
"Информация для клиента"
],
"type": "Passport"
}
]
},
"FinanceDocumentsRequirements": {
"comments": [
"Информация для клиента"
],
"documentCount": 1,
"FinanceDocumentRequirement": [
{
"required": true,
"comments": [
"Информация для клиента"
],
"type": "Payroll"
}
]
},
"JobDocumentsRequirements": {
"comments": [
"Информация для клиента"
],
"documentCount": 1,
"JobDocumentRequirement": [
{
"required": true,
"comments": [
"Информация для клиента"
],
"type": "EmploymentHistory"
}
]
},
"OtherDocumentsRequirements": {
"comments": [
"Информация для клиента"
],
"documentCount": 1,
"DocumentRequirement": [
{
"required": true,
"comments": [
"Информация для клиента"
],
"type": "Passport"
}
]
}
},
"OtherTypeRequirements": [
{
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
}
]
},
"SupplementaryData": {}
},
"Links": {
"self": "https://sb.example.ru/v1.3/example?page=1",
"first": "https://sb.example.ru/v1.3/example?page=1",
"prev": "https://sb.example.ru/v1.3/example?page=1",
"next": "https://sb.example.ru/v1.3/example?page=1",
"last": "https://sb.example.ru/v1.3/example?page=1"
},
"Meta": {
"totalPages": 1
}
}
¶ Удаление Предложения по продукту
¶ Запрос
DELETE /product-offers/{productOfferId}/ HTTP/1.1
Authorization: Bearer Az90SAOJklae
productOfferId: APPLICATION-01-df034b28574a
¶ Ответ
HTTP/1.1 204
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
¶ Подписанные документы
¶ Передать подписанный документ.
¶ Запрос
POST /signed-documents HTTP/1.1
Authorization: Bearer Az90SAOJklae
Accept: application/json
{
"Data": {
"productApplicationId": "OFFER-01-df034b28574a",
"customerLeadId": "95791e79-0f2d-47de-a5e0-df034b28574a",
"SignedDocument": {
"signedData": "string",
"Signatures": {
"Signature": [
{
"signatureType": "CUSTOMER",
"value": "string"
}
]
}
}
}
}
¶ Ответ
HTTP/1.1 201 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Content-Type: application/json
{
"Data": {
"signedDocumentId": "10011e79-0f2d-47de-a5e0-df034b28b001",
"status": "Accepted",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"productApplicationId": "OFFER-01-df034b28574a",
"customerLeadId": "95791e79-0f2d-47de-a5e0-df034b28574a"
},
"Links": {
"self": "https://sb.example.ru/v1.3/example?page=1",
"first": "https://sb.example.ru/v1.3/example?page=1",
"prev": "https://sb.example.ru/v1.3/example?page=1",
"next": "https://sb.example.ru/v1.3/example?page=1",
"last": "https://sb.example.ru/v1.3/example?page=1"
},
"Meta": {
"totalPages": 1
}
}
¶ Получить подписанный документ
¶ Запрос
GET /signed-documents/{signedDocumentId}/ HTTP/1.1
Authorization: Bearer Az90SAOJklae
signedDocumentId: 10011e79-0f2d-47de-a5e0-df034b28b001
Accept: application/json
¶ Ответ
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
Content-Type: application/json
{
"Data": {
"signedDocumentId": "10011e79-0f2d-47de-a5e0-df034b28b001",
"status": "Accepted",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"productApplicationId": "OFFER-01-df034b28574a",
"customerLeadId": "95791e79-0f2d-47de-a5e0-df034b28574a",
"SignedDocument": {
"signedData": "string",
"Signatures": {
"Signature": [
{
"signatureType": "CUSTOMER",
"value": "string"
}
]
}
}
},
"Links": {
"self": "https://sb.example.ru/v1.3/example?page=1",
"first": "https://sb.example.ru/v1.3/example?page=1",
"prev": "https://sb.example.ru/v1.3/example?page=1",
"next": "https://sb.example.ru/v1.3/example?page=1",
"last": "https://sb.example.ru/v1.3/example?page=1"
},
"Meta": {
"totalPages": 1
}
}