USER PROFILE
This API fetches the complete profile details of a user, including personal information, bank details, DP details, MF details, enabled features, and trading configurations.
🔍 Query Parameters
| Parameter | Type | Required | Description | Example |
|---|
| userId | string | Yes | Unique user ID (UCC) | "{{user_id}}" |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Specifies request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{x-api-key}} |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Success message | "User profile fetched successfully" |
| data | object | User profile details | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example / Enum |
|---|
| user_name | string | User ID (UCC) | "DL12345" |
| email | string | Registered email | "user@example.com" |
| mobile_no | string | Registered mobile number | "9876543210" |
| pan | string | PAN number | "ABCDE1234F" |
| address | string | Address | "Bangalore, India" |
| mpin_enabled | boolean | MPIN enabled flag | true, false |
| fingerprint_enabled | boolean | Fingerprint enabled flag | true, false |
| dob | string | Date of birth | "01-01-1990" |
| gender | string | Gender | "MALE", "FEMALE" |
| login_time | string | Last login time | "2026-06-10 10:00:00" |
| totp_enabled | boolean | TOTP enabled flag | true, false |
| exchanges | array | Allowed exchanges | ["NSE","BSE"] |
| bcastExchanges | array | Exchanges for market feed | ["NSE"] |
| product_types | array | Allowed product types | ["CNC","MIS"] |
| product_types_exchange | object | Product types per exchange | {"NSE":["MIS"]} |
🏦 Bank Details
| Field | Type | Description | Example / Enum |
|---|
| bank_name | string | Bank name | "HDFC Bank" |
| branch_name | string | Branch | "MG Road" |
| branch_city | string | City | "Bangalore" |
| account_no | string | Account number | "XXXX1234" |
| account_type | integer | Account type | 1 = Current, 2 = Savings |
| is_default | boolean | Default bank | true, false |
🧾 DP Details
| Field | Type | Description | Example / Enum |
|---|
| dpId | string | DP ID | "IN300XXX" |
| clientBeneficiaryId | string | Beneficiary ID | "12345678" |
| holdingType | string | Holding type | "INDIVIDUAL", "JOINT" |
| dpType | string | Depository type | "NSDL", "CDSL" |
| defaultDP | boolean | Default DP flag | true, false |
| dpName | string | DP name | "HDFC Securities" |
🧮 MF Details
| Field | Type | Description | Example |
|---|
| bseTransactionMode | integer | BSE transaction mode | 1 |
| bseUCCMode | integer | UCC mode | 1 |
| bseUCC | string | UCC ID | "UCC123" |
| holdingMode | string | Holding mode | "SINGLE" |
⚙️ Others Object
| Field | Type | Description | Example / Enum |
|---|
| userCode | string | User code | "USR001" |
| groupId | string | Group ID | "GRP01" |
| groupCode | string | Group code | "G001" |
| newsCategories | string | News categories | "MARKET" |
| messageSocket | string | Socket endpoint | "https://socket.url" |
| POA | string | POA status | "0 = POA", "2 = Non POA" |
| nGTDDefault | integer | Default GTD | 1 |
| nGTDMaxDays | integer | Max GTD days | 30 |
| sGTDConfigDetails | string | GTD config | "Config" |
| ocToken | string | OC token | "TOKEN123" |
| managerIP | string | Manager IP | "192.168.1.1" |
| tslAllowed | array | TSL allowed products | ["MIS"] |
| edisForMTF | boolean | EDIS flag | true, false |
| showJumpPriceBothLtpAndTriggerPrice | boolean | UI config flag | true, false |
| CFT | string | CFT flag | "Y" |
| bAMOAllowedForUser | boolean | AMO permission | true, false |