latestSwagger 2.02026-08-2181213270.0 KB

0a9c1f8784f2

Eligibility and credit limit

<div> <h3>Ask for the pre-eligibility of a borrower.</h3> <p>It should be interpreted the following way:</p> <ul> <li>when <code>is_eligible</code> is <code>false</code> and <code>reasons</code> is <code>null</code> or <code>[]</code> it means the borrower **might** be eligible. This will depend on his financials and will be evaluated after you share data with the <code>/business/data/XXX</code> endpoints. </li> <li>when <code>is_eligible</code> is <code>true</code>, the borrower is eligible. However, we recommend you to share the data you have with the <code>/business/data/XXX</code> endpoints in order to have a more accurate (likely higher) eligible amount. </li> <li>when <code>is_eligible</code> is <code>false</code> and all items of <code>reasons</code> are in: [OUTDATED_DATA, KYB_STATUS] this means the borrower might be eligible depending on his financing, and we are expecting him to perform a few actions prior to requesting loan. Once you register the borrower, this will be represented by the borrower's status. </li> </ul> </div>
post/eligibility/borrower

Request body

identifierstring required

Legal identifier of the business, such as its SIRET or SIREN in France. Must not contain spaces.

identifier_type'belgium_registration_number' | 'bsn' | 'cif' | 'hr_nummer' | 'kvk' | 'name' | 'nif' | 'siren' | 'siret' | 'steuernummer' | 'vat_number' required

Type of legal business identifier of the business, such as the SIRET in France.

Response

OK