Credit Line API Parameters Table
| Parameter Name | Required | Format | Comment |
|---|---|---|---|
| mobile_number | Yes | The 10-digit mobile number, should start with 6/7/8/9. | OTP verified mobile number of the customer. |
| full_name | Yes | Ascii string. Regex check: r^[a-zA-Z\s]{5,200}$ | Full name of the customer. |
| Yes | Valid email format | Email of the customer. | |
| gender | Yes | 1: Male 2: Female Note that integer codes should be passed in the API request. | Gender of the customer. |
| date_of_birth | Yes | Date format: DD-MMM-YYYY For e.g 1 Jan 209 should be passed as "01-Jan-2019" | Date of birth of the customer. |
| fathers_name | Yes | Ascii string. Regex check: r^[a-zA-Z\s]{5,200}$ | Father's name of the customer. If you don't have it pass : "Father Name Not Present" |
| mothers_name | Yes | Ascii string Regex check: r^[a-zA-Z\s]{5,200}$ | Mothers's name of the customer. If you don't have it pass : "Mother Name Not Present" |
| address | Yes | Ascii string | Address of the customer. |
| pincode | Yes | Valid 6-digit Pincode | Pincode where the customer currently resides. |
| monthly_income | Yes | Integer | Monthly income of the customer. Pass any estimate of monthly income you have. If you don't have it, pass 0. |
| monthly_emi | Yes | Integer | Monthly EMI of the customer. Pass any estimate of monthly emi you have. If you don't have it, pass 0. |
| credit_score | Yes | Integer Range: [300,900] or [-1,10] | Credit Score of the customer. In case customer is NTC, NTC score should be returned, which ranges from 0-10.If no score is returned from the burau pass -1. If you don't have credit score, pass 300. |
| ckyc_no | No | CKYC Number | CKYC number of the customer. |
| employment_type | Yes | 0: Unemployed 1: Salaried 2: Self-employed 3: Self-employed professional Note that integer codes should be passed. | Employment type of the customer. If you don’t have it pass 1. |
| company_name | Yes | Ascii string | Company name of the customer. If you don’t have it, pass “Company Name Not Present” |
| loan_application_date | Yes | Date format - DD-MMM-YYYY. For e.g. 1 Jan 2019 should be passed as “01-Jan-2019” | Loan application date, when the application was done. |
| agreement_date | Yes | Date format - DD-MMM-YYYY. For e.g. 1 Jan 2019 should be passed as “01-Jan-2019” | Agreement date, when the agreement was signed with the customer. Date format is - YYYYMMDD It can be same as loan application date. |
| line_amount | Yes | Integer | The line amount which is approved for the customer. |
| line_expiry_date | Yes | Date format - DD-MMM-YYYY. For e.g. 1 Jan 2019 should be passed as “01-Jan-2019” | This is the date at which the credit line will expire. |
| interest_rate | Yes | Decimal, max 2 digits after decimal. | Interest rate which is charged to the customer, this is in annualized IRR space. This is the IRR corresponding to the interest paid by the customer. For e.g. If it is 0% EMI to the customer this should be passed as ‘0.00’. If the annualized IRR is 24.32%, then it should be passed as ‘24.32’. |
| payment_frequency | Yes | 1: Weekly 2: Bi-weekly 3: Monthly Note that integer codes should be passed in the API request. | Payment frequency at which the payment is to be done. |
| loan_type | Yes | 0 : Unclassified 1 : Personal loan 2: Education loan 3: Medical loan 4 : Vehicle loan 5 : Bussiness loan Note that integer codes should be passed in the API request. | Loan product type. You can pass 1 as the default value. |
| agreement_signature_type | Yes | 1: Physical 2: Aadhaar e-signature 3: Click wrap Note that integer codes should be passed in the API request. | How the agreement is signed by the customer. |
| bank_account | Yes | JSON | Bank account details of the customer. |
| kyc | Yes | An array of JSON. | KYC documents which are collected and verified for the customer. |