-
API Reference
- Getting Started
-
Loan Product
- Loan Creation Flow
- Lead
-
Webhooks
- Webhooks
Lead
You can create loan product lead with basic details use them for applying loan.
Create Lead
You can create a lead via API.
field | type | required/optional | desc |
---|---|---|---|
user_uid | string |
optional |
User UUID of Applicant |
order_id | string |
required |
Unique Order ID |
courseTenure | integer |
required |
Course Duration |
courseName | string |
required |
Partner Course Name |
universityName | string |
optional |
University/Institute name that is mapped with your branch/center. If you have multiple branch/centers, this is compulsory to pass. |
branch | integer |
required |
Branch Id that is mapped with your branch/center. If you have multiple branch/centers, this is compulsory to pass. |
string |
required |
Email of Applicant | |
mobile | string |
required |
Mobile Number of Applicant |
name | string |
required |
Full Name of Applicant |
firstName | string |
optional |
First Name of Applicant |
lastName | string |
optional |
Last Name of Applicant |
loanAmount | integer |
optional |
Loan Amount for the Course. If not provided, max financing amount for discounted course fee is considered |
Tenor | integer |
optional |
Tenor of loan in months . If not provided, courseTenure of product
is considered |
apikey | string |
required |
API key that provided by Techfino |
waiveOtpConsent | string |
optional |
Pass yes if OTP consent taken from customer else no |
consentTimestamp | string |
optional |
required if waiveOtpConsent field is yes format is YYYY-MM-DD |
flexiTenure | string |
optional |
Pass LESSER_THAN_EQUAL to show EMI tenure less than/equals to course tenure, FIXED to show EMI tenure as course tenure, GREATER_THAN_EQUAL to show EMI tenure greater than/equals to course tenure, FREE to show all EMI tenures |
dob | string |
optional |
Customer's DOB in format YYYY-MM-DD |
panNumber | string |
optional |
Customer's PAN Number |
gender | integer |
optional |
Customer's gender, accepted value:
Male:
0
Female: 1
|
salutation | integer |
optional |
Customer's salutation, accepted value:
Mr:
0
Ms: 1
Mrs: 2
Miss: 3
Dr: 4
|
maritalStatus | string |
optional |
Customer's marriage status; accepted value:
Single:
0
Married: 1
Others: 2
|
incomeConsent | boolean |
optional |
If you have the customer's income consent, pass true ; otherwise, pass false . |
income | string |
optional |
Customer's monthly salary |
employementType | integer |
optional |
Customer's employment type, accepted value:
SALARIED:
0
SELF_EMPLOYED: 1
STUDENT: 2
HOME_MAKER: 3
RETIRED: 4
OTHER: 5
|
companyName | string |
optional |
The name of the company where the customer is currently employed. |
employerEmail | string |
optional |
Customer's official email ID provided by employer |
fatherhusbandName | string |
optional |
Customer's father/husband name |
alternateMobile | string |
optional |
Customer alternate mobile number |
residenceType | string |
optional |
Customer's residence type, accepted value: Rented/Paying Guest/self Owned/Company provided/with Parents |
pincode | string |
optional |
Customer's pincode |
houseNo | string |
optional |
Customer house number |
buildingName | string |
optional |
Customer's building name |
addressLine1 | string |
optional |
Customer's address line 1 |
addressLine2 | string |
optional |
Customer's address line 2 |
landmark | string |
optional |
Customer's address landmark |
Response
field | type | desc |
---|---|---|
leadId | string |
Unique Id for each lead creation |
Example
Request :
{
"user_uid": 0,
"FirstName": "string",
"LastName": "string",
"loanAmount": 0,
"courseTenure": 0,
"courseName": "string",
"universityName": "string",
"email": "string",
"mobile": 0,
"order_id": "string",
"branch": "string",
"apikey": "Value",
"waiveOtpConsent": "string",
"consentTimestamp": "string",
"flexiTenure": "string",
"dob": "string",
"panNumber": "string",
"gender": "integer",
"salutation": "integer",
"maritalStatus": "integer",
"incomeConsent": "boolean",
"income": "string",
"employementType": "integer",
"companyName": "string",
"employerEmail": "string",
"fatherhusbandName": "string",
"alternateMobile": "string",
"residenceType": "string",
"pincode": "string",
"houseNo": "string",
"buildingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"landmark": "string"
}
Response :
{
leadId": "string"
}