Skip to main content

USER PROFILE API

This API fetches the basic profile details of a client, including personal information such as user name, email, mobile number, PAN, address, along with bank and DP (Depository Participant) details.

🔍 Query Parameters

ParameterTypeDescriptionExample
client_idstringClient ID of the end user whose details need to be fetchedclient_id=VISHAL1

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringSpecifies the media type of the request payloadapplication/json
AuthorizationstringDealer authentication tokenBearer {{access_token}}
x-api-keystringAPI key used to authorize the request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code to user request"s-101"
messagestringSuccess message"User profile fetched successfully"
dataobjectUser profile detailsRefer below

📦 Data Object Fields

FieldTypeDescriptionExample
user_namestringUser's name"Vishal Kumar"
emailstringRegistered email ID"vishal@example.com"
mobile_nostringRegistered mobile number"9876543210"
panstringPAN card number"ABCDE1234F"
addressstringUser's address"Bangalore, India"
mpin_enabledbooleanFlag if user has registered MPINtrue / false
fingerprint_enabledbooleanFlag if user has registered fingerprinttrue / false
dobstringDate of birth"1990-01-01"
genderstringGender of the user"Male"
bank_detailsobject[]List of user's bank detailsRefer below
dp_detailsobject[]List of user's DP detailsRefer below

🏦 Bank Details Object

FieldTypeDescriptionExample
bank_namestringName of the bank"HDFC Bank"
branch_namestringBranch name"MG Road"
branch_citystringBranch city"Bangalore"
account_nostringBank account number"123456789012"
account_typeintegerType of account (1 - Current, 2 - Savings)2
is_defaultbooleanIndicates default bank accounttrue / false

📑 DP Details Object

FieldTypeDescriptionExample
dpIdstringDepository ID"IN300XXX"
clientBeneficiaryIdstringBeneficiary ID"12345678"
holdingTypestringType of holding"Single"
dpTypestringDepository type"NSDL" / "CDSL"
defaultDPbooleanIndicates default depositorytrue / false
dpNamestringDepository name"NSDL Participant"