> ## Documentation Index
> Fetch the complete documentation index at: https://digitalsurge.com.au/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Profile Brief

> Presentable profile information.
Intended for use by AI agents and external integrations.



## OpenAPI

````yaml /openapi.json get /api/private/profile/brief/
openapi: 3.0.3
info:
  title: Digital Surge API
  version: '2.0'
  description: >-
    Digital Surge is an Australian cryptocurrency exchange. This API provides
    programmatic access to your account: live AUD pricing for hundreds of
    assets, instant swaps, recurring buys, price triggers, portfolio balances,
    transaction history, and crypto withdrawals.


    **Authentication** — create an API key in the Digital Surge app under
    *Account Settings → API Keys* and send it with every request:
    `Authorization: Bearer <your-api-key>`. Read-only and read & write keys are
    available.


    **Guides and interactive documentation** — https://digitalsurge.com.au/docs


    **AI agents** — connect via the Digital Surge MCP server:
    https://mcp.digitalsurge.com.au/mcp
servers:
  - url: https://app.digitalsurge.com.au
    description: Production
security: []
tags:
  - name: Public
    description: Unauthenticated endpoints — market data, asset info, pricing
  - name: Private
    description: Authenticated endpoints — trading, portfolio, account management
paths:
  /api/private/profile/brief/:
    get:
      tags:
        - Private
      summary: Get Profile Brief
      description: |-
        Presentable profile information.
        Intended for use by AI agents and external integrations.
      operationId: private_profile_brief_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileBrief'
          description: ''
      security:
        - bearerAuth: []
components:
  schemas:
    ProfileBrief:
      type: object
      description: >-
        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).
      properties:
        first_name:
          type: string
          readOnly: true
        last_name:
          type: string
          readOnly: true
        email:
          type: string
          format: email
          readOnly: true
        phone:
          type: string
          readOnly: true
          nullable: true
        acc_type:
          type: string
          readOnly: true
        email_verified:
          type: boolean
          readOnly: true
        phone_verified:
          type: boolean
          readOnly: true
          nullable: true
        account_verification:
          type: string
          readOnly: true
        verified_account:
          type: boolean
          readOnly: true
        account_frozen:
          type: boolean
          readOnly: true
        account_created:
          type: string
          readOnly: true
        monthly_trading_volume:
          type: string
          format: decimal
          readOnly: true
          nullable: true
        broker_commission_rate:
          type: string
          format: decimal
          readOnly: true
        account_aud_value:
          type: string
          readOnly: true
        is_vip:
          type: boolean
          readOnly: true
        affiliate_code:
          type: string
          readOnly: true
          nullable: true
        limits:
          type: object
          additionalProperties: {}
          readOnly: true
      required:
        - acc_type
        - account_aud_value
        - account_created
        - account_frozen
        - account_verification
        - affiliate_code
        - broker_commission_rate
        - email
        - email_verified
        - first_name
        - is_vip
        - last_name
        - limits
        - monthly_trading_volume
        - phone
        - phone_verified
        - verified_account
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        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>`.

````