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
| Parameter | Type | Description | Example |
|---|
| client_id | string | Client ID of the end user whose details need to be fetched | client_id=VISHAL1 |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Specifies the media type of the request payload | application/json |
| Authorization | string | Dealer authentication token | Bearer {{access_token}} |
| x-api-key | string | API key used to authorize the 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 to user request | "s-101" |
| message | string | Success message | "User profile fetched successfully" |
| data | object | User profile details | Refer below |
📦 Data Object Fields
| Field | Type | Description | Example |
|---|
| user_name | string | User's name | "Vishal Kumar" |
| email | string | Registered email ID | "vishal@example.com" |
| mobile_no | string | Registered mobile number | "9876543210" |
| pan | string | PAN card number | "ABCDE1234F" |
| address | string | User's address | "Bangalore, India" |
| mpin_enabled | boolean | Flag if user has registered MPIN | true / false |
| fingerprint_enabled | boolean | Flag if user has registered fingerprint | true / false |
| dob | string | Date of birth | "1990-01-01" |
| gender | string | Gender of the user | "Male" |
| bank_details | object[] | List of user's bank details | Refer below |
| dp_details | object[] | List of user's DP details | Refer below |
🏦 Bank Details Object
| Field | Type | Description | Example |
|---|
| bank_name | string | Name of the bank | "HDFC Bank" |
| branch_name | string | Branch name | "MG Road" |
| branch_city | string | Branch city | "Bangalore" |
| account_no | string | Bank account number | "123456789012" |
| account_type | integer | Type of account (1 - Current, 2 - Savings) | 2 |
| is_default | boolean | Indicates default bank account | true / false |
📑 DP Details Object
| Field | Type | Description | Example |
|---|
| dpId | string | Depository ID | "IN300XXX" |
| clientBeneficiaryId | string | Beneficiary ID | "12345678" |
| holdingType | string | Type of holding | "Single" |
| dpType | string | Depository type | "NSDL" / "CDSL" |
| defaultDP | boolean | Indicates default depository | true / false |
| dpName | string | Depository name | "NSDL Participant" |