{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Circle Docs","description":"Developer documentation for Circle's developer tools","colors":{"primary":"#0073C3","light":"#90D2FF","dark":"#0073C3"},"logo":{"light":"https://mintcdn.com/circle-167b8d39/K2XWSLhaeRomzNa1/logo/light.svg?fit=max\u0026auto=format\u0026n=K2XWSLhaeRomzNa1\u0026q=85\u0026s=decfb42837e0eb7c32dd425866902e78","dark":"https://mintcdn.com/circle-167b8d39/K2XWSLhaeRomzNa1/logo/dark.svg?fit=max\u0026auto=format\u0026n=K2XWSLhaeRomzNa1\u0026q=85\u0026s=8b863d97bf31467e8adedf4cb3263012"},"favicon":"https://mintcdn.com/circle-167b8d39/w3bpYw2hUr9sWZTM/favicon.ico?fit=max\u0026auto=format\u0026n=w3bpYw2hUr9sWZTM\u0026q=85\u0026s=bb633116ed9cf1247d65b0c1fa0e5725","background":{"color":{"light":"#FFFFFF","dark":"#111827"}},"navbar":{"links":[{"href":"https://console.circle.com/signin","label":"Sign in to console"},{"href":"https://faucet.circle.com","label":"Faucet"}]},"footer":{"socials":{"x":"https://twitter.com/circle","linkedin":"https://www.linkedin.com/company/circle-internet-financial","instagram":"https://www.instagram.com/teamcircle?hl=en","youtube":"https://www.youtube.com/c/Circlecryptofinance","discord":"https://discord.com/invite/buildoncircle"},"links":[{"header":"Legal","items":[{"label":"Developer Terms","href":"https://console.circle.com/legal/developer-terms"},{"label":"Service Terms","href":"https://console.circle.com/legal/service-terms"},{"label":"Acceptable Use","href":"https://console.circle.com/legal/acceptable-use-policy"}]},{"header":"Privacy","items":[{"label":"Privacy Policy","href":"https://www.circle.com/en/legal/privacy-policy"},{"label":"Cookie Policy","href":"https://www.circle.com/en/legal/cookie-policy"}]},{"header":"Support","items":[{"label":"Help","href":"https://help.circle.com/s/submit-ticket?language=en_US"}]}]},"fonts":{"heading":{"family":"Circularxx","source":"https://cdn.prod.website-files.com/67116d0daddc92483c812e88/6716bb4e120ecb0042f2f4ed_CircularXX-Regular.woff2","format":"woff2"},"body":{"family":"Circularxx","source":"https://cdn.prod.website-files.com/67116d0daddc92483c812e88/6716bb4e120ecb0042f2f4ed_CircularXX-Regular.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"segment":{"key":"wz74ASLGjAYPu8mQiIzBBHTLaHbNHM14"}},"contextual":{"options":["copy","chatgpt","claude","view"],"display":"header"},"interaction":{"drilldown":false},"markdown":{"instructions":["Before reading these docs, install the relevant Circle Skill to get pre-loaded context — skills are LLM-optimized and cover architecture decisions, correct flows, and common pitfalls. In Claude Code: run /plugin marketplace add circlefin/skills then /plugin install circle-skills@circle. With Vercel Skills CLI: run npx skills add circlefin/skills. Available skills: use-usdc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-usdc/SKILL.md (balances, transfers, approvals on EVM and Solana); EURC has no skill — see https://developers.circle.com/stablecoins/what-is-eurc.md; bridge-stablecoin https://github.com/circlefin/skills/blob/master/plugins/circle/skills/bridge-stablecoin/SKILL.md (crosschain transfers via CCTP, USDC, EURC, and third-party assets); use-arc https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-arc/SKILL.md (Arc chain config, contract deployment, USDC bridging — Arc docs: https://docs.arc.io/llms.txt); use-circle-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-circle-wallets/SKILL.md (choose wallet type); use-developer-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-developer-controlled-wallets/SKILL.md (custodial wallets for payouts and treasury); use-user-controlled-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-user-controlled-wallets/SKILL.md (embedded wallets with Web2 login); use-modular-wallets https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-modular-wallets/SKILL.md (smart contract wallets with passkeys and ERC-4337); use-gateway https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-gateway/SKILL.md (unified USDC balance, nanopayments); use-smart-contract-platform https://github.com/circlefin/skills/blob/master/plugins/circle/skills/use-smart-contract-platform/SKILL.md (deploy, interact, monitor contracts). Pair any skill with the Circle MCP server for live SDK signatures, contract addresses, and chain IDs: {\"mcpServers\":{\"circle\":{\"url\":\"https://api.circle.com/v1/codegen/mcp\"}}}.","Read the product overview first. Each product has an overview explaining when and why to use it. Read it before quickstarts.","Pick the right wallet type. Developer-controlled (you hold keys), user-controlled (end user holds keys via PIN/social login), or modular (smart contract wallets with passkeys). See https://developers.circle.com/wallets.md.","Use CCTP V2 for crosschain transfers. CCTP natively transfers USDC and EURC via burn-and-mint, and supports permissionless wrapping of third-party assets via lock-and-mint. V1 is legacy; always use V2 unless V1 is specified or the chain requires it (Noble, Sui, and Aptos still require V1). Migration guide: https://developers.circle.com/cctp/migration-from-v1-to-v2.md.","Use Bridge Kit for frontend bridging. Wraps CCTP with a simpler SDK for user-facing apps. Use CCTP directly for backend transfers.","Gas Station vs Paymaster. Gas Station sponsors gas for Circle Wallet transactions. Paymaster lets users pay gas in USDC. Different use cases — read both overviews.","Gateway Nanopayments for sub-cent payments. Gasless USDC micropayments down to $0.000001 via x402 and batched settlement. For pay-per-request APIs, AI agent payments, streaming.","Look up USDC addresses per chain. Never hardcode — use https://developers.circle.com/stablecoins/usdc-contract-addresses.md.","Prefer SDKs over raw API calls. Node.js and Python SDKs handle auth, retries, and errors.","API key required. Bearer token in Authorization header. Testnet and mainnet use separate keys and may use different base URLs depending on the product.","Set up webhooks when available. Most operations are async. Webhooks deliver transaction confirmations and state changes.","When calling list endpoints, paginate using pageSize and pageAfter until no nextPageAfter cursor is returned—stopping at the first page silently misses records.","Building an AI agent? Start with the Agent Stack—Circle CLI, agent wallets, and nanopayments built for autonomous use cases: https://developers.circle.com/agent-stack.md."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"circle-167b8d39","hasAudioNarration":false,"actualSubdomain":"circle-167b8d39","customDomains":["developers.circle.com"],"gitSource":{"type":"github","owner":"crcl-main","repo":"circle-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4fc8d4cb09384c14fb2c5","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API reference","count":610},{"language":"default","tag":"Circle Payments Network","count":166},{"language":"default","tag":"Wallets","count":159},{"language":"default","tag":"Mint and Custody","count":131},{"language":"default","tag":"Digital Asset Accounts","count":118},{"language":"default","tag":"StableFX","count":108},{"language":"default","tag":"Liquidity services","count":107},{"language":"default","tag":"Crosschain transfers","count":102},{"language":"default","tag":"Payments","count":94},{"language":"default","tag":"Managed Payments","count":86}]},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"instinct-self-updating-docs","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"snippets/SDKCard.css","content":".cb-card{border:1px solid #e5e7eb;border-radius:12px;background:white;box-shadow:0 1px 3px 0 rgba(0, 0, 0, 0.1)}.cb-icon-circle{display:flex;align-items:center;justify-content:center;border-radius:50%;flex-shrink:0}.accent-orange{background-color:#fff7ed;color:#ea580c}.accent-blue{background-color:#eff6ff;color:#2563eb}.accent-green{background-color:#f0fdf4;color:#16a34a}.accent-purple{background-color:#faf5ff;color:#9333ea}.accent-violet{background-color:#f5f3ff;color:#7c3aed}.type-header-xs{font-size:18px;font-weight:600;line-height:1.4;color:#111827}.type-body-base{font-size:14px;line-height:1.5;color:#6b7280}.type-body-xs-bold{font-size:12px;font-weight:600;text-transform:uppercase;letter-spacing:0.05em;color:#6b7280}.type-body-sm{font-size:14px;line-height:1.5;color:#374151}.type-body-sm-bold{font-size:14px;font-weight:600;line-height:1.5}.text-neutral-subtle{color:#6b7280}.text-icon-neutral{color:#6b7280}.cb-button{display:inline-flex;align-items:center;padding:8px 16px;border-radius:8px;font-size:14px;font-weight:500;text-decoration:none;transition:all 0.2s;border:1px solid #e5e7eb;background:white;color:#374151}.cb-button:hover{background:#f9fafb;border-color:#d1d5db}"},{"filePath":"style.css","content":":root{--background-dark: 17 24 39 !important}html.dark .card{background-color:#111827!important}html.dark .accordion{background-color:#111827!important}#navbar [data-component-name=\"theme-toggle\"],#navbar a[href*=\"console.circle.com\"],#navbar a[href*=\"faucet.circle.com\"],#navbar .navbar-link a{background-color:rgba(17, 24, 39, 0.03)!important}#navbar [data-component-name=\"theme-toggle\"]:hover,#navbar a[href*=\"console.circle.com\"]:hover,#navbar a[href*=\"faucet.circle.com\"]:hover,#navbar .navbar-link a:hover{background-color:rgba(17, 24, 39, 0.07)!important}@media (prefers-color-scheme: dark){#navbar [data-component-name=\"theme-toggle\"],#navbar a[href*=\"console.circle.com\"],#navbar a[href*=\"faucet.circle.com\"],#navbar .navbar-link a{background-color:rgba(255, 255, 255, 0.05)!important}#navbar [data-component-name=\"theme-toggle\"]:hover,#navbar a[href*=\"console.circle.com\"]:hover,#navbar a[href*=\"faucet.circle.com\"]:hover,#navbar .navbar-link a:hover{background-color:rgba(255, 255, 255, 0.10)!important}}html.dark #navbar [data-component-name=\"theme-toggle\"],html.dark #navbar a[href*=\"console.circle.com\"],html.dark #navbar a[href*=\"faucet.circle.com\"],html.dark #navbar .navbar-link a{background-color:rgba(255, 255, 255, 0.05)!important}html.dark #navbar [data-component-name=\"theme-toggle\"]:hover,html.dark #navbar a[href*=\"console.circle.com\"]:hover,html.dark #navbar a[href*=\"faucet.circle.com\"]:hover,html.dark #navbar .navbar-link a:hover{background-color:rgba(255, 255, 255, 0.10)!important}html.dark #topbar-cta-button,html.dark #topbar-cta-button a{color:#000000!important}html.dark #feedback-form-submit{color:#000000!important}html.dark tryit-button{color:#000000!important}html.dark chat-assistant-send-button{color:#000000!important}html.dark contextual-feedback-form-submit-button{color:#000000!important}html.dark code-snippet-feedback-form-submit-button{color:#000000!important}html.dark a[class*=\"bg-[#5FBFFF]\"],html.dark a[class*=\"bg-[#90D2FF]\"],html.dark a[class*=\"bg-[#1AA3FF]\"],html.dark a[class*=\"bg-[#0073C3]\"]{color:#000000!important}html.dark a[class*=\"bg-[#5FBFFF]\"] svg,html.dark a[class*=\"bg-[#90D2FF]\"] svg,html.dark a[class*=\"bg-[#1AA3FF]\"] svg,html.dark a[class*=\"bg-[#0073C3]\"] svg{color:#000000!important}.mcp-setup-container{display:flex;flex-wrap:wrap;gap:24px;margin:20px 0 28px}.mcp-setup-section{display:flex;flex-direction:column;gap:8px}.mcp-setup-label{font-size:0.75rem;font-weight:500;text-transform:uppercase;letter-spacing:0.05em;color:#64748b}.dark .mcp-setup-label{color:#94a3b8}.mcp-cta-group{display:flex;flex-wrap:wrap;gap:10px}.mcp-cta{height:40px;border-radius:12px;font-weight:600;font-size:0.875rem;padding:0 16px;text-decoration:none!important;display:inline-flex;align-items:center;gap:8px;border:1px solid rgba(15, 23, 42, 0.15);background-color:#f8fafc;color:#0b0f19;transition:background-color 0.15s ease, border-color 0.15s ease;cursor:pointer}.mcp-cta:hover{background-color:#f1f5f9;border-color:rgba(15, 23, 42, 0.25)}.mcp-cta img{width:20px;height:20px;object-fit:contain;border-radius:6px;flex-shrink:0}.mcp-cta span{white-space:nowrap}.dark .mcp-cta{border-color:rgba(255, 255, 255, 0.2);background-color:rgba(255, 255, 255, 0.08);color:#f8fafc}.dark .mcp-cta:hover{background-color:rgba(255, 255, 255, 0.12);border-color:rgba(255, 255, 255, 0.3)}.mcp-cta-cli{background-color:#f1f5f9;border-color:#e2e8f0}.mcp-cta-cli:hover{background-color:#e2e8f0;border-color:#cbd5e1}.dark .mcp-cta-cli{background-color:rgba(255, 255, 255, 0.06);border-color:rgba(255, 255, 255, 0.15)}.dark .mcp-cta-cli:hover{background-color:rgba(255, 255, 255, 0.1);border-color:rgba(255, 255, 255, 0.25)}.mcp-cli-label{font-weight:600;color:#0f172a}.dark .mcp-cli-label{color:#f1f5f9}.mcp-cli-cmd{font-size:0.75rem;font-family:ui-monospace, SFMono-Regular, \"SF Mono\", Menlo, Consolas, monospace;color:#64748b;background:transparent!important;padding:0;white-space:nowrap;border:none}.dark .mcp-cli-cmd{color:#94a3b8;background:transparent!important}.mcp-cli-icon-wrap{display:flex;align-items:center;justify-content:center;flex-shrink:0;width:14px;height:14px;position:relative}.mcp-cli-icon-wrap svg{color:#94a3b8;transition:opacity 0.15s ease}.mcp-cta-cli:hover .mcp-cli-icon-wrap svg{color:#64748b}.dark .mcp-cli-icon-wrap svg{color:#64748b}.dark .mcp-cta-cli:hover .mcp-cli-icon-wrap svg{color:#94a3b8}.mcp-icon-check{position:absolute;opacity:0;color:#22c55e!important}.mcp-cta-cli.copied .mcp-icon-copy{opacity:0}.mcp-cta-cli.copied .mcp-icon-check{opacity:1}.dark .mcp-cli-openai-logo{filter:invert(1)}table thead{text-align:left;background-color:#f5f5f8}.dark table thead{text-align:left;background-color:#29233b}table thead th,table td{padding:8px!important}.accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]){background-color:#e1f2ff!important;border-color:#c9e1f5!important}.accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary{transition:background-color 0.3s ease!important}.accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary:hover{background-color:#c9e1f5!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]){background-color:#1f1a30!important;border-color:#29233b!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary{transition:background-color 0.3s ease!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) summary:hover{background-color:#29233b!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-title\"]{color:#ffffff!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"]{color:#e5e7eb!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"] a{color:#1aa3ff!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"] a:hover{color:#1894e8!important}.dark .accordion:has([data-component-part=\"accordion-icon\"] svg[style*=\"circle-info.svg\"]) [data-component-part=\"accordion-content\"] code{color:#fbbf24!important;background-color:#374151!important}.TryItOutComponent pre,.TryItOutComponent code{background-color:transparent!important}.TryItOutComponent .code-container{background-color:white!important}.dark .TryItOutComponent .code-container{background-color:#29233b!important}.home_code_container .code-block{margin:0!important;height:100%}.home_code_container .code-block .code-block-background{height:100%!important}.home_mint_cards a.card>div{padding:20px!important}.home_mint_cards h2{color:#29233b!important}.home_mint_cards div.prose span{color:#6b6580!important}.dark .home_mint_cards h2{color:#fff!important}.dark .home_mint_cards div.prose span{color:#9ca3af!important}.home_mint_cards a.card svg{background-color:#6b6580!important}.home_mint_cards a.card:hover svg{background:linear-gradient(135deg, #5fbfff 0%, #b090f5 100%)!important}.home_tryitout{background:linear-gradient(\n 89deg,\n var(\n --background-gradient-bg-accent-purple-gradient-bottom-left,\n rgba(241, 235, 255, 0.5)\n )\n 0%,\n var(\n --background-gradient-bg-accent-purple-gradient-top-right,\n rgba(225, 242, 255, 0.5)\n )\n 94.58%\n )}.dark .home_tryitout{background:linear-gradient(\n 89deg,\n var(\n --background-gradient-bg-accent-purple-gradient-bottom-left,\n rgba(44, 44, 44, 0.5)\n )\n 0%,\n var(\n --background-gradient-bg-accent-purple-gradient-top-right,\n rgba(75, 82, 86, 0.5)\n )\n 94.58%\n )}.quickstart-cards-aligned [data-component-part=\"card-group\"]{gap:16px!important}.asset-card-grid{display:grid;grid-template-columns:repeat(auto-fit, minmax(220px, 1fr));gap:1.5rem;margin:1.5rem 0;align-items:stretch}.asset-card{border:1px solid #e5e7eb;border-radius:1rem;background:transparent;padding:1rem 1.25rem 1.5rem;text-decoration:none;color:inherit;display:flex;flex-direction:column;justify-content:space-between;gap:0.45rem;transition:border-color 0.2s ease, box-shadow 0.2s ease, transform 0.2s ease;height:100%}.asset-card:hover{border-color:#cfd3dc;box-shadow:0 12px 24px rgba(15, 23, 42, 0.08);transform:translateY(-2px)}.dark .asset-card{border-color:rgba(148, 163, 184, 0.14);background:transparent;box-shadow:none}.asset-card h3{font-size:1.125rem;font-weight:600;margin:0;color:#0f172a}.dark .asset-card h3{color:#f8fafc}.asset-card p{margin:0;font-weight:300;color:#475569}.dark .asset-card p{color:#b8b8b8}.asset-card-image-wrapper,.asset-card-inline-icon{width:56px;height:56px;border-radius:9999px;margin-bottom:0.6rem;flex-shrink:0}.asset-card-image-wrapper{overflow:hidden;display:flex;align-items:center;justify-content:center;background:rgba(15, 23, 42, 0.05)}.dark .asset-card-image-wrapper{background:rgba(248, 250, 252, 0.08)}.asset-card-image{width:100%;height:100%;object-fit:cover;display:block}.asset-card-inline-icon{padding:10px;display:flex;align-items:center;justify-content:center;background:linear-gradient(\n 135deg,\n rgba(0, 96, 255, 0.18),\n rgba(0, 164, 255, 0.05)\n );color:#0d5be1}.dark .asset-card-inline-icon{background:rgba(255, 255, 255, 0.08);color:#82b7ff}.asset-card-inline-icon svg{width:26px;height:26px}.asset-card.secondary{justify-content:flex-start}.quickstart-cards-aligned a.card,.quickstart-cards-aligned [data-component-part=\"card\"]{display:flex!important;flex-direction:column!important;height:100%!important}.quickstart-cards-aligned a.card>div,.quickstart-cards-aligned [data-component-part=\"card\"]>div{display:flex!important;flex-direction:column!important;height:100%!important}.quickstart-cards-aligned a.card>div>.prose,.quickstart-cards-aligned [data-component-part=\"card\"]>div>.prose{flex-grow:1!important;display:flex!important;flex-direction:column!important}.quickstart-cards-aligned a.card>div>div:last-child,.quickstart-cards-aligned [data-component-part=\"card\"]>div>div:last-child{margin-top:auto!important}@media (max-width: 1024px){div.quickstart-cards-aligned,.quickstart-cards-aligned{display:flex!important;flex-direction:column!important;gap:4px!important}div.quickstart-cards-aligned [data-component-part=\"card-group\"],div.quickstart-cards-aligned>div,.quickstart-cards-aligned [data-component-part=\"card-group\"],.quickstart-cards-aligned>div{display:flex!important;flex-direction:column!important;gap:4px!important;row-gap:4px!important;grid-row-gap:4px!important;width:100%!important}div.quickstart-cards-aligned a.card,.quickstart-cards-aligned a.card,.quickstart-cards-aligned [data-component-part=\"card\"]{margin-bottom:4px!important;width:100%!important}div.quickstart-cards-aligned a.card:last-child,.quickstart-cards-aligned a.card:last-child,.quickstart-cards-aligned [data-component-part=\"card\"]:last-child{margin-bottom:0!important}}footer,footer>div,footer [data-component-part=\"footer\"],footer [data-component-part=\"footer-section\"]{overflow-x:hidden!important;max-width:100%!important;padding-top:1.75rem!important}footer a,footer [data-component-part=\"footer-link\"],footer .footer-link,#your-privacy-choices-button{overflow-wrap:normal!important;word-wrap:normal!important;word-break:keep-all!important;hyphens:none!important;font-size:0.75rem!important;white-space:normal!important;max-width:100%!important;line-height:1.4!important;min-width:0!important}#footer a,#your-privacy-choices-button{color:#6B6580!important}html.dark #footer a,html.dark #your-privacy-choices-button{color:#8A849C!important}#footer a:hover,#your-privacy-choices-button:hover{color:#4E4763!important}html.dark #footer a:hover,html.dark #your-privacy-choices-button:hover{color:#A7A3B5!important}#your-privacy-choices-button{position:relative;align-self:start}footer .md\\:items-center>div:has(>#your-privacy-choices-button){align-self:flex-start!important}#your-privacy-choices-button::after{content:url(\"https://6778953.fs1.hubspotusercontent-na1.net/hubfs/6778953/legal/opt-out-30x14.svg\");right:-34px;position:absolute}#footer>div{gap:12px;padding-bottom:20px}#footer a[href*=\"mintlify\"],#footer a[href*=\"mintlify\"] span,#footer a[href*=\"mintlify\"] svg{color:#6B6580!important;fill:currentColor!important}html.dark #footer a[href*=\"mintlify\"],html.dark #footer a[href*=\"mintlify\"] span,html.dark #footer a[href*=\"mintlify\"] svg{color:#8A849C!important}#footer a[href*=\"mintlify\"]:hover,#footer a[href*=\"mintlify\"]:hover span,#footer a[href*=\"mintlify\"]:hover svg{color:#4E4763!important}html.dark #footer a[href*=\"mintlify\"]:hover,html.dark #footer a[href*=\"mintlify\"]:hover span,html.dark #footer a[href*=\"mintlify\"]:hover svg{color:#A7A3B5!important}#footer .gap-4.min-w-\\[140px\\].max-w-\\[492px\\].flex-wrap.hidden.md\\:flex:has([data-powered-by-relocated]){flex:0 0 auto!important;width:auto!important;max-width:200px!important}#footer [data-powered-by-relocated]{flex:0 0 100%!important;display:flex!important;justify-content:flex-end!important;margin-top:0.25rem!important}#footer [data-powered-by-relocated] a[href*=\"mintlify\"]{font-size:0.75rem!important}#footer [data-powered-by-relocated] a[href*=\"mintlify\"] svg{height:0.75rem!important;width:auto!important}#footer [data-powered-by-relocated]>*:not(:has(a[href*=\"mintlify\"])){display:none!important}@media (max-width: 767px){#footer .gap-4.min-w-\\[140px\\].max-w-\\[492px\\].flex-wrap.hidden.md\\:flex{display:flex!important;justify-content:flex-end!important}#footer .gap-4.min-w-\\[140px\\].max-w-\\[492px\\].flex-wrap.hidden.md\\:flex>a{display:none!important}}#footer svg[style*=\"mask-image\"]{background-color:#6B6580!important}html.dark #footer svg[style*=\"mask-image\"]{background-color:#8A849C!important}#footer a:hover svg[style*=\"mask-image\"]{background-color:#4E4763!important}html.dark #footer a:hover svg[style*=\"mask-image\"]{background-color:#A7A3B5!important}"}],"page":{"pagePath":"api-reference/digital-asset-accounts/all/update-account","slug":"/api-reference/digital-asset-accounts/all/update-account","pageMetadata":{"openapi":"openapi/accounts.yaml put /v1/accounts/{accountId}","title":"Update an account","description":"Updates mutable fields on an account. Only fields present in the\nrequest body are changed; omitted fields are left untouched.\n","href":"/api-reference/digital-asset-accounts/all/update-account"},"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: \"Updates mutable fields on an account. Only fields present in the\\nrequest body are changed; omitted fields are left untouched.\"\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":{"openapi":"openapi/accounts.yaml put /v1/accounts/{accountId}","title":"Update an account","description":"Updates mutable fields on an account. Only fields present in the\nrequest body are changed; omitted fields are left untouched.\n","href":"/api-reference/digital-asset-accounts/all/update-account"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/circle-167b8d39/d67aae5e94f8afee/content/gtm.js","/_mintlify/custom/circle-167b8d39/df50992471c6ad37/content/footer-powered-by.js","/_mintlify/custom/circle-167b8d39/749fc460434d1999/circle-fees.js"],"openApiReferenceData":{"operation":{"security":["78991be7-2d4f-44b9-9b04-f3e3374e0b20"],"parameters":["ec9de5e6-787f-4cb7-9305-75e484b45bbb"],"summary":"Update an account","description":"Updates mutable fields on an account. Only fields present in the\nrequest body are changed; omitted fields are left untouched.\n","operationId":"updateAccount","tags":["Accounts"],"requestBody":"2bf26f03-ff1a-4bda-8270-6d9174084bda","responses":{"200":"90445196-fad7-4561-84bd-3c346a0ce057","400":"228ae8dd-1b2f-4528-a49e-f4c3aa031552","401":"a97f05e3-5db9-4a66-9503-1fe018f65f02","404":"a78cb431-f3e5-44fb-a9ee-871266fb14a4","500":"71d8f785-43c2-4d7e-b025-9a5934c5fe6e"},"method":"put","type":"path","servers":["424b41df-3440-49f0-a7fd-8240348ca490","536c9ff2-a31d-440f-a942-25b96b035831"],"path":"/v1/accounts/{accountId}","baseUrlOptions":["https://api-sandbox.circle.com","https://api.circle.com"],"title":"Update an account","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ec9de5e6-787f-4cb7-9305-75e484b45bbb":{"name":"accountId","description":"Identifier of the account.","in":"path","required":true,"schema":{"type":"string","example":"1000565227","isRequired":true,"description":"Identifier of the account.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Mutable account fields. All fields are optional; only fields present in the request body are updated. Omitting a field leaves it unchanged.\n","properties":{"description":{"type":"string","description":"Human-readable account description.","maxLength":255,"example":"Treasury US","uniqueKey":"description","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"description":"Treasury US"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"90445196-fad7-4561-84bd-3c346a0ce057":{"description":"Successfully updated the account.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"title":"UpdateAccountResponse","properties":{"data":{"type":"object","description":"An account exposed by the Accounts API.","required":["accountId","entityId","type","purpose","status","description","balances"],"properties":{"accountId":{"type":"string","description":"Identifier of the account.","example":"1000662322","isRequired":true,"uniqueKey":"data.accountId","typeLabel":"string"},"entityId":{"type":"string","format":"uuid","description":"Identifier of the owning entity.","example":"a49f9b1d-75e0-44a9-b8d2-4293b3f11ebd","isRequired":true,"uniqueKey":"data.entityId","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"External account type.\n\n- `first_party`: the calling entity itself owns the account.\n- `third_party`: a sub-entity or end user owns the account.\n","enum":["first_party","third_party"],"example":"first_party","isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"purpose":{"type":"string","description":"Intended use of the account.\n\n- `custody`: the account holds stablecoin balances for the owning\n entity. This is the default for new accounts.\n\n- `payments`: the account is used for Managed Payments products.\n","enum":["custody","payments"],"example":"custody","isRequired":true,"uniqueKey":"data.purpose","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Lifecycle status of the account.\n\n- `active`: account is fully operational.\n- `pending`: account has been created but is not yet operational.\n- `rejected`: account creation was rejected and the account cannot be used.\n- `archived`: account has been archived and is excluded from default\n listings. Most mutating operations on the account (transfers, withdrawals,\n new address generation, etc.) are blocked while archived.\n","enum":["active","pending","rejected","archived"],"example":"active","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Human-readable description of the account.","example":"End User Wallet","isRequired":true,"uniqueKey":"data.description","typeLabel":"string"},"balances":{"type":"array","description":"Balances currently associated with the account.","items":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"Magnitude of the amount, in units of the currency, with a `.`.","example":"3.14","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","description":"Currency code for the amount. `ETH` appears only in responses, as the native value of `contract_execution` activity on ETH-native chains.\n","example":"USD","enum":["USD","EUR","ETH"],"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.balances.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.balances","typeLabel":"object[]"},"clientEntityId":{"type":"string","format":"uuid","description":"Identifier of the client entity, if applicable.","example":"a3f1b2c4-d5e6-7890-abcd-ef1234567890","uniqueKey":"data.clientEntityId","typeLabel":"string\u003cuuid>"},"custodyType":{"type":"string","description":"How the account's assets are held.\n\n- `omnibus`: Circle holds the assets in a pooled account. This is the default\n for new accounts.\n\n- `self`: a non-custodial account. The end user authorizes changes\n with the authorization key registered through the Digital Asset Accounts SDK.\n `self` (non-custodial) is available in sandbox only. Production\n non-custodial accounts are on the roadmap.\n","enum":["omnibus","self"],"example":"omnibus","uniqueKey":"data.custodyType","typeLabel":"enum\u003cstring>"},"endCustomerType":{"type":"string","description":"Type of end customer attributed to a Managed Payments intermediary account. Omitted for accounts that are not Managed Payments intermediary accounts.\n","enum":["business","individual"],"example":"individual","uniqueKey":"data.endCustomerType","typeLabel":"enum\u003cstring>"},"businessPii":{"type":"object","description":"PII for the business sub-client associated with a Managed Payments intermediary account. Omitted for accounts that are not Managed Payments intermediary accounts.\n","required":["businessName","businessUniqueIdentifier","identifierIssuingCountryCode","address"],"properties":{"businessName":{"type":"string","example":"Acme Corporation","isRequired":true,"uniqueKey":"data.businessPii.businessName","typeLabel":"string"},"businessUniqueIdentifier":{"type":"string","description":"e.g. EIN or company registration number.","example":"12-3456789","isRequired":true,"uniqueKey":"data.businessPii.businessUniqueIdentifier","typeLabel":"string"},"identifierIssuingCountryCode":{"type":"string","description":"ISO 3166-1 alpha-2.","example":"US","isRequired":true,"uniqueKey":"data.businessPii.identifierIssuingCountryCode","typeLabel":"string"},"address":{"type":"object","description":"Physical address of the end customer being onboarded.","required":["line1","city","postalCode","country"],"properties":{"line1":{"type":"string","description":"Address line 1.","example":"100 Pine Street","isRequired":true,"uniqueKey":"data.businessPii.address.line1","typeLabel":"string"},"city":{"type":"string","example":"San Francisco","isRequired":true,"uniqueKey":"data.businessPii.address.city","typeLabel":"string"},"postalCode":{"type":"string","example":"94111","isRequired":true,"uniqueKey":"data.businessPii.address.postalCode","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US","isRequired":true,"uniqueKey":"data.businessPii.address.country","typeLabel":"string"},"line2":{"type":"string","description":"Address line 2 (optional).","example":"Suite 2500","uniqueKey":"data.businessPii.address.line2","typeLabel":"string"},"district":{"type":"string","description":"State or province code.","example":"CA","uniqueKey":"data.businessPii.address.district","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.businessPii.address","typeLabel":"object"}},"uniqueKey":"data.businessPii","typeLabel":"object"},"individualPii":{"type":"object","description":"PII for the individual (retail) end customer associated with a Managed Payments intermediary account. Present when `endCustomerType` is `individual`. Omitted for accounts that are not Managed Payments intermediary accounts.\n","required":["firstName","lastName","dateOfBirth","address"],"properties":{"firstName":{"type":"string","example":"John","isRequired":true,"uniqueKey":"data.individualPii.firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","isRequired":true,"uniqueKey":"data.individualPii.lastName","typeLabel":"string"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth in `yyyy-MM-dd` format. Must be in the past.","example":"1990-10-23","isRequired":true,"uniqueKey":"data.individualPii.dateOfBirth","typeLabel":"string\u003cdate>"},"address":{"type":"object","description":"Physical address of the end customer being onboarded.","required":["line1","city","postalCode","country"],"properties":{"line1":{"type":"string","description":"Address line 1.","example":"100 Pine Street","isRequired":true,"uniqueKey":"data.individualPii.address.line1","typeLabel":"string"},"city":{"type":"string","example":"San Francisco","isRequired":true,"uniqueKey":"data.individualPii.address.city","typeLabel":"string"},"postalCode":{"type":"string","example":"94111","isRequired":true,"uniqueKey":"data.individualPii.address.postalCode","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US","isRequired":true,"uniqueKey":"data.individualPii.address.country","typeLabel":"string"},"line2":{"type":"string","description":"Address line 2 (optional).","example":"Suite 2500","uniqueKey":"data.individualPii.address.line2","typeLabel":"string"},"district":{"type":"string","description":"State or province code.","example":"CA","uniqueKey":"data.individualPii.address.district","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.individualPii.address","typeLabel":"object"}},"uniqueKey":"data.individualPii","typeLabel":"object"},"createDate":{"type":"string","description":"Timestamp the account was created.","example":"2020-04-10T02:13:30.000Z","uniqueKey":"data.createDate","typeLabel":"string"},"groupId":{"oneOf":[{"type":"string","format":"uuid","description":"Identifier of the custody account group this account belongs to, or `null` if it is not assigned to any group. Each account can belong to at most one group at a time.\n","example":"9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e","uniqueKey":"data.groupId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Identifier of the custody account group this account belongs to, or `null` if it is not assigned to any group. Each account can belong to at most one group at a time.\n","example":"9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e","uniqueKey":"data.groupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.groupId","typeLabel":"string\u003cuuid> | null"},"blockchain":{"type":"string","description":"Home blockchain of a non-custodial account. Set when the account is created and can't be changed. If account creation omits it, the home blockchain is `ARC`. `MATIC` is Polygon PoS. Some other endpoints in this API call it `POLY`; send `MATIC` here. Not every value is available in every environment. A blockchain that isn't available returns `400`.\n","enum":["APTOS","ARB","ARC","AVAX","BASE","ETH","MATIC","MONAD","NEAR","OP","SOL","UNI"],"example":"ARC","uniqueKey":"data.blockchain","typeLabel":"enum\u003cstring>"},"depositAddress":{"type":"string","description":"Address where a non-custodial account receives funds on its home blockchain. Omitted until the address is ready.\n","example":"0x8f3a2b1c4d5e6f708192a3b4c5d6e7f8091a2b3c","uniqueKey":"data.depositAddress","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"UpdateAccountResponse · object"},"examples":{"Example":{"title":"Example","value":{"data":{"accountId":"1000662322","entityId":"a49f9b1d-75e0-44a9-b8d2-4293b3f11ebd","type":"first_party","purpose":"custody","status":"active","description":"End User Wallet","balances":[{"amount":"3.14","currency":"USD"}],"clientEntityId":"a3f1b2c4-d5e6-7890-abcd-ef1234567890","custodyType":"omnibus","endCustomerType":"individual","businessPii":{"businessName":"Acme Corporation","businessUniqueIdentifier":"12-3456789","identifierIssuingCountryCode":"US","address":{"line1":"100 Pine Street","city":"San Francisco","postalCode":"94111","country":"US","line2":"Suite 2500","district":"CA"}},"individualPii":{"firstName":"John","lastName":"Doe","dateOfBirth":"1990-10-23","address":{"line1":"100 Pine Street","city":"San Francisco","postalCode":"94111","country":"US","line2":"Suite 2500","district":"CA"}},"createDate":"2020-04-10T02:13:30.000Z","groupId":"9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e","blockchain":"ARC","depositAddress":"0x8f3a2b1c4d5e6f708192a3b4c5d6e7f8091a2b3c"}}}},"exampleType":"generated"}},"exampleType":"generated"},"228ae8dd-1b2f-4528-a49e-f4c3aa031552":{"description":"The request cannot be processed due to a client error.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"Circle internal status code from the platform `CoreStatusCode` enum (and its domain-specific extensions). **This is not the HTTP status code** — `-1` is the catch-all unknown error, `1`/`2` indicate API parameter problems, `3` is forbidden, `4` is unauthorized, and larger values identify domain-specific failures. Consumers should rely on the HTTP status line for transport-level error class and on this field for the specific Circle error case.\n","example":2,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Internal error message; suitable for logging but not for end-user display.","example":"API parameter invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"externalMessage":{"type":"string","description":"End-user-displayable error message. Present when the server has generated a customer-facing variant for this error; omitted otherwise.\n","example":"The provided amount exceeds the maximum allowed.","uniqueKey":"externalMessage","typeLabel":"string"},"errors":{"type":"array","description":"Additional request-field validation errors, when available.","items":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error identifier.","example":"invalid_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the specific error.","example":"The operation and assetType combination is invalid.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Query parameter or request field that caused the error.","example":"assetType","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":2,"message":"API parameter invalid."},"examples":{"Example":{"title":"Example","value":{"code":2,"message":"API parameter invalid."}}},"exampleType":"examples"}},"exampleType":"examples"},"a97f05e3-5db9-4a66-9503-1fe018f65f02":{"description":"The request has not been applied because it lacks valid authentication credentials.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"Circle internal status code from the platform `CoreStatusCode` enum (and its domain-specific extensions). **This is not the HTTP status code** — `-1` is the catch-all unknown error, `1`/`2` indicate API parameter problems, `3` is forbidden, `4` is unauthorized, and larger values identify domain-specific failures. Consumers should rely on the HTTP status line for transport-level error class and on this field for the specific Circle error case.\n","example":2,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Internal error message; suitable for logging but not for end-user display.","example":"API parameter invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"externalMessage":{"type":"string","description":"End-user-displayable error message. Present when the server has generated a customer-facing variant for this error; omitted otherwise.\n","example":"The provided amount exceeds the maximum allowed.","uniqueKey":"externalMessage","typeLabel":"string"},"errors":{"type":"array","description":"Additional request-field validation errors, when available.","items":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error identifier.","example":"invalid_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the specific error.","example":"The operation and assetType combination is invalid.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Query parameter or request field that caused the error.","example":"assetType","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":4,"message":"Unauthorized."},"examples":{"Example":{"title":"Example","value":{"code":4,"message":"Unauthorized."}}},"exampleType":"examples"}},"exampleType":"examples"},"a78cb431-f3e5-44fb-a9ee-871266fb14a4":{"description":"The specified resource was not found.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"Circle internal status code from the platform `CoreStatusCode` enum (and its domain-specific extensions). **This is not the HTTP status code** — `-1` is the catch-all unknown error, `1`/`2` indicate API parameter problems, `3` is forbidden, `4` is unauthorized, and larger values identify domain-specific failures. Consumers should rely on the HTTP status line for transport-level error class and on this field for the specific Circle error case.\n","example":2,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Internal error message; suitable for logging but not for end-user display.","example":"API parameter invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"externalMessage":{"type":"string","description":"End-user-displayable error message. Present when the server has generated a customer-facing variant for this error; omitted otherwise.\n","example":"The provided amount exceeds the maximum allowed.","uniqueKey":"externalMessage","typeLabel":"string"},"errors":{"type":"array","description":"Additional request-field validation errors, when available.","items":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error identifier.","example":"invalid_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the specific error.","example":"The operation and assetType combination is invalid.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Query parameter or request field that caused the error.","example":"assetType","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":404,"message":"Not found."},"examples":{"Example":{"title":"Example","value":{"code":404,"message":"Not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"71d8f785-43c2-4d7e-b025-9a5934c5fe6e":{"description":"The server encountered an unexpected condition that prevented it from fulfilling the request.","headers":{"X-Request-Id":{"description":"Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support.\n","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"Circle internal status code from the platform `CoreStatusCode` enum (and its domain-specific extensions). **This is not the HTTP status code** — `-1` is the catch-all unknown error, `1`/`2` indicate API parameter problems, `3` is forbidden, `4` is unauthorized, and larger values identify domain-specific failures. Consumers should rely on the HTTP status line for transport-level error class and on this field for the specific Circle error case.\n","example":2,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Internal error message; suitable for logging but not for end-user display.","example":"API parameter invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"externalMessage":{"type":"string","description":"End-user-displayable error message. Present when the server has generated a customer-facing variant for this error; omitted otherwise.\n","example":"The provided amount exceeds the maximum allowed.","uniqueKey":"externalMessage","typeLabel":"string"},"errors":{"type":"array","description":"Additional request-field validation errors, when available.","items":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Machine-readable error identifier.","example":"invalid_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the specific error.","example":"The operation and assetType combination is invalid.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"location":{"type":"string","description":"Query parameter or request field that caused the error.","example":"assetType","uniqueKey":"errors.items.[INDEX].location","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":-1,"message":"Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"},"examples":{"Example":{"title":"Example","value":{"code":-1,"message":"Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"78991be7-2d4f-44b9-9b04-f3e3374e0b20":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"424b41df-3440-49f0-a7fd-8240348ca490":{"url":"https://api-sandbox.circle.com"},"536c9ff2-a31d-440f-a942-25b96b035831":{"url":"https://api.circle.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/accounts.yaml"},"subdomain":"circle-167b8d39","siteName":"Circle Docs","title":"Update an account - Circle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-05T15:50:51.304Z","originalFileLocation":"api-reference/digital-asset-accounts/all/update-account.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=\"Updates mutable fields on an account. Only fields present in the request body are changed; omitted fields are left untouched.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Circle Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_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=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update an account - Circle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates mutable fields on an account. Only fields present in the request body are changed; omitted fields are left untouched.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Circle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://circle-167b8d39.mintlify.site/_mintlify/api/og/v2?division=Accounts\u0026amp;title=Update+an+account\u0026amp;description=Updates+mutable+fields+on+an+account.+Only+fields+present+in+the%0Arequest+body+are+changed%3B+omitted+fields+are+left+untouched.%0A\u0026amp;theme=b86ce57c82f364033d1c00f9\u0026amp;signature=1ba42f64e3fc17307f98e712e36fd14c29633e2699cd1a2e078e8fb4685b461d\">\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=\"Update an account - Circle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates mutable fields on an account. Only fields present in the request body are changed; omitted fields are left untouched.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://circle-167b8d39.mintlify.site/_mintlify/api/og/v2?division=Accounts\u0026amp;title=Update+an+account\u0026amp;description=Updates+mutable+fields+on+an+account.+Only+fields+present+in+the%0Arequest+body+are+changed%3B+omitted+fields+are+left+untouched.%0A\u0026amp;theme=b86ce57c82f364033d1c00f9\u0026amp;signature=1ba42f64e3fc17307f98e712e36fd14c29633e2699cd1a2e078e8fb4685b461d\">\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=\"/mintlify-assets/_mintlify/favicons/circle-167b8d39/NmgH-UQQhRa2ts0q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Circle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0073C3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/digital-asset-accounts/all/update-account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.circle.com/#organization\",\"name\":\"Circle Docs\",\"url\":\"https://developers.circle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/circle-167b8d39/K2XWSLhaeRomzNa1/logo/light.svg?fit=max\u0026auto=format\u0026n=K2XWSLhaeRomzNa1\u0026q=85\u0026s=decfb42837e0eb7c32dd425866902e78\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.circle.com#website\",\"name\":\"Circle Docs\",\"url\":\"https://developers.circle.com\",\"publisher\":{\"@id\":\"https://developers.circle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account#webpage\",\"url\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account\",\"name\":\"Update an account\",\"description\":\"Updates mutable fields on an account. Only fields present in the request body are changed; omitted fields are left untouched.\",\"dateModified\":\"2026-06-05T15:50:51.304Z\",\"isPartOf\":{\"@id\":\"https://developers.circle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accounts\",\"item\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/list-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Accounts\",\"item\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/list-accounts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update an account\",\"item\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account#apireference\",\"headline\":\"Update an account\",\"name\":\"Update an account\",\"description\":\"Updates mutable fields on an account. Only fields present in the request body are changed; omitted fields are left untouched.\",\"url\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account\",\"mainEntityOfPage\":{\"@id\":\"https://developers.circle.com/api-reference/digital-asset-accounts/all/update-account#webpage\"},\"dateModified\":\"2026-06-05T15:50:51.304Z\",\"publisher\":{\"@id\":\"https://developers.circle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.circle.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/digital-asset-accounts/all/update-account.md","siteName":"Circle Docs","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Assets","pages":[{"title":"Assets","href":"/assets"}]},{"tab":"Build onchain","pages":[{"title":"Build onchain","href":"/build-onchain"}]},{"tab":"Crosschain transfers","pages":[{"title":"Crosschain transfers","href":"/crosschain-transfers"}]},{"tab":"Agent stack","pages":[{"title":"Agent stack","href":"/agent-stack"}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/cpn"}]},{"tab":"Liquidity services","pages":[{"title":"Liquidity services","href":"/liquidity-services"}]},{"tab":"API reference","anchors":[{"anchor":"Home","icon":"home","pages":[{"title":"Home","href":"/api-reference"}]},{"anchor":"Wallets","icon":"wallet","pages":[{"title":"Wallets","href":"/api-reference/wallets"}]},{"anchor":"Contracts","icon":"file-contract","pages":[{"title":"Contracts","href":"/api-reference/contracts"}]},{"anchor":"CCTP","icon":"bridge","pages":[{"title":"CCTP","href":"/api-reference/cctp"}]},{"anchor":"Gateway","icon":"dungeon","pages":[{"title":"Gateway","href":"/api-reference/gateway"}]},{"anchor":"x402 facilitators","icon":"handshake","pages":[{"title":"x402 facilitators","href":"/api-reference/x402-facilitators"}]},{"anchor":"Digital Asset Accounts","icon":"money-bill-1-wave","pages":[{"title":"Digital Asset Accounts API","sidebarTitle":"Overview","href":"/api-reference/digital-asset-accounts"},{"group":"Accounts","pages":[{"group":"Accounts","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts","title":"List all accounts","href":"/api-reference/digital-asset-accounts/all/list-accounts"},{"openapi":"openapi/accounts.yaml post /v1/accounts","title":"Create an account","href":"/api-reference/digital-asset-accounts/all/create-account"},{"openapi":"openapi/accounts.yaml get /v1/accounts/{accountId}","title":"Get an account","description":"Retrieves a single account by `accountId`.","href":"/api-reference/digital-asset-accounts/all/get-account"},{"openapi":"openapi/accounts.yaml put /v1/accounts/{accountId}","title":"Update an account","href":"/api-reference/digital-asset-accounts/all/update-account"},{"openapi":"openapi/accounts.yaml post /v1/accounts/{accountId}/archive","title":"Archive an account","description":"Archives a subledger account. The account must have a zero balance. The\ndefault account, which is the first account created for each `clientEntityId`,\ncannot be archived. Archiving it returns `400` with code `2041`, and archiving\nan account with a balance returns `400` with code `2040`.\n\nWhile archived, mutating operations on the account are blocked: transfers\ninto or out of the account, new deposit-address generation, fiat\nwithdrawals, payment-intent creation, and fetching wire instructions are\nall rejected. Read endpoints (e.g. `GET /v1/accounts/{accountId}`,\n`GET /v1/accounts/deposits`) continue to work.\n\nAn archived account is excluded from the default `GET /v1/accounts`\nlisting; pass `status=archived` (or include `archived` in a multi-value\n`status` filter) to retrieve it.\n\nArchiving is idempotent: archiving an already-archived account succeeds.\nAn incoming deposit to a pre-existing deposit address or wire instruction\non the archived account will auto-unarchive it (status returns to\n`active`).\n","href":"/api-reference/digital-asset-accounts/all/archive-account"}]},{"group":"Account Groups","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/groups","title":"List custody account groups","href":"/api-reference/digital-asset-accounts/all/list-account-groups"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups","title":"Create a custody account group","href":"/api-reference/digital-asset-accounts/all/create-account-group"},{"openapi":"openapi/accounts.yaml get /v1/accounts/groups/{groupId}","title":"Get a custody account group","href":"/api-reference/digital-asset-accounts/all/get-account-group"},{"openapi":"openapi/accounts.yaml put /v1/accounts/groups/{groupId}","title":"Update a custody account group","href":"/api-reference/digital-asset-accounts/all/update-account-group"},{"openapi":"openapi/accounts.yaml delete /v1/accounts/groups/{groupId}","title":"Delete a custody account group","href":"/api-reference/digital-asset-accounts/all/delete-account-group"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups/{groupId}/assign","title":"Bulk-assign accounts to a custody account group","href":"/api-reference/digital-asset-accounts/all/assign-accounts-to-group"},{"openapi":"openapi/accounts.yaml post /v1/accounts/groups/{groupId}/unassign","title":"Bulk-unassign accounts from a custody account group","href":"/api-reference/digital-asset-accounts/all/unassign-accounts-from-group"}]},{"group":"Limits","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/{accountId}/limits/usage","title":"List account limits and usage","href":"/api-reference/digital-asset-accounts/all/list-account-limits-usage"}]},{"group":"Transactions","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/transactions","title":"List all account transactions","href":"/api-reference/digital-asset-accounts/all/list-account-transactions"}]}]},{"group":"First-party bank operations","pages":[{"group":"Wires","pages":[{"openapi":"openapi/accounts.yaml get /v1/banks/wires","title":"List all wire bank accounts","href":"/api-reference/digital-asset-accounts/all/list-wire-accounts"},{"openapi":"openapi/accounts.yaml post /v1/banks/wires","title":"Create a wire bank account","href":"/api-reference/digital-asset-accounts/all/create-wire-account"},{"openapi":"openapi/accounts.yaml get /v1/banks/wires/{id}","title":"Get a wire bank account","href":"/api-reference/digital-asset-accounts/all/get-wire-account"},{"openapi":"openapi/accounts.yaml get /v1/banks/wires/{id}/instructions","title":"Get wire instructions","href":"/api-reference/digital-asset-accounts/all/get-wire-account-instructions"}]},{"group":"ACH","pages":[{"openapi":"openapi/accounts.yaml get /v1/banks/ach","title":"List all ACH bank accounts","href":"/api-reference/digital-asset-accounts/all/list-achaccounts"},{"openapi":"openapi/accounts.yaml post /v1/banks/ach","title":"Create an ACH bank account","href":"/api-reference/digital-asset-accounts/all/create-achaccount"},{"openapi":"openapi/accounts.yaml get /v1/banks/ach/{id}","title":"Get an ACH bank account","href":"/api-reference/digital-asset-accounts/all/get-achaccount"},{"openapi":"openapi/accounts.yaml get /v1/banks/ach/{id}/instructions","title":"Get ACH instructions","href":"/api-reference/digital-asset-accounts/all/get-achaccount-instructions"}]},{"group":"Deposits","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/deposits","title":"List all account bank deposits","href":"/api-reference/digital-asset-accounts/all/list-account-deposits"},{"openapi":"openapi/accounts.yaml get /v1/accounts/deposits/{id}","title":"Get an account bank deposit","href":"/api-reference/digital-asset-accounts/all/get-account-deposit"}]},{"group":"Withdrawals","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/withdrawals","title":"List all account bank withdrawals","href":"/api-reference/digital-asset-accounts/all/list-account-withdrawals"},{"openapi":"openapi/accounts.yaml post /v1/accounts/withdrawals","title":"Create an account bank withdrawal","href":"/api-reference/digital-asset-accounts/all/create-account-withdrawal"},{"openapi":"openapi/accounts.yaml get /v1/accounts/withdrawals/{id}","title":"Get an account bank withdrawal","href":"/api-reference/digital-asset-accounts/all/get-account-withdrawal"}]}]},{"group":"First-party crypto operations","pages":[{"group":"Deposit Addresses","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/addresses/deposit","title":"List all account deposit addresses","href":"/api-reference/digital-asset-accounts/all/list-account-deposit-addresses"},{"openapi":"openapi/accounts.yaml post /v1/accounts/addresses/deposit","title":"Create an account deposit address","href":"/api-reference/digital-asset-accounts/all/create-account-deposit-address"},{"openapi":"openapi/accounts.yaml get /v1/accounts/addresses/deposit/{id}","title":"Get an account deposit address","href":"/api-reference/digital-asset-accounts/all/get-account-deposit-address"}]},{"group":"Recipient Addresses","pages":[{"openapi":"openapi/accounts.yaml get /v1/addresses/recipient","title":"List all recipient addresses","href":"/api-reference/digital-asset-accounts/all/list-recipient-addresses"},{"openapi":"openapi/accounts.yaml post /v1/addresses/recipient","title":"Create a recipient address","href":"/api-reference/digital-asset-accounts/all/create-recipient-address"},{"openapi":"openapi/accounts.yaml get /v1/addresses/recipient/{id}","title":"Get a recipient address","href":"/api-reference/digital-asset-accounts/all/get-recipient-address"},{"openapi":"openapi/accounts.yaml delete /v1/addresses/recipient/{id}","title":"Delete a recipient address","href":"/api-reference/digital-asset-accounts/all/delete-recipient-address"},{"openapi":"openapi/accounts.yaml post /v1/addresses/recipient/{id}/verification/resend","title":"Resend a recipient address verification challenge","href":"/api-reference/digital-asset-accounts/all/resend-recipient-verification-challenge"}]},{"group":"Transfers","pages":[{"openapi":"openapi/accounts.yaml get /v1/accounts/transfers","title":"List all account transfers","href":"/api-reference/digital-asset-accounts/all/list-account-transfers"},{"openapi":"openapi/accounts.yaml post /v1/accounts/transfers","title":"Create an account transfer","href":"/api-reference/digital-asset-accounts/all/create-account-transfer"},{"openapi":"openapi/accounts.yaml get /v1/accounts/transfers/{id}","title":"Get an account transfer","href":"/api-reference/digital-asset-accounts/all/get-account-transfer"}]},{"group":"Contract Executions","pages":[{"openapi":"openapi/accounts.yaml post /v1/accounts/contractExecutions","title":"Create a contract execution","href":"/api-reference/digital-asset-accounts/all/create-account-contract-execution"},{"openapi":"openapi/accounts.yaml get /v1/accounts/contractExecutions/{id}","title":"Get a contract execution","href":"/api-reference/digital-asset-accounts/all/get-account-contract-execution"}]}]},{"group":"Third-party crypto operations","pages":[{"group":"Crypto Payment Intents","pages":[{"openapi":"openapi/accounts.yaml get /v1/paymentIntents","title":"List all payment intents","href":"/api-reference/digital-asset-accounts/all/list-payment-intents"},{"openapi":"openapi/accounts.yaml post /v1/paymentIntents","title":"Create a payment intent","href":"/api-reference/digital-asset-accounts/all/create-payment-intent"},{"openapi":"openapi/accounts.yaml get /v1/paymentIntents/{id}","title":"Get a payment intent","href":"/api-reference/digital-asset-accounts/all/get-payment-intent"},{"openapi":"openapi/accounts.yaml post /v1/paymentIntents/{id}/expire","title":"Expire a payment intent","href":"/api-reference/digital-asset-accounts/all/expire-payment-intent"},{"openapi":"openapi/accounts.yaml post /v1/paymentIntents/{id}/refund","title":"Refund a payment intent","href":"/api-reference/digital-asset-accounts/all/refund-payment-intent"}]},{"group":"Crypto Payments","pages":[{"openapi":"openapi/accounts.yaml get /v1/payments","title":"List all crypto payments","href":"/api-reference/digital-asset-accounts/all/list-payments"},{"openapi":"openapi/accounts.yaml get /v1/payments/{id}","title":"Get a crypto payment","href":"/api-reference/digital-asset-accounts/all/get-payment"}]},{"group":"Crypto Address Book","pages":[{"openapi":"openapi/accounts.yaml get /v1/addressBook/recipients","title":"List all address book recipients","href":"/api-reference/digital-asset-accounts/all/list-address-book-recipients"},{"openapi":"openapi/accounts.yaml post /v1/addressBook/recipients","title":"Create an address book recipient","href":"/api-reference/digital-asset-accounts/all/create-address-book-recipient"},{"openapi":"openapi/accounts.yaml get /v1/addressBook/recipients/{id}","title":"Get an address book recipient","href":"/api-reference/digital-asset-accounts/all/get-address-book-recipient"},{"openapi":"openapi/accounts.yaml patch /v1/addressBook/recipients/{id}","title":"Modify an address book recipient","href":"/api-reference/digital-asset-accounts/all/modify-address-book-recipient"},{"openapi":"openapi/accounts.yaml delete /v1/addressBook/recipients/{id}","title":"Delete an address book recipient","href":"/api-reference/digital-asset-accounts/all/delete-address-book-recipient"}]},{"group":"Crypto Payouts","pages":[{"openapi":"openapi/accounts.yaml get /v1/payouts","title":"List all crypto payouts","href":"/api-reference/digital-asset-accounts/all/list-payouts"},{"openapi":"openapi/accounts.yaml post /v1/payouts","title":"Create a crypto payout","href":"/api-reference/digital-asset-accounts/all/create-payout"},{"openapi":"openapi/accounts.yaml get /v1/payouts/{id}","title":"Get a crypto payout","href":"/api-reference/digital-asset-accounts/all/get-payout"}]}]},{"group":"Cross-currency API","pages":[{"group":"FX Trades","pages":[{"openapi":"openapi/accounts.yaml post /v1/exchange/quotes","title":"Create an FX quote","href":"/api-reference/digital-asset-accounts/all/create-fx-quote"},{"openapi":"openapi/accounts.yaml get /v1/exchange/trades","title":"List all FX trades","href":"/api-reference/digital-asset-accounts/all/list-fx-trades"},{"openapi":"openapi/accounts.yaml post /v1/exchange/trades","title":"Create an FX trade","href":"/api-reference/digital-asset-accounts/all/create-fx-trade"},{"openapi":"openapi/accounts.yaml get /v1/exchange/trades/{id}","title":"Get an FX trade","href":"/api-reference/digital-asset-accounts/all/get-fx-trade"}]},{"group":"FX Settlements","pages":[{"openapi":"openapi/accounts.yaml get /v1/exchange/trades/settlements","title":"List all FX settlements","href":"/api-reference/digital-asset-accounts/all/list-fx-settlements"},{"openapi":"openapi/accounts.yaml get /v1/exchange/trades/settlements/{id}","title":"Get an FX settlement","href":"/api-reference/digital-asset-accounts/all/get-fx-settlement"}]}]},{"group":"Notifications","pages":[{"group":"Webhook Subscriptions","pages":[{"openapi":"openapi/accounts.yaml get /v2/notifications/subscriptions","title":"Get all webhook subscriptions","href":"/api-reference/digital-asset-accounts/all/get-subscriptions"},{"openapi":"openapi/accounts.yaml post /v2/notifications/subscriptions","title":"Create a webhook subscription","href":"/api-reference/digital-asset-accounts/all/create-subscription"},{"openapi":"openapi/accounts.yaml get /v2/notifications/subscriptions/{id}","title":"Get a webhook subscription","href":"/api-reference/digital-asset-accounts/all/get-subscription"},{"openapi":"openapi/accounts.yaml patch /v2/notifications/subscriptions/{id}","title":"Update a webhook subscription","href":"/api-reference/digital-asset-accounts/all/update-subscription"},{"openapi":"openapi/accounts.yaml delete /v2/notifications/subscriptions/{id}","title":"Delete a webhook subscription","href":"/api-reference/digital-asset-accounts/all/delete-subscription"},{"openapi":"openapi/accounts.yaml get /v2/notifications/publicKey/{id}","title":"Get a notification signature public key","href":"/api-reference/digital-asset-accounts/all/get-notification-signature"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/accounts.yaml webhook accountContractExecution","title":"Contract execution completed or failed","href":"/api-reference/digital-asset-accounts/all/account-contract-execution"},{"openapi":"openapi/accounts.yaml webhook custodyTransfer","title":"Transfer state change","href":"/api-reference/digital-asset-accounts/all/custody-transfer"},{"openapi":"openapi/accounts.yaml webhook mintDeposits","title":"Deposit state change","href":"/api-reference/digital-asset-accounts/all/mint-deposits"},{"openapi":"openapi/accounts.yaml webhook mintPayout","title":"Payout state change","href":"/api-reference/digital-asset-accounts/all/mint-payout"},{"openapi":"openapi/accounts.yaml webhook mintWire","title":"Wire state change","href":"/api-reference/digital-asset-accounts/all/mint-wire"},{"openapi":"openapi/accounts.yaml webhook mintAddressBookRecipients","title":"Recipient address state change","href":"/api-reference/digital-asset-accounts/all/mint-address-book-recipients"},{"openapi":"openapi/accounts.yaml webhook bankAccountsCreated","title":"Bank account created","href":"/api-reference/digital-asset-accounts/all/bank-accounts-created"},{"openapi":"openapi/accounts.yaml webhook bankAccountsUpdated","title":"Bank account updated","href":"/api-reference/digital-asset-accounts/all/bank-accounts-updated"},{"openapi":"openapi/accounts.yaml webhook bankAccountsDenied","title":"Bank account denied","href":"/api-reference/digital-asset-accounts/all/bank-accounts-denied"}]}]},{"group":"Security","pages":[{"group":"Device Authentication","pages":[{"openapi":"openapi/accounts.yaml post /v1/accounts/auth/loginRequests","title":"Prepare a social login","href":"/api-reference/digital-asset-accounts/all/prepare-social-login"},{"openapi":"openapi/accounts.yaml post /v1/accounts/auth/sessions","title":"Complete a social session","href":"/api-reference/digital-asset-accounts/all/complete-social-session"},{"openapi":"openapi/accounts.yaml post /v1/accounts/auth/deviceKeyRegistration","title":"Complete device registration","href":"/api-reference/digital-asset-accounts/all/complete-device-registration"},{"openapi":"openapi/accounts.yaml get /v1/accounts/auth/context","title":"Get the device context","href":"/api-reference/digital-asset-accounts/all/get-device-context"}]},{"group":"Passkeys","pages":[{"openapi":"openapi/accounts.yaml post /v1/accounts/passkeys/registrations","title":"Open a passkey registration session","href":"/api-reference/digital-asset-accounts/all/open-passkey-registration"},{"openapi":"openapi/accounts.yaml get /v1/accounts/passkeys","title":"List passkeys","href":"/api-reference/digital-asset-accounts/all/list-passkeys"},{"openapi":"openapi/accounts.yaml post /v1/accounts/passkeys","title":"Complete passkey registration","href":"/api-reference/digital-asset-accounts/all/complete-passkey-registration"},{"openapi":"openapi/accounts.yaml delete /v1/accounts/passkeys/{passkeyId}","title":"Revoke a passkey","href":"/api-reference/digital-asset-accounts/all/revoke-passkey"},{"openapi":"openapi/accounts.yaml post /v1/accounts/passkeys/challenges","title":"Create an SCA challenge","href":"/api-reference/digital-asset-accounts/all/create-sca-challenge"}]}]}]},{"anchor":"End User Onboarding","icon":"user-plus","pages":[{"title":"End User Onboarding","href":"/api-reference/end-user-onboarding"}]},{"anchor":"Mint and Custody","icon":"building-columns","pages":[{"title":"Mint and Custody","href":"/api-reference/circle-mint"}]},{"anchor":"Circle Payments Network","icon":"chart-network","pages":[{"title":"Circle Payments Network","href":"/api-reference/cpn"}]},{"anchor":"StableFX","icon":"swap","pages":[{"title":"StableFX","href":"/api-reference/stablefx"}]},{"anchor":"xReserve","icon":"vault","pages":[{"title":"xReserve","href":"/api-reference/xreserve"}]},{"anchor":"Match","pages":[{"title":"Match","href":"/api-reference/circle-match/all/get-account"}]}]},{"tab":"Developer tools","menu":[{"item":"Sample projects","pages":[{"title":"Sample projects","href":"/sample-projects"}]},{"item":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"item":"Release notes","pages":[{"title":"Release notes","href":"/release-notes"}]}],"pages":[{"title":"Developer tools","href":"/sample-projects"}]}]},"basePath":"","title":"Update an account - Circle Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}