User Profile

This API fetches the complete user profile including identity,contact, banking, demat, mutual fund and trading cofiguration details.

🔑Header Parameters

Header	Type	Required	Description	Example
Content-type	string	Yes	Specifies the media type of the request body.	application/json
Authorization	string	Yes	Bearer token for user authentication.	Bearer {{access_token}}
x-api-key	string	Yes	API key for accessing the endpoint securely.	x-api-key

🟢Success Response - 200 Ok

Field	Type	Description	Example
status	string	Status of the API call. Indicates whether the call was successful.	"success"
code	string	Response code indicating the result of the API request	"s-101"
message	string	A message describing the result of the API Request	"Success Message"
data	object	Contains the detailed user profile information. This object includes personal details, bank, DP, and other related information.	See below for data schema

📘 Data Object Info Fields

Field	Type	Description	Example/ENUM
user_name	string	Unique Client code (UCC) assigned to the user	"U123456"
email	string	User's registered email ID in the system.	"user@xyz.com"
mobile_no	string	User registered mobile number in the system	"9876543210"
pan	string	User's PAN (Permanent Account Number) available in the system.	"ABCDE1234F"
address	string	User's address available in the system.	"123 Street Name, City"
mpin_enabled	boolean	Flag indicating whether the user has registered MPIN.	true / false
fingerprint_enabled	boolean	Flag indicating whether the user has registered fingerprint login.	true / false
dob	string	User's date of birth in DD-MM-YYYY format.	"01-01-1990"
gender	string	User's gender as per the system.	"Male" / "Female" / "Other"
dp_details	array of objs	List of user's Depository Participant (DP) details.	See below for DP details schema
bank_details	array of objs	List of user's bank account details available in the system.	See below for bank details schema
mf_details	array of objs	List of user's Mutual Fund (MF) details.	See below for MF details schema
login_time	string	Timestamp of the user's last login.	"2025-05-21 14:35:00"
totp_enabled	boolean	Flag indicating whether the user has TOTP (Time-based One-Time Password) enabled.	true / false
ptnType	string	Type of PTN (Platform Transaction Number).	"PTN01"
exchanges	array	List of exchanges the user is allowed to trade on.	["NSE", "BSE"]
bcastExchanges	array	List of exchanges allowed for market feed data.	["NSE"]
product_types	array	List of Product type allowed across all exchanges.	["INTRADAY", "DELIVERY"]
product_types_exchange	object	Product type allowed per exchange.	{ "NSE": ["DELIVERY", "COVER"] }
others	object	Other miscellaneous details related to the user profile.	See below for other details schema

🏦 Bank Details Object Info Fields

Field Name	Type	Description	Example
bank_name	string	Name of the bank where the user holds an account.	"HDFC Bank"
branch_name	string	Name of the branch where the account is held.	"Main Branch"
branch_city	string	City where the bank branch is located.	"Mumbai"
account_no	string	User’s bank account number.	"1234567890"
account_type	integer	Type of account: 1 = Current, 2 = Savings.	1 / 2
is_default	boolean	Flag indicating if this bank account is set as the default account.	true / false

🏛️ Depository Participant (DP) Object Info Fields

Field Name	Type	Description	Example
dpId	string	Unique Depository Participant ID available in the system.	"IN123456"
clientBeneficiaryId	string	User’s unique Beneficiary ID assigned by the Depository.	"12345678"
holdingType	string	Type of holding for the account (e.g., Individual or Joint).	"Individual" / "Joint"
dpType	string	Type of Depository Participant (e.g., NSDL or CDSL).	"NSDL" / "CDSL"
defaultDP	boolean	Flag indicating if this depository is set as the default for the user.	true / false
dpName	string	Name of the Depository Participant as registered in the system.	"XYZ Securities"

💹 Mutual Fund (MF) Object Info Fields

Field Name	Type	Description	Example
bseTransactionMode	integer	BSE Transaction Mode (used for mutual fund transactions).	1 / 2
bseUCCMode	integer	BSE UCC Mode (defines the mode of the Unique Client Code).	1 / 2
bseUCC	string	Unique Client Code (UCC) for mutual fund transactions in the BSE system.	"UCC12345"
holdingMode	string	Mode of holding for mutual funds (e.g., Individual or Joint).	"Individual" / "Joint"

📝 Others Object Info Fields

Field Name	Type	Description	Example
userCode	string	Unique identifier code for the user.	"USR12345"
groupId	string	ID of the group to which the user belongs.	"GID789"
groupCode	string	Group code for categorizing or grouping the user.	"GRP001"
newsCategories	string	Categories of news the user is interested in.	"finance, stocks"
messageSocket	string	WebSocket URL endpoint for receiving interactive messages.	"wss://socket.url"
POA	string	Power of Attorney status of the user (0 = POA, 2 = Non-POA).	"0" / "2"
nGTDDefault	integer	Default Good-Till-Date (GTD) days set for the user.	5
nGTDMaxDays	integer	Maximum GTD days allowed for the user.	30
sGTDConfigDetails	string	Configuration details for GTD (Good-Till-Date).	"Config details string"
ocToken	string	One-time OC (Order Confirmation) Token.	"OC12345"
managerIP	string	IP address of the manager's system.	"192.168.1.1"
tslAllowed	array	List of allowed TLS (Transport Layer Security) versions.	["TLS1.2", "TLS1.3"]
edisForMTF	boolean	Flag indicating whether EDIs are allowed for Margin Trading Facility (MTF).	true / false
showJumpPriceBothLtpAndTriggerPrice	boolean	Flag indicating if both LTP (Last Traded Price) and Trigger Price should be shown.	true / false
CFT	string	CFT (Customer Financial Transaction) code or identifier.	"CFT123"
bAMOAllowedForUser	boolean	Flag indicating whether After Market Orders (AMO) are allowed for the user.	true / false

get/authentication/v1/user/profile