Search for leads by identifier list

GET

Search for leads using a comma-separated list of identifiers. When passing the preserveOrder parameter to the method with the value true, the method will return the leads in the JSON file in exactly the order that was passed to the method. If this parameter is not passed, then leads are returned by ascending ID

Parameters

Path Parameters

ids*

ids

Type

string

Required

Query Parameters

preserveOrder

preserveOrder

Type

boolean

Default

false

Responses

OK

Content-Type

*/*

object

object[]

Amount of current debt

Format"double"

Number of active loans

Format"int32"

Amount of current overdue payments

Format"double"

object

Residence address (for legal entities Actual address).

When adding an address to the Brainysoft system, you can use one of two options: - Fill in only fullAddressText fields (enter here is the full address) and fiasId (fias code that corresponds to fullAddressText), the rest of the address fields (countryId, houseNo, blockNo (optional), buildingNo (optional), apartmentNo (optional), postalCode, regionName, localityName, streetName) will be filled in automatically - Fill in the address fields: countryId, houseNo, blockNo (optional), buildingNo (optional), apartmentNo (optional), postalCode, regionName, localityName, streetName Option 1 is preferred

object[]

A collection of linked sub-addresses.
In sub-addresses, all properties are the same as the main addresses.

When adding an address to Brainysoft, you can use one of two options: - Fill in only the fields fullAddressText (enter the full address here) and fiasId (fias code, which corresponds to fullAddressText), the rest of the address fields (countryId, houseNo, blockNo (optional), buildingNo (optional), apartmentNo ( optional), postalCode, regionName, localityName, streetName) will be filled automatically - Fill in the address fields: countryId, houseNo, blockNo (optional), buildingNo (optional), apartmentNo (optional), postalCode, regionName, localityName, streetName Option 1 is preferred

Number of adult children

Format"int32"

Loan amount

Format"double"

Scorista approved

Average monthly expenses

Format"double"

Country of citizenship ID

Format"int64"

Date of birth (YYYY-MM-DD)

Format"date"

Place of Birth

CVC code, 3 digits

Card holder (To store card data, the client must have a PCI DSS certificate)

Bank card number, only numbers, no spaces or other signs

Channel for lead receipt

Channel list : - PRESCORE - GENERATOR - SITE - ECOMM - UNO_MOMENTO - **LOAN_APPLICATION **

Valid values"ECOMM""GENERATOR""LOAN_APPLICATION""PRESCORE""SITE""UNO_MOMENTO"

Amount of children

Format"int32"

Link to a client (either created by lead, or found from existing ones)

Format"int64"

Number of closed loans

Format"int32"

Contract ID (If filled, then a contract has been created for the lead)

Format"int64"

Lead creation date

Format"date-time"

Loan product identifier : - ** 101339 ** - Short loans under salary. - ** 1013310 ** - Loan for a year (annuity). - ** 1013311 ** - Loan for a year (with distributed OS) (Pyatak). - ** 1013312 ** - Remaining with preferential tranches - ..

Format"int64"

Current business status of the lead: - ** NEW_LEAD ** - New lead - ** AUTO_CHECK ** - Automatic check - ** MANUAL_CHECK ** - Manual verification - ** FAILED ** - Failure (request rejection, client rejection, timeout, technical error, etc. .) - ** NEW_CONTRACT ** - New contract - ** CONTRACT_FOR_ISSUE ** - Contract agreed (To issue) - CONTRACT_ISSUED - Contract issued - ** CONTRACT_CLOSED ** - Contract closed

Valid values"AUTO_CHECK""CONTRACT_CLOSED""CONTRACT_FOR_ISSUE""CONTRACT_ISSUED""FAILED""MANUAL_CHECK""NEW_CONTRACT""NEW_LEAD"

Current lead status: - ** WAITING ** - Pending - ** CHECK ** - Checking ** ROSFINMON_OK ** - Rosfinmonitoring check passed - ** SCORISTA_OK ** - Skorist scoring approved - ** CARD_CHECK_OK ** - check passed card number - ** CLIENT_CHECK_OK ** - Customer Verification Passed - ** COMPANY_CHECK_OK ** - Company Verification Passed - ** PC_CHECK_OK ** - Computer check passed - ** MOBILE_CHECK_OK ** - Mobile phone check passed - ** FMS_CHECK_OK ** - FMS passport check passed - ** EQUIFAX_OK ** - Request for Equifax credit history - EMAIL_CHECK_OK - Passed e-mail address verification - ** NBKI_CHECK_OK ** - Passed NBKI verification - ** NBKI_SCORING_OK ** - NBKI scored - ** IP_CHECK_OK ** - Check by IP - ** INN_CHECK_OK ** - Check by INN - ** SNILS_CHECK_OK ** - Check by SNILS - ** PSP_SERIA_CHECK_OK ** - Check by passport series - ** PSP_NO_CHECK_OK ** - Check by passport number - ** BIRTHDATE_CHECK_OK ** - Check by date of birth - ** CONSOLIDATION_OK ** - Consolidated lead with customer data - ** INNER_SCORING_OK ** - Approved by internal scoring - ** CLIENT_SNILS_CHECK_OK ** - Client verification by SNILS - ** DRIVING_LICENS E_CHECK_OK ** - Checking a driver's license - ** FSSP_DEBT_CHECK_OK ** - Checking the amount of debt on the FSSP website - ** TAX_DEBT_CHECK_OK ** - Checking the amount of debt on taxes - ** BANKRUPTCY_CHECK_OK ** - Checking "Bankruptcy" cases - ** DISQUALIFIED_PERSON_CHECK_OK ** - Checking the list of disqualified persons - ** BANK_BLACKLIST_CHECK_OK ** - Checking a client in a bank emergency situation - ** FINANCIAL_POSITION_CHECK_OK ** - Checking a client's financial position - ** PYRUS_CHECK_OK ** - Pyrus Checkout - ** APPROVED ** - Approved - ** DENIED ** - Denied - UNDEFINED - Not defined - ** TIMEOUT ** - Timeout (when checking a lead) - ** CLIENT_REFUSAL ** - Client refused - ** VALIDATION_ERROR ** - Validation failed - ** TECH_FAULT ** - Technical failure - ** CONTRACT ** - Issuance passed

Valid values"ACCOUNT_NO_CHECK_OK""APPROVED""BANKRUPTCY_CHECK_OK""BANK_BLACKLIST_CHECK_OK""BIRTHDATE_CHECK_OK""CARD_CHECK_OK""CHECK""CLIENT_CHECK_OK""CLIENT_REFUSAL""CLIENT_SNILS_CHECK_OK""COMPANY_CHECK_OK""CONSOLIDATION_OK""CONTRACT""DENIED""DISQUALIFIED_PERSON_CHECK_OK""DRIVING_LICENSE_CHECK_OK""EMAIL_CHECK_OK""EQUIFAX_OK""EXTREMISTS_CHECK_OK""FINANCIAL_POSITION_CHECK_OK""FMS_CHECK_OK""FSSP_CHECK_OK""FSSP_DEBT_CHECK_OK""HOLDING_OVERLAP_CHECK_OK""INNER_SCORING_OK""INN_CHECK_OK""IP_CHECK_OK""MOBILE_CHECK_OK""NBKI_CHECK_OK""NBKI_SCORING_OK""OKB_CREDIT_HISTORY_OK""PC_CHECK_OK""PSP_NO_CHECK_OK""PSP_SERIA_CHECK_OK""PYRUS_CHECK_OK""RFM2_CHECK_OK""RFM_BLOCK_CHECK_OK""ROSFINMON_OK""SCORISTA_OK""SNILS_CHECK_OK""TAX_DEBT_CHECK_OK""TECH_FAULT""TIMEOUT""UNDEFINED""VALIDATION_ERROR""WAITING"

Number of past arrears

Format"int32"

Refusal reason ID

Format"int64"

The number of dependents

Format"int32"

Device type identifier

Format"int64"

Email

Employer's TIN

Employer name

object[]

Additional fields

Name

How to get a loan

Format"int64"

object[]

List of goods

How did you hear about us : - ** 102171 ** - Transport - ** 102172 ** - Television - ** 102173 ** - Newspaper - ** 102174 ** - Outdoor advertising - ** 102175 ** - Acquaintances - ** 102176 ** - Internet

Format"int64"

Lead ID

Format"int64"

INN

Interest rate

Format"double"

IP address

Does the declared region in the registration address match the applicant's IP address?

Does the declared region in the actual address (residence address) match the applicant's IP address?

Surname

object[]

Current loans and borrowings