Модуль обработки заявок сайта vbr.ru
Программный модуль "Модуль обработки заявок сайта vbr.ru" - приложение и веб-сервис - это программное обеспечение, предназначенное для сбора заявок пользователей на продукты финансовых организаций, подбора предложений финансовых услуг на основе данных заявки, отправки заявки в финансовые организации, отслеживания статуса отправленных заявок и автоматизации отчетности в зависимости от типа продукта и финансовой организации.
Информация о правообладателе
ООО “Выберу.ру Маркетплейс”
ИНН: 7726477597 ОГРН:1217700241010
Юридический адрес: 117105, Москва, ш. Варшавское, д.29, к. 1, каб. 7
Описание функциональных характеристик сервиса
В интегрируемые финансовые организации входят банки, микрофинансовые организации, кредитные бюро.
Возможными продуктами финансовых организаций являются: депозиты, кредиты, ипотека, автокредиты, кредитные и дебетовые карты, займы и т.п.
Функциональные возможности модуля включают в себя:
- регистрацию заявки от пользователя на получение конкретного продукта;
- регистрацию заявки пользователя на получение конкретного типа продукта;
- отправку заявки в одну или несколько финансовых организаций;
- отслеживание статусов заявок;
- запрос скоринга из кредитного бюро;
- управление критериями соответствия продуктов заявкам;
- отчётность;
- загрузку отчетов партнеров для сверки статусов заявок.
Получение доступа к сервису
Чтобы получить доступ к сервису, необходимо обратиться к правообладателю для получения персонального токена и эндпоинта. Контакты для обращения:
Email: info@vbr.ru
Телефон: 8 (800) 500-34-23
Информация о стоимости сервиса
Сервис предоставляется на бесплатной основе. Подробные условия можно запросить у правообладателя по электронной почте: info@vbr.ru
Информация по эксплуатации
Способ применения
Данный модуль не предназначен для прямого использования пользователями и не имеет графического интерфейса. Он предназначен для интеграции разработчиками в составе другого ПО.
Адрес размещения сервиса и информация для подключения
Сервис размещен по адресу http://10.77.111.89:5000 Для доступа к нему потребуется подключиться к приватной сети (VPN) при помощи клиента OpenVPN. Для получения доступа к приватной сети обратитесь к правообладателю по электронной почте: info@vbr.ru
Документация по использованию сервиса
Набор методов, формат запросов и ответов, а также возможность интерактивного выполнения команд предоставляется самим сервисом посредством визуального интерфейса Swagger, размещенного по адресу http://10.77.111.89:5000/swagger.
Получение токена безопасности
Для авторизации в системе управления заявками, все запросы должны отправляться с прикреплённым токеном безопасности – цифровым ключом. Для получения ключа следует направить запрос на info@vbr.ru. При передаче токена в сервис, разработчику требуется прикрепить его как заголовок запроса.
Пример заголовка:
| Название | Содержимое | |
|---|---|---|
| Authorization | Bearer 49027540-328r0f94834h09f3 |
Для обращения к каждому методу модуля обработки заявок требуется прикреплять токен безопасности, если не указано обратное у конкретного метода.
Регистрация заявки
После сбора данных заявки от пользователя данные регистрируются в модуле вызовом метода API /api/v1/Order/add.
Варианты ответов модуля:
- При успешной регистрации заявки будет возвращён её идентификатор. Идентификатор требуется для отслеживания статуса конкретной заявки и для управления.
- При ошибке регистрации заявки, будет указан список нарушений. Например, указан ошибочный номер телефона или паспортные данные указаны с ошибкой.
Добавление финансовой организации
Список интеграций с финансовыми организациями фиксирован, интеграции реализуются разработчиками Выберу.ру. Методы управления API позволяют включать и выключать данные интеграции.
Для обеспечения возможности отправки заявки в финансовую организацию, требуется добавить критерий соответствия продукта заявкам. Это делается вызовом метода API /api/v1/order/adm/criteria/insert/. Добавление критерия позволит определять в какие финансовые организации возможно отправить заявку (например, проверить соответствие суммы кредита минимально или максимально допустимым значениям, проверить срок кредита, соответствие рабочего стажа заявителя требованиям и т.п.).
После добавления критерия, для зарегистрированной заявки возможно получить список доступных получателей заявки. Для этого вызывается метод API /api/v1/Order/reciever, который возвращает идентификаторы финансовых организаций и их описание для предоставления пользователю.
Отправка заявки в финансовую организацию
Для отправки зявки в финансовую организацию, передадим с метод API /api/v1/Order/reciever/addsingle идентификаторы заявки и организации. После связывания заявки и организации, отправка заявки произойдёт автоматически. При ошибке отправки заявки, автоматически будут предприняты повторные попытки отправки. После отправки заявки, финансовые организации будут автоматически опрашиваться для отслеживания изменения статуса заявки. Отслеживание статуса заявки прекращается при достижении финального состояния (выдана, отклонена, дубликат).
Отчётность
Для системы администрирования предусмотрены методы API /api/v1/order/adm/order и /api/v1/order/adm/request, возвращающие данные о зарегистрированных заявках пользователей и их копиях отправленных в каждую финансовую организацию (с отслеживанием статуса для каждой организации).
Для работы с отзывами пользователей по заявкам и отчётности по ним предусмотрены следующие методы:
- /api/v1/order/request/feedback/add - позволяет зарегистрировать обратный отзыв пользователя по конкретной заявке;
- /api/v1/order/adm/request-feedback - возвращает данные об отзывах для системы администрирования для обеспечения работы службы поддержки пользователей.
Описание методов и моделей
VBR - Order API
Сервис приёма заявок
Access
- APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
Methods
[ Jump to Models ]Table of Contents
AdminOrderRequest
Contact
Geo
get /api/v1/order/Geo/getForCashloanget /api/v1/order/Geo/getForMfoget /api/v1/order/Geo/getForMortgagepost /api/v1/order/Geo/getpost /api/v1/order/Geo/validateAddress
Integration
get /api/v1/order/adm/Integrationpost /api/v1/order/adm/Integration/searchByIdspost /api/v1/order/adm/Integration/search
Order
post /api/v1/Order/addpost /api/v1/Order/changeOrderMethodpost /api/v1/Order/checkOrderByClickIdpost /api/v1/Order/checkduplicatepost /api/v1/Order/copypost /api/v1/Order/fetch-scorespost /api/v1/Order/getLastOrderForPhonepost /api/v1/Order/getpost /api/v1/Order/get-scorepost /api/v1/Order/listpost /api/v1/Order/payloadpost /api/v1/Order/reciever/addpost /api/v1/Order/reciever/addsinglepost /api/v1/Order/reciever/checkpost /api/v1/Order/recieverpost /api/v1/Order/redirectRegistrationpost /api/v1/Order/set-statepost /api/v1/Order/statuspost /api/v1/Order/update
OrderRequest
post /api/v1/order/request/feedback/addpost /api/v1/order/request/feedback/infopost /api/v1/order/request/set-statepost /api/v1/order/request/set-states
Organization
Reference
get /api/v1/order/Reference/getget /api/v1/order/Reference/getlistget /api/v1/order/Reference/getmapped
Service
post /api/v1/order/Service/getDebtLoadRatiopost /api/v1/order/Service/getMonthlyPaymentpost /api/v1/order/Service/updateDebtLoadRatio
User
AdminOrderRequest
Up
post /api/v1/order/adm/orderПолучение списка заявок. (apiV1OrderAdmOrderPost)
Пример запроса: { "correlationId": "b1e88ccd-91c4-4a84-a514-e0d9db826629", "data": { "page": 0, "itemsPerPage": 20, "dateFrom": "2020-01-01T00:00:00", "dateTo": "2021-01-11T17:27:19.24964+03:00", "fetchContent": false } }
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body OrderReportRequestServiceRequest (optional)
Body Parameter — Входящий запрос (см. пример).
example:
{ "correlationId" : "eb928471-9a88-424a-8346-9573cde9339d", "data" : { "page" : 0, "itemsPerPage" : 20, "dateFrom" : "2020-01-01T00:00:00", "dateTo" : "2022-11-24T17:41:28.8301704+00:00", "fetchContent" : false, "integrationId" : "00000000-0000-0000-0000-000000000000", "fetchExcludedCriterias" : false } }Return type
Example data
Content-Type: application/json
{
"data" : {
"total" : 9,
"items" : [ {
"offers" : [ {
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"sourceId" : 1,
"tagId" : 6,
"userScore" : 1,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"debtLoadRatio" : 4.965218492984954,
"lastStateModifyDate" : "2000-01-23T04:56:07.000+00:00",
"content" : "content",
"orderMethod" : "UnifiedForm",
"payload" : "payload",
"orderRequestCount" : 7,
"offersCount" : 1,
"currentDebtLoadRatio" : 5.025004791520295,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 1,
"jsonContent" : "jsonContent",
"lastModifyDate" : "2000-01-23T04:56:07.000+00:00",
"productType" : "Any",
"issueCity" : "issueCity",
"excludedCriterias" : {
"exclusions" : [ {
"reasons" : [ {
"actualValue" : "actualValue",
"key" : "key"
}, {
"actualValue" : "actualValue",
"key" : "key"
} ],
"criteria" : {
"orderType" : "Unknown",
"estateType" : "Unknown",
"debtLoadRatioMax" : 7,
"ageMax" : 5,
"workIncomeMin" : 3,
"experienceMin" : 7,
"occupationTypes" : "Unknown",
"enabled" : true,
"experienceMax" : 9,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"minEducationLvl" : "Unknown",
"daysMax" : 2,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"mortgageType" : "Unknown",
"dontCheckCustomLimits" : true,
"sumMin" : 0.8008281904610115,
"daysMin" : 5,
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"ageMin" : 1,
"workIncomeMax" : 2,
"clientOfferId" : "clientOfferId",
"sumMax" : 6.027456183070403,
"offerId" : "offerId",
"nbkiRatingMin" : 4,
"popupText" : "popupText"
}
}, {
"reasons" : [ {
"actualValue" : "actualValue",
"key" : "key"
}, {
"actualValue" : "actualValue",
"key" : "key"
} ],
"criteria" : {
"orderType" : "Unknown",
"estateType" : "Unknown",
"debtLoadRatioMax" : 7,
"ageMax" : 5,
"workIncomeMin" : 3,
"experienceMin" : 7,
"occupationTypes" : "Unknown",
"enabled" : true,
"experienceMax" : 9,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"minEducationLvl" : "Unknown",
"daysMax" : 2,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"mortgageType" : "Unknown",
"dontCheckCustomLimits" : true,
"sumMin" : 0.8008281904610115,
"daysMin" : 5,
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"ageMin" : 1,
"workIncomeMax" : 2,
"clientOfferId" : "clientOfferId",
"sumMax" : 6.027456183070403,
"offerId" : "offerId",
"nbkiRatingMin" : 4,
"popupText" : "popupText"
}
} ]
}
}, {
"offers" : [ {
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"sourceId" : 1,
"tagId" : 6,
"userScore" : 1,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"debtLoadRatio" : 4.965218492984954,
"lastStateModifyDate" : "2000-01-23T04:56:07.000+00:00",
"content" : "content",
"orderMethod" : "UnifiedForm",
"payload" : "payload",
"orderRequestCount" : 7,
"offersCount" : 1,
"currentDebtLoadRatio" : 5.025004791520295,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 1,
"jsonContent" : "jsonContent",
"lastModifyDate" : "2000-01-23T04:56:07.000+00:00",
"productType" : "Any",
"issueCity" : "issueCity",
"excludedCriterias" : {
"exclusions" : [ {
"reasons" : [ {
"actualValue" : "actualValue",
"key" : "key"
}, {
"actualValue" : "actualValue",
"key" : "key"
} ],
"criteria" : {
"orderType" : "Unknown",
"estateType" : "Unknown",
"debtLoadRatioMax" : 7,
"ageMax" : 5,
"workIncomeMin" : 3,
"experienceMin" : 7,
"occupationTypes" : "Unknown",
"enabled" : true,
"experienceMax" : 9,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"minEducationLvl" : "Unknown",
"daysMax" : 2,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"mortgageType" : "Unknown",
"dontCheckCustomLimits" : true,
"sumMin" : 0.8008281904610115,
"daysMin" : 5,
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"ageMin" : 1,
"workIncomeMax" : 2,
"clientOfferId" : "clientOfferId",
"sumMax" : 6.027456183070403,
"offerId" : "offerId",
"nbkiRatingMin" : 4,
"popupText" : "popupText"
}
}, {
"reasons" : [ {
"actualValue" : "actualValue",
"key" : "key"
}, {
"actualValue" : "actualValue",
"key" : "key"
} ],
"criteria" : {
"orderType" : "Unknown",
"estateType" : "Unknown",
"debtLoadRatioMax" : 7,
"ageMax" : 5,
"workIncomeMin" : 3,
"experienceMin" : 7,
"occupationTypes" : "Unknown",
"enabled" : true,
"experienceMax" : 9,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"minEducationLvl" : "Unknown",
"daysMax" : 2,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"mortgageType" : "Unknown",
"dontCheckCustomLimits" : true,
"sumMin" : 0.8008281904610115,
"daysMin" : 5,
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"ageMin" : 1,
"workIncomeMax" : 2,
"clientOfferId" : "clientOfferId",
"sumMax" : 6.027456183070403,
"offerId" : "offerId",
"nbkiRatingMin" : 4,
"popupText" : "popupText"
}
} ]
}
} ]
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success OrderAdmReportItemsContainerServiceResultUp
post /api/v1/order/adm/request-feedbackПолучение списка отзывов по запросам заявок. (apiV1OrderAdmRequestFeedbackPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body OrderRequestFeedbackRequestServiceRequest (optional)
Body Parameter —
example:
{ "correlationId" : "1cf73833-3d9a-4bd8-8def-43804c1e947c", "data" : { "page" : 0, "itemsPerPage" : 10, "createdFrom" : "2020-01-01T00:00:00", "createdTo" : "2022-11-24T17:41:28.894553+00:00" } }Return type
Example data
Content-Type: application/json
{
"data" : {
"total" : 6,
"items" : [ {
"lastName" : "lastName",
"orderType" : "Unknown",
"orderRequestCreationDate" : "2000-01-23T04:56:07.000+00:00",
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"orderMethod" : "UnifiedForm",
"orderState" : "Incomplete",
"orderRequestDeliveryDate" : "2000-01-23T04:56:07.000+00:00",
"firstName" : "firstName",
"phone" : "phone",
"orderRequestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"middleName" : "middleName",
"id" : 0,
"text" : "text",
"email" : "email"
}, {
"lastName" : "lastName",
"orderType" : "Unknown",
"orderRequestCreationDate" : "2000-01-23T04:56:07.000+00:00",
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"orderMethod" : "UnifiedForm",
"orderState" : "Incomplete",
"orderRequestDeliveryDate" : "2000-01-23T04:56:07.000+00:00",
"firstName" : "firstName",
"phone" : "phone",
"orderRequestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"middleName" : "middleName",
"id" : 0,
"text" : "text",
"email" : "email"
} ]
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success OrderRequestFeedbackAdmReportItemsContainerServiceResultUp
post /api/v1/order/adm/requestПолучение списка запросов в банк/мфо (apiV1OrderAdmRequestPost)
Пример запроса: { "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "data": { "page": 0, "itemsPerPage": 10, "dateFrom": "2020-01-11T12:30:38.096Z", "dateTo": "2021-01-30T12:30:38.096Z", "fetchContent": false } }
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body OrderRequestReportRequestServiceRequest (optional)
Body Parameter — Входящий запрос (см. пример).
example:
{ "correlationId" : "669a59d3-fd00-42d2-9621-c0ec5d808c01", "data" : { "page" : 0, "itemsPerPage" : 10, "dateFrom" : "2020-01-01T00:00:00", "dateTo" : "2022-11-24T17:41:28.6212984+00:00", "fetchContent" : false } }Return type
Example data
Content-Type: application/json
{
"data" : {
"total" : 3,
"items" : [ {
"orderType" : "Unknown",
"orderRequestStateResponse" : "orderRequestStateResponse",
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"tagId" : 5,
"integrationName" : "integrationName",
"orderRequestTryCount" : 6,
"userPhone" : "userPhone",
"clickId" : "clickId",
"orderRequestState" : "Created",
"userScore" : 2,
"lastStateModifyDate" : "2000-01-23T04:56:07.000+00:00",
"content" : "content",
"productName" : "productName",
"orderState" : 1,
"requestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currentDebtLoadRatio" : 9.301444243932576,
"deliveryDate" : "2000-01-23T04:56:07.000+00:00",
"lastModifyDate" : "2000-01-23T04:56:07.000+00:00",
"issueCity" : "issueCity",
"amount" : 5.637376656633329,
"deliveryTryCount" : 0,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"userName" : "userName",
"debtLoadRatio" : 7.061401241503109,
"orderMethod" : "UnifiedForm",
"orderLastModifyDate" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"deliveryState" : "Unknown",
"jsonContent" : "jsonContent"
}, {
"orderType" : "Unknown",
"orderRequestStateResponse" : "orderRequestStateResponse",
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"tagId" : 5,
"integrationName" : "integrationName",
"orderRequestTryCount" : 6,
"userPhone" : "userPhone",
"clickId" : "clickId",
"orderRequestState" : "Created",
"userScore" : 2,
"lastStateModifyDate" : "2000-01-23T04:56:07.000+00:00",
"content" : "content",
"productName" : "productName",
"orderState" : 1,
"requestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currentDebtLoadRatio" : 9.301444243932576,
"deliveryDate" : "2000-01-23T04:56:07.000+00:00",
"lastModifyDate" : "2000-01-23T04:56:07.000+00:00",
"issueCity" : "issueCity",
"amount" : 5.637376656633329,
"deliveryTryCount" : 0,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"userName" : "userName",
"debtLoadRatio" : 7.061401241503109,
"orderMethod" : "UnifiedForm",
"orderLastModifyDate" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"deliveryState" : "Unknown",
"jsonContent" : "jsonContent"
} ]
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success OrderRequestAdmReportItemsContainerServiceResultContact
Up
post /api/v1/order/Contact/addДобавление контактных данных (apiV1OrderContactAddPost)
Query parameters
userId (optional)
Query Parameter — Идентификатор пользователя в общем списке format: int32
productType (optional)
Query Parameter — Тип продукта format: int32
name (optional)
Query Parameter — Имя контакта
phone (optional)
Query Parameter — Телефон контакта
Responses
200
SuccessUp
get /api/v1/order/Email/getПолучение дозаполненного e-mail адреса (apiV1OrderEmailGetGet)
Query parameters
terms (optional)
Query Parameter — Дозаполняемое значение
Return type
array[String]
Example data
Content-Type: application/json
[ "", "" ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessGeo
Up
get /api/v1/order/Geo/getForCashloanПолучение доступных регинов получения кредита наличными по части слова (apiV1OrderGeoGetForCashloanGet)
Query parameters
terms (optional)
Query Parameter — Часть искомого слова
count (optional)
Query Parameter — Кол-во выдаваемых результатов default: 10 format: int32
Return type
array[Address]
Example data
Content-Type: application/json
[ {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
}, {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessUp
get /api/v1/order/Geo/getForMfoПолучение доступных регинов получения займа по части слова (apiV1OrderGeoGetForMfoGet)
Query parameters
terms (optional)
Query Parameter — Часть искомого слова
count (optional)
Query Parameter — Кол-во выдаваемых результатов default: 10 format: int32
Return type
array[Address]
Example data
Content-Type: application/json
[ {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
}, {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessUp
get /api/v1/order/Geo/getForMortgageПолучение доступных регинов получения ипотечного кредита по части слова (apiV1OrderGeoGetForMortgageGet)
Query parameters
terms (optional)
Query Parameter — Часть искомого слова
count (optional)
Query Parameter — Кол-во выдаваемых результатов default: 10 format: int32
Return type
array[Address]
Example data
Content-Type: application/json
[ {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
}, {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessUp
post /api/v1/order/Geo/getПолучение доступных регинов получения кредита по части слова (apiV1OrderGeoGetPost)
Consumes
This API call consumes the following media types via the Content-Type request header:multipart/form-data
Form parameters
terms (optional)
Form Parameter —
type (optional)
Form Parameter —
pid (optional)
Form Parameter — format: uuid
rcp (optional)
Form Parameter — format: uuid
count (optional)
Form Parameter — format: int32
offer (optional)
Form Parameter —
Return type
array[Address]
Example data
Content-Type: application/json
[ {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
}, {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessUp
post /api/v1/order/Geo/validateAddressПроверка на допустимость использования данного адреса по КЛАДР в интеграции (apiV1OrderGeoValidateAddressPost)
Consumes
This API call consumes the following media types via the Content-Type request header:multipart/form-data
Form parameters
rcp (optional)
Form Parameter — format: uuid
kladr (optional)
Form Parameter —
type (optional)
Form Parameter —
Return type
Boolean
Example data
Content-Type: application/json
trueProduces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success BooleanIntegration
Up
get /api/v1/order/adm/IntegrationПолучить дополнительную информацию об интеграции (apiV1OrderAdmIntegrationGet)
Query parameters
integrationId (optional)
Query Parameter — Идентификатор интеграции format: uuid
Return type
array[IntegrationResponse]
Example data
Content-Type: application/json
[ {
"information" : {
"stepByStepIntegration" : true,
"organizationName" : "organizationName",
"name" : "name",
"description" : "description",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"allowSendShortForm" : true,
"allowMultipleOffers" : true,
"applicableOrderTypes" : [ "Unknown", "Unknown" ],
"hasAdditionalForm" : true
}
}, {
"information" : {
"stepByStepIntegration" : true,
"organizationName" : "organizationName",
"name" : "name",
"description" : "description",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"allowSendShortForm" : true,
"allowMultipleOffers" : true,
"applicableOrderTypes" : [ "Unknown", "Unknown" ],
"hasAdditionalForm" : true
}
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessUp
post /api/v1/order/adm/Integration/searchByIdsПолучение дополнительной информации для запрошенных интеграциях по их идентификаторам (apiV1OrderAdmIntegrationSearchByIdsPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body GuidArrayServiceRequest (optional)
Body Parameter — Список запрашиваемых идентификаторов
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"information" : {
"stepByStepIntegration" : true,
"organizationName" : "organizationName",
"name" : "name",
"description" : "description",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"allowSendShortForm" : true,
"allowMultipleOffers" : true,
"applicableOrderTypes" : [ "Unknown", "Unknown" ],
"hasAdditionalForm" : true
}
}, {
"information" : {
"stepByStepIntegration" : true,
"organizationName" : "organizationName",
"name" : "name",
"description" : "description",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"allowSendShortForm" : true,
"allowMultipleOffers" : true,
"applicableOrderTypes" : [ "Unknown", "Unknown" ],
"hasAdditionalForm" : true
}
} ],
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success IntegrationResponseIReadOnlyCollectionServiceResultUp
post /api/v1/order/adm/Integration/searchПоиск дополнительной информацию об интеграции по названию (apiV1OrderAdmIntegrationSearchPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body StringServiceRequest (optional)
Body Parameter — Название искомой интеграции
example:
{ "correlationId" : "c0fd7e91-8d43-411d-9067-1e608a67dad8", "data" : "" }Return type
Example data
Content-Type: application/json
{
"data" : [ {
"information" : {
"stepByStepIntegration" : true,
"organizationName" : "organizationName",
"name" : "name",
"description" : "description",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"allowSendShortForm" : true,
"allowMultipleOffers" : true,
"applicableOrderTypes" : [ "Unknown", "Unknown" ],
"hasAdditionalForm" : true
}
}, {
"information" : {
"stepByStepIntegration" : true,
"organizationName" : "organizationName",
"name" : "name",
"description" : "description",
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"allowSendShortForm" : true,
"allowMultipleOffers" : true,
"applicableOrderTypes" : [ "Unknown", "Unknown" ],
"hasAdditionalForm" : true
}
} ],
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success IntegrationResponseIReadOnlyCollectionServiceResultOrder
Up
post /api/v1/Order/addСохранение запроса в базу данных (apiV1OrderAddPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body AddOrderRequestServiceRequest (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
},
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success AddOrderResponseServiceResultUp
post /api/v1/Order/changeOrderMethodИзменение метода получения запроса. (apiV1OrderChangeOrderMethodPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body ChangeOrderMethodRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : true,
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success BooleanServiceResultUp
post /api/v1/Order/checkOrderByClickIdПроверка запроса по идентификатору клика рекламной системы (apiV1OrderCheckOrderByClickIdPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body CheckOrderByClickIdRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : true,
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success BooleanServiceResultUp
post /api/v1/Order/checkduplicateПроверка запроса на дубликат (apiV1OrderCheckduplicatePost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body CheckDuplicateRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"isDuplicate" : true
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success CheckDuplicateResponseServiceResultUp
post /api/v1/Order/copyСоздание копии запроса (apiV1OrderCopyPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body CopyOrderRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"newOrderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success CopyOrderResponseServiceResultUp
post /api/v1/Order/fetch-scoresОбновление данных скоринга по запросам (apiV1OrderFetchScoresPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body FetchScoresRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : true,
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success BooleanServiceResultUp
post /api/v1/Order/getLastOrderForPhoneПолучение последней заявки по номеру телефона (apiV1OrderGetLastOrderForPhonePost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body GetLastOrderForPhoneRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"reqCount" : 0,
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state" : 6
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success LastOrderForPhoneResponseServiceResultUp
post /api/v1/Order/getПолучение запроса на кредитный продукт. (apiV1OrderGetPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body GuidServiceRequest (optional)
Body Parameter — Идентификатор запроса
Return type
Example data
Content-Type: application/json
{
"data" : {
"AdditionalInfo" : {
"ChangeOfPassport" : true,
"MaritalStatus" : "MaritalStatus",
"TypeOfAdditionalIncome" : 9,
"ChangeOfFullName" : true,
"AdditionalDocumentType" : "AdditionalDocumentType",
"AdditionalIncome" : "AdditionalIncome",
"EducationLevel" : "EducationLevel",
"FamilyIncome" : "FamilyIncome",
"UnderAgeChildrenCount" : 3,
"DateChangeOfFullName" : "DateChangeOfFullName",
"NumberOfDependents" : 7
},
"Ownership" : {
"Car" : true,
"House" : true
},
"Email" : "Email",
"Pensioner" : {
"HavePension" : true,
"PensionerStatus" : "PensionerStatus",
"PensionReasons" : "PensionReasons",
"DocumentNumber" : "DocumentNumber",
"PensionIncome" : "PensionIncome",
"Date" : "Date"
},
"Amount" : "Amount",
"IndividualIntegrations" : [ {
"PropertyName" : "PropertyName",
"Value" : "Value",
"IntegrationId" : "IntegrationId"
}, {
"PropertyName" : "PropertyName",
"Value" : "Value",
"IntegrationId" : "IntegrationId"
} ],
"MortgageType" : "MortgageType",
"LoadingData" : {
"LoanSpending" : 2.027123023002322,
"PreviouslyApplied" : "PreviouslyApplied"
},
"Duration" : {
"Type" : "Type",
"Value" : "Value"
},
"Security" : "Security",
"Addresses" : [ {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
}, {
"Zip" : "Zip",
"FullAddress" : "FullAddress",
"House" : "House",
"City" : "City",
"Okato" : "Okato",
"Date" : "Date",
"Apartments" : "Apartments",
"Oktmo" : "Oktmo",
"Type" : "Type",
"State" : "State",
"FiasId" : "FiasId",
"Region" : "Region",
"Street" : "Street",
"Block" : "Block",
"RegionId" : "RegionId",
"Kladr" : "Kladr"
} ],
"EstateType" : "EstateType",
"Passport" : {
"Series" : "Series",
"Number" : "Number",
"DateOfIssue" : "DateOfIssue",
"Birthplace" : "Birthplace",
"PeriodOfResidenceInYears" : 0,
"IsResidentOfRussianFederation" : true,
"CitizenOfRussianFederation" : true,
"Code" : "Code",
"IssuedBy" : "IssuedBy"
},
"OrderType" : "OrderType",
"Phones" : [ {
"Msisdn" : "Msisdn",
"Type" : "Type",
"Usage" : "Usage"
}, {
"Msisdn" : "Msisdn",
"Type" : "Type",
"Usage" : "Usage"
} ],
"InitialAmount" : "InitialAmount",
"Persons" : [ {
"Relation" : "Relation",
"FirstName" : "FirstName",
"Sex" : "Sex",
"LastName" : "LastName",
"MiddleName" : "MiddleName",
"Birthdate" : "Birthdate"
}, {
"Relation" : "Relation",
"FirstName" : "FirstName",
"Sex" : "Sex",
"LastName" : "LastName",
"MiddleName" : "MiddleName",
"Birthdate" : "Birthdate"
} ],
"WorkInfo" : {
"MonthIncome" : "MonthIncome",
"Okopf" : 1,
"PositionLevel" : 5,
"ActivityArea" : 5,
"Position" : "Position",
"Inn" : "Inn",
"NumberOfEmployees" : 6,
"TotalWorkExperience" : 2,
"Name" : "Name",
"StartDate" : "StartDate",
"CanConfirmEmployment" : true,
"OkopfCode" : "OkopfCode",
"OccupationType" : "OccupationType",
"ProofOfIncome" : "ProofOfIncome"
},
"CreditPurpose" : "CreditPurpose",
"CardHolder" : "CardHolder",
"SecretCode" : "SecretCode",
"DefaultContactPerson" : "DefaultContactPerson"
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success OrderServiceResultUp
post /api/v1/Order/get-scoreПолучение скоринга по данным запроса (apiV1OrderGetScorePost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body UserScoreRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"dateTime" : "2000-01-23T04:56:07.000+00:00",
"score" : 0
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success UserScoreServiceResultUp
post /api/v1/Order/listПолучение списка запросов с разбиением по страницам (apiV1OrderListPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body FindOrdersRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
},
"orders" : [ {
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"tagId" : 5,
"orderStatus" : 6,
"partnerId" : 0,
"requests" : [ {
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"requestStatus" : 5
}, {
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"requestStatus" : 5
} ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"totalCount" : 1
}, {
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"tagId" : 5,
"orderStatus" : 6,
"partnerId" : 0,
"requests" : [ {
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"requestStatus" : 5
}, {
"integrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"requestStatus" : 5
} ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"totalCount" : 1
} ]
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success FindOrdersResponseServiceResultUp
post /api/v1/Order/payloadПолучение сервисных данных запроса. (apiV1OrderPayloadPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body GetOrderPayloadRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
},
"payload" : {
"adsClientId" : "adsClientId",
"orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"tagId" : 0,
"ip" : "ip",
"clickId" : "clickId",
"userAgent" : "userAgent",
"userScore" : 2,
"b24ContactId" : 5,
"afzIntegrationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"parentOrderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"editMode" : 6,
"abTestInformation" : {
"Index" : 7,
"Said" : "Said"
},
"requestDate" : "2000-01-23T04:56:07.000+00:00",
"regionAlias" : "regionAlias",
"childOrderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"stepNumber" : 1,
"adsPartnerId" : "adsPartnerId",
"b24LeadtId" : 5
}
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success GetOrderPayloadResponseServiceResultUp
post /api/v1/Order/reciever/addУстановка получателей заявки (apiV1OrderRecieverAddPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body AddOrderRecieversRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"recievers" : [ {
"orderType" : "Unknown",
"stepByStepIntegration" : true,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isValid" : true,
"clientOfferId" : "clientOfferId",
"isApplicable" : true,
"offerId" : "offerId",
"recieverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"popupText" : "popupText",
"isUsed" : true,
"hasAdditionalForm" : true
}, {
"orderType" : "Unknown",
"stepByStepIntegration" : true,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isValid" : true,
"clientOfferId" : "clientOfferId",
"isApplicable" : true,
"offerId" : "offerId",
"recieverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"popupText" : "popupText",
"isUsed" : true,
"hasAdditionalForm" : true
} ],
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
}
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success AddOrderRecieversResponseServiceResultUp
post /api/v1/Order/reciever/addsingleУстановка получателя заявки (apiV1OrderRecieverAddsinglePost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body AddOrderRecieverRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
},
"reciever" : {
"orderType" : "Unknown",
"stepByStepIntegration" : true,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isValid" : true,
"clientOfferId" : "clientOfferId",
"isApplicable" : true,
"offerId" : "offerId",
"recieverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"popupText" : "popupText",
"isUsed" : true,
"hasAdditionalForm" : true
}
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success AddOrderRecieverResponseServiceResultUp
post /api/v1/Order/reciever/checkПроверка интеграции на возможность применения (apiV1OrderRecieverCheckPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body CheckRecieverForPossibilityUseRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
},
"canUse" : true
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success CheckRecieverForPossibilityUseResponseServiceResultUp
post /api/v1/Order/recieverПолучение подходящих интеграций для заявки (apiV1OrderRecieverPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body GetAvailOrderRecieversRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"recievers" : [ {
"orderType" : "Unknown",
"stepByStepIntegration" : true,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isValid" : true,
"clientOfferId" : "clientOfferId",
"isApplicable" : true,
"offerId" : "offerId",
"recieverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"popupText" : "popupText",
"isUsed" : true,
"hasAdditionalForm" : true
}, {
"orderType" : "Unknown",
"stepByStepIntegration" : true,
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isValid" : true,
"clientOfferId" : "clientOfferId",
"isApplicable" : true,
"offerId" : "offerId",
"recieverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"popupText" : "popupText",
"isUsed" : true,
"hasAdditionalForm" : true
} ],
"alternateRecieversByPeriod" : [ null, null ],
"alternateRecieversBySum" : [ null, null ],
"alternateDays" : 6,
"alternateSum" : 0.8008281904610115
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success GetAvailOrderRecieversResponseServiceResultUp
post /api/v1/Order/redirectRegistrationОтправка SMS и Email о регистрации (apiV1OrderRedirectRegistrationPost)
Query parameters
orderId (optional)
Query Parameter — Идентификатор запроса format: uuid
utmMedium (optional)
Query Parameter — UTM метка
utmCampaign (optional)
Query Parameter — UTM метка
Responses
200
SuccessUp
post /api/v1/Order/set-stateУстановка статуса запросу (apiV1OrderSetStatePost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body SetOrderStateRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
}
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success SetOrderStateResponseServiceResultUp
post /api/v1/Order/statusПолучение статуса запроса. (apiV1OrderStatusPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body GetOrderStatusRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
},
"state" : 0
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success GetOrderStatusResponseServiceResultUp
post /api/v1/Order/updateОбновление заявки в базе данных (дополнение). (apiV1OrderUpdatePost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body UpdateOrderRequestServiceRequest (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"data" : {
"validationResult" : {
"isError" : true,
"isWarning" : true,
"isValid" : true,
"items" : [ {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
}, {
"isError" : true,
"isWarning" : true,
"propertyName" : "propertyName",
"description" : "description"
} ]
}
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success UpdateOrderResponseServiceResultOrderRequest
Up
post /api/v1/order/request/feedback/addДобавление обратной связи для заявки (apiV1OrderRequestFeedbackAddPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body AddOrderRequestFeedbackRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"feedbackId" : 0
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success AddOrderRequestFeedbackResponseServiceResultUp
post /api/v1/order/request/feedback/infoПолучение данных заявки для обратной связи (apiV1OrderRequestFeedbackInfoPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body OrderRequestDataForFeedbackRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : {
"orderType" : "Unknown",
"productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"orderRequestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success OrderRequestDataForFeedbackResponseServiceResultUp
post /api/v1/order/request/set-stateУстановка статуса заявки (apiV1OrderRequestSetStatePost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body SetOrderRequestStateRequestServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : { },
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success SetOrderRequestStateResponseServiceResultUp
post /api/v1/order/request/set-statesУстановка статуса на несколько заявок (apiV1OrderRequestSetStatesPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body SetOrderRequestStateRequestIReadOnlyCollectionServiceRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"data" : { },
"success" : true,
"correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success SetOrderRequestStateResponseServiceResultOrganization
Up
get /api/v1/order/OrganizationПолучение данных по организации в DaData. (apiV1OrderOrganizationGet)
Query parameters
inn (optional)
Query Parameter — ИНН
Return type
Example data
Content-Type: application/json
{
"address" : "address",
"phone" : "phone",
"okopf" : "okopf",
"name" : "name",
"inn" : "inn",
"employeeCount" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success OrganizationUp
get /api/v1/order/Organization/searchПоиск по названию или части названия в DaData. (apiV1OrderOrganizationSearchGet)
Query parameters
query (optional)
Query Parameter — Поисковой запрос
count (optional)
Query Parameter — Количество выводимых элементов, не более которого нам необходимо вернуть default: 10 format: int32
Return type
array[Organization]
Example data
Content-Type: application/json
[ {
"address" : "address",
"phone" : "phone",
"okopf" : "okopf",
"name" : "name",
"inn" : "inn",
"employeeCount" : 0
}, {
"address" : "address",
"phone" : "phone",
"okopf" : "okopf",
"name" : "name",
"inn" : "inn",
"employeeCount" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessReference
Up
get /api/v1/order/Reference/getПолучение справоных данных для запроса / заявки (apiV1OrderReferenceGetGet)
Query parameters
lrt (optional)
Query Parameter — Тип справочника
key (optional)
Query Parameter — Ключ справочной информации
code (optional)
Query Parameter — Код справочной информации
rcp (optional)
Query Parameter — Идентификатор интеграции format: uuid
filter (optional)
Query Parameter — Дополнительный фильтр определяющийся в интеграции
Return type
Example data
Content-Type: application/json
{
"code" : "code",
"orderCost" : 0,
"value" : "value",
"key" : "key"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ReferenceItemUp
get /api/v1/order/Reference/getlistПолучить список справочных данных (apiV1OrderReferenceGetlistGet)
Query parameters
lrt (optional)
Query Parameter — Тип справочника
rows (optional)
Query Parameter — Кол-во возвращаемых строк default: 50 format: int32
term (optional)
Query Parameter — Поиск схожего значения
rcp (optional)
Query Parameter — Идентификатор интеграции format: uuid
filter (optional)
Query Parameter — Дополнительный фильтр определяющийся в интеграции
Return type
array[ReferenceItem]
Example data
Content-Type: application/json
[ {
"code" : "code",
"orderCost" : 0,
"value" : "value",
"key" : "key"
}, {
"code" : "code",
"orderCost" : 0,
"value" : "value",
"key" : "key"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessUp
get /api/v1/order/Reference/getmappedПолучить сопоставленное справочное значение (apiV1OrderReferenceGetmappedGet)
Query parameters
lrt (optional)
Query Parameter — Тип справочника
key (optional)
Query Parameter — Ключ справочной информации
rcp (optional)
Query Parameter — Идентификатор интеграции format: uuid
filter (optional)
Query Parameter — Дополнительный фильтр определяющийся в интеграции
Return type
Example data
Content-Type: application/json
{
"code" : "code",
"orderCost" : 0,
"value" : "value",
"key" : "key"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/json
Responses
200
Success ReferenceItemService
Up
post /api/v1/order/Service/getDebtLoadRatioРасчет долговой нагрузки по ежемесячному платежу для используемого продукта (apiV1OrderServiceGetDebtLoadRatioPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body DebtLoadRatioRequest (optional)
Body Parameter — Входящий запрос
Return type
Example data
Content-Type: application/json
{
"monthlyPayment" : 1.4658129805029452,
"currentDebtLoadRatio" : 0.8008281904610115,
"debtLoadRatio" : 6.027456183070403
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success DebtLoadRatioResponseUp
post /api/v1/order/Service/getMonthlyPaymentПолучение суммы ежемесячного платежа (apiV1OrderServiceGetMonthlyPaymentPost)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/xmltext/xmlapplication/*+xml
Request body
body Period (optional)
Body Parameter — Период кредита
Query parameters
productId (optional)
Query Parameter — ID продукта format: uuid
amount (optional)
Query Parameter — Размер кредита format: double
orderType (optional)
Query Parameter — Тип кредитного продукта
Return type
Double
Example data
Content-Type: application/json
0.8008281904610115Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success DoubleUp
post /api/v1/order/Service/updateDebtLoadRatioОбновление долговой нагрузки (apiV1OrderServiceUpdateDebtLoadRatioPost)
Query parameters
fromDate (optional)
Query Parameter — От даты создания format: date-time
toDate (optional)
Query Parameter — До даты создания format: date-time
orderType (optional)
Query Parameter — Тип кредитного продукта
Return type
Boolean
Example data
Content-Type: application/json
trueProduces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
Success BooleanUser
Up
get /api/v1/order/User/fmsАвтоматическое дозаполнение места выдачи паспорта (apiV1OrderUserFmsGet)
Query parameters
terms (optional)
Query Parameter — Начальный текс места выдачи паспорта
Return type
array[UserFms]
Example data
Content-Type: application/json
[ {
"data" : {
"code" : "code",
"name" : "name",
"type" : "type",
"region_code" : "region_code"
},
"unrestricted_value" : "unrestricted_value",
"value" : "value"
}, {
"data" : {
"code" : "code",
"name" : "name",
"type" : "type",
"region_code" : "region_code"
},
"unrestricted_value" : "unrestricted_value",
"value" : "value"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessUp
get /api/v1/order/User/suggestАвтоматическое дозаполнение ФИО (apiV1OrderUserSuggestGet)
Query parameters
terms (optional)
Query Parameter — Начальный текст ФИО
Return type
array[UserData]
Example data
Content-Type: application/json
[ {
"patronymic" : "patronymic",
"gender" : 0,
"surname" : "surname",
"name" : "name",
"value" : "value"
}, {
"patronymic" : "patronymic",
"gender" : 0,
"surname" : "surname",
"name" : "name",
"value" : "value"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.text/plainapplication/jsontext/jsonapplication/xmltext/xml
Responses
200
SuccessModels
[ Jump to Methods ]Table of Contents
AbTestInformationAddOrderRecieverRequestAddOrderRecieverRequestServiceRequestAddOrderRecieverResponseAddOrderRecieverResponseServiceResultAddOrderRecieversRequestAddOrderRecieversRequestServiceRequestAddOrderRecieversResponseAddOrderRecieversResponseServiceResultAddOrderRequestAddOrderRequestFeedbackRequestAddOrderRequestFeedbackRequestServiceRequestAddOrderRequestFeedbackResponseAddOrderRequestFeedbackResponseServiceResultAddOrderRequestServiceRequestAddOrderResponseAddOrderResponseServiceResultAdditionalInfoAddressAddressTypeBooleanServiceResultChangeOrderMethodRequestChangeOrderMethodRequestServiceRequestCheckDuplicateRequestCheckDuplicateRequestServiceRequestCheckDuplicateResponseCheckDuplicateResponseServiceResultCheckOrderByClickIdRequestCheckOrderByClickIdRequestServiceRequestCheckRecieverForPossibilityUseRequestCheckRecieverForPossibilityUseRequestServiceRequestCheckRecieverForPossibilityUseResponseCheckRecieverForPossibilityUseResponseServiceResultCopyOrderRequestCopyOrderRequestServiceRequestCopyOrderResponseCopyOrderResponseServiceResultDebtLoadRatioRequestDebtLoadRatioResponseDeliveryStateEducationLevelEstateTypeExcludedCriteriaRecordExcludedCriteriasExclusionReasonFetchScoresRequestFetchScoresRequestServiceRequestFindOrdersRequestFindOrdersRequestServiceRequestFindOrdersResponseFindOrdersResponseServiceResultFindOrdersResponse_OrderFindOrdersResponse_RequestGeo_get_bodyGeo_validateAddress_bodyGetAvailOrderRecieversRequestGetAvailOrderRecieversRequestServiceRequestGetAvailOrderRecieversResponseGetAvailOrderRecieversResponseServiceResultGetLastOrderForPhoneRequestGetLastOrderForPhoneRequestServiceRequestGetOrderPayloadRequestGetOrderPayloadRequestServiceRequestGetOrderPayloadResponseGetOrderPayloadResponseServiceResultGetOrderStatusRequestGetOrderStatusRequestServiceRequestGetOrderStatusResponseGetOrderStatusResponseServiceResultGuidArrayServiceRequestGuidServiceRequestIndividualIntegrationDataIntegrationInformationIntegrationResponseIntegrationResponseIReadOnlyCollectionServiceResultLastOrderForPhoneResponseLastOrderForPhoneResponseServiceResultLoadingDataLocalReferenceTypeMortgageTypeOccupationTypeOrderOrderAdmReportOrderAdmReportItemsContainerOrderAdmReportItemsContainerServiceResultOrderMethodOrderOfferInfoOrderPayloadOrderReportRequestOrderReportRequestServiceRequestOrderRequestAdmReportOrderRequestAdmReportItemsContainerOrderRequestAdmReportItemsContainerServiceResultOrderRequestDataForFeedbackRequestOrderRequestDataForFeedbackRequestServiceRequestOrderRequestDataForFeedbackResponseOrderRequestDataForFeedbackResponseServiceResultOrderRequestFeedbackAdmReportOrderRequestFeedbackAdmReportItemsContainerOrderRequestFeedbackAdmReportItemsContainerServiceResultOrderRequestFeedbackRequestOrderRequestFeedbackRequestServiceRequestOrderRequestPayloadOrderRequestReportRequestOrderRequestReportRequestServiceRequestOrderRequestStateOrderServiceResultOrderStateOrderTypeOrganizationOwnershipPassportPensionerPeriodPersonPhoneProductTypeRecieverRecipientCriteriaReferenceItemSetOrderRequestStateRequestSetOrderRequestStateRequestIReadOnlyCollectionServiceRequestSetOrderRequestStateRequestServiceRequestSetOrderRequestStateResponseSetOrderRequestStateResponseServiceResultSetOrderStateRequestSetOrderStateRequestServiceRequestSetOrderStateResponseSetOrderStateResponseServiceResultStringServiceRequestUpdateOrderRequestUpdateOrderRequestServiceRequestUpdateOrderResponseUpdateOrderResponseServiceResultUserDataUserFmsUserFmsDataUserScoreUserScoreRequestUserScoreRequestServiceRequestUserScoreServiceResultValidationItemValidationResultWorkInfo
AddOrderRecieverRequest Up
AddOrderRecieverRequestServiceRequest Up
AddOrderRecieverResponseServiceResult Up
AddOrderRecieversRequest Up
AddOrderRecieversRequestServiceRequest Up
AddOrderRecieversResponseServiceResult Up
AddOrderRequest Up
AddOrderRequestFeedbackRequest Up
Добавление отзыва на запрос заявки. Ответ - Vbr.OrderService.Contracts.Response.AddOrderRequestFeedbackResponse.
AddOrderRequestFeedbackRequestServiceRequest Up
AddOrderRequestFeedbackResponse Up
feedbackId (optional)
Integer Идентификатор отзыва. format: int32
AddOrderRequestFeedbackResponseServiceResult Up
AddOrderRequestServiceRequest Up
AddOrderResponse Up
orderId (optional)
UUID Идентификатор заявки в системе (Id заявки из базы данных) или Guid.Empty при ошибке. format: uuid
validationResult (optional)
AddOrderResponseServiceResult Up
AdditionalInfo Up
Дополнительная информация по заемщику
AdditionalIncome (optional)
String Сумма дополнительного дохода
ChangeOfFullName (optional)
Boolean Признак смены ФИО
ChangeOfPassport (optional)
Boolean Признак смены паспорта.
DateChangeOfFullName (optional)
String Дата смены ФИО
EducationLevel (optional)
String0 - Unknown: Не указано 1 - IncompleteSecondary: Неполное среднее 2 - Secondary: Среднее 3 - SpecializedSecondary: Среднее специальное 4 - UnfinishedHigher: Неоконченное высшее 5 - Higher: Высшее 6 - SecondaryHigher: Второе высшее 7 - AcademicDegree: Ученая степень
Уровень образования
FamilyIncome (optional)
String Доход жены/мужа
MaritalStatus (optional)
String0 - Unknown: Не указан 1 - Single: Холост 2 - Married: Женат, замужем 3 - Divorced: Разведены 4 - Widower: Вдовец / вдова
Семейное положение
NumberOfDependents (optional)
Integer Кол-во иждивенцев format: int32
TypeOfAdditionalIncome (optional)
Integer Тип дополнительного дохода format: int32
UnderAgeChildrenCount (optional)
Integer Кол-во детей в возрасте до 21 года format: int32
AdditionalDocumentType (optional)
Address Up
State (optional)
String Субъект РФ
Region (optional)
String Район
City (optional)
String Населённый пункт
Street (optional)
String Улица
House (optional)
String Дом
Block (optional)
String Строение
Apartments (optional)
String Квартира
Zip (optional)
String Почтовый индекс
FullAddress (optional)
String Полный адрес
Okato (optional)
String Код ОКАТО
Oktmo (optional)
String Код ОКТМО
Kladr (optional)
String Код КЛАДР Формат:
FiasId (optional)
String ФИАС-код адреса (идентификатор ФИАС)
RegionId (optional)
String Идентификатор региона.
Type (optional)
String0 - Unknown: Не указан. 1 - Actual: Фактический адрес. 2 - Registration: Адрес регистрации. 3 - Work: Рабочий адрес. 4 - PlaceOfIssue: Место выдачи. 5 - RealEstate: Адрес залоговой недвижимости 6 - Passport: Место получения паспорта
Тип адреса (домашний, рабочий).
Date (optional)
String Дата регистрации по адресу
AddressType Up
Тип адреса.
ChangeOrderMethodRequestServiceRequest Up
CheckDuplicateRequestServiceRequest Up
CheckDuplicateResponse Up
isDuplicate (optional)
Boolean Является дубликатом
CheckDuplicateResponseServiceResult Up
CheckOrderByClickIdRequestServiceRequest Up
CheckRecieverForPossibilityUseRequest Up
CheckRecieverForPossibilityUseRequestServiceRequest Up
CheckRecieverForPossibilityUseResponseServiceResult Up
CopyOrderRequest Up
orderId (optional)
UUID Идентификатор запроса format: uuid
newOrderMethod (optional)
editMode (optional)
Integer Идентификация редактирования заявки 0 - нет, 1 - да format: int32
newClickId (optional)
String Новый идентификатор клика в рекламной системе
newClientId (optional)
String Новый идентификатор клиента в рекламной системе
newPartnerId (optional)
String Новый индентификатор партнера в рекламной системе
CopyOrderRequestServiceRequest Up
CopyOrderResponse Up
newOrderId (optional)
UUID Идентификатор нового запроса format: uuid
CopyOrderResponseServiceResult Up
DeliveryState Up
Статус доставки заявки потребителю.
EducationLevel Up
Уровень образования
EstateType Up
Тип недвижимости.
ExcludedCriterias Up
exclusions (optional)
ExclusionReason Up
Причины недоступности интеграции
FetchScoresRequest Up
orders (optional)
array[UUID] Список идентифкаторов запросов format: uuid
updateOrders (optional)
Boolean Обновлять данные скоринга в запросах
updateOrderRequests (optional)
Boolean Обновлять данные скоринга в заявках
forceRenew (optional)
Boolean Использовать укоренное обновление данных используя хэш
FetchScoresRequestServiceRequest Up
FindOrdersRequest Up
orderId (optional)
UUID Идентификатор запроса format: uuid
orderStatus (optional)
Integer Статус запроса смотри OrderState format: int32
fromDate (optional)
Date Выборка от текущей даты format: date-time
toDate (optional)
Date Выборка до текущей даты format: date-time
pageIndex (optional)
Integer Индекс страницы format: int32
pageSize (optional)
Integer Размер страницы format: int32
FindOrdersRequestServiceRequest Up
FindOrdersResponse Up
FindOrdersResponseServiceResult Up
FindOrdersResponse_Order Up
partnerId (optional)
Integer Идентификатор партнера format: int32
orderId (optional)
UUID Идентификтор запроса format: uuid
creationDate (optional)
Date Дата создания запроса format: date-time
orderStatus (optional)
Integer Статус запроса смотри OrderState format: int32
totalCount (optional)
Integer Итого строк format: int32
tagId (optional)
Long Идентификатор клиента format: int64
requests (optional)
array[FindOrdersResponse_Request] Список заявок по запросу
GetAvailOrderRecieversRequestServiceRequest Up
GetAvailOrderRecieversResponse Up
recievers (optional)
array[Reciever] Список подходящих интеграций
alternateRecieversBySum (optional)
array[Reciever] Список подходящих интеграций по сумме, без учета срока кредитования
alternateRecieversByPeriod (optional)
array[Reciever] Список подходящих интеграций по сроку кредитования, без учета суммы кредиты
alternateSum (optional)
Double Альтернативная сумма кредита format: double
alternateDays (optional)
Integer Альтернативный срок кредитования в днях format: int32
GetAvailOrderRecieversResponseServiceResult Up
GetLastOrderForPhoneRequest Up
GetLastOrderForPhoneRequestServiceRequest Up
GetOrderPayloadRequest Up
orderId (optional)
UUID Идентификатор запроса format: uuid
GetOrderPayloadRequestServiceRequest Up
GetOrderPayloadResponseServiceResult Up
GetOrderStatusRequest Up
orderId (optional)
UUID Идентификатор запроса format: uuid
GetOrderStatusRequestServiceRequest Up
GetOrderStatusResponse Up
GetOrderStatusResponseServiceResult Up
GuidArrayServiceRequest Up
correlationId (optional)
UUID Уникальный идентификатор запроса format: uuid
data (optional)
array[UUID] Содержимое запроса format: uuid
IndividualIntegrationData Up
Набор данных использующийся только в определенной интеграции, такой как "офис получения кредита"
PropertyName (optional)
String0 - Unknown: Не определен 1 - BankOffice: Офис получения кредита (Справочник банка) 2 - ActivityAreaBankRef: Сфера деятельности компании (Справочник банка) 3 - JobTitleRef: Название должности (Справочник банка) 4 - OccupationTypeRef: Тип занятости (Справочник банка) 5 - CurrentPropertyTypeRef: Тип недвижемости по месту жительства (Справочник банка) 6 - NumberOfEmployeesRef: Кол-во сотрудников (Справочник банка) 7 - ProductTypeRef: Тип продукта 100 - Okopf: Справочник организационно-правовой формы 101 - ActivityArea: Сфера деятельности компании 102 - PositionLevel: Характер должности 103 - AdditionalIncomeType: Тип дополнительного дохода 104 - EMailDomains: Список Email доменов для подсказок
Название поля сохраняемое для интеграции
IntegrationId (optional)
String Идентификатор интеграции
Value (optional)
String Значение сохраняемого поля
IntegrationInformation Up
name (optional)
String Название интеграции.
description (optional)
String Описание интеграции.
organizationName (optional)
String Название организации.
integrationId (optional)
UUID Идентификатор интеграции format: uuid
applicableOrderTypes (optional)
array[OrderType] Доступные типы заявок.
hasAdditionalForm (optional)
Boolean Иммет форму дополнительных полей
allowSendShortForm (optional)
Boolean Интеграция позволяет отправлять ей короткую форму заявки.
allowMultipleOffers (optional)
Boolean Интеграция позволяет иметь несколько экземпляров у одной заявки (в интеграцию передаётся идентификатор оффера).
stepByStepIntegration (optional)
Boolean Интеграция реализована только с возможностью пошагового создания заявки
IntegrationResponse Up
information (optional)
IntegrationResponseIReadOnlyCollectionServiceResult Up
correlationId (optional)
UUID Уникальный идентификатор запроса. format: uuid
data (optional)
array[IntegrationResponse] Содержимое ответа.
success (optional)
Boolean флаг, что запрос успешно выполнен.
LastOrderForPhoneResponseServiceResult Up
LoadingData Up
Нагрузочные данные для заявок
LocalReferenceType Up
Варианты локальных справочнииков
MortgageType Up
Тип ипотеки.
OccupationType Up
Тип занятости.
Order Up
DefaultContactPerson (optional)
String0 - Unknown: Не указано. 1 - TheApplicantHimself: Сам заявитель. 2 - MotherOrFather: Отец/мать. 3 - SonOrDaughter: Сын/дочь. 4 - BrotherOrSister: Брат/сестра. 5 - Friend: Друг/подруга. 6 - Spouse: Супруг/супруга. 7 - PreviousApplicantHimself: Сам заявитель, старые данные 8 - Colleague: Коллега. 9 - Other: Другое. 10 - Chief: Начальник.
Контактное лицо по умолчанию
OrderType (optional)
String0 - Unknown: Не указан. 1 - Mortgage: Ипотека. 2 - CashLoan: Кредит наличными 3 - CreditCard: Кредитная карта 4 - MicrofinanceCredit: Микрозайм 5 - PropertyPledgeCredit: Займ под недвижимость 6 - AutoPledgeCredit: Займ под авто 7 - AutoPledgePtsCredit: Займ под ПТС 8 - DebitCard: Дебетовая карта 9 - AutoCredit: Автокредит 10 - CashService: РКО 11 - Deposit: Вклад
Тип кредитного продукта
MortgageType (optional)
String0 - Unknown: Не указан. 1 - Primary: Первичная недвижимость. 2 - Resale: Вторичная недвижимость. 3 - Refinancing: Рефинансирование.
Тип ипотеки для ипотечных продуктов
EstateType (optional)
String0 - Unknown: Не указана. 1 - Flat: Квартира. 2 - Apartments: Аппартаменты. 3 - Townhouse: Загородная недвижимость/таунхаус. 4 - Share: Доля. 5 - Commercial: Коммерческая недвижимость.
Тип недвижимости
Email (optional)
String Email клиента
Amount (optional)
String Размер кредита / ипотеки
InitialAmount (optional)
String Сумма первоначального взноса
Duration (optional)
Security (optional)
String0 - Unknown: Не указано. 1 - Flat: Квартира. 2 - Apartments: Аппартаменты. 3 - Townhouse: Таунхаус. 4 - House: Жилой дом. 5 - Room: Комната. 6 - WithOutSecurity: Без обеспечения 7 - RealEstate: Под залог недвижимости 8 - Car: Автомобиль 9 - Pts: ПТС
Обеспечение кредита
Persons (optional)
array[Person] Данные по клиенту и контактным лицам
Passport (optional)
PreviousPassport (optional)
WorkInfo (optional)
Phones (optional)
array[Phone] Данные по телефонам связанные с клиентом
Addresses (optional)
array[Address] Данные по адресам связанные с клиентом
IndividualIntegrations (optional)
array[IndividualIntegrationData] Набор данных для определенных интеграций
Ownership (optional)
AdditionalInfo (optional)
Pensioner (optional)
CreditPurpose (optional)
String0 - Unknown: Не указано 1 - Other: На любые цели 2 - HomeRepair: Ремонт квартиры / дома 3 - Education: Образование 4 - Electronic: Покупка электронной и бытовой техники 5 - Treatment: Лечение 6 - Vacation: Отпуск 7 - Farming: Ведение подсобного хозяйства 8 - HouseholdExpenses: Бытовые расходы (продукты питания, одежда и т.д.) 9 - Mortgage: Покупка недвижимости / первый взнос за ипотеку 10 - Refinancing: Рефинансирование 11 - CountryHouse: Строительство дома / покупка участка
Цель кредита
CardHolder (optional)
String Имя клиента на кредитной карте
SecretCode (optional)
String Секретный код
LoadingData (optional)
OrderAdmReport Up
issueCity (optional)
String Город получения услуги.
offers (optional)
array[OrderOfferInfo] Предложения, показанные пользователю.
jsonContent (optional)
String Тело заявки в формате JSON.
excludedCriterias (optional)
userScore (optional)
Integer Скоринг пользователя оставившего заявку format: int32
id (optional)
UUID ID заявки. format: uuid
state (optional)
Integer Статус заявки: 1 - Короткая 2 - Полная 4 - Обработано 8 - Есть заявки 16 - Принята 32 - Отказ format: int32
creationDate (optional)
Date Дата создания заявки. format: date-time
lastModifyDate (optional)
Date Дата последнего изменения заявки. format: date-time
sourceId (optional)
Integer Источник заявки (0 - Выберу.ру). format: int32
orderType (optional)
productType (optional)
content (optional)
String Контент заявки.
payload (optional)
String Дополнительные данные от источника заявки.
tagId (optional)
Long Тег. Если старшие 32 бита равны 0, то младшие содержат идентификатор пользователя в Выберу.ру. format: int64
orderMethod (optional)
orderRequestCount (optional)
Integer format: int32
offersCount (optional)
Integer Кол-во предложений доступных на момент последнего запроса предложений format: int32
debtLoadRatio (optional)
Double format: double
currentDebtLoadRatio (optional)
Double format: double
lastStateModifyDate (optional)
Date format: date-time
OrderAdmReportItemsContainer Up
Контейнер коллекции
items (optional)
array[OrderAdmReport] Коллекция заначений
total (optional)
Integer Итоговое кол-во элементов format: int32
OrderAdmReportItemsContainerServiceResult Up
OrderMethod Up
Метод получения запроса.
OrderOfferInfo Up
Данные о показанном пользователю предложении.
OrderPayload Up
Сервисные данные запроса.
orderId (optional)
UUID Идентификатор запроса. format: uuid
ip (optional)
String IP адрес с которого создается запрос.
requestDate (optional)
Date Дата запроса. format: date-time
tagId (optional)
Long Идентификатор пользователя. format: int64
clickId (optional)
String Идентификатор клика в рекламной системе.
editMode (optional)
Integer Идентификация режима редактирования. format: int32
adsClientId (optional)
String Идентификатор клиента на стороне рекламной админки.
adsPartnerId (optional)
String Идентификатор партнера на стороне рекламной админки.
regionAlias (optional)
String Алиас региона сайта с которого сделан запрос.
stepNumber (optional)
Integer Номер шага для интеграций StepByStep. format: int32
userAgent (optional)
String User agent с которого был создан запрос.
b24ContactId (optional)
Integer Идентификатор контакта на стороне CRM. format: int32
b24LeadtId (optional)
Integer Идентификатор лида на стороне CRM. format: int32
userScore (optional)
Integer Персональный кредитный рейтинг. format: int32
afzIntegrationId (optional)
UUID Идентификатор интеграции действителен только для АФЗ. format: uuid
childOrderId (optional)
UUID Дочерний orderId созданный при копировании данных. format: uuid
parentOrderId (optional)
UUID Родиельский orderId созданный при копировании данных. format: uuid
abTestInformation (optional)
OrderReportRequest Up
page (optional)
Integer Номер страницы (от 0). format: int32
itemsPerPage (optional)
Integer Количество элементов на странице. format: int32
orderId (optional)
UUID Идентификатор запроса (указывается, если требуется фильтрация по номера заявки). format: uuid
orderType (optional)
Integer Тип заявки (указывается, если требуется фильтрация). смотри OrderType format: int32
dateFrom (optional)
Date Дата и время от которых требуется получить заявки. format: date-time
dateTo (optional)
Date Дата и время до которого требуется получать заявки. format: date-time
fetchContent (optional)
Boolean Флаг, что требуется получать контент самой заявки.
integrationId (optional)
UUID Идентификатор интеграции с (банком, агрегатором и т.п.) в которую напралена заявка. format: uuid
productId (optional)
UUID Идентификатор продукта (продукты привязаны к интеграциям). format: uuid
tagId (optional)
Long Идентификатор получателя кредита. format: int64
regionId (optional)
Integer Идентификатор региона. format: int32
orderState (optional)
Integer Статус заявки - бинароное значение. смотри OrderState format: int32
deliveryState (optional)
Integer Статус отправки заявки в интеграцию. смотри DeliveryState format: int32
orderRequestState (optional)
Integer Статус запроса состояния заявки у интеграции (указывается, если требуется фильтрация). смотри OrderRequestState format: int32
orderMethod (optional)
Integer Метод получения запроса. смотри OrderMethod format: int32
fetchExcludedCriterias (optional)
Boolean Флаг, что требуется включать в ответ данные о критериях, которые не показаны пользователю.
clientId (optional)
String Идентификатор клиента на стороне рекламной системы
partnerId (optional)
String Идентификатор партнера на стороне рекламной системы
modifyStateFrom (optional)
Date Дата и время последнего изменения статуса от которых требуется получить заявки. format: date-time
modifyStateTo (optional)
Date Дата и время последнего изменения статуса до которых требуется получить заявки. format: date-time
firstName (optional)
String Имя получателя кредита
lastName (optional)
String Фамилия получателя кредита
middleName (optional)
String Отчество получателя кредита
phone (optional)
String Телефон получателя кредита
clickId (optional)
String Идентификатор клика на стороне рекламной системы
OrderReportRequestServiceRequest Up
OrderRequestAdmReport Up
requestId (optional)
UUID ID запроса. format: uuid
orderId (optional)
UUID ID заявки. format: uuid
integrationId (optional)
UUID ID интеграции с получателем заявки format: uuid
creationDate (optional)
Date Дата и время создания заявки. format: date-time
lastModifyDate (optional)
Date Дата и время последней модификации заявки. format: date-time
deliveryDate (optional)
Date Дата и время успешной отправки заявки в интеграцию. format: date-time
orderLastModifyDate (optional)
Date Дата и время последнего изменения запроса. format: date-time
content (optional)
String Данные заявки.
response (optional)
String Тело ответа от интеграции.
deliveryState (optional)
deliveryTryCount (optional)
Integer Кол-во попыток доставки заявки. format: int32
orderRequestState (optional)
orderRequestTryCount (optional)
Integer Кол-во попыток получения статуса заявки. format: int32
orderState (optional)
Integer Статус заявки: смотри OrderState format: int32
tagId (optional)
Long Тег. Если старшие 32 бита равны 0, то младшие содержат идентификатор пользователя в Выберу.ру. format: int64
userName (optional)
String ФИО пользователя оставившего заявку.
userPhone (optional)
String Номер телефона пользователя, оставившего заявку.
issueCity (optional)
String Город получения услуги.
integrationName (optional)
String Название интеграции (банка, агрегатора и т.п.).
productId (optional)
UUID Идентификатор продукта. format: uuid
productName (optional)
String Название продукта.
orderType (optional)
orderMethod (optional)
orderRequestStateResponse (optional)
String Тело ответа из интеграции при запросе текущего статуса заявки
jsonContent (optional)
String Тело заявки в формате JSON.
amount (optional)
Double Размер кредита / ипотеки / займа format: double
lastStateModifyDate (optional)
Date Дата последнего изменения статуса format: date-time
clickId (optional)
String Идентификатор клика на стороне рекламной системы
userScore (optional)
Integer Скоринг пользователя оставившего заявку format: int32
debtLoadRatio (optional)
Double Расчетная долговая нагрузка format: double
currentDebtLoadRatio (optional)
Double Долговая нагрузка по данной заявке format: double
OrderRequestAdmReportItemsContainer Up
Контейнер коллекции
items (optional)
array[OrderRequestAdmReport] Коллекция заначений
total (optional)
Integer Итоговое кол-во элементов format: int32
OrderRequestAdmReportItemsContainerServiceResult Up
OrderRequestDataForFeedbackRequest Up
orderRequestId (optional)
UUID Идентификатор заявки format: uuid
OrderRequestDataForFeedbackRequestServiceRequest Up
OrderRequestDataForFeedbackResponseServiceResult Up
OrderRequestFeedbackAdmReport Up
Отзыв пользователя на запрос на продукт.
Vbr.OrderService.Contracts.Request.Adm.OrderRequestFeedbackRequest
id (optional)
Integer Идентификатор отзыва format: int32
firstName (optional)
String Имя получателя кредита.
lastName (optional)
String Фамилия получателя кредита.
middleName (optional)
String Отчество получателя кредита.
email (optional)
String Email получателя кредита
creationDate (optional)
Date Дата отзыва format: date-time
orderType (optional)
orderMethod (optional)
orderState (optional)
orderRequestId (optional)
UUID Идентификатор запроса заявки format: uuid
orderRequestCreationDate (optional)
Date Дата создания запроса format: date-time
orderRequestDeliveryDate (optional)
Date Дата отправки запроса в интеграцию format: date-time
text (optional)
String Текст отзыва
phone (optional)
String Номер телефона получателя заявки
integrationId (optional)
UUID Идентификатор интеграции format: uuid
productId (optional)
UUID Идентификатор продукта format: uuid
OrderRequestFeedbackAdmReportItemsContainer Up
Контейнер коллекции
items (optional)
array[OrderRequestFeedbackAdmReport] Коллекция заначений
total (optional)
Integer Итоговое кол-во элементов format: int32
OrderRequestFeedbackAdmReportItemsContainerServiceResult Up
OrderRequestFeedbackRequest Up
page (optional)
Integer Номер страницы (от 0). format: int32
itemsPerPage (optional)
Integer Количество элементов на странице. format: int32
id (optional)
Integer Идентификатор заявки. format: int32
createdFrom (optional)
Date Дата и время, от которых требуется получить элементы. format: date-time
createdTo (optional)
Date Дата и время, по которые требуется получать элементы. format: date-time
OrderRequestFeedbackRequestServiceRequest Up
OrderRequestPayload Up
Сервисные данные заявки.
adsClientId (optional)
String Идентификатор клиента на стороне рекламной админки.
adsPartnerId (optional)
String Идентификатор партнера на стороне рекламной админки.
clickId (optional)
String Идентификатор клика на стороне рекламной админки.
clientOrderRequestId (optional)
String Идентификтор заявки на стороне банка.
clientOfferId (optional)
String Идентификтор оффера на стороне банка.
b24DealtId (optional)
Integer Идентификатор лида на стороне CRM. format: int32
userScore (optional)
Integer Персональный кредитный рейтинг. format: int32
editMode (optional)
Integer Идентификация режима редактирования. 0 - Создание, 1 - Редактирование format: int32
monthlyPayment (optional)
Double Ежемесячный платеж по текщей заявке. format: double
debtLoadRatio (optional)
Double Полная долговая нагрузка (ПДН) траты_по_текущим_кредитам / зарплата Vbr.OrderService.Contracts.WorkInfo.MonthIncome format: double
currentDebtLoadRatio (optional)
Double Коэффициент долговой нагрузки (КДН) (ежемесячный_платеж_по_будущему_кредиту + траты_по_текущим_кредитам) / зарплата Vbr.OrderService.Contracts.OrderRequestPayload.MonthlyPaymentVbr.OrderService.Contracts.WorkInfo.MonthIncome format: double
OrderRequestReportRequest Up
page (optional)
Integer Номер страницы (от 0). format: int32
itemsPerPage (optional)
Integer Количество элементов на странице. format: int32
requestId (optional)
UUID Идентификатор запроса по заявке (указывается, если требуется фильтрация по запросу заявки). format: uuid
orderId (optional)
UUID Идентификатор заявки. format: uuid
integrationId (optional)
UUID Идентификатор интеграции с (банком, агрегатором и т.п.) в которую напралена заявка. format: uuid
productId (optional)
UUID Идентификатор продукта (продукты привязаны к интеграциям). format: uuid
tagId (optional)
Long Идентификатор получателя кредита. format: int64
regionId (optional)
Integer Идентификатор региона. format: int32
orderState (optional)
Integer Статус заявки - бинароное значение. смотри OrderState format: int32
deliveryState (optional)
Integer Статус отправки заявки в интеграцию. смотри DeliveryState format: int32
orderRequestState (optional)
Integer Статус запроса состояния заявки. смотри OrderRequestState format: int32
orderType (optional)
Integer Тип заявки. смотри OrderType format: int32
dateFrom (optional)
Date Дата и время, от которых требуется получить запросы заявок. format: date-time
dateTo (optional)
Date Дата и время, по которые требуется получать запросы заявок. format: date-time
fetchContent (optional)
Boolean Флаг, что требуется получать контент самой заявки.
orderMethod (optional)
Integer Метод получения запроса. смотри OrderMethod format: int32
clientId (optional)
String Идентификатор клиента рекламной системы.
partnerId (optional)
String Идентификатор партнера рекламной системы.
modifyStateFrom (optional)
Date Дата и время последнего изменения статуса от которых требуется получить запросы заявок. format: date-time
modifyStateTo (optional)
Date Дата и время последнего изменения статуса до которых требуется получить запросы заявок. format: date-time
firstName (optional)
String Имя получателя кредита.
lastName (optional)
String Фамилия получателя кредита.
middleName (optional)
String Отчество получателя кредита.
phone (optional)
String Телефон получателя кредита.
clickId (optional)
String Идентификатор клика рекламной системы.
clientOrderId (optional)
String Идентификатор заявки на стороне (банка, агрегатора и т.п.)
OrderRequestReportRequestServiceRequest Up
OrderRequestState Up
Состояния заявки банка.
OrderState Up
Статус запроса (бинарное значение)
OrderType Up
Тип кредитного продукта
Passport Up
Паспортные данные.
Series (optional)
String Серия паспорта.
Number (optional)
String Номер паспорта.
DateOfIssue (optional)
String Дата выдачи паспорта.
Code (optional)
String Код подразделения.
IssuedBy (optional)
String Кем выдан паспорт?
Birthplace (optional)
String Место рождения.
CitizenOfRussianFederation (optional)
Boolean Имеет гражданство РФ
IsResidentOfRussianFederation (optional)
Boolean Является резидентом РФ
PeriodOfResidenceInYears (optional)
Integer Период проживания в РФ в годах Значение данного поля в интеграциях ЕФЗ считать по умолчанию от даты рождения format: int32
Pensioner Up
Дополнительная информация по заемщику - если он пенсионер
Date (optional)
String Дата выдачи пенсионного удостоверения
DocumentNumber (optional)
String Дата получения документа
HavePension (optional)
Boolean Получаете ли вы пенсию
PensionerStatus (optional)
String0 - Unknown: Не указан. 1 - No: Нет 2 - Yes: Да, я пенсионер 3 - Working: Я работающий пенсионер
Статус пенсионера
PensionIncome (optional)
String Размер пенсии
PensionReasons (optional)
String0 - Unknown: Не указан 1 - OldAge: По старости 2 - Disability: По инвалидности 3 - LossOfBreadwinner: По инвалидности 4 - DisabledChild: На ребенка-инвалида 5 - LaborInjuries: По случаю получения трудовых увечий 6 - ParticipationHostilities: По случаю участия в боевых действиях 7 - AccidentNuclearPowerPlant: По случаю участия в боевых действиях
Основание для получения пенсии
Person Up
Данные по клиенту и контактным лицам
FirstName (optional)
String Имя
MiddleName (optional)
String Отчество
LastName (optional)
String Фамилия
Sex (optional)
Birthdate (optional)
String Дата рождения
Relation (optional)
String0 - Unknown: Не указано. 1 - TheApplicantHimself: Сам заявитель. 2 - MotherOrFather: Отец/мать. 3 - SonOrDaughter: Сын/дочь. 4 - BrotherOrSister: Брат/сестра. 5 - Friend: Друг/подруга. 6 - Spouse: Супруг/супруга. 7 - PreviousApplicantHimself: Сам заявитель, старые данные 8 - Colleague: Коллега. 9 - Other: Другое. 10 - Chief: Начальник.
Тип отношения к заемщику
Phone Up
Msisdn (optional)
String Номер телефона в формате MSISDN
Type (optional)
String0 - Unknown: Не указан. 1 - Federal: Федеральный номер. 2 - Mobile: Мобильный номер.
Тип телефонного номера
Usage (optional)
String0 - Unknown: Не указано. 1 - Personal: Личный номер (сотовый). 2 - Additional: Дополнительный, личный. 3 - Home: Домашний телефон (стационарный). 4 - Work: Рабочий телефон. 5 - ContactPerson: Контактного лица
Применение телефона
Reciever Up
recieverId (optional)
UUID Получатель заявки format: uuid
isValid (optional)
Boolean Статус прохождения валидации для банка (по критериям заявок)
hasAdditionalForm (optional)
Boolean Имеет форму дополнительных полей
productId (optional)
UUID format: uuid
isApplicable (optional)
Boolean Заявка полностью сформирована для интеграции
isUsed (optional)
Boolean Заявка была ранее отправлена в эту интеграцию
offerId (optional)
clientOfferId (optional)
stepByStepIntegration (optional)
popupText (optional)
orderType (optional)
RecipientCriteria Up
id (optional)
UUID Идентификатор критерия format: uuid
integrationId (optional)
UUID Идентификатор интеграции (с банком. мфо и т.п.) format: uuid
enabled (optional)
Boolean Флаг активности критерия
orderType (optional)
productId (optional)
UUID Идентификатор продукта format: uuid
sumMin (optional)
Double Минимальная сумма format: double
sumMax (optional)
Double Максимальная сумма format: double
ageMin (optional)
Integer Минимальный возрат format: int32
ageMax (optional)
Integer Максимальный возрат format: int32
daysMin (optional)
Integer Минимальное кол-во дней format: int32
daysMax (optional)
Integer Максимальное кол-во дней format: int32
dontCheckCustomLimits (optional)
Boolean Не проверять другие лимиты / критерии
mortgageType (optional)
estateType (optional)
offerId (optional)
String Идентификатор оффера из рекламной системы
clientOfferId (optional)
String Идентификатор оффера из рекламной системы
experienceMin (optional)
Integer Минимальный стаж format: int32
experienceMax (optional)
Integer Максимальный стаж format: int32
workIncomeMin (optional)
Integer Минимальный ежемесячнй доход format: int32
workIncomeMax (optional)
Integer Максимальный ежемесячный доход format: int32
nbkiRatingMin (optional)
Integer Минимальное значение скоринга НБКИ format: int32
popupText (optional)
String Максимальное значение скоринга НБКИ
debtLoadRatioMax (optional)
Integer Минимальное значение долговой нагрузки format: int32
minEducationLvl (optional)
occupationTypes (optional)
ReferenceItem Up
Модель справочника для передачи между сервисами
SetOrderRequestStateRequest Up
orderRequestId (optional)
UUID Идентификатор заявки. format: uuid
orderRequestState (optional)
Integer Новый статус. format: int32
clientOrderRequestId (optional)
String Номер заявки на стороне банка.
clickId (optional)
String Идентификатор клика в рекламной админке
changed (optional)
Date Дата изменения статуса, если параметр не установлен, то заполняется текущее время format: date-time
SetOrderRequestStateRequestIReadOnlyCollectionServiceRequest Up
correlationId (optional)
UUID Уникальный идентификатор запроса format: uuid
data (optional)
array[SetOrderRequestStateRequest] Содержимое запроса
SetOrderRequestStateRequestServiceRequest Up
SetOrderRequestStateResponseServiceResult Up
SetOrderStateRequestServiceRequest Up
SetOrderStateResponse Up
validationResult (optional)
SetOrderStateResponseServiceResult Up
UpdateOrderRequest Up
UpdateOrderRequestServiceRequest Up
UpdateOrderResponse Up
validationResult (optional)
UpdateOrderResponseServiceResult Up
UserScoreRequestServiceRequest Up
ValidationResult Up
isError (optional)
Boolean Имеются ошибки
isWarning (optional)
Boolean Имеются предупреждения
items (optional)
array[ValidationItem] Набор валидируемой информации
isValid (optional)
WorkInfo Up
Информация по работе
OccupationType (optional)
String0 - Unknown: Не указан. 1 - Employed: Работа по найму. 2 - Individual: Индивидуальный предприниматель. 4 - SelfEmployed: Самозанятый. 16 - Pensioner: Пенсионер. 32 - Military: Военный. 64 - Unemployed: Не работаю.
Тип занятости
MonthIncome (optional)
String Доход
StartDate (optional)
String Дата начала работы
ProofOfIncome (optional)
String0 - Unknown: Не указано. 1 - CoBorrower: Созаемщик без учета дохода. 2 - HiringNdfl: Найм, 2-НДФЛ. 3 - HiringReference: Найм, Справка по форме банка. 4 - HiringVoice: Найм, Устное подтверждение. 5 - IpTax: ИП, Налоговая декларация. 6 - IpVoice: ИП, Устное подтверждение. 7 - BusinessOwnerTax: Собственник бизнеса, Налоговая декларация. 8 - BusinessOwnerDocs: Собственник бизнеса, Иными документами. 9 - BusinessOwnerVoice: Собственник бизнеса, Устное подтверждение.
Подтверждение дохода.
Inn (optional)
String ИНН
Name (optional)
String Наименование места работы
NumberOfEmployees (optional)
Integer Кол-во сотрудников format: int32
Position (optional)
String Должность
Okopf (optional)
Integer Ключ кода ОКОПФ format: int32
OkopfCode (optional)
String Код ОКОПФ
ActivityArea (optional)
Integer Сфера деятельности, справочное значение смотри методы /Reference/ format: int32
PositionLevel (optional)
Integer Характер занимаемой должности, справочное значение смотри методы /Reference/ format: int32
TotalWorkExperience (optional)
Integer Общий трудовой стаж в годах format: int32
CanConfirmEmployment (optional)
Boolean Могу подтвердить свою занятость копией трудовой книжки
