Onboarding

Check Eligibility

post/v1/onboarding/check-eligibility

Headers

accept-languagestring

Language of the response, supported languages: en-us, in

Request body

customerReferenceNostring required

Customer Reference Number of company/business assigned by the platform to uniquely identify the customer. It's a unique number with a combination of alphabets, numeric and some special characters like dash, hash, ampersand and forward slash.

/(^[a-zA-Z0-9#/-]+)$/

customerNamestring required

Customer or a Company's Full Name

/^[a-zA-Z][a-zA-Z0-9-@.'_/#&+ws]*$

customerEmailstring required

Email address of Customer/company

Should be valid email.

dataConsentProvidedboolean required

Consent to access platform data. Possible values : true/false

requiredLoanAmountnumber required

Required loan amount

Example request

{
  "customerReferenceNo": "c3eb1619-ff24-4773-97d8-b05264621e60",
  "customerName": "John Doe",
  "customerEmail": "johndoe2@gmail.com",
  "requiredLoanAmount": 100000
}

Response

Eligibility Checked and application initiated

statusCodenumber required

The HTTP status code of the error

messagestring required

Human-readable message containing all available details about the operation

successboolean required

A boolean indicating whether this was a success response or an error response