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).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Digital Surge API","description":"API documentation for Digital Surge, the Australian cryptocurrency exchange. Trade, track your portfolio, and automate with API keys or AI agents.","colors":{"primary":"#664DFF","light":"#BD99FF","dark":"#322593"},"logo":{"light":"https://mintcdn.com/digitalsurge/v62aNZmWKjllpl9w/logo/light.svg?fit=max\u0026auto=format\u0026n=v62aNZmWKjllpl9w\u0026q=85\u0026s=3f12651d3670f8bbd605b0ecf3d5846c","dark":"https://mintcdn.com/digitalsurge/v62aNZmWKjllpl9w/logo/dark.svg?fit=max\u0026auto=format\u0026n=v62aNZmWKjllpl9w\u0026q=85\u0026s=1a73e4ebdea9818c3797d2022f9b3be2","href":"https://digitalsurge.com.au"},"favicon":"https://mintcdn.com/digitalsurge/v62aNZmWKjllpl9w/favicon.svg?fit=max\u0026auto=format\u0026n=v62aNZmWKjllpl9w\u0026q=85\u0026s=89b3596b6826371c879c2a27a55ff2fa","api":{"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"https://help.digitalsurge.com.au","label":"Support"}],"primary":{"type":"button","label":"Open Digital Surge","href":"https://app.digitalsurge.com.au"}},"footer":{"socials":{"website":"https://digitalsurge.com.au"}},"seo":{"metatags":{"og:site_name":"Digital Surge API Documentation"},"indexing":"all"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"digitalsurge","hasAudioNarration":false,"actualSubdomain":"digitalsurge","customDomains":["digitalsurge.com.au"],"gitSource":{"type":"gitlab","owner":"digital-surge2","repo":"ds-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":84082694,"mountPath":"","label":""},"chroma":{"collectionId":"b596dff0-b1c2-47c3-8102-603b78c8f0c0","liveDeploymentHistoryId":"6a4881849e94978f9d555c21","schemaVersion":"v3"},"entitlements":{},"buildId":"6a4881849e94978f9d555c21:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":55},{"language":"default","tag":"Endpoints","count":53},{"language":"default","tag":"Private","count":46},{"language":"default","tag":"Public","count":7},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Getting started","count":3},{"language":"default","tag":"Using the API","count":2},{"language":"default","tag":"AI agents","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/private/get-profile-brief","slug":"/api-reference/private/get-profile-brief","pageMetadata":{"title":"Get Profile Brief","description":"Presentable profile information.\nIntended for use by AI agents and external integrations.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/profile/brief/","href":"/api-reference/private/get-profile-brief","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Presentable profile information.\\nIntended for use by AI agents and external integrations.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Profile Brief","description":"Presentable profile information.\nIntended for use by AI agents and external integrations.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/profile/brief/","href":"/api-reference/private/get-profile-brief","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/digitalsurge/3641986737ad18ec/worker/src/index.js"],"openApiReferenceData":{"operation":{"operationId":"private_profile_brief_retrieve","description":"Presentable profile information.\nIntended for use by AI agents and external integrations.","tags":["Private"],"security":["92ef3222-25d5-43fd-a4aa-2b8bd9f3548f"],"responses":{"200":"a4aa8280-0bc3-4631-b2f7-e28b117d34c3"},"summary":"Get Profile Brief","method":"get","type":"path","servers":["df865b17-d79a-41fa-8ed2-0cc2f415cf87"],"path":"/api/private/profile/brief/","baseUrlOptions":["https://app.digitalsurge.com.au"],"title":"Get Profile Brief","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"responses":{"a4aa8280-0bc3-4631-b2f7-e28b117d34c3":{"content":{"application/json":{"schema":{"type":"object","description":"Customer-safe profile snapshot for MCP / AI agent consumption.\n\nExcludes internal flags, auth tokens, banking details, and workflow state.\naccount_verification uses customer-facing language (no L1/L2 internal codes).","properties":{"first_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"last_name","typeLabel":"string"},"email":{"type":"string","format":"email","readOnly":true,"isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"phone":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"phone","typeLabel":"string | null"},"acc_type":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"acc_type","typeLabel":"string"},"email_verified":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"email_verified","typeLabel":"boolean"},"phone_verified":{"oneOf":[{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"phone_verified.oneOf.0","typeLabel":"boolean"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"phone_verified.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"phone_verified","typeLabel":"boolean | null"},"account_verification":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"account_verification","typeLabel":"string"},"verified_account":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"verified_account","typeLabel":"boolean"},"account_frozen":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"account_frozen","typeLabel":"boolean"},"account_created":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"account_created","typeLabel":"string"},"monthly_trading_volume":{"oneOf":[{"type":"string","format":"decimal","readOnly":true,"isRequired":true,"uniqueKey":"monthly_trading_volume.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","readOnly":true,"isRequired":true,"uniqueKey":"monthly_trading_volume.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"monthly_trading_volume","typeLabel":"string\u003cdecimal> | null"},"broker_commission_rate":{"type":"string","format":"decimal","readOnly":true,"isRequired":true,"uniqueKey":"broker_commission_rate","typeLabel":"string\u003cdecimal>"},"account_aud_value":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"account_aud_value","typeLabel":"string"},"is_vip":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"is_vip","typeLabel":"boolean"},"affiliate_code":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"affiliate_code.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"affiliate_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"affiliate_code","typeLabel":"string | null"},"limits":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"limits.additionalProperties","typeLabel":"any"},"readOnly":true,"isRequired":true,"uniqueKey":"limits","typeLabel":"object"}},"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"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"first_name":"\u003cstring>","last_name":"\u003cstring>","email":"jsmith@example.com","phone":"\u003cstring>","acc_type":"\u003cstring>","email_verified":true,"phone_verified":true,"account_verification":"\u003cstring>","verified_account":true,"account_frozen":true,"account_created":"\u003cstring>","monthly_trading_volume":"\u003cstring>","broker_commission_rate":"\u003cstring>","account_aud_value":"\u003cstring>","is_vip":true,"affiliate_code":"\u003cstring>","limits":{}}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"92ef3222-25d5-43fd-a4aa-2b8bd9f3548f":{"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 \u003cyour-api-key>`.","scopes":[]}}},"servers":{"df865b17-d79a-41fa-8ed2-0cc2f415cf87":{"url":"https://app.digitalsurge.com.au","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"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 \u003cyour-api-key>`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Personal API key, created in the Digital Surge app under Account Settings → API Keys. Send it with every request as `Authorization: Bearer \u003cyour-api-key>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"digitalsurge","siteName":"Digital Surge API","title":"Get Profile Brief - Digital Surge API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-04T03:44:07.167Z","originalFileLocation":"api-reference/private/get-profile-brief.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Presentable profile information. Intended for use by AI agents and external integrations.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Digital Surge API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Profile Brief - Digital Surge API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Presentable profile information. Intended for use by AI agents and external integrations.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Digital Surge API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://digitalsurge.mintlify.app/_mintlify/api/og/v2?division=Private\u0026amp;title=Get+Profile+Brief\u0026amp;description=Presentable+profile+information.%0AIntended+for+use+by+AI+agents+and+external+integrations.\u0026amp;theme=cca07053cdd6aa929ec823f2\u0026amp;signature=757314705bbc9828fadfd53758f10dd658e848bd3166d43d702f8ee3f957f5cb\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Profile Brief - Digital Surge API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Presentable profile information. Intended for use by AI agents and external integrations.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://digitalsurge.mintlify.app/_mintlify/api/og/v2?division=Private\u0026amp;title=Get+Profile+Brief\u0026amp;description=Presentable+profile+information.%0AIntended+for+use+by+AI+agents+and+external+integrations.\u0026amp;theme=cca07053cdd6aa929ec823f2\u0026amp;signature=757314705bbc9828fadfd53758f10dd658e848bd3166d43d702f8ee3f957f5cb\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/digitalsurge/ftUiGR1TsUtR6JbP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Digital Surge API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#664DFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/private/get-profile-brief.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://digitalsurge.com.au/#organization\",\"name\":\"Digital Surge API\",\"url\":\"https://digitalsurge.com.au\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/digitalsurge/v62aNZmWKjllpl9w/logo/light.svg?fit=max\u0026auto=format\u0026n=v62aNZmWKjllpl9w\u0026q=85\u0026s=3f12651d3670f8bbd605b0ecf3d5846c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://digitalsurge.com.au/docs#website\",\"name\":\"Digital Surge API\",\"url\":\"https://digitalsurge.com.au/docs\",\"publisher\":{\"@id\":\"https://digitalsurge.com.au/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief#webpage\",\"url\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief\",\"name\":\"Get Profile Brief\",\"description\":\"Presentable profile information. Intended for use by AI agents and external integrations.\",\"dateModified\":\"2026-07-04T03:44:07.167Z\",\"isPartOf\":{\"@id\":\"https://digitalsurge.com.au/docs#website\"},\"breadcrumb\":{\"@id\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://digitalsurge.com.au/docs/api-reference/private/generate-account-statement-pdf\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Private\",\"item\":\"https://digitalsurge.com.au/docs/api-reference/private/generate-account-statement-pdf\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Profile Brief\",\"item\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief#apireference\",\"headline\":\"Get Profile Brief\",\"name\":\"Get Profile Brief\",\"description\":\"Presentable profile information. Intended for use by AI agents and external integrations.\",\"url\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief\",\"mainEntityOfPage\":{\"@id\":\"https://digitalsurge.com.au/docs/api-reference/private/get-profile-brief#webpage\"},\"dateModified\":\"2026-07-04T03:44:07.167Z\",\"publisher\":{\"@id\":\"https://digitalsurge.com.au/#organization\"},\"isPartOf\":{\"@id\":\"https://digitalsurge.com.au/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Digital Surge API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Digital Surge API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Reference","sidebarTitle":"Overview","href":"/api-reference"}]},{"group":"Endpoints","pages":[{"group":"Private","pages":[{"title":"Generate Account Statement PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/account-statement/pdf/","href":"/api-reference/private/generate-account-statement-pdf"},{"title":"List All Balances","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/balances/","href":"/api-reference/private/list-all-balances"},{"title":"Get Asset Balance","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/balances/{asset}/","href":"/api-reference/private/get-asset-balance"},{"title":"List Price Triggers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/broker/price-triggers/","href":"/api-reference/private/list-price-triggers"},{"title":"Create Price Trigger","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/broker/price-triggers/","href":"/api-reference/private/create-price-trigger"},{"title":"Get Price Trigger","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/broker/price-triggers/{id}/","href":"/api-reference/private/get-price-trigger"},{"title":"Update Price Trigger","deprecated":null,"version":null,"openapi":"/openapi.json put /api/private/broker/price-triggers/{id}/","href":"/api-reference/private/update-price-trigger"},{"title":"Delete Price Trigger","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/private/broker/price-triggers/{id}/","href":"/api-reference/private/delete-price-trigger"},{"title":"Patch Price Trigger","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/private/broker/price-triggers/{id}/","href":"/api-reference/private/patch-price-trigger"},{"title":"List Recurring Buys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/broker/schedules/","href":"/api-reference/private/list-recurring-buys"},{"title":"Create Recurring Buy","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/broker/schedules/","href":"/api-reference/private/create-recurring-buy"},{"title":"Get Recurring Buy","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/broker/schedules/{id}/","href":"/api-reference/private/get-recurring-buy"},{"title":"Update Recurring Buy","deprecated":null,"version":null,"openapi":"/openapi.json put /api/private/broker/schedules/{id}/","href":"/api-reference/private/update-recurring-buy"},{"title":"Delete Recurring Buy","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/private/broker/schedules/{id}/","href":"/api-reference/private/delete-recurring-buy"},{"title":"Patch Recurring Buy","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/private/broker/schedules/{id}/","href":"/api-reference/private/patch-recurring-buy"},{"title":"Generate EOFY Closing Statement PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/eofy-closing-statement/pdf/","href":"/api-reference/private/generate-eofy-closing-statement-pdf"},{"title":"List Transfer Limits","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/limits/","href":"/api-reference/private/list-transfer-limits"},{"title":"Get Transfer Limit","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/limits/{id}/","href":"/api-reference/private/get-transfer-limit"},{"title":"List Connected AI Agents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/mcp-agents/","href":"/api-reference/private/list-connected-ai-agents"},{"title":"Get Connected AI Agent","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/mcp-agents/{id}/","href":"/api-reference/private/get-connected-ai-agent"},{"title":"Disconnect AI Agent","description":"Connected AI agents (MCP OAuth tokens) for the authenticated customer.\n\nList the agents currently connected to your account, retrieve the details\nof a specific one, or disconnect any of them. Disconnecting an agent\nimmediately revokes the access and refresh tokens it was issued, so the\nagent loses access on its next request.","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/private/mcp-agents/{id}/","href":"/api-reference/private/disconnect-ai-agent"},{"title":"Get Profile Brief","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/profile/brief/","href":"/api-reference/private/get-profile-brief"},{"title":"List Swaps","description":"Swap one asset directly for another at the current market price —\nthis is the **instant / one-shot** trade flow. For recurring or\nscheduled buys (DCA), use the broker schedules endpoints instead.\n\nDirection is implied by which asset is AUD:\n - BUY a crypto: ``src_asset=\"AUD\"``, ``dst_asset=\u003ccrypto code>``\n - SELL a crypto: ``src_asset=\u003ccrypto code>``, ``dst_asset=\"AUD\"``\n\nListing returns swap history, most recent first. Retrieving by\n``id`` returns the current state of a single swap — used after\n``create`` to check whether ``status`` has moved from\n``processing`` to ``processed``, ``error``, or ``canceled``.\n\nPlacing a new swap is a two-step flow: ``estimate`` first to\npreview price, fees, and amounts, ask the user to confirm, then\n``create`` to execute.\nSee the per-operation documentation for details.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/swaps/","href":"/api-reference/private/list-swaps"},{"title":"Create Swap","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/swaps/","href":"/api-reference/private/create-swap"},{"title":"Get Swap","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/swaps/{id}/","href":"/api-reference/private/get-swap"},{"title":"Estimate Swap","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/swaps/estimate/","href":"/api-reference/private/estimate-swap"},{"title":"Get Portfolio Stats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet-stats/","href":"/api-reference/private/get-portfolio-stats"},{"title":"List Wallet Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet/{asset}/wallet-transactions/","href":"/api-reference/private/list-wallet-transactions"},{"title":"Get Wallet Transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet/{asset}/wallet-transactions/{id}/","href":"/api-reference/private/get-wallet-transaction"},{"title":"Get Transaction Invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet/{asset}/wallet-transactions/{id}/invoice/","href":"/api-reference/private/get-transaction-invoice"},{"title":"List Withdrawals","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet/{asset}/withdrawals/","href":"/api-reference/private/list-withdrawals"},{"title":"Create Withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/v2/wallet/{asset}/withdrawals/","href":"/api-reference/private/create-withdrawal"},{"title":"Get Withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet/{asset}/withdrawals/{id}/","href":"/api-reference/private/get-withdrawal"},{"title":"Authorize Withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/v2/wallet/{asset}/withdrawals/{id}/authorize/","href":"/api-reference/private/authorize-withdrawal"},{"title":"Resend Withdrawal Code","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/v2/wallet/{asset}/withdrawals/resend-code/","href":"/api-reference/private/resend-withdrawal-code"},{"title":"List Address Book","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet/address-book/","href":"/api-reference/private/list-address-book"},{"title":"Add Address Book Entry","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/v2/wallet/address-book/","href":"/api-reference/private/add-address-book-entry"},{"title":"Get Address Book Entry","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/v2/wallet/address-book/{id}/","href":"/api-reference/private/get-address-book-entry"},{"title":"Delete Address Book Entry","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/private/v2/wallet/address-book/{id}/","href":"/api-reference/private/delete-address-book-entry"},{"title":"Resend Address Confirmation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/v2/wallet/address-book/{id}/resend_confirmation/","href":"/api-reference/private/resend-address-confirmation"},{"title":"List Deposit Addresses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/wallet/{asset}/deposit-addresses/","href":"/api-reference/private/list-deposit-addresses"},{"title":"Get Deposit Travel Rule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/wallet/{asset}/deposits/{deposit_id}/travel-rule/","href":"/api-reference/private/get-deposit-travel-rule"},{"title":"Submit Deposit Travel Rule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/private/wallet/{asset}/deposits/{deposit_id}/travel-rule/","href":"/api-reference/private/submit-deposit-travel-rule"},{"title":"List All Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/wallet/all-transactions/","href":"/api-reference/private/list-all-transactions"},{"title":"Get Transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/wallet/all-transactions/{id}/","href":"/api-reference/private/get-transaction"},{"title":"Get Transaction Invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/private/wallet/all-transactions/{id}/invoice/","href":"/api-reference/private/get-transaction-invoice-1"}]},{"group":"Public","pages":[{"title":"List Assets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/broker/assets/","href":"/api-reference/public/list-assets"},{"title":"Get Asset","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/broker/assets/{code}/","href":"/api-reference/public/get-asset"},{"title":"List Asset Categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/broker/assets/categories/","href":"/api-reference/public/list-asset-categories"},{"title":"Get Asset Category","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/broker/assets/categories/{slug}/","href":"/api-reference/public/get-asset-category"},{"title":"List EOFY Closing Prices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/broker/eofy-closing-prices/","href":"/api-reference/public/list-eofy-closing-prices"},{"title":"Get Ticker","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/broker/ticker/","href":"/api-reference/public/get-ticker"},{"title":"Top Assets Summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/broker/ticker/top-assets-summary/","href":"/api-reference/public/top-assets-summary"}]}]}]}]},"basePath":"","title":"Get Profile Brief - Digital Surge API","buildId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","deploymentId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CLz2_Z5D.js","utils-7A5jZhOT.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BVWmkKuv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-4SOfrh0F.js","snippetPresets-CMc8KicP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ba9tX7z3.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Be8krXvv.js","shallow-CBC3K1uB.js","getApiPlaygroundDisplay-4tKcUAYo.js","CodeSnippet-C1Xa06ft.js","CodeSnippets-vqiz27A_.js","Page-DeQN5MDd.js","getPastedJson-NUwRfM32.js","icon-DkIVqWh9.js","MethodPill-qmhT7_wz.js","DuplicateIcon-_gWp1vhn.js","createIcon-NA1p_TVA.js","DynamicMarkdown-Bas9A7wq.js","SectionHeading-a1cS-24U.js","axios-vUo_bRtp.js","Markdown-D3ZTwq_a.js","clsx-BcghKhHb.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B66mVNPp.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DmooSyTN.js"]}