Check Loan Eligibility
PURPOSE
This method allows the partner to check the eligibility of the prospect for personal loan by taking basic personal details like unique id, name, DOB, gender, ID proof, address and enquiry purpose as inputs. The method returns the scheme of the loan for the prospect on successful execution of the API.”
Request Method: POST
Request format: JSON
Request Header
Content-Type: application/json
Ocp-Apim-Subscription-Key: provided by IIFL
REQUEST BODY
HEADER
| Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
|---|---|---|---|---|
| requestCode | Request Code of the API called | Varchar | Yes | FTRQCLE01 |
| appVer | Developer App Version | Varchar | Yes | 1.0 |
| key | UserKey generated at the time of registration | Varchar | Yes | ABpyyGUh1nsbesSlup3VKURkI4tQDe8y |
| osName | Channel of order | Varchar | Yes | WebAPI, Android, iOS |
| appName | App Name provided at the time of registration | Varchar | Yes | ALLIANCE |
| source | Source provided at the time of registration | Varchar | Yes | 321 |
BODY
| Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
|---|---|---|---|---|
| UniqueID | UniqueID created by partner | Varchar(25) | Yes | 123456789 |
| FName | First Name of client | Varchar(26) | Yes | ABC |
| MName | Middle Name of client | Varchar(26) | No | DEF |
| LName | Last Name of client | Varchar(26) | Yes | GHAI |
| DOB | Date Of Birth (format should be ‘DDMMYYYY’) | Varchar(8) | Yes | 12031900 |
| GenderCode | Gender Code (Code as provided by IIFL) | Int | Yes | 1 |
| IdProofTypeCode | Id Proof Type Code (Code as provided by IIFL) | Int | Yes | 2 |
| IdProofValue | ID proof value of selected ID proof type code | Varchar(50) | Yes | 123456789123 |
| MobileNo | Mobile No | Varchar(10) | Yes | 9999999999 |
| Amount | Enquiry Amount | Int | Yes | 50000 |
| AddressLine1 | Address 1 | Varchar(26) | Yes | Address 1 |
| AddressLine2 | Address 2 | Varchar(26) | No | Address 2 |
| AddressLine3 | Address 3 | Varchar(26) | Yes | Address 3 |
| StateCode | State Code (Code as provided by IIFL) | Varchar(2) | Yes | 27 |
| PinCode | PIN Code | Varchar(6) | Yes | 400001 |
| ProductCode | Product (Business) Code (Only Alphabets) | Varchar(5) | Yes | 10 |
| EnquiryPurpose | “05” --- For Personal Loan “52” --- For SME Loan |
Int | Yes | 05 |
| MkrId | Maker Id/Partner Id | Varchar(10) | Yes | Partner ID |
RESPONSE BODY
Head
| Field Name | Description | Data Type (max length) |
List of Values | Sample Value |
|---|---|---|---|---|
| responseCode | This is the response code of API | Varchar(20) | - | FTRQCLE01 |
| status | This is the response code of API | Varchar(10) | 0 - Success 1 - Fail |
0 |
| Source | This is the Partner’s name | Varchar(20) | - | Partner_Name |
| statusDescription | Description of the response status | Varchar(50) | - | - |
| success_user_status | Status of the user for a partner | Varchar(10) | 0 - Success 1 - Fail |
0 |
BODY
| Field Name | Description | Data Type (max length) |
Sample Value |
|---|---|---|---|
| status | Status of request | Varchar(10) | Success Null |
| scheme | Scheme of the loan | Varchar(20) | New to credit |
REQUEST:
{
"head": {
"requestCode": "FTRQCLE01",
"key": "f12cd83f550241a1180ce6757f779468",
"appVer": "1.0",
"osName": "WebAPI",
"appName": "fintech",
"source": "PartnerName"
},
"body": {
"UniqueID" : "12345678910120" ,
"FName" : "Dummy_first" ,
"MName" : "" ,
"LName" : "Dummy_last" ,
"DOB" : "01011970" ,
"GenderCode" : "1" ,
"IdProofTypeCode" : "01" ,
"IdProofValue" : "GCNPS6757Y" ,
"MobileNo" : "9999999999" ,
"Amount" : "500000" ,
"AddressLine1" : "asd asd asdas asd" ,
"AddressLine2" : "" ,
"AddressLine3" : "" ,
"StateCode" : "07" ,
"PinCode" : "110001" ,
"ProductCode" : "SME" ,
"EnquiryPurpose" : "05" ,
"MkrId" : "PartnerName"
}
}
Response (Success)
{
"head": {
"status": "0",
"success_user_status": "0",
"response_code": "FTRSCLE01",
"status_description": "success",
"source": "PartnerName"
},
"body": {
"Status": "Success",
"Scheme": "New to Credit"
}
}
Response (Failure)
{
"head": {
"status": "1",
"success_user_status": "1",
"response_code": "FTRSCLE01",
"status_description": "FName is mandetory.",
"source": "PartnerName"
},
"body": {
"Status": null,
"Scheme": null
}
}