Skip to main content

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

NameRequiredTypeDescription
AuthorizationtruestringRequires the format Bearer access_token where access_token is obtained from the Token API.
AccepttruestringDefines the content format the client expects, which should be set to application/json.
Responses

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,
"is_active": true
}
}
NameTypeDescription
statusstringA string indicating the outcome of the request. Typically success for successful operations.
dataobjectResponse data for user profile
data.emailstringE-mail address of the user
data.exchangesstring[]List of exchanges enabled for the user. Valid exchanges can be found in the Exchange Appendix
data.productsstring[]Lists the types of products enabled for the user.
Possible values: I, D, CO, MTF
data.brokerstringThe broker ID
data.user_idstringUniquely identifies the user (commonly referred as UCC)
data.user_namestringName of the user
data.order_typesstring[]Order types enabled for the user.
Possible values: MARKET, LIMIT, SL, SL-M
data.user_typestringIdentifies the user's registered role at the broker. This will be individual for all retail users
data.poabooleanIndicates whether the user has authorized power of attorney for transactions.
data.is_activebooleanIndicates if the account status is active.

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...