EKYC APIs

Mobile Number¶

Method	API	Detail
Post	user/sendSmsOtp	Fetch Index Details
Post	user/verifySmsOtp	Get Multiple Index Details with titles

Input Mobile¶

Request Structure

{
    "mobileNo":1234567890
}

Input parameters

Field	Type	Description
mobileNo	Int	Individual's mobile number

Response Structure

{
   "stat":1,
   "page":null,
   "message":"Success",
   "reason":null,
   "result":{
      "id":6,
      "userName":null,
      "firstName":null,
      "middleName":null,
      "lastName":null,
      "mobileNo":1234567890,
      "emailId":null,
      "emailVerified":0,
      "smsVerified":0,
      "panNumber":null,
      "dob":null,
      "stage":0.0,
      "status":null
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	User ID
userName	String	Username
firstName	String	First name
middleName	String	Middle name
lastName	String	Last name
mobileNo	Int	Mobile number
emailId	String	Email address
emailVerified	Int	Email verification status
smsVerified	Int	SMS verification status
panNumber	String	PAN number
dob	String	Date of birth
stage	Float	Stage status
status	String	Status

Verify Mobile¶

Request Structure

{
    "mobileNo": "xxxx",
    "smsOtp": "xxxx",
    "referralBy": "xxxx",(Optional)
    "referralType": "1"(Optional)
}

Input parameters

Field	Type	Description
mobileNo	String	Mobile number
smsOtp	String	SMS One-Time Password
referralBy	String	Referral source
referralType	String	Referral type

Response Structure

{
    "stat": 1,
    "page": "13",
    "message": "Success",
    "reason": null,
    "result": {
        "id": xxxxx,
        "userName": "xxxxx",
        "firstName": "xxxxx",
        "middleName": "",
        "lastName": "xxxxx",
        "mobileNo": xxxxx,
        "emailId": "xxxxx",
        "emailVerified": 1,
        "smsVerified": 1,
        "panNumber": "xxxxx",
        "dob": "06-06-1998",
        "stage": "12",
        "status": "Esign Completed",
        "esignCompleted": 0,
        "pdfGenerated": 0,
        "panConfirm": 1,
        "panStatusCode": "7",
        "nomineeOptedOut": 0,
        "esigedName": "xxxxx",
        "kraResponseDate": "21/12/2023 11:17:50",
        "uccCodePrefix": "SKY",
        "uccCodeSuffix": "xxxxx",
        "aadharPanLink": "Y",
        "gender": null,
        "authToken": "xxxxx",
        "referralBy": null,
        "referralType": null
    },
    "rejectionUser": null,
    "address_response": null
}

parameters

Field	Type	Description
id	Int	User ID
userName	String	Username
firstName	String	First name
middleName	String	Middle name
lastName	String	Last name
mobileNo	String	Mobile number
emailId	String	Email address
emailVerified	Int	Email verification status (0 or 1)
smsVerified	Int	SMS verification status (0 or 1)
panNumber	String	PAN number
dob	String	Date of Birth (DD-MM-YYYY)
stage	Float	Stage status
status	String	User status
esignCompleted	Int	eSign completion status (0 or 1)
pdfGenerated	Int	PDF generation status (0 or 1)
panConfirm	Int	PAN confirmation status (0 or 1)
panStatusCode	String	PAN status code
nomineeOptedOut	Int	Nominee opted-out status (0 or 1)
esigedName	String	eSigned name
kraResponseDate	String	KRA response date (DD/MM/YYYY HH:MM:SS)
uccCodePrefix	String	UCC code prefix
uccCodeSuffix	String	UCC code suffix
aadharPanLink	String	Aadhar-PAN linking status ("Y" or "N")
gender	String	Gender
authToken	String	Authentication token
referralBy	String	Referral source
referralType	String	Referral type

Email ID¶

Method	API	Detail
Post	user/sendMailOtp	Get Multiple Index Details with titles
Post	user/verifyEmailOtp	Fetch Index Details

Input Email¶

Request Structure

{   
   "id": 12,
   "email":"xyz@gmail.com"
}

Input parameters

Field	Type	Description
id	Int	User ID
email	String	Email address

Response Structure

{
   "stat":1,
   "page":"1",
   "message":"Success",
   "reason":null,
   "result":{
      "id":6,
      "userName":null,
      "firstName":null,
      "middleName":null,
      "lastName":null,
      "mobileNo":1234567890,
      "emailId":"xyx@gmail.com",
      "emailVerified":0,
      "smsVerified":1,
      "panNumber":null,
      "dob":null,
      "stage":0.5,
      "status":null
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	User ID
userName	String	Username
firstName	String	First name
middleName	String	Middle name
lastName	String	Last name
mobileNo	String	Mobile number
emailId	String	Email address
emailVerified	Int	Email verification status (0 or 1)
smsVerified	Int	SMS verification status (0 or 1)
panNumber	String	PAN number
dob	String	Date of Birth
stage	Float	Stage status
status	String	User status

Verify Email¶

Request Structure

{
    "email": "xyz@gmail.com"
    "otp": "123456"
}

Input parameters

Field	Type	Description
email	String	Email address
otp	String	OTP (One-Time Password)

Response Structure

{
   "stat":1,
   "page":"2",
   "message":"Success",
   "reason":null,
   "result":{
      "id":6,
      "userName":null,
      "firstName":null,
      "middleName":null,
      "lastName":null,
      "mobileNo":1234567890,
      "emailId":"xyx@gmail.com",
      "emailVerified":1,
      "smsVerified":1,
      "panNumber":null,
      "dob":null,
      "stage":1.0,
      "status":"In-Progress"
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	User ID
userName	String	Username
firstName	String	First name
middleName	String	Middle name
lastName	String	Last name
mobileNo	Int	Mobile number
emailId	String	Email address
emailVerified	Int	Email verification status (0 or 1)
smsVerified	Int	SMS verification status (0 or 1)
panNumber	String	PAN number
dob	String	Date of Birth
stage	Float	Stage status
status	String	User status

PAN Card Validation¶

Method	API	Detail
Post	pan/getPan	Fetch Index Details
Post	pan/saveDOB	Get Multiple Index Details with titles

NSDL Validation¶

Request Structure

{
    "id": 12,
    "panNumber": "xxxxx"
}

Input parameters

Field	Type	Description
id	String	User ID
panNumber	String	PAN number

Response Structure

{
   "stat":1,
   "page":"2.1",
   "message":"Success",
   "reason":null,
   "result":{
      "id":6,
      "userName":xyz",
      "firstName":"xyz",
      "middleName":"",
      "lastName":"xyz",
      "mobileNo":1234567890,
      "emailId":"xyx@gmail.com",
      "emailVerified":1,
      "smsVerified":1,
      "panNumber":"xxxxx",
      "dob":null,
      "stage":2.1,
      "status":"In-Progress"
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Integer	Identifier
userName	String	User's username
firstName	String	User's first name
middleName	String	User's middle name (can be empty)
lastName	String	User's last name
mobileNo	String	User's mobile number
emailId	String	User's email address
emailVerified	Integer	Indicator (1 for verified, 0 for not verified)
smsVerified	Integer	Indicator (1 for verified, 0 for not verified)
panNumber	String	User's PAN (Permanent Account Number)
dob	String	Date of birth (currently null)
stage	Float	Stage value (e.g., 2.1)
status	String	Current status of the user's application

KRA Check¶

Request Structure

{
    "id": 6,
    "dob": "23-07-1999"
}

Input parameters

Field	Type	Description
id	Int	Identifier
dob	String	Date of birth (in DD-MM-YYYY format)

Response Structure

{
   "stat":1,
   "page":"3",
   "message":"Success",
   "reason":null,
   "result":{
      "id":6,
      "userName":xyz",
      "firstName":"xyz",
      "middleName":"",
      "lastName":"xyz",
      "mobileNo":1234567890,
      "emailId":"xyx@gmail.com",
      "emailVerified":1,
      "smsVerified":1,
      "panNumber":"xxxxx",
      "dob":"20-06-2001",
      "stage":2.2,
      "status":"In-Progress"
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	User ID
userName	String	Username
firstName	String	First name
middleName	String	Middle name
lastName	String	Last name
mobileNo	Int	Mobile number
emailId	String	Email address
emailVerified	Int	Email verification status (0 or 1)
smsVerified	Int	SMS verification status (0 or 1)
panNumber	String	PAN number
dob	String	Date of Birth (DD-MM-YYYY)
stage	Float	Stage status
status	String	User status

Digi¶

Request Structure

{
   "mobilenumber": xxxxxxx,
   "Aadhar Number": xxxx xxxx xxxx ,
}

Input parameters

Field	Type	Description
mobilenumber	Int	Mobile number
Aadhar Number	String	Aadhar Number

Response Structure

{
    "stat": 1,
    "page": "9",
    "message": "Success",
    "reason": null,
    "result": {
        "empty": false,
        "present": true
    },
    "rejectionUser": null,
    "address_response": {
        "id": 604,
        "addressConfirm": 1,
        "isdigi": 1,
        "accessToken": "xxxxx",
        "applicationId": 656,
        "flatNo": null,
        "digiCurAddress": "xxxxx",
        "digiCurLocality": "xxxxx",
        "digiCurDistrict": "xxxxx",
        "digiCurState": "Tamil Nadu",
        "digiCurCountry": null,
        "digiCurPincode": "xxxxx",
        "digiPerAddress": "xxxxx"
        "digiPerLocality": "xxxxx",
        "digiPerDistrict": "xxxxx",
        "digiPerState": "Tamil Nadu",
        "digiPerCountry": null,
        "digidob": "xxxxx",
        "diginame": "xxxxx",
        "digigender": "M",
        "digiPerPincode": "xxxxx",
        "aadharNo": "xxxxxxxxxxxx",
        "isKra": 0,
        "kraAddress1": null,
        "kraAddress2": null,
        "kraAddress3": null,
        "kraPin": 0,
        "kraCity": null,
        "kraState": null,
        "kraCountry": null,
        "kraPerAddress1": null,
        "kraPerAddress2": null,
        "kraPerAddress3": null,
        "kraPerPin": 0,
        "kraPerCity": null,
        "kraPerState": null,
        "kraPerCountry": null,
        "kraaddressproof": null,
        "kraproofIdNumber": null
    }
}

parameters

Field	Type	Description
stat	String	Status code
page	String	Page number
message	String	Success/Failure message
reason	String	Reason for failure
result	Object	Result details
empty	Boolean	Flag indicating if empty
present	Boolean	Flag indicating if present
rejectionUser	Object	Rejected user details
address_response	Object	Address response details
id	Int	ID of the address
addressConfirm	Int	Address confirmation status
isdigi	Int	Digi status
accessToken	String	Access token
applicationId	Int	Application ID
flatNo	String	Flat number
digiCurAddress	String	Current Digi address
digiCurLocality	String	Current Digi locality
digiCurDistrict	String	Current Digi district
digiCurState	String	Current Digi state
digiCurCountry	String	Current Digi country
digiCurPincode	String	Current Digi pincode
digiPerAddress	String	Permanent Digi address
digiPerLocality	String	Permanent Digi locality
digiPerDistrict	String	Permanent Digi district
digiPerState	String	Permanent Digi state
digiPerCountry	String	Permanent Digi country
digidob	String	Digi date of birth
diginame	String	Digi name
digigender	String	Digi gender
digiPerPincode	String	Permanent Digi pincode
aadharNo	String	Aadhar number
isKra	Int	KRA status
kraAddress1	String	KRA address line 1
kraAddress2	String	KRA address line 2
kraAddress3	String	KRA address line 3
kraPin	Int	KRA pincode
kraCity	String	KRA city
kraState	String	KRA state
kraCountry	String	KRA country
kraPerAddress1	String	KRA permanent address line 1
kraPerAddress2	String	KRA permanent address line 2
kraPerAddress3	String	KRA permanent address line 3
kraPerPin	Int	KRA permanent pincode
kraPerCity	String	KRA permanent city
kraPerState	String	KRA permanent state
kraPerCountry	String	KRA permanent country
kraaddressproof	String	KRA address proof
kraproofIdNumber	String	KRA proof ID number

Profile¶

Method	API	Detail
Post	profile/getProfile/?:applicationId	Fetch Index Details
Post	profile/saveProfile	Get Multiple Index Details with titles

Get profile¶

Request Structure

applicationId=6

Input parameters

Field	Type	Description
applicationId	Int	ID of the application

Response Structure

{
   "stat":1,
   "page":"4",
   "message":"Success",
   "reason":null,
   "result":{
      "id":4,
      "applicationId":6,
      "fatherName":"xyz",
      "applicantName":null,
      "motherName":"xxxxx",
      "occupation":"Private Sector",
      "gender":"Male",
      "title":null,
      "annualIncome":"0-1 lakh",
      "maritalStatus":"Single",
      "politicalExposure":"",
      "tradingExperience":"0-1 year",
      "legalAction":"No"
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	User ID
applicationId	Int	ID of the application
fatherName	String	Father's name
applicantName	String	Applicant's name (possibly null)
motherName	String	Mother's name
occupation	String	Occupation of the applicant
gender	String	Gender of the applicant
title	String	Title (possibly null)
annualIncome	String	Annual income range
maritalStatus	String	Marital status of the applicant
politicalExposure	String	Political exposure status
tradingExperience	String	Trading experience range
legalAction	String	Legal action status

Save profile¶

Request Structure

{
   "applicationId":6,
   "fatherName":"xyz",
   "motherName":"xxxxx",
   "occupation":"Private Sector",
   "gender":"Male",
   "annualIncome":"0-1 lakh",
   "maritalStatus":"Single",
   "politicalExposure":"",
   "tradingExperience":"0-1 year",
   "legalAction":"No"
}

Input parameters

Field	Type	Description
applicationId	Int	Application ID
fatherName	String	Father's name
motherName	String	Mother's name
occupation	String	Occupation of the applicant
gender	String	Gender of the applicant
annualIncome	String	Annual income range
maritalStatus	String	Marital status of the applicant
politicalExposure	String	Political exposure status
tradingExperience	String	Trading experience range
legalAction	String	Legal action status

Response Structure

{
   "stat":1,
   "page":"5",
   "message":"Success",
   "reason":null,
   "result":{
      "id":4,
      "applicationId":6,
      "fatherName":"xyz",
      "applicantName":null,
      "motherName":"xxxxx",
      "occupation":"Private Sector",
      "gender":"Male",
      "title":null,
      "annualIncome":"0-1 lakh",
      "maritalStatus":"Single",
      "politicalExposure":"",
      "tradingExperience":"0-1 year",
      "legalAction":"No"
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	ID
applicationId	Int	Application ID
fatherName	String	Father's name
applicantName	String	Applicant's name
motherName	String	Mother's name
occupation	String	Occupation of the applicant
gender	String	Gender of the applicant
title	String	Title
annualIncome	String	Annual income range
maritalStatus	String	Marital status of the applicant
politicalExposure	String	Political exposure status
tradingExperience	String	Trading experience range
legalAction	String	Legal action status

Get UserDetails¶

Method	API	Detail
Post	user/getUsrDetails/?:applicationId	Fetch Index Details

Request Structure

applicationId=6

Input parameters

Field	Type	Description
applicationId	Int	Application ID

Response Structure

{
   "stat":1,
   "page":"4.0",
   "message":"Success",
   "reason":null,
   "result":{
      "id":6,
      "userName":xyz",
      "firstName":"xyz",
      "middleName":"",
      "lastName":"xyz",
      "mobileNo":1234567890,
      "emailId":"xyx@gmail.com",
      "emailVerified":1,
      "smsVerified":1,
      "panNumber":"xxxxx",
      "dob":"20-06-2001",
      "stage":3.0,
      "status":"In-Progress"
   },
   "address_response":{
      "id":3,
      "isdigi":1,
      "accessToken":"xxxx",
      "co":"S/O: xyz",
      "applicationId":6,
      "flatNo":"6/61",
      "address1":"xxxxxx",
      "address2":null,
      "landmark":null,
      "street":"ARIVOZHI NAGAR",
      "district":"Tiruppur",
      "state":"Tamil Nadu",
      "country":"India",
      "pincode":638106,
      "isKra":0,
      "kraAddress1":null,
      "kraAddress2":null,
      "kraAddress3":null,
      "kraPin":0,
      "kraCity":null,
      "kraState":null,
      "kraPerAddress1":null,
      "kraPerAddress2":null,
      "kraPerAddress3":null,
      "kraPerPin":0,
      "kraPerCity":null,
      "kraPerState":null
   }
}

parameters

Field	Type	Description
id	Int	ID
userName	String	Username
firstName	String	First name
middleName	String	Middle name
lastName	String	Last name
mobileNo	Int	Mobile number
emailId	String	Email address
emailVerified	Int	Email verification status
smsVerified	Int	SMS verification status
panNumber	String	PAN number
dob	String	Date of birth
stage	Float	Stage
status	String	Status
isdigi	Int	ISDIGI status
accessToken	String	Access token
co	String	Care of (CO)
applicationId	Int	Application ID
flatNo	String	Flat number
address1	String	Address line 1
address2	String	Address line 2
landmark	String	Landmark
street	String	Street name
district	String	District
state	String	State
country	String	Country
pincode	Int	Pincode
isKra	Int	KRA status
kraAddress1	String	KRA Address line 1
kraAddress2	String	KRA Address line 2
kraAddress3	String	KRA Address line 3
kraPin	Int	KRA Pincode
kraCity	String	KRA City
kraState	String	KRA State
kraPerAddress1	String	KRA Permanent Address line 1
kraPerAddress2	String	KRA Permanent Address line 2
kraPerAddress3	String	KRA Permanent Address line 3
kraPerPin	Int	KRA Permanent Pincode
kraPerCity	String	KRA Permanent City
kraPerState	String	KRA Permanent State

Bank Details¶

Method	API	Detail
Post	bank/getBank/?:applicationId	Fetch Index Details
Post	bank/getBankAdd	Get Multiple Index Details with titles
Post	bank/saveBank	Fetch Index Details

Get bank details¶

Request Structure

applicationId=6

Input parameters

Field	Type	Description
applicationId	Int	Application ID

Response Structure

{
   "stat":1,
   "page":"5",
   "message":"Success",
   "reason":null,
   "result":{
      "id":4,
      "applicationId":6,
      "micr":"600751023",
      "address":"xxxxxx",
      "branchName":null,
      "pincode":null,
      "ifsc":"xxxxxx",
      "accountNo":"xxxxxx"
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	ID
applicationId	Int	Application ID
micr	String	MICR Code
address	String	Address
branchName	String	Branch Name
pincode	String	Pincode
ifsc	String	IFSC Code
accountNo	String	Account Number

Get branch details¶

Request Structure

ifsc="XXXX"

Input parameters

Field	Type	Description
ifsc	String	IFSC Code

Response Structure

{
   "stat":1,
   "page":null,
   "message":"Success",
   "reason":null,
   "result":{
      "BRANCH":"XXXXX",
      "NEFT":true,
      "CITY":"XXXXX",
      "MICR":"xxxxxx",
      "UPI":true,
      "STATE":"TAMIL NADU",
      "ISO3166":"IN-TN",
      "CONTACT":"",
      "RTGS":true,
      "DISTRICT":"CHENNAI",
      "ADDRESS":"xxxxxx",
      "IMPS":true,
      "CENTRE":"CHENNAI",
      "BANK":"xxxxxx",
      "BANKCODE":"xxxxxx",
      "IFSC":"xxxxxx"
   },
   "address_response":null
}

parameters

Parameters

Field	Type	Description
BRANCH	String	Branch Name
NEFT	Boolean	NEFT Availability
CITY	String	City
MICR	String	MICR Code
UPI	Boolean	UPI Availability
STATE	String	State
ISO3166	String	ISO3166 Code
CONTACT	String	Contact Info
RTGS	Boolean	RTGS Availability
DISTRICT	String	District
ADDRESS	String	Address
IMPS	Boolean	IMPS Availability
CENTRE	String	Centre
BANK	String	Bank Name
BANKCODE	String	Bank Code
IFSC	String	IFSC Code

Save bank¶

Request Structure

{
   "applicationId":6,
   "micr":"xxxxxx",
   "address":"xxxxxx",
   "ifsc":"xxxxxx",
   "accountNo":"xxxxxx"
}

Input parameters

Field	Type	Description
applicationId	Int	Application ID
micr	String	MICR Code
address	String	Address
ifsc	String	IFSC Code
accountNo	String	Account Number

Response Structure

{
   "stat":1,
   "page":"6",
   "message":"Success",
   "reason":null,
   "result":{
      "id":4,
      "applicationId":6,
      "micr":"600751023",
      "address":"xxxxxx",
      "branchName":null,
      "pincode":null,
      "ifsc":"xxxxxx",
      "accountNo":"xxxxxx"
   },
   "address_response":null
}

parameters

Parameters

Field	Type	Description
id	Int	ID
applicationId	Int	Application ID
micr	String	MICR Code
address	String	Address
branchName	String	Branch Name
pincode	String	Pincode
ifsc	String	IFSC Code
accountNo	String	Account Number

Pennydrop¶

Request Structure

applicationId=6

Input parameters

Field	Type	Description
applicationId	Int	Application ID

Response Structure

{
    "stat": 1,
    "page": 6,
    "message": "Success",
    "reason": Penny Drop  performed SuccessFully",
    "rejectionUser": null,
    "address_response": null
}

Parameters

Field	Type	Description
stat	Int	Status code
page	Int	Page number
message	String	Success or error message
reason	String	Reason or additional message details
rejectionUser	Null	User rejection details (if any)
address_response	Null	Address response details (if any)

Segment Selection¶

Method	API	Detail
Post	segment/getSegment/?:applicationId	Fetch Index Details
Post	segment/saveSegment	Get Multiple Index Details with titles

Get segment¶

Request Structure

applicationId = 6

Input parameters

Field	Type	Description
applicationId	Int	Application ID

Response Structure

{
   "stat":1,
   "page":"6",
   "message":"Success",
   "reason":null,
   "result":{
      "id":4,
      "applicationId":6,
      "allSegment":1,
      "equity":0,
      "derivatives":0,
      "aluminium":"FPOs/Farmers",
      "brass":"Others",
      "cardamom":"Others",
      "copper":"Others",
      "cotton":"Others",
      "crupalmoil":"Others",
      "crudeoil":"Others",
      "gold":"Others",
      "menthaoil":"Others",
      "naturalgas":"Others",
      "nickel":"Others",
      "pepper":"Others",
      "rbdpmolein":"Others",
      "silver":"Others",
      "zinc":"Others",
      "kapas":"Others",
      "rubber":"Others",
      "mcxbulldex":"Others",
      "mcxmetldex":"Others",
      "mcxcomdex":"Others",
      "lead":"Others"
   },
   "address_response":null
}

Parameters

Field	Type	Description
id	Int	Identifier
applicationId	Int	Application Identifier
allSegment	Int	Segment indicator (presumably 1 or 0)
equity	Int	Equity value
derivatives	Int	Derivatives value
aluminium	String	Aluminium category
brass	String	Brass category
cardamom	String	Cardamom category
copper	String	Copper category
cotton	String	Cotton category
crupalmoil	String	Crude palm oil category
crudeoil	String	Crude oil category
gold	String	Gold category
menthaoil	String	Mentha oil category
naturalgas	String	Natural gas category
nickel	String	Nickel category
pepper	String	Pepper category
rbdpmolein	String	RBD Palm Olein category
silver	String	Silver category
zinc	String	Zinc category
kapas	String	Kapas category
rubber	String	Rubber category
mcxbulldex	String	MCX Bulldex category
mcxmetldex	String	MCX Metldex category
mcxcomdex	String	MCX Comdex category
lead	String	Lead category

Save Segment¶

Request Structure

{
   "applicationId":6,
   "allSegment":1,
   "equity":0,
   "derivatives":0,
   "aluminium":"FPOs/Farmers",
   "brass":"Others",
   "cardamom":"Others",
   "copper":"Others",
   "cotton":"Others",
   "crupalmoil":"Others",
   "crudeoil":"Others",
   "gold":"Others",
   "menthaoil":"Others",
   "naturalgas":"Others",
   "nickel":"Others",
   "pepper":"Others",
   "rbdpmolein":"Others",
   "silver":"Others",
   "zinc":"Others",
   "kapas":"Others",
   "rubber":"Others",
   "mcxbulldex":"Others",
   "mcxmetldex":"Others",
   "mcxcomdex":"Others",
   "lead":"Others"
}

Input parameters

Field	Type	Description
applicationId	Int	Application Identifier
allSegment	Int	Segment indicator (presumably 1 or 0)
equity	Int	Equity value
derivatives	Int	Derivatives value
aluminium	String	Aluminium category
brass	String	Brass category
cardamom	String	Cardamom category
copper	String	Copper category
cotton	String	Cotton category
crupalmoil	String	Crude palm oil category
crudeoil	String	Crude oil category
gold	String	Gold category
menthaoil	String	Mentha oil category
naturalgas	String	Natural gas category
nickel	String	Nickel category
pepper	String	Pepper category
rbdpmolein	String	RBD Palm Olein category
silver	String	Silver category
zinc	String	Zinc category
kapas	String	Kapas category
rubber	String	Rubber category
mcxbulldex	String	MCX Bulldex category
mcxmetldex	String	MCX Metldex category
mcxcomdex	String	MCX Comdex category
lead	String	Lead category

Response Structure

{
   "stat":1,
   "page":"7",
   "message":"Success",
   "reason":null,
   "result":{
      "id":4,
      "applicationId":6,
      "allSegment":1,
      "equity":0,
      "derivatives":0,
      "aluminium":"FPOs/Farmers",
      "brass":"Others",
      "cardamom":"Others",
      "copper":"Others",
      "cotton":"Others",
      "crupalmoil":"Others",
      "crudeoil":"Others",
      "gold":"Others",
      "menthaoil":"Others",
      "naturalgas":"Others",
      "nickel":"Others",
      "pepper":"Others",
      "rbdpmolein":"Others",
      "silver":"Others",
      "zinc":"Others",
      "kapas":"Others",
      "rubber":"Others",
      "mcxbulldex":"Others",
      "mcxmetldex":"Others",
      "mcxcomdex":"Others",
      "lead":"Others"
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	Identifier
applicationId	Int	Application Identifier
allSegment	Int	Segment indicator (presumably 1 or 0)
equity	Int	Equity value
derivatives	Int	Derivatives value
aluminium	String	Aluminium category
brass	String	Brass category
cardamom	String	Cardamom category
copper	String	Copper category
cotton	String	Cotton category
crupalmoil	String	Crude palm oil category
crudeoil	String	Crude oil category
gold	String	Gold category
menthaoil	String	Mentha oil category
naturalgas	String	Natural gas category
nickel	String	Nickel category
pepper	String	Pepper category
rbdpmolein	String	RBD Palm Olein category
silver	String	Silver category
zinc	String	Zinc category
kapas	String	Kapas category
rubber	String	Rubber category
mcxbulldex	String	MCX Bulldex category
mcxmetldex	String	MCX Metldex category
mcxcomdex	String	MCX Comdex category
lead	String	Lead category

Nominee¶

Method	API	Detail
Post	nominee/getNominee/?:applicationId	Fetch Index Details
Post	nominee/saveNominee	Get Multiple Index Details with titles

Get Nominee¶

Request Structure

applicationId=6

Input parameters

Field	Type	Description
applicationId	Int	Application Identifier

Response Structure

{
    "stat": 1,
    "page": "8.3",
    "message": "Success",
    "reason": null,
    "result": [
        {
            "id": 216,
            "applicationId": 607,
            "nomineeId": "Nominee_1",
            "firstname": "xxxxxx",
            "lastname": "P",
            "relationship": "Son",
            "dateOfbirth": "02-04-1992",
            "typeOfProof": "Aadhar card",
            "proofId": "0542",
            "mobilenumber": xxxxxx,
            "emailaddress": "xxxxxx",
            "address1": "address",
            "address2": "xxxxxx",
            "pincode": xxxxxxx,
            "state": "Tamil Nadu",
            "attachementUrl": "/opt/files/sky/docs/607/Nominee_1_NOMINEE_PROOF.jpeg",
            "allocation": 50,
            "guardianEntity": null,
            "nomOneAllocation": 0,
            "nomTwoAllocation": 0,
            "nomThreeAllocation": 0
        }
    ]
}

parameters

Field	Type	Description
id	Int	Identifier
applicationId	Int	Application Identifier
nomineeId	String	Nominee Identifier
firstName	String	First name of the nominee
lastName	String	Last name of the nominee
relationship	String	Relationship of the nominee with the applicant
dateOfBirth	String	Date of birth of the nominee (format: DD-MM-YYYY)
typeOfProof	String	Type of identification proof
proofId	String	Identification proof ID
mobileNumber	Int	Mobile number of the nominee
emailAddress	String	Email address of the nominee
address1	String	Address line 1 of the nominee
address2	String	Address line 2 of the nominee
pincode	Int	Pincode of the nominee's address
state	String	State of the nominee's address
attachmentUrl	String	URL to the attachment/proof of the nominee
allocation	Int	Allocation percentage or value
guardianEntity	String	Guardian entity (if applicable)
nomOneAllocation	Int	Allocation for first nominee
nomTwoAllocation	Int	Allocation for second nominee
nomThreeAllocation	Int	Allocation for third nominee

Save Nominee¶

Request Structure

{
    "applicationId": 607,
    "firstname": "xxxxxx",
    "lastname": "P",
    "relationship": "Son",
    "dateOfbirth": "02-04-1969",
    "typeOfProof": "Pan",
    "mobilenumber": xxxxxxx,
    "emailaddress": "xxxxxx",
    "address1": "xxxxxx",
    "address2": "xxxxxx",
    "pincode": "xxxxxxx",
    "state": "Tamil Nadu",
    "nomOneAllocation": 0,
    "nomTwoAllocation": 0,
    "nomThreeAllocation": 0,
    "proofId": "xxxxxx"
}

Input parameters

Field	Type	Description
applicationId	Int	Application Identifier
firstname	String	First name of the nominee
lastname	String	Last name of the nominee
relationship	String	Relationship of the nominee with the applicant
dateOfBirth	String	Date of birth of the nominee (format: DD-MM-YYYY)
typeOfProof	String	Type of identification proof (e.g., Pan, Aadhar)
mobileNumber	String	Mobile number of the nominee
emailAddress	String	Email address of the nominee
address1	String	Address line 1 of the nominee
address2	String	Address line 2 of the nominee
pincode	String	Pincode of the nominee's address
state	String	State of the nominee's address
nomOneAllocation	Int	Allocation for first nominee
nomTwoAllocation	Int	Allocation for second nominee
nomThreeAllocation	Int	Allocation for third nominee

Response Structure

{
   "stat":0,
   "page":null,
   "message":null,
   "reason":null,
   "result":{
      "stat":1,
      "page":"8.2",
      "message":"Success",
      "reason":null,
      {
            "id": 216,
            "applicationId": 607,
            "nomineeId": "Nominee_1",
            "firstname": "xxxxxx",
            "lastname": "P",
            "relationship": "Son",
            "dateOfbirth": "xxxxxx",
            "typeOfProof": "Aadhar card",
            "proofId": "0542",
            "mobilenumber": xxxxxx,
            "emailaddress": "xxxxxx",
            "address1": "xxxxxx",
            "address2": "xxxxxx"",
            "pincode": xxxxxxx,
            "state": "Tamil Nadu",
            "attachementUrl": "xxxxxx",
            "allocation": 50,
            "guardianEntity": null,
            "nomOneAllocation": 0,
            "nomTwoAllocation": 0,
            "nomThreeAllocation": 0
        },
      "address_response":null
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	Identifier for the nominee
applicationId	Int	Application Identifier
nomineeId	String	Identifier for the specific nominee
firstName	String	First name of the nominee
lastName	String	Last name of the nominee
relationship	String	Relationship of the nominee with the applicant
dateOfbirth	String	Date of birth of the nominee (format: DD-MM-YYYY)
typeOfProof	String	Type of identification proof (e.g., Aadhar card)
proofId	String	Identifier for the proof provided
mobileNumber	String	Mobile number of the nominee
emailAddress	String	Email address of the nominee
address1	String	Address line 1 of the nominee
address2	String	Address line 2 of the nominee
pincode	String	Pincode of the nominee's address
state	String	State of the nominee's address
attachementUrl	String	URL to access the proof attachment
allocation	Int	Percentage allocation for the nominee
guardianEntity	String	Guardian entity for the nominee (if applicable)
nomOneAllocation	Int	Allocation for the first nominee
nomTwoAllocation	Int	Allocation for the second nominee
nomThreeAllocation	Int	Allocation for the third nominee

Payment¶

Method	API	Detail
Post	bank/createPayment	Fetch Index Details
Post	bank/checkPayment/?:applicationId	Get Multiple Index Details with titles
Post	bank/verifyPayment	Fetch Index Details

Create Payment¶

Request Structure

{
   "applicationId":1,
   "amount":1
}

Input parameters

Field	Type	Description
applicationId	Int	Identifier for the application
amount	Int	Amount associated with the application

Response Structure

No body

Check Payment¶

Request Structure

applicationId=1

Input parameters

Field	Type	Description
applicationId	Int	Identifier for the application

Response Structure

NO body

verify Payment¶

Request Structure

{
   "razorpayOrderId":"",
   "razorpayPaymentId":"order_LDVmKnAEvvhIAT",
   "razorpaySignature":"",
   "receipt":"1",
   "amount":1
}

Input parameters

Field	Type	Description
razorpayOrderId	String	Identifier for the Razorpay Order
razorpayPaymentId	String	Identifier for the Razorpay Payment
razorpaySignature	String	Signature associated with the Razorpay
receipt	String	Receipt identifier
amount	Int	Amount associated with the payment

Response Structure

NO body

Document Upload¶

Method	API	Detail
Post	doc/upload/	Fetch Index Details

Save document¶

Request Structure

{
applicationId: 6
typeOfProof: Cheque_Statement
password: 12345
file: (binary)
}

Input parameters

Field	Type	Description
applicationId	String	Identifier for the application
typeOfProof	String	Type of proof (e.g., Cheque_Statement)
password	String	Password associated with the application
file	String	Placeholder for binary file data

Response Structure

{
   "stat":0,
   "page":null,
   "message":"Success",
   "reason":null,
   "result":{
      "id":5,
      "applicationId":6,
      "attachement":"application/pdf",
      "attachementUrl":"/opt/files/doc/6/6_Cheque_Statement.pdf",
      "typeOfProof":"Cheque_Statement",
      "password":"xxxxxx",
      "latitude":null,
      "longitude":null
   },
   "address_response":null
}

parameters

Response parameters

Field	Type	Description
stat	Int	Status indicator (e.g., 0 for success, 1 for error)
page	String	Page information
message	String	Message indicating the outcome (e.g., "Success")
reason	String	Reason for the outcome
id	String	Identifier for the document
applicationId	String	Identifier for the associated application
attachement	String	Type of the attached document (e.g., "application/pdf")
attachementUrl	String	URL/path to access the attached document
typeOfProof	String	Type of proof/document (e.g., "Cheque_Statement")
password	String	Password associated with the document (masked)
latitude	String	Latitude
longitude	String	Longitude
address_response	Null	Address response

IPV¶

Request Structure

{
applicationId: 607
file:(binary)
latitude: "null"
longitude: "null"
}

Input parameters

Field	Type	Description
applicationId	Int	Identifier for the associated application
file	String	Binary data for the file
latitude	String	Latitude value
longitude	String	Longitude value

Response Structure

{
   "stat":0,
   "page":null,
   "message":"Success",
   "reason":null,
   "result":{
      "id":5,
      "applicationId":6,
      "attachement":"application/pdf",
      "attachementUrl":"/opt/files/doc/6/6_Cheque_Statement.pdf",
      "typeOfProof":"Cheque_Statement",
      "password":"12345",
      "latitude":null,
      "longitude":null
   },
   "address_response":null
}

parameters

Field	Type	Description
id	Int	Identifier
applicationId	Int	Identifier for the associated application
attachement	String	Type of attachment
attachementUrl	String	URL pointing to the attached file
typeOfProof	String	Type of proof
password	String	Password
latitude	String	Latitude value
longitude	String	Longitude value

EKYC APIs

Mobile Number¶

Input Mobile¶

Verify Mobile¶

Email ID¶

Input Email¶

Verify Email¶

PAN Card Validation¶

NSDL Validation¶

KRA Check¶

Digi¶

Profile¶

Get profile¶

Save profile¶

Get UserDetails¶

Bank Details¶

Get bank details¶

Get branch details¶

Save bank¶

Pennydrop¶

Segment Selection¶

Get segment¶

Save Segment¶

Nominee¶

Get Nominee¶

Save Nominee¶

Payment¶

Create Payment¶

Check Payment¶

verify Payment¶

Document Upload¶

Save document¶

IPV¶

ESign¶