Skip to main content
GET
/
api
/
private
/
profile
/
brief
/
Get Profile Brief
curl --request GET \
  --url https://app.digitalsurge.com.au/api/private/profile/brief/ \
  --header 'Authorization: Bearer <token>'
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "acc_type": "<string>",
  "email_verified": true,
  "phone_verified": true,
  "account_verification": "<string>",
  "verified_account": true,
  "account_frozen": true,
  "account_created": "<string>",
  "monthly_trading_volume": "<string>",
  "broker_commission_rate": "<string>",
  "account_aud_value": "<string>",
  "is_vip": true,
  "affiliate_code": "<string>",
  "limits": {}
}

Authorizations

​
Authorization
string
header
required

Personal API key, created in the Digital Surge app under Account Settings → API Keys. Send it with every request as Authorization: Bearer <your-api-key>.

Response

200 - application/json

Customer-safe profile snapshot for MCP / AI agent consumption.

Excludes internal flags, auth tokens, banking details, and workflow state. account_verification uses customer-facing language (no L1/L2 internal codes).

​
first_name
string
required
read-only
​
last_name
string
required
read-only
​
email
string<email>
required
read-only
​
phone
string | null
required
read-only
​
acc_type
string
required
read-only
​
email_verified
boolean
required
read-only
​
phone_verified
boolean | null
required
read-only
​
account_verification
string
required
read-only
​
verified_account
boolean
required
read-only
​
account_frozen
boolean
required
read-only
​
account_created
string
required
read-only
​
monthly_trading_volume
string<decimal> | null
required
read-only
​
broker_commission_rate
string<decimal>
required
read-only
​
account_aud_value
string
required
read-only
​
is_vip
boolean
required
read-only
​
affiliate_code
string | null
required
read-only
​
limits
object
required
read-only