Check Eligibility

post

https://sandbox-api.credilinq.ai/v1/onboarding/check-eligibility

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Purpose

Partners can use this API to provide data consent for a customer who already passes through boundary conditions agreed upon at the time of partner registration. Partner initiates data collection process and uploads organization data to s3 bucket in zip format with following naming convention.

customer-Id_week-no(current-1)-year(yyyy)

For example, if customer-id is "b68cfcd7-2443-4092-9066-c7cef6f07387" and we have a date is 31st Mar-23 then the filename will be b68cfcd7-2443-4092-9066-c7cef6f07387_12-2023.zip

Webhook Event

DATA_PROCESSING_COMPLETED / DATA_PROCESSING_FAILED, on success or failure of data processing, we update partners through webhook along with the in-principle approved credit line.

Prerequisite

The partner should be registered with Credilinq.
Customer passes through the boundary condition.

Body Params

customerReferenceNo

string

required

length ≤ 100

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#/-]+)$/

customerName

string

required

length ≤ 200

Customer or a Company's Full Name

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

customerEmail

string

required

length ≤ 75

Email address of Customer/company

Should be valid email.

dataConsentProvided

boolean

required

Defaults to true

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

requiredLoanAmount

number

required

Required loan amount

Headers

accept-language

string

Defaults to en-us

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

Responses

Purpose

Webhook Event

Prerequisite

200Eligibility Checked and application initiated

400Invalid Request

401Invalid credentials

403Forbidden resource

500Internal Server Error, Some problem is there, please try after sometime