Get Eligibility
This API is used to securely access a user's financial statements and check their eligibility for loans from different lenders. The OTP ensures that only the rightful owner of the account can access this sensitive information.
Input
To use this API, you need to provide the following details:
Customer ID: The unique identifier for the user (e.g., "32ce79860a45cd4857be9df097f46b4f8d").
Authorization Key: A secure key to authenticate the request. This key must be included in the headers of your request.
Output
The response from this API provides confirmation that the OTP has been sent and includes detailed loan eligibility information. It includes:
Status: Indicates whether the request was successful.
Code: A numerical code representing the result (e.g., 200 for success).
Message: A brief message describing the outcome (e.g., "success").
Portfolio Value: The total value of the user's investment portfolio.
Eligibility List: Details of loan eligibility from various lenders, including:
Lender Name: Name of the lender.
Link: URL to access the lender's details.
Eligibility Portfolio: The portion of the portfolio considered for loan eligibility.
Eligibility Limit: The maximum loan amount eligible.
Non-Eligibility Portfolio: The portion of the portfolio not considered for loan eligibility.
Locked Portfolio: The portion of the portfolio locked for loan processing.
Interest Rate: The interest rate for the loan.
Tenure in Months: The tenure range for the loan.
Average Disbursal Time: The average time for loan disbursement.
Input Type
| Input | Type | Description |
|---|---|---|
| finsire_id | string | A valid id generated during user creation |
Common error scenarios
The following are the common error scenarios in sending an API request:
| Error | Description |
|---|---|
| param is missing or the value is empty: finsire_id | finsire_id is a required field |
Try out the API here
Updated about 2 months ago