Get Profile

API to retrieve user profile data, which encompasses details such as supported exchanges, enabled product offerings, and permitted order types. If you're business and developing an application for multi-client API usage, you can utilize this data to display in the user's profile section.

Header Parameters

Name	Required	Type	Description
Authorization	true	string	Requires the format Bearer access_token where access_token is obtained from the Token API.
Accept	true	string	Defines the content format the client expects, which should be set to application/json.

Responses

• 200
• 4XX

---

Response Body

{
  "status": "success",
  "data": {
    "email": "******",
    "exchanges": ["NSE", "NFO", "BSE", "CDS", "BFO", "BCD"],
    "products": ["D", "CO", "I"],
    "broker": "UPSTOX",
    "user_id": "******",
    "user_name": "******",
    "order_types": ["MARKET", "LIMIT", "SL", "SL-M"],
    "user_type": "individual",
    "poa": false,
    "ddpi": false,
    "is_active": true
  }
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Typically success for successful operations.
data	object	Response data for user profile
data.email	string	E-mail address of the user
data.exchanges	string[]	List of exchanges enabled for the user. Valid exchanges can be found in the Exchange Appendix
data.products	string[]	Lists the types of products enabled for the user. Possible values: I, D, CO, MTF
data.broker	string	The broker ID
data.user_id	string	Uniquely identifies the user (commonly referred as UCC)
data.user_name	string	Name of the user
data.order_types	string[]	Order types enabled for the user. Possible values: MARKET, LIMIT, SL, SL-M
data.user_type	string	Identifies the user's registered role at the broker. This will be individual for all retail users
data.poa	boolean	Indicates whether the user has authorized power of attorney for transactions.
data.ddpi	boolean	Indicates whether the user has authorized DDPI (Demat Debit and Pledge Instruction) for transactions.
data.is_active	boolean	Indicates if the account status is active.

Error codes

Error code	Description
UDAPI100058	No segments for these users are active. Manual reactivation is recommended from Upstox app/web. - Thrown when the signing-in user lacks active segments on their account. It's recommended that the user re-enable these segments through the Upstox app or website.

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.

Loading...