03-12-2018 23:59

Получение лида по ID

GET   /bs-core/main/leads/{id}

Метод позволяет получить существующий лид по его идентификатору.

Запрос

GET /bs-core/main/leads/2330
Описание параметров
Нет описанных параметров

Ответ


                        {
    "status": "ok",
    "timestamp": 1502973378302,
    "data": {
        "id": 2330,
        "channel": "LOAN_APPLICATION",
        "naturalPerson": true,
        "firstName": "Вжух",
        "lastName": "Вжух",
        "patronymic": "Вжухец",
        "title": "",
        "registrationNumber": "",
        "sexId": 101251,
        "birthDate": "1972-08-09",
        "birthPlace": "Гималаи",
        "birthCountryId": 101042,
        "passport": {
            "id": 101113935,
            "seria": "9846",
            "no": "684684",
            "extraNumber": null,
            "issueDate": "2017-08-10",
            "closeDate": "2117-08-09",
            "manager": "Главное Вжуховское подразделение по Вжуховскому району города Вжухов",
            "subdivisionCode": "684-613",
            "complementaryDocTypeId": null
        },
        "inn": "656565646766",
        "snils": "747-347-384 83",
        "mobilePhone": "71968746646",
        "email": "vzhuh@vzhuh-vzhuh.ru",
        "howYouKnowId": 102173,
        "subdivisionId": 101791,
        "relatives": [
            {
                "id": 1381,
                "lastName": "Китаяц",
                "firstName": "Китаеза",
                "patronymic": "Китаевич",
                "resident": null,
                "passport": null,
                "rnn": "651413513654",
                "telephone": "73219846542",
                "email": "",
                "workPlace": "везде",
                "address": "Луна",
                "birthDate": "1990-08-09",
                "collateralRelId": 1021413,
                "verified": true,
                "comments": "парам пам пам"
            },
            {
                "id": 1382,
                "lastName": "Японец",
                "firstName": "Япоша",
                "patronymic": "Японович",
                "resident": null,
                "passport": null,
                "rnn": "456546546546",
                "telephone": "71231651651",
                "email": "",
                "workPlace": "На свалке",
                "address": "Устал писать",
                "birthDate": "1991-08-13",
                "collateralRelId": 1021415,
                "verified": false,
                "comments": "Может хватит?"
            }
        ],
        "leadDebts": [
            {
                "id": 112,
                "debtName": "Кредит на новое ухо",
                "debtAmount": 1000000,
                "bank": "Банк Бум-Бум",
                "debtBankId": null,
                "remainderDebt": 900000,
                "monthlyPayment": 5000,
                "availabilityDelays": "есть",
                "paymentPeriodicity": "не плачу",
                "lastFactPaymentDate": "2017-08-25",
                "intRate": 1.12,
                "contractNameAndDate": "123321",
                "requisites": "Бик -12350823957 КПП 2309570239 р/c 320895856023985"
            },
            {
                "id": 113,
                "debtName": "Кредит на второе ухо",
                "debtAmount": 1000000,
                "bank": "Банк Вжух-Вжух",
                "debtBankId": null,
                "remainderDebt": 900000,
                "monthlyPayment": 500,
                "availabilityDelays": "нет1",
                "paymentPeriodicity": "тоже не плачу",
                "lastFactPaymentDate": "2017-08-30",
                "intRate": 1.11,
                "contractNameAndDate": "6541651",
                "requisites": "654654611 и все вроде"
            }
        ],
        "managerId": 1010812,
        "creditProductId": 1013310,
        "amount": 100000,
        "period": 360,
        "periodUnit": "DAYS",
        "gettingMoneyMethodId": 102391,
        "goods": [],
        "extraFields": [],
        "storeTypeId": null,
        "cardNumber": "",
        "cardHolder": "",
        "validThruMonth": "",
        "validThruYear": "",
        "cardCvc": "",
        "employerTitle": "",
        "employerInn": "",
        "childrenCount": 20,
        "adultChildrenCount": 15,
        "dependentsCount": 12,
        "meanIncome": 100000000,
        "averageMonthlyCost": 100,
        "monthlyCreditPayment": 0,
        "closedCreditsCount": 0,
        "delinquencyCount": 0,
        "payedDelinquencyCount": 0,
        "writtenDelinquencyCount": 0,
        "activeCreditsCount": 0,
        "activeCreditsAmount": 0,
        "activeDelinquencyAmount": 0,
        "mobilePhoneCheck": false,
        "ipAndRegionMatch": false,
        "ipAndRegAddressMatch": false,
        "rosfinmonitoringCheck": false,
        "ufmsCheck": false,
        "approvedByScorista": false,
        "denialReasonId": null,
        "creationDate": 1502971978532,
        "storeCode": null,
        "orderCode": null,
        "ipAddress": "",
        "macAddress": "",
        "deviceTypeId": null,
        "referralLink": "",
        "currentStatus": "APPROVED",
        "currentBusinessStatus": "NEW_CONTRACT",
        "clientId": 101322743,
        "loanApplicationId": 101132101,
        "contractId": 101341519,
        "intRate": 180,
        "totalAmount": 2159471.56,
        "totalAmountDelinq30": 2194843.7,
        "addressData": {
            "id": 101267652,
            "countryId": 1010412,
            "fiasId": "",
            "fullAddressText": "",
            "fiasChainText": null,
            "houseNo": "800",
            "blockNo": "900",
            "buildingNo": "1000",
            "apartmentNo": "1500",
            "telephone": "74955000000",
            "postalCode": "164131",
            "regDate": null,
            "housingType": "",
            "metroStation": "",
            "regionName": null,
            "localityName": null,
            "streetName": "Вжуховская",
            "oldAddressText": ""
        },
        "registrationAddressData": {
            "id": 101267653,
            "countryId": 1010412,
            "fiasId": "",
            "fullAddressText": "",
            "fiasChainText": null,
            "houseNo": "800",
            "blockNo": "900",
            "buildingNo": "1000",
            "apartmentNo": "1500",
            "telephone": "74955000000",
            "postalCode": "164131",
            "regDate": "2017-08-15",
            "housingType": "",
            "metroStation": "",
            "regionName": null,
            "localityName": null,
            "streetName": "Вжуховская",
            "oldAddressText": ""
        },
        "addresses": null
    }
}
Описание параметров
Параметр Обязателен Тип данных Описание
id О [int][20]

Идентификатор лида
channel О [enum]

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

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

  • PRESCORE
  • GENERATOR
  • SITE
  • ECOMM
  • UNO_MOMENTO
  • LOAN_APPLICATION
naturalPerson О [bool]

Физическое лицо (да/нет), по умолчанию стоит true.
firstName О [string][50]

Имя
lastName О [string][50]

Фамилия
patronymic О [string][50]

Отчество
title О [string][500]

Наименование организации (Для Юридического лица)
registrationNumber О [string][50]

Регистрационный номер (ОГРН) (для лида юр.лица)
sexId О [int][20]

Пол:

  • 101251 - Мужчина
  • 101252 - Женщина
birthDate О [date]

Дата рождения (YYYY-MM-DD)
birthPlace О [string][100]

Место рождения
birthCountryId О [int][20]

Идентификатор страны гражданства
passport О [object]

Паспорт
passport.id О [int][20]

Паспорт. Идентификационный номер.
passport.seria О [string][25]

Паспорт серия
passport.no О [string][25]

Паспорт номер
passport.extraNumber О [string][100]

Дополнительный номер
passport.issueDate О [date]

Дата выдачи паспорта. (YYYY-MM-DD)
passport.closeDate О [date]

Дата окончания действия паспорта. (YYYY-MM-DD)
passport.manager О [string][255]

Орган выдачи паспорта
passport.subdivisionCode О [string][10]

Код подразделения
passport.complementaryDocTypeId О [int][20]

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

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

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

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

например описание этого метода).
inn О [string][50]

ИНН
snils О [string][50]

СНИЛС
mobilePhone О [string][50]

Указываются только цифры в международном формате 79886542301
email О [string][100]

Электронная почта
howYouKnowId О [int][20]

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

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

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

  • 101791 - Москва
  • 101792 - Москва - интернет
  • 101793 - Севастополь-1
  • 101794 - Красногорск
  • 101795 - Севастополь-2
  • 101798 - Седьмое
  • 1017910 - На "Посадской"
  • 101796 - Первое
  • 101797 - Второе
  • 101799 - Касса долька
relatives О [collection]

Список родственников
relatives._.id О [int][20]

Идентификатор родственника
relatives._.lastName О [string][50]

Фамилия родственника
relatives._.firstName О [string][50]

Имя родственника
relatives._.patronymic О [string][50]

Отчество родственника
relatives._.resident О [bool]

Резидент
relatives._.passport О [object]

Паспорт родственника.
relatives._.passport._.id О [int][20]

Паспорт родственника. Идентификационный номер.
relatives._.passport._.seria О [string][25]

Паспорт серия родственника
relatives._.passport._.no О [string][25]

Паспорт номер родственника
relatives._.passport._.extraNumber О [string][100]

Дополнительный номер родственника
relatives._.passport._.issueDate О [date]

Дата выдачи паспорта родственника. (YYYY-MM-DD)
relatives._.passport._.closeDate О [date]

Дата окончания действия паспорта родственника. (YYYY-MM-DD)
relatives._.passport._.manager О [string][255]

Орган выдачи паспорта родственника
relatives._.passport._.subdivisionCode О [string][10]

Код подразделения
relatives._.passport._.complementaryDocTypeId О [int][20]

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

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

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

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

например описание этого метода).
relatives._.rnn О [string][50]

ИНН родственника
relatives._.telephone О [string][100]

Номер телефона родственника
relatives._.email О [string][50]

Электронная почта родственника
relatives._.workPlace О [string][50]

Место работы родственника
relatives._.address О [string][255]

Адрес родственника
relatives._.birthDate О [date]

Дата рождения родственника (YYYY-MM-DD)
relatives._.collateralRelId О [int][20]

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

  • 102141 - Жена
  • 102142 - Муж
  • 102143 - Мама
  • 102144 - Папа
  • 102145 - Дочь
  • 102146 - Сын
  • 102147 - Брат
  • 102148 - Сестра
  • 102149 - Коллеги
  • 1021410 - Друзья
  • 1021411 - Бабушка
  • 1021412 - Дедушка
  • 1021413 - Дядя
  • 1021414 - Тетя
  • 1021415 - Иное
relatives._.verified О [bool]

Верифицирован
relatives._.comments О [string][255]

Комментарии по родственникам
leadDebts О [collection]

Действующие кредиты и займы
leadDebts._.id О [int][20]

Идентификатор действующего кредита или займа
leadDebts._.debtName О [string][200]

Наименование действующего кредита или займа
leadDebts._.debtAmount О [float]

Сумма действующего кредита или займа
leadDebts._.bank О [string][100]

Банк действующего кредита или займа
leadDebts._.debtBankId О [int][20]

Идентификатор объекта банк действующего кредита или займа
leadDebts._.remainderDebt О [float]

Остаток долга действующего кредита или займа
leadDebts._.monthlyPayment О [float]

Ежемесячный платеж действующего кредита или займа
leadDebts._.availabilityDelays О [string][200]

Наличие просрочек действующего кредита или займа
leadDebts._.paymentPeriodicity О [string][50]

Периодичность выплат действующего кредита или займа
leadDebts._.lastFactPaymentDate О [date]

Дата последнего фактического платежа по действующему кредиту или займу в формате YYYY-MM-DD
leadDebts._.intRate О [float]

Процентная ставка действующего кредита или займа
leadDebts._.contractNameAndDate О [string][100]

Номер/Дата договора действующего кредита или займа
leadDebts._.requisites О [string][200]

Реквизиты действующего кредита или займа
managerId О [int][20]

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

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

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

Сумма займа
period О [int][11]

Запрашиваемый срок займа
periodUnit О [enum]

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

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

Способа получения займа
goods О [collection]

Список товаров
goods._.id О [int][20]

Идентификатор товара
goods._.name О [string][100]

Наименование товара
goods._.article О [string][50]

Артикул товара
goods._.description О [string][1024]

Описание товара
goods._.quantity О [int][11]

Количество товара
goods._.amount О [float]

Сумма товара
extraFields О [collection]

Дополнительные поля
extraFields._.id О [int][20]

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

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

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

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

  • client.field_name - для помещения поля в клиента
  • loanApplication.field_name - для помещения поля в заявку
  • contract.field_name - для помещения поля в контракт
extraFields._.value О [string][255]

Значение дополнительного поля
storeTypeId О [int][20]

Идентификатор категории магазина.
cardNumber О [string][25]

Номер банковской карты, только цифры, без пробелов и других знаков
cardHolder О [string][75]

Держатель карты (Для хранения данных карты необходимо наличие сертификата PCI DSS у клиента)
validThruMonth О [string][2]

Срок действия карты месяц, формат: ММ
validThruYear О [string][2]

Срок действия карты год, формат: ГГ
cardCvc О [string][10]

CVC код, 3 цифры
employerTitle О [string][100]

Наименование работодателя
employerInn О [string][25]

ИНН работодателя.
childrenCount О [int][20]

Количество детей.
adultChildrenCount О [int][20]

Количество совершеннолетних детей.
dependentsCount О [int][11]

Количество иждивенцев.
meanIncome О [float]

Среднемесячный доход.
averageMonthlyCost О [float]

Среднемесячный расходы
monthlyCreditPayment О [float]

Ежемесячные платежи по кредитам
closedCreditsCount О [int][11]

Количество закрытых кредитов
delinquencyCount О [int][11]

Количество просрочек в прошлом
payedDelinquencyCount О [int][11]

Количество закрытых просрочек
writtenDelinquencyCount О [int][11]

Количество списанных просрочек
activeCreditsCount О [int][11]

Количество активных кредитов
activeCreditsAmount О [float]

Сумма текущей задолженности
activeDelinquencyAmount О [float]

Сумма текущих просроченных платежей
mobilePhoneCheck О [bool]

Флаг верификации телефона.
ipAndRegionMatch О [bool]

Совпадает ли заявленный регион в фактическом адресе (адресе проживания) с IP адресом заявителя
ipAndRegAddressMatch О [bool]

Совпадает ли заявленный регион в адресе регистрации с IP адресом заявителя
rosfinmonitoringCheck О [bool]

Пройдена проверка Росфинмониторинг
ufmsCheck О [bool]

Пройдена проверка по базе паспортов УФМС
approvedByScorista О [bool]

Одобрено скорингом Scorista
denialReasonId О [int][20]

Идентификатор причины отказа
creationDate О [timestamp]

Дата создания лида
storeCode О [string][50]

Идентификатор магазина для создания лидов.
orderCode О [string][50]

Код заказа поступивший от партнеров.
ipAddress О [string][50]

IP адрес
macAddress О [string][50]

МАС адрес
deviceTypeId О [int][20]

Идентификатор типа устройств
referralLink О [string][255]

Реферальная ссылка
currentStatus О [enum]

Текущий статус лида
currentBusinessStatus О [enum]

Текущий бизнес-статус лида
clientId О [int][20]

Ссылка на клиента (либо созданного по лиду, либо найденного из существующих)
loanApplicationId О [int][20]

Идентификатор заявки (Если заполнен, значит по лиду создана заявка)
contractId О [int][20]

Идентификатор контракта (Если заполнен, значит по лиду создан контракт)
intRate О [float]

Процентная ставка
totalAmount О [float]

Общая сумма с процентами
totalAmountDelinq30 О [float]

Общая сумма с процентами и штрафами (в случае просрочки 30 дней)
addressData О [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 О [int][20]

Идентификатор адреса проживания.
addressData.countryId О [int][20]

Идентификатор страны проживания.
addressData.fiasId О [string][50]

Код ФИАС (уровня улицы).
addressData.fullAddressText О [string][1024]

Строка адреса ФИАС.
addressData.fiasChainText О [string][2048]

Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
addressData.houseNo О [string][15]

Номер дома.
addressData.blockNo О [string][15]

Номер корпуса.
addressData.buildingNo О [string][15]

Номер строения.
addressData.apartmentNo О [string][25]

Номер квартиры.
addressData.telephone О [string][50]

Стационарный номер телефона.
addressData.postalCode О [string][25]

Почтовый индекс.
addressData.regDate О [date]

Дата регистрации (YYYY-MM-DD).
addressData.housingType О [string][100]

Тип жилья
addressData.metroStation О [string][100]

Ближайшая станция метро.
addressData.regionName О [string][50]

Название региона
addressData.localityName О [string][75]

Название города.
addressData.streetName О [string][75]

Название улицы.
addressData.oldAddressText О [string][1024]

Строка адреса введенная вручную (не актуальный адрес как в паспорте)
registrationAddressData О [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 О [int][20]

Идентификатор адреса проживания.
registrationAddressData.countryId О [int][20]

Идентификатор страны проживания.
registrationAddressData.fiasId О [string][50]

Код ФИАС (уровня улицы).
registrationAddressData.fullAddressText О [string][1024]

Строка адреса ФИАС.
registrationAddressData.fiasChainText О [string][2048]

Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
registrationAddressData.houseNo О [string][15]

Номер дома.
registrationAddressData.blockNo О [string][15]

Номер корпуса.
registrationAddressData.buildingNo О [string][15]

Номер строения.
registrationAddressData.apartmentNo О [string][25]

Номер квартиры.
registrationAddressData.telephone О [string][50]

Стационарный номер телефона.
registrationAddressData.postalCode О [string][25]

Почтовый индекс.
registrationAddressData.regDate О [date]

Дата регистрации (YYYY-MM-DD).
registrationAddressData.housingType О [string][100]

Тип жилья
registrationAddressData.metroStation О [string][100]

Ближайшая станция метро.
registrationAddressData.regionName О [string][50]

Название региона
registrationAddressData.localityName О [string][75]

Название города.
registrationAddressData.streetName О [string][75]

Название улицы.
registrationAddressData.oldAddressText О [string][1024]

Строка адреса введенная вручную (не актуальный адрес как в паспорте)
addresses О [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 О [int][20]

Идентификатор адреса.
addresses._.countryId О [int][20]

Идентификатор страны.
addresses._.fiasId О [string][50]

Код ФИАС (уровня улицы).
addresses._.fullAddressText О [string][1024]

Строка адреса ФИАС.
addresses._.fiasChainText О [string][2048]

Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
addresses._.houseNo О [string][15]

Номер дома.
addresses._.blockNo О [string][15]

Номер корпуса.
addresses._.buildingNo О [string][15]

Номер строения.
addresses._.apartmentNo О [string][25]

Номер квартиры.
addresses._.telephone О [string][50]

Стационарный номер телефона.
addresses._.postalCode О [string][25]

Почтовый индекс.
addresses._.regDate О [date]

Дата регистрации (YYYY-MM-DD).
addresses._.housingType О [string][100]

Тип жилья
addresses._.metroStation О [string][100]

Ближайшая станция метро.
addresses._.regionName О [string][50]

Название региона
addresses._.localityName О [string][75]

Название города.
addresses._.streetName О [string][300]

Название улицы.
addresses._.oldAddressText О [string][1024]

Строка адреса введенная вручную (не актуальный адрес как в паспорте)
addresses._.purposeId О [int][20]

Назначение адреса (регистрации, места работы итп.)