Lead API

post

https://uat-apiorigin.arthmate.com/api/lead

A Lead is an intent made by a customer for availing a loan.The response of the loan request is primarily 2 main fields (loan application id and borrower id) that need to be used in all subsequent API's. The fields in this API are conditional and differs from product to product. Your account manager will share the postman collection relevant for you.

Use Array Data in request for this API.

The fields in this API are conditional and differs from product to product. Your account manager will share the postman collection relevant for you.

Note: USE PRODUCT TOKEN FOR THIS API.

Body Params

partner_loan_app_id

string

required

Defaults to PARTLOANAPP00001

This contains the partner loan application id for the request that is being sent.

partner_borrower_id

string

required

Defaults to PARTBORROW00001

Borrower id at partner's end

first_name

string

required

Defaults to John

Borrower first name

middle_name

string

Defaults to Doe

Borrower middle name

last_name

string

required

Defaults to Kate

Borrower last name

sector

string

Defaults to BL or bullet etc

This contains sector number

type_of_addr

string

enum

required

Defaults to Current

This contains type of address of the applicant.

Allowed:

resi_addr_ln1

string

required

Defaults to ABCDEF

Borrower current address line1

resi_addr_ln2

string

Defaults to ABCDEF

Borrower current address line2

city

string

required

Defaults to Pune

Borrower city

state

string

required

Defaults to Maharashtra

Borrower state

pincode

string

required

Defaults to 421765

Borrower current pincode

per_addr_ln1

string

Defaults to ABCDEF

Borrower permanent address line 1

per_addr_ln2

string

Defaults to ABCDEF

Borrower permanent address line 2

per_city

string

Defaults to Pune

Borrower permanent city

per_state

string

Defaults to Maharashtra

Borrower permanent state

per_pincode

string

Defaults to 421765

Borrower permanent pincode

appl_phone

string

required

Defaults to 9999999999

Borrower phone number

appl_pan

string

required

Defaults to ABCDE1234F

Borrower pan

email_id

string

Defaults to [email protected]

Borrower email id

aadhar_card_num

string

Defaults to 222335566476

Borrower aadhar card number

dob

date

required

Defaults to 2021-09-15

Borrower Date of birth in format YYYY-MM-DD

ebill_num

string

Defaults to 345434

Borrower ebill number

gender

string

enum

required

Defaults to Male

Borrower gender

Allowed:

photo_id_type

string

Defaults to pan / aadhar

Borrower photo ID type

photo_id_num

string

Defaults to ABCDE1234F/222233334444

Borrower photo ID number

addr_id_type

string

enum

Defaults to Aadhar

Borrower address ID type

Allowed:

addr_id_num

string

Defaults to ABCDE1234F/222233334444

Borrower address ID number

no_year_current_addr

float

Defaults to 2

Total number of years borrower living at current address

total_experience

float

Defaults to 4

Borrower total years of work experience

cibil_score_borro

float

Defaults to 123

CIBIL score of Borrower

purpose_of_loan

string

Defaults to Medical expense

Borrower reason for applying a loan

annual_income_borro

float

Defaults to 324500

Borrower's annual income

borro_bank_name

string

required

Defaults to Test Bank of India

Borrower bank name

borro_bank_acc_num

string

required

Defaults to 456323456345

Borrower bank account number

borro_bank_ifsc

string

required

Defaults to IFSC1234567

Borrower Bank IFSC code

passport

string

Defaults to A1234567

Borrower passport

itr_ack_no

string

Defaults to 234564789574567

ITR acknowledgment number

uan

float

Defaults to 234564789574

Borrower UNIVERSAL ACCOUNT NUMBER (UAN)

age

float

Defaults to 23

Borrower's age

religion

string

enum

Defaults to Hindu

Borrower religion

Allowed:

qualification

string

enum

Defaults to High School

Borrower's Qualification

Allowed:

marital_status

string

enum

Defaults to Married

Borrower marital status

Allowed:

employer_id

string

Defaults to COM12345

Employer id of Borrower

business_name

string

Defaults to Sample Business

Business Name

business_establishment_proof_type

string

enum

Defaults to Corroborative Evidence

Business Establishment Proof type

Allowed:

co_app_name

string

Defaults to JENNY

Co Applicant Name

co_app_address

string

Defaults to AbcdeFg

Co Applicant Address

co_app_mobile_no

string

Defaults to 9988998899

Co Applicant Mobile No

co_app_pan

string

Defaults to EDCBA4321F

Co Applicant PAN

co_app_address_proof_type

string

enum

Defaults to Aadhar

Co Applicant Address Proof type

Allowed:

relation_with_applicant

string

enum

Defaults to Wife

Relation With Applicant

co_app_poi

string

enum

Defaults to PAN

Co Applicant POI

Allowed:

co_app_bureau_score

int32

Defaults to 700

Co Applicant Bureau Score

residence_status

string

enum

Defaults to Rental

Residence Status

Allowed:

avg_3_mnts_txn_amt

float

Defaults to 2000

Avg 3 months Txn Amt

vintage_months_partner_platform

int32

Defaults to 12

Vintage Months Partner Platform

sherlock_match

string

enum

Defaults to No

Sherlock Status Match

Allowed:

bureau_pull_consent

string

enum

Defaults to Yes

Bureau Pull Consent

Allowed:

legacy_lead_id

string

Defaults to LEGACY_00_00000

Legacy Lead Id

father_fname

string

Defaults to JACK

Father First Name

father_mname

string

Defaults to Daniel

Father Middle Name

father_lname

string

Defaults to Doe

Father Last Name

Responses

Use Array Data in request for this API.

Note: USE PRODUCT TOKEN FOR THIS API.

200200

400400