Поиск лида по идентификатору контракта
GET   /bs-core/main/leads/find/contract-id/{contractId}
Запрос
GET /bs-core/main/leads/find/contract-id/10134296 HTTP/1.1
Нет описанных параметров
Ответ
{
"status": "ok",
"timestamp": 1462950863446,
"data": {
"id": 358,
"channel": "LOAN_APPLICATION",
"naturalPerson": true,
"firstName": "Иван",
"lastName": "Иванов",
"patronymic": "Иванович",
"title": "",
"registrationNumber": "",
"sexId": 101251,
"birthDate": "1995-04-01",
"birthPlace": "Г. Москва",
"passport": {
"id": 10111484,
"seria": "111111",
"no": "123456",
"issueDate": "2012-10-02",
"closeDate": "2020-10-02",
"manager": "ОВД г.Москвы",
"subdivisionCode": "",
"complementaryDocTypeId": null
},
"inn": "0101010",
"snils": "01011011111101",
"mobilePhone": "79151111112",
"email": "",
"relatives": [
{
"id": 21,
"lastName": "Иванова Анна",
"firstName": "",
"patronymic": "",
"rnn": "123456789",
"telephone": "8915123456789999999",
"email": "",
"workPlace": "ресторан Прага",
"address": "г.москва, ул. Варварка",
"birthDate": "2010-09-09",
"collateralRelId": 102141,
"comments": "дозвон до жены"
}
],
"leadDebts": [],
"amount": 1110,
"period": 0,
"periodUnit": null,
"gettingMoneyMethodId": null,
"goods": [],
"storeTypeId": null,
"cardNumber": "",
"cardHolder": "",
"validThruMonth": "",
"validThruYear": "",
"cardCvc": "",
"employerTitle": "",
"employerInn": "",
"childrenCount": 0,
"adultChildrenCount": 0,
"dependentsCount": 0,
"meanIncome": 0,
"averageMonthlyCost": 0,
"monthlyCreditPayment": 0,
"closedCreditsCount": 0,
"delinquencyCount": 0,
"payedDelinquencyCount": 0,
"writtenDelinquencyCount": 0,
"activeCreditsCount": 0,
"activeCreditsAmount": 0,
"activeDelinquencyAmount": 0,
"mobilePhoneCheck": true,
"ipAndRegionMatch": false,
"ipAndRegAddressMatch": false,
"rosfinmonitoringCheck": false,
"ufmsCheck": false,
"approvedByScorista": false,
"denialReasonId": null,
"creationDate": 1462491532899,
"storeCode": null,
"orderCode": null,
"ipAddress": "",
"macAddress": "",
"deviceTypeId": null,
"referralLink": "",
"currentStatus": "APPROVED",
"loanApplicationId": 10113502,
"contractId": 10134296,
"intRate": 10,
"totalAmount": 1443,
"totalAmountDelinq30": 2308.8,
"addressData": {
"id": 101262182,
"countryId": 101042,
"fullAddressText": "пр-кт Кутузовский, г. Москва",
"fiasChainText": "{\"fullAddressText\":\"пр-кт Кутузовский, г. Москва\",\"mainElement\":{\"id\":\"b27f4263-64a5-4172-a61e-1e6e912019c5\",\"level\":7,\"name\":\"Кутузовский\",\"type\":\"пр-кт\",\"settlement\":false},\"parentElements\":[{\"id\":\"0c5b2444-70a0-4932-980c-b4dc0d3f02b5\",\"level\":1,\"name\":\"Москва\",\"type\":\"г\",\"settlement\":true}]}",
"houseNo": "дом 12",
"blockNo": "2",
"buildingNo": "1",
"apartmentNo": "125",
"telephone": "84951234564",
"postalCode": "140000",
"regDate": null,
"metroStation": "м. ВДНХ",
"fiasId": "b27f4263-64a5-4172-a61e-1e6e912019c5",
"regionName": "Москва г",
"localityName": "Москва",
"streetName": "Кутузовский"
},
"registrationAddressData": {
"id": 101262183,
"countryId": 101042,
"fullAddressText": "пр-кт Кутузовский, г. Москва",
"fiasChainText": "{\"fullAddressText\":\"пр-кт Кутузовский, г. Москва\",\"mainElement\":{\"id\":\"b27f4263-64a5-4172-a61e-1e6e912019c5\",\"level\":7,\"name\":\"Кутузовский\",\"type\":\"пр-кт\",\"settlement\":false},\"parentElements\":[{\"id\":\"0c5b2444-70a0-4932-980c-b4dc0d3f02b5\",\"level\":1,\"name\":\"Москва\",\"type\":\"г\",\"settlement\":true}]}",
"houseNo": "дом 12",
"blockNo": "2",
"buildingNo": "1",
"apartmentNo": "125",
"telephone": "84951234564",
"postalCode": "140000",
"regDate": null,
"metroStation": "м. ВДНХ",
"fiasId": "b27f4263-64a5-4172-a61e-1e6e912019c5",
"regionName": "Москва г",
"localityName": "Москва",
"streetName": "Кутузовский"
}
}
}
Описание параметров
Параметр | Обязателен | Тип данных | Описание |
id | R | [int][20] | Идентификатор лида |
channel | R | [enum] | Канал поступления лида
|
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] | Пол:
|
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] |
В настоящее время, хотя этот параметр и присутствует, у него в паспорте будет проставляться значение null, так как существует объект complementaryDoc который содержит параметр complementaryDocTypeId, который имеет значение (смотрите например описание этого метода). |
inn | R | [string][50] | ИНН |
snils | R | [string][50] | СНИЛС |
mobilePhone | R | [string][50] | Указываются только цифры в международном формате 79886542301 |
R | [string][100] | Электронная почта | |
howYouKnowId | R | [int][20] |
|
subdivisionId | R | [int][20] |
|
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] |
В настоящее время, хотя этот параметр и присутствует, у него в паспорте будет проставляться значение 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] | Идентификатор степени родства:
|
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] | Идентификатор кредитного продукта:
|
amount | R | [float] | Сумма займа |
period | R | [int][11] | Запрашиваемый срок займа |
periodUnit | О | [enum] | Единица измерения срока:
|
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] | Название дополнительного поля. Если нужно, чтобы в процессе работы системы принятия решений (СПР) переменные из лида были взяты в клиента/заявку/контракт, то нужно их передать следующим образом:
|
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] | Текущий статус лида:
|
currentBusinessStatus | R | [enum] | Текущий бизнес-статус лида:
|
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 является предпочтительным. |
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 является предпочтительным. |
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 является предпочтительным. |
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 | О | [string][300] | Название улицы. |
addresses._.oldAddressText | R | [string][1024] | Строка адреса введенная вручную (не актуальный адрес как в паспорте) |
addresses._.purposeId | R | [int][20] | Назначение адреса (регистрации, места работы итп.) |