13-12-2018 12:06

Поиск лидов

GET   /bs-core/main/leads/find/date-from/{dateFrom}/date-to/{dateTo}

Этот метод помечен как @Deprecated. Вместо него рекомендуется использовать метод "Поиск по лидам".

Для поиска указывается период времени. Можно использовать фильтры по Фамилии, Каналу поступления лидов, Статусу лидов и Мобильному телефону.

Запрос

GET /bs-core/main/leads/find/date-from/2016-04-01T00:00:00/date-to/2016-04-15T23:59:59?lead-status=DENIED HTTP/1.1
Описание параметров
Нет описанных параметров

Ответ


                        {
    "status": "ok",
    "timestamp": 1462952215708,
    "data": [
        {
            "id": 306,
            "creationDate": 1459771471479,
            "channel": "LOAN_APPLICATION",
            "firstName": "Артем",
            "lastName": "Полетковй",
            "patronymic": "Васильевич",
            "mobilePhone": "76775676764",
            "amount": 11111,
            "currentStatus": "DENIED",
            "denialReasonId": 101557,
            "loanApplicationId": 10113431,
            "contractId": null,
            "scoringTask": {
                "id": 106,
                "startDate": 1459771471265,
                "endDate": 1459771471265,
                "finalRecommendation": "DENY",
                "ruleTasks": null
            }
        },
        {
            "id": 307,
            "creationDate": 1460461046693,
            "channel": "LOAN_APPLICATION",
            "firstName": "Иван",
            "lastName": "Иванов",
            "patronymic": "Иванович",
            "mobilePhone": "79151111112",
            "amount": 10000,
            "currentStatus": "CHECK",
            "denialReasonId": null,
            "loanApplicationId": 10113434,
            "contractId": null,
            "scoringTask": {
                "id": 107,
                "startDate": 1460461046350,
                "endDate": null,
                "finalRecommendation": null,
                "ruleTasks": null
            }
        },
        {
            "id": 308,
            "creationDate": 1460729203811,
            "channel": "LOAN_APPLICATION",
            "firstName": "Иван",
            "lastName": "Иванов",
            "patronymic": "Иванович",
            "mobilePhone": "79151111112",
            "amount": 1110,
            "currentStatus": "DENIED",
            "denialReasonId": null,
            "loanApplicationId": 10113435,
            "contractId": null,
            "scoringTask": {
                "id": 108,
                "startDate": 1460729203603,
                "endDate": 1461027619122,
                "finalRecommendation": "UNDEFINED",
                "ruleTasks": null
            }
        },
        {
            "id": 309,
            "creationDate": 1460729259435,
            "channel": "LOAN_APPLICATION",
            "firstName": "Иван",
            "lastName": "Иванов",
            "patronymic": "Иванович",
            "mobilePhone": "79151111112",
            "amount": 20,
            "currentStatus": "DENIED",
            "denialReasonId": null,
            "loanApplicationId": 10113436,
            "contractId": null,
            "scoringTask": {
                "id": 109,
                "startDate": 1460729259261,
                "endDate": null,
                "finalRecommendation": null,
                "ruleTasks": null
            }
        }
    ]
}
Описание параметров
Параметр Обязателен Тип данных Описание
id R [int][20] Идентификатор лида
channel R [enum]

Канал поступления лида

Список каналов:

  • PRESCORE
  • GENERATOR
  • SITE
  • ECOMM
  • UNO_MOMENTO
  • LOAN_APPLICATION
naturalPerson R [bool] Физическое лицо (да/нет), по умолчанию стоит true.
firstName R [string][50] Имя
lastName R [string][50] Фамилия
patronymic R [string][50] Отчество
title R [string][500] Наименование организации (Для Юридического лица)
registrationNumber R [string][50] Регистрационный номер (ОГРН) (для лида юр.лица)
sexId R [int][20]

Пол:

  • 101251 - Мужчина
  • 101252 - Женщина
birthDate R [date] Дата рождения (YYYY-MM-DD)
birthPlace R [string][100] Место рождения
birthCountryId R [int][20] Идентификатор страны гражданства
passport R [object] Паспорт
passport.id R [int][20] Паспорт. Идентификационный номер.
passport.seria R [string][25] Паспорт серия
passport.no R [string][25] Паспорт номер
passport.extraNumber R [string][100] Дополнительный номер
passport.issueDate R [date] Дата выдачи паспорта. (YYYY-MM-DD)
passport.closeDate R [date] Дата окончания действия паспорта. (YYYY-MM-DD)
passport.manager R [string][255] Орган выдачи паспорта
passport.subdivisionCode R [string][10] Код подразделения
passport.complementaryDocTypeId R [int][20]

Идентификатор типа документа:

  • 102121 - Водительское удостоверение
  • 102122 - СНИЛС
  • 102123 - Заграничный паспорт
  • 102126 - Паспорт
  • 102127 - Другой документ
  • 102128 - Нет

В настоящее время, хотя этот параметр и присутствует, у него в паспорте будет проставляться значение null,

так как существует объект complementaryDoc который содержит параметр complementaryDocTypeId, который имеет значение (смотрите

например описание этого метода).
inn R [string][50] ИНН
snils R [string][50] СНИЛС
mobilePhone R [string][50] Указываются только цифры в международном формате 79886542301
email R [string][100] Электронная почта
howYouKnowId R [int][20]

Как вы о нас узнали:

  • 102171 - Транспорт
  • 102172 - Телевидение
  • 102173 - Газета
  • 102174 - Наружная реклама
  • 102175 - Знакомые
  • 102176 - Интернет
subdivisionId R [int][20]

Идентификатор подразделения

  • 101791 - Москва
  • 101792 - Москва - интернет
  • 101793 - Севастополь-1
  • 101794 - Красногорск
  • 101795 - Севастополь-2
  • 101798 - Седьмое
  • 1017910 - На "Посадской"
  • 101796 - Первое
  • 101797 - Второе
  • 101799 - Касса долька
relatives R [collection] Список родственников
relatives._.id R [int][20] Идентификатор родственника
relatives._.lastName R [string][50] Фамилия родственника
relatives._.firstName R [string][50] Имя родственника
relatives._.patronymic R [string][50] Отчество родственника
relatives._.resident R [bool] Резидент
relatives._.passport R [object] Паспорт родственника.
relatives._.passport._.id R [int][20] Паспорт родственника. Идентификационный номер.
relatives._.passport._.seria R [string][25] Паспорт серия родственника
relatives._.passport._.no R [string][25] Паспорт номер родственника
relatives._.passport._.extraNumber R [string][100] Дополнительный номер родственника
relatives._.passport._.issueDate R [date] Дата выдачи паспорта родственника. (YYYY-MM-DD)
relatives._.passport._.closeDate R [date] Дата окончания действия паспорта родственника. (YYYY-MM-DD)
relatives._.passport._.manager R [string][255] Орган выдачи паспорта родственника
relatives._.passport._.subdivisionCode R [string][10] Код подразделения
relatives._.passport._.complementaryDocTypeId R [int][20]

Идентификатор типа документа:

  • 102121 - Водительское удостоверение
  • 102122 - СНИЛС
  • 102123 - Заграничный паспорт
  • 102126 - Паспорт
  • 102127 - Другой документ
  • 102128 - Нет

В настоящее время, хотя этот параметр и присутствует, у него в паспорте будет проставляться значение null,

так как существует объект complementaryDoc который содержит параметр complementaryDocTypeId, который имеет значение (смотрите

например описание этого метода).
relatives._.rnn R [string][50] ИНН родственника
relatives._.telephone R [string][100] Номер телефона родственника
relatives._.email R [string][50] Электронная почта родственника
relatives._.workPlace R [string][50] Место работы родственника
relatives._.address R [string][255] Адрес родственника
relatives._.birthDate R [date] Дата рождения родственника (YYYY-MM-DD)
relatives._.collateralRelId R [int][20]

Идентификатор степени родства:

  • 102141 - Жена
  • 102142 - Муж
  • 102143 - Мама
  • 102144 - Папа
  • 102145 - Дочь
  • 102146 - Сын
  • 102147 - Брат
  • 102148 - Сестра
  • 102149 - Коллеги
  • 1021410 - Друзья
  • 1021411 - Бабушка
  • 1021412 - Дедушка
  • 1021413 - Дядя
  • 1021414 - Тетя
  • 1021415 - Иное
relatives._.verified R [bool] Верифицирован
relatives._.comments R [string][255] Комментарии по родственникам
leadDebts R [collection] Действующие кредиты и займы
leadDebts._.id R [int][20] Идентификатор действующего кредита или займа
leadDebts._.debtName R [string][200] Наименование действующего кредита или займа
leadDebts._.debtAmount R [float] Сумма действующего кредита или займа
leadDebts._.bank R [string][100] Банк действующего кредита или займа
leadDebts._.debtBankId R [int][20] Идентификатор объекта банк действующего кредита или займа
leadDebts._.remainderDebt R [float] Остаток долга действующего кредита или займа
leadDebts._.monthlyPayment R [float] Ежемесячный платеж действующего кредита или займа
leadDebts._.availabilityDelays R [string][200] Наличие просрочек действующего кредита или займа
leadDebts._.paymentPeriodicity R [string][50] Периодичность выплат действующего кредита или займа
leadDebts._.lastFactPaymentDate R [date] Дата последнего фактического платежа по действующему кредиту или займу в формате YYYY-MM-DD
leadDebts._.intRate R [float] Процентная ставка действующего кредита или займа
leadDebts._.contractNameAndDate R [string][100] Номер/Дата договора действующего кредита или займа
leadDebts._.requisites R [string][200] Реквизиты действующего кредита или займа
managerId R [int][20]

Идентификатор специалиста по займам
creditProductId R [int][20]

Идентификатор кредитного продукта:

  • 101339 - Короткие займы под з/п.
  • 1013310 - Займ на год (аннуитет).
  • 1013311 - Займ на год (с распределенной ОС)(Пятак).
  • 1013312 - Остаточный с льготными траншами
  • .........
amount R [float] Сумма займа
period R [int][11] Запрашиваемый срок займа
periodUnit О [enum]

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

  • DAYS - Дни
  • MONTHS - Месяцы
  • YEARS - Годы
  • WEEKS - Недели
gettingMoneyMethodId R [int][20]

Способа получения займа
goods R [collection] Список товаров
goods._.id R [int][20] Идентификатор товара
goods._.name R [string][100] Наименование товара
goods._.article R [string][50] Артикул товара
goods._.description R [string][1024] Описание товара
goods._.quantity R [int][11] Количество товара
goods._.amount R [float] Сумма товара
extraFields R [collection] Дополнительные поля
extraFields._.id R [int][20]

Идентификатор дополнительного поля.
extraFields._.key R [string][255]

Название дополнительного поля.

Если нужно, чтобы в процессе работы системы принятия решений (СПР) переменные из лида были взяты в клиента/заявку/контракт,

то нужно их передать следующим образом:

  • client.field_name - для помещения поля в клиента
  • loanApplication.field_name - для помещения поля в заявку
  • contract.field_name - для помещения поля в контракт
extraFields._.value R [string][255] Значение дополнительного поля
storeTypeId R [int][20] Идентификатор категории магазина.
cardNumber R [string][25] Номер банковской карты, только цифры, без пробелов и других знаков
cardHolder R [string][75] Держатель карты (Для хранения данных карты необходимо наличие сертификата PCI DSS у клиента)
validThruMonth R [string][2] Срок действия карты месяц, формат: ММ
validThruYear R [string][2] Срок действия карты год, формат: ГГ
cardCvc R [string][10] CVC код, 3 цифры
employerTitle R [string][100] Наименование работодателя
employerInn R [string][25] ИНН работодателя.
childrenCount R [int][20] Количество детей.
adultChildrenCount R [int][20] Количество совершеннолетних детей.
dependentsCount R [int][11] Количество иждивенцев.
meanIncome R [float] Среднемесячный доход.
averageMonthlyCost R [float] Среднемесячный расходы
monthlyCreditPayment R [float] Ежемесячные платежи по кредитам
closedCreditsCount R [int][11] Количество закрытых кредитов
delinquencyCount R [int][11] Количество просрочек в прошлом
payedDelinquencyCount R [int][11] Количество закрытых просрочек
writtenDelinquencyCount R [int][11] Количество списанных просрочек
activeCreditsCount R [int][11] Количество активных кредитов
activeCreditsAmount R [float] Сумма текущей задолженности
activeDelinquencyAmount R [float] Сумма текущих просроченных платежей
mobilePhoneCheck R [bool] Флаг верификации телефона.
ipAndRegionMatch R [bool] Совпадает ли заявленный регион в фактическом адресе (адресе проживания) с IP адресом заявителя
ipAndRegAddressMatch R [bool] Совпадает ли заявленный регион в адресе регистрации с IP адресом заявителя
rosfinmonitoringCheck R [bool] Пройдена проверка Росфинмониторинг
ufmsCheck R [bool] Пройдена проверка по базе паспортов УФМС
approvedByScorista R [bool] Одобрено скорингом Scorista
denialReasonId R [int][20] Идентификатор причины отказа
creationDate R [timestamp] Дата создания лида
storeCode R [string][50] Идентификатор магазина для создания лидов.
orderCode R [string][50] Код заказа поступивший от партнеров.
ipAddress R [string][50] IP адрес
macAddress R [string][50] МАС адрес
deviceTypeId R [int][20] Идентификатор типа устройств
referralLink R [string][255] Реферальная ссылка
currentStatus R [enum]

Текущий статус лида:

  • WAITING - Ожидает
  • CHECK - Проверка
  • ROSFINMON_OK - Пройдена проверка Росфинмониторинга
  • SCORISTA_OK - Одобрено скорингом Скориста
  • CARD_CHECK_OK - пройдена проверка номера карты
  • CLIENT_CHECK_OK - Пройдена проверка клиента
  • COMPANY_CHECK_OK - Пройдена проверка компании
  • PC_CHECK_OK - Пройдена проверка компьютера
  • MOBILE_CHECK_OK - Пройдена проверка мобильного телефона
  • FMS_CHECK_OK - Пройдена проверка паспорта ФМС
  • EQUIFAX_OK - Выполнен запрос кредитной истории Equifax
  • EMAIL_CHECK_OK - Пройдена проверка e-mail адреса
  • NBKI_CHECK_OK - Пройдена проверка НБКИ
  • NBKI_SCORING_OK - Выполнен скоринг НБКИ
  • IP_CHECK_OK - Проверка по IP
  • INN_CHECK_OK - Проверка по ИНН
  • SNILS_CHECK_OK - Проверка по СНИЛС
  • PSP_SERIA_CHECK_OK - Проверка по серии паспорта
  • PSP_NO_CHECK_OK - Проверка по номеру паспорта
  • BIRTHDATE_CHECK_OK - Проверка по дате рождения
  • CONSOLIDATION_OK - Выполнена консолидация лида с данными клиента
  • INNER_SCORING_OK - Одобрено внутренним скорингом
  • CLIENT_SNILS_CHECK_OK - Проверка клиента по СНИЛС
  • DRIVING_LICENSE_CHECK_OK - Проверка водительского удостоверения
  • FSSP_DEBT_CHECK_OK - Проверка суммы задолженности по сайту ФССП
  • TAX_DEBT_CHECK_OK - Проверка суммы задолженности по налогам
  • BANKRUPTCY_CHECK_OK - Проверка "Банкротных" дел
  • DISQUALIFIED_PERSON_CHECK_OK - Проверка списка дисквалифицированных лиц
  • BANK_BLACKLIST_CHECK_OK - Проверка клиента в ЧС банка
  • FINANCIAL_POSITION_CHECK_OK - Проверка финансового положения клиента
  • PYRUS_CHECK_OK - Проверка Pyrus
  • APPROVED - Одобрено
  • DENIED - Отказано
  • UNDEFINED - Не определено
  • TIMEOUT - Таймаут (при проверке лида)
  • CLIENT_REFUSAL - Отказ клиента
  • VALIDATION_ERROR - Ошибка валидации
  • TECH_FAULT - Технический сбой
  • CONTRACT - Прошла выдача
currentBusinessStatus R [enum]

Текущий бизнес-статус лида:

  • NEW_LEAD - Новый лид
  • AUTO_CHECK - Автоматическая проверка
  • MANUAL_CHECK - Ручная верификация
  • FAILED - Неуспех (отказ по заявке, отказ клиента, таймаут, тех.ошибка и т.п.)
  • NEW_CONTRACT - Новый контракт
  • CONTRACT_FOR_ISSUE - Контракт согласован (К выдаче)
  • CONTRACT_ISSUED - Контракт выдан
  • CONTRACT_CLOSED - Контракт закрыт
clientId R [int][20] Ссылка на клиента (либо созданного по лиду, либо найденного из существующих)
loanApplicationId R [int][20] Идентификатор заявки (Если заполнен, значит по лиду создана заявка)
contractId R [int][20] Идентификатор контракта (Если заполнен, значит по лиду создан контракт)
intRate R [float] Процентная ставка
totalAmount R [float] Общая сумма с процентами
totalAmountDelinq30 R [float] Общая сумма с процентами и штрафами (в случае просрочки 30 дней)
addressData R [object]

Адрес проживания (для юр.лиц Фактический адрес).

При добавлении адреса в систему Brainysoft можно использовать один из двух вариантов:

  1. Заполнить только поля fullAddressText(вписать сюда полный адрес) и fiasId(код фиас, которых соответствует fullAddressText), остальные поля адреса ( countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName ) будут заполнены автоматически
  2. Заполнить поля адреса: countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName

Вариант 1 является предпочтительным.
addressData.id R [int][20] Идентификатор адреса проживания.
addressData.countryId R [int][20] Идентификатор страны проживания.
addressData.fiasId R [string][50] Код ФИАС (уровня улицы).
addressData.fullAddressText R [string][1024] Строка адреса ФИАС.
addressData.fiasChainText R [string][2048] Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
addressData.houseNo R [string][15] Номер дома.
addressData.blockNo R [string][15] Номер корпуса.
addressData.buildingNo R [string][15] Номер строения.
addressData.apartmentNo R [string][25] Номер квартиры.
addressData.telephone R [string][50] Стационарный номер телефона.
addressData.postalCode R [string][25] Почтовый индекс.
addressData.regDate R [date] Дата регистрации (YYYY-MM-DD).
addressData.housingType R [string][100] Тип жилья
addressData.metroStation R [string][100] Ближайшая станция метро.
addressData.regionName R [string][50] Название региона
addressData.localityName R [string][75] Название города.
addressData.streetName R [string][75] Название улицы.
addressData.oldAddressText R [string][1024] Строка адреса введенная вручную (не актуальный адрес как в паспорте)
registrationAddressData R [object]

Адрес прописки (для юр.лиц Юридический адрес).

При добавлении адреса в систему Brainysoft можно использовать один из двух вариантов:

  1. Заполнить только поля fullAddressText(вписать сюда полный адрес) и fiasId(код фиас, которых соответствует fullAddressText), остальные поля адреса ( countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName ) будут заполнены автоматически
  2. Заполнить поля адреса: countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName

Вариант 1 является предпочтительным.
registrationAddressData.id R [int][20] Идентификатор адреса проживания.
registrationAddressData.countryId R [int][20] Идентификатор страны проживания.
registrationAddressData.fiasId R [string][50] Код ФИАС (уровня улицы).
registrationAddressData.fullAddressText R [string][1024] Строка адреса ФИАС.
registrationAddressData.fiasChainText R [string][2048] Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
registrationAddressData.houseNo R [string][15] Номер дома.
registrationAddressData.blockNo R [string][15] Номер корпуса.
registrationAddressData.buildingNo R [string][15] Номер строения.
registrationAddressData.apartmentNo R [string][25] Номер квартиры.
registrationAddressData.telephone R [string][50] Стационарный номер телефона.
registrationAddressData.postalCode R [string][25] Почтовый индекс.
registrationAddressData.regDate R [date] Дата регистрации (YYYY-MM-DD).
registrationAddressData.housingType R [string][100] Тип жилья
registrationAddressData.metroStation R [string][100] Ближайшая станция метро.
registrationAddressData.regionName R [string][50] Название региона
registrationAddressData.localityName R [string][75] Название города.
registrationAddressData.streetName R [string][75] Название улицы.
registrationAddressData.oldAddressText R [string][1024] Строка адреса введенная вручную (не актуальный адрес как в паспорте)
addresses R [collection]

Коллекция привязанных дополнительных адресов.
В дополнительных адресах все свойства совпадают с основными адресами.

 

При добавлении адреса в систему Brainysoft можно использовать один из двух вариантов:

  1. Заполнить только поля fullAddressText(вписать сюда полный адрес) и fiasId(код фиас, которых соответствует fullAddressText), остальные поля адреса ( countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName ) будут заполнены автоматически
  2. Заполнить поля адреса: countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName

Вариант 1 является предпочтительным.
addresses._.id R [int][20] Идентификатор адреса.
addresses._.countryId R [int][20] Идентификатор страны.
addresses._.fiasId R [string][50] Код ФИАС (уровня улицы).
addresses._.fullAddressText R [string][1024] Строка адреса ФИАС.
addresses._.fiasChainText R [string][2048] Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
addresses._.houseNo R [string][15] Номер дома.
addresses._.blockNo R [string][15] Номер корпуса.
addresses._.buildingNo R [string][15] Номер строения.
addresses._.apartmentNo R [string][25] Номер квартиры.
addresses._.telephone R [string][50] Стационарный номер телефона.
addresses._.postalCode R [string][25] Почтовый индекс.
addresses._.regDate R [date] Дата регистрации (YYYY-MM-DD).
addresses._.housingType R [string][100] Тип жилья
addresses._.metroStation R [string][100] Ближайшая станция метро.
addresses._.regionName R [string][50] Название региона
addresses._.localityName R [string][75] Название города.
addresses._.streetName R [string][300]

Название улицы.
addresses._.oldAddressText R [string][1024] Строка адреса введенная вручную (не актуальный адрес как в паспорте)
addresses._.purposeId R [int][20] Назначение адреса (регистрации, места работы итп.)