User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.
Request body for updating user profile. All fields are optional - include only the fields you want to update.
Request body for updating user profile. All fields are optional - include only the fields you want to update.
timezone
string
User's timezone in IANA format
Example:
"America/New_York"
notificationPreferences
object[]
Notification preferences to update. Supports partial updates: only include the notification types you want to change. For each type included, you can update just 'email', just 'mobile', or both fields. Notification types not included in this array will retain their existing settings.
User's identity verification status and any pending requirements
Show child attributes
capabilities
object[]
required
User's available capabilities and their requirements
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Spritz","colors":{"primary":"#F35130","light":"#FF7954","dark":"#D92F0D"},"logo":{"light":"https://mintcdn.com/spritz/Oo-fWmzSaNcbhJum/logo/light.svg?fit=max\u0026auto=format\u0026n=Oo-fWmzSaNcbhJum\u0026q=85\u0026s=3f82e0ffd2d2c52feefac2c4033878c5","dark":"https://mintcdn.com/spritz/Oo-fWmzSaNcbhJum/logo/dark.svg?fit=max\u0026auto=format\u0026n=Oo-fWmzSaNcbhJum\u0026q=85\u0026s=1e524526e7acb0c02933de3e06bdae06"},"favicon":"https://mintcdn.com/spritz/Oo-fWmzSaNcbhJum/favicon.svg?fit=max\u0026auto=format\u0026n=Oo-fWmzSaNcbhJum\u0026q=85\u0026s=93a2982f7cf7506be67dd928a0cae696","navbar":{"links":[{"href":"https://help.spritz.finance/en/","label":"Support"}],"primary":{"type":"button","label":"Go to App","href":"https://app.spritz.finance"}},"footer":{"socials":{"website":"https://spritz.finance","x":"https://x.com/spritzfinance","discord":"https://discord.gg/spritz"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Help Center","icon":"life-ring","href":"https://help.spritz.finance/en/"},{"anchor":"Website","icon":"globe","href":"https://spritz.finance"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spritz","hasAudioNarration":false,"actualSubdomain":"spritz","customDomains":["docs.spritz.finance"],"gitSource":{"type":"github","owner":"spritz-finance","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae8b5cfde528214ed20a9a3","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":120},{"language":"default","tag":"Guides","count":29},{"language":"default","tag":"Wallet Kit","count":24},{"language":"default","tag":"Core Concepts","count":13},{"language":"default","tag":"Integrator","count":13},{"language":"default","tag":"Sandbox","count":12},{"language":"default","tag":"Bills","count":11},{"language":"default","tag":"Cards","count":8},{"language":"default","tag":"Get Started","count":7},{"language":"default","tag":"Use Cases","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/users/update-the-current-authenticated-user","slug":"/api-reference/users/update-the-current-authenticated-user","pageMetadata":{"title":"Update the current authenticated user","description":"Updates the authenticated user's profile. Both fields are optional - include only what you want to change.\n\n**Updatable fields:**\n- `timezone`: User's timezone in IANA format (e.g., \"America/New_York\")\n- `notificationPreferences`: Array of notification preference updates\n\n**Partial updates for notification preferences:**\nThe `notificationPreferences` array supports partial updates at two levels:\n\n1. **Type-level**: Only include notification types you want to modify. Types not included will keep their existing settings.\n2. **Field-level**: For each type included, you must provide both `email` and `mobile` fields, but only the values you provide will be applied.\n\n**Example - Update just one notification type:**\n```json\n{\n \"notificationPreferences\": [\n { \"type\": \"cardTransaction.approved\", \"email\": false, \"mobile\": true }\n ]\n}\n```\nThis updates only \"cardTransaction.approved\" preferences; all other notification types remain unchanged.\n\n**Example - Update only timezone:**\n```json\n{\n \"timezone\": \"Europe/London\"\n}\n```","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me","href":"/api-reference/users/update-the-current-authenticated-user","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Updates the authenticated user’s profile. Both fields are optional - include only what you want to change.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Updatable fields:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"timezone\"\n }), \": User’s timezone in IANA format (e.g., “America/New_York”)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"notificationPreferences\"\n }), \": Array of notification preference updates\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Partial updates for notification preferences:\"\n }), \"\\nThe \", _jsx(_components.code, {\n children: \"notificationPreferences\"\n }), \" array supports partial updates at two levels:\"]\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Type-level\"\n }), \": Only include notification types you want to modify. Types not included will keep their existing settings.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Field-level\"\n }), \": For each type included, you must provide both \", _jsx(_components.code, {\n children: \"email\"\n }), \" and \", _jsx(_components.code, {\n children: \"mobile\"\n }), \" fields, but only the values you provide will be applied.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example - Update just one notification type:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"5\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"5\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"notificationPreferences\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": [\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" { \"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"type\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"cardTransaction.approved\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \", \"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"email\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"false\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \", \"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"mobile\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"true\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" ]\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"This updates only “cardTransaction.approved” preferences; all other notification types remain unchanged.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example - Update only timezone:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"3\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"3\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"timezone\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Europe/London\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\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":"Update the current authenticated user","description":"Updates the authenticated user's profile. Both fields are optional - include only what you want to change.\n\n**Updatable fields:**\n- `timezone`: User's timezone in IANA format (e.g., \"America/New_York\")\n- `notificationPreferences`: Array of notification preference updates\n\n**Partial updates for notification preferences:**\nThe `notificationPreferences` array supports partial updates at two levels:\n\n1. **Type-level**: Only include notification types you want to modify. Types not included will keep their existing settings.\n2. **Field-level**: For each type included, you must provide both `email` and `mobile` fields, but only the values you provide will be applied.\n\n**Example - Update just one notification type:**\n```json\n{\n \"notificationPreferences\": [\n { \"type\": \"cardTransaction.approved\", \"email\": false, \"mobile\": true }\n ]\n}\n```\nThis updates only \"cardTransaction.approved\" preferences; all other notification types remain unchanged.\n\n**Example - Update only timezone:**\n```json\n{\n \"timezone\": \"Europe/London\"\n}\n```","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me","href":"/api-reference/users/update-the-current-authenticated-user","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Users"],"security":["7ed06737-b0f2-4011-98d8-8b619969322d","8e18f9e0-2a8d-4eda-9011-86bd9f33ecd7","68b1b345-8903-4a82-8766-ee9a532a4f7c"],"summary":"Update the current authenticated user","description":"Updates the authenticated user's profile. Both fields are optional - include only what you want to change.\n\n**Updatable fields:**\n- `timezone`: User's timezone in IANA format (e.g., \"America/New_York\")\n- `notificationPreferences`: Array of notification preference updates\n\n**Partial updates for notification preferences:**\nThe `notificationPreferences` array supports partial updates at two levels:\n\n1. **Type-level**: Only include notification types you want to modify. Types not included will keep their existing settings.\n2. **Field-level**: For each type included, you must provide both `email` and `mobile` fields, but only the values you provide will be applied.\n\n**Example - Update just one notification type:**\n```json\n{\n \"notificationPreferences\": [\n { \"type\": \"cardTransaction.approved\", \"email\": false, \"mobile\": true }\n ]\n}\n```\nThis updates only \"cardTransaction.approved\" preferences; all other notification types remain unchanged.\n\n**Example - Update only timezone:**\n```json\n{\n \"timezone\": \"Europe/London\"\n}\n```","requestBody":"903adf5e-2317-4d0a-8683-037450527d09","responses":{"200":"e5805e25-1c17-4fc0-b5b7-8cdaf2cf6223","401":"3c111267-d213-4769-8ed7-f8fb253e705b","404":"dfffb59c-320d-4527-9e2a-1c863b046e19","500":"d2122a84-f5e6-45be-9416-61af2832f588"},"operationId":"postV1UsersMe","method":"post","type":"path","servers":["0b678c23-1093-4a15-9b46-c01fe544a174","933a41d1-9273-480b-a475-9963e51720f0"],"path":"/v1/users/me","baseUrlOptions":["https://platform.spritz.finance","https://sandbox.spritz.finance"],"title":"Update the current authenticated user","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Request body for updating user profile. All fields are optional - include only the fields you want to update.","required":true,"content":{"application/json":{"schema":{"description":"Request body for updating user profile. All fields are optional - include only the fields you want to update.","type":"object","properties":{"timezone":{"description":"User's timezone in IANA format","type":"string","example":"America/New_York","uniqueKey":"timezone","typeLabel":"string"},"notificationPreferences":{"description":"Notification preferences to update. Supports partial updates: only include the notification types you want to change. For each type included, you can update just 'email', just 'mobile', or both fields. Notification types not included in this array will retain their existing settings.","type":"array","items":{"description":"A notification preference for a specific notification type","type":"object","properties":{"type":{"type":"string","enum":["cardTransaction.approved","cardTransaction.declined","credit.added"],"isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"email":{"description":"Whether email notifications are enabled for this type","default":true,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].email","typeLabel":"boolean"},"mobile":{"description":"Whether mobile notifications are enabled for this type","default":false,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].mobile","typeLabel":"boolean"}},"required":["type","email","mobile"],"uniqueKey":"notificationPreferences.items.[INDEX]","typeLabel":"object"},"example":[{"type":"cardTransaction.approved","email":false,"mobile":true}],"uniqueKey":"notificationPreferences","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"timezone":"America/New_York","notificationPreferences":[{"type":"cardTransaction.approved","email":false,"mobile":true}]}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"description":"Request body for updating user profile. All fields are optional - include only the fields you want to update.","type":"object","properties":{"timezone":{"description":"User's timezone in IANA format","type":"string","example":"America/New_York","uniqueKey":"timezone","typeLabel":"string"},"notificationPreferences":{"description":"Notification preferences to update. Supports partial updates: only include the notification types you want to change. For each type included, you can update just 'email', just 'mobile', or both fields. Notification types not included in this array will retain their existing settings.","type":"array","items":{"description":"A notification preference for a specific notification type","type":"object","properties":{"type":{"type":"string","enum":["cardTransaction.approved","cardTransaction.declined","credit.added"],"isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"email":{"description":"Whether email notifications are enabled for this type","default":true,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].email","typeLabel":"boolean"},"mobile":{"description":"Whether mobile notifications are enabled for this type","default":false,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].mobile","typeLabel":"boolean"}},"required":["type","email","mobile"],"uniqueKey":"notificationPreferences.items.[INDEX]","typeLabel":"object"},"example":[{"type":"cardTransaction.approved","email":false,"mobile":true}],"uniqueKey":"notificationPreferences","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"timezone":"America/New_York","notificationPreferences":[{"type":"cardTransaction.approved","email":false,"mobile":true}]}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"description":"Request body for updating user profile. All fields are optional - include only the fields you want to update.","type":"object","properties":{"timezone":{"description":"User's timezone in IANA format","type":"string","example":"America/New_York","uniqueKey":"timezone","typeLabel":"string"},"notificationPreferences":{"description":"Notification preferences to update. Supports partial updates: only include the notification types you want to change. For each type included, you can update just 'email', just 'mobile', or both fields. Notification types not included in this array will retain their existing settings.","type":"array","items":{"description":"A notification preference for a specific notification type","type":"object","properties":{"type":{"type":"string","enum":["cardTransaction.approved","cardTransaction.declined","credit.added"],"isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"email":{"description":"Whether email notifications are enabled for this type","default":true,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].email","typeLabel":"boolean"},"mobile":{"description":"Whether mobile notifications are enabled for this type","default":false,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].mobile","typeLabel":"boolean"}},"required":["type","email","mobile"],"uniqueKey":"notificationPreferences.items.[INDEX]","typeLabel":"object"},"example":[{"type":"cardTransaction.approved","email":false,"mobile":true}],"uniqueKey":"notificationPreferences","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"timezone":"America/New_York","notificationPreferences":[{"type":"cardTransaction.approved","email":false,"mobile":true}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e5805e25-1c17-4fc0-b5b7-8cdaf2cf6223":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique identifier for the user","type":"string","example":"6ae897f0fdfe33df5171832c","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"email":{"oneOf":[{"description":"User's email address","format":"email","type":"string","example":"user@example.com","isRequired":true,"uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"User's email address","format":"email","type":"null","example":"user@example.com","isRequired":true,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"firstName":{"oneOf":[{"description":"User's first name","type":"string","example":"John","isRequired":true,"uniqueKey":"firstName.oneOf.0","typeLabel":"string"},{"description":"User's first name","type":"null","example":"John","isRequired":true,"uniqueKey":"firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"firstName","typeLabel":"string | null"},"signedUpAt":{"description":"ISO 8601 timestamp of when the user was created","format":"date-time","type":"string","example":"2026-11-02T14:02:24.680Z","isRequired":true,"uniqueKey":"signedUpAt","typeLabel":"string\u003cdate-time>"},"timezone":{"oneOf":[{"description":"User's timezone in IANA format","type":"string","example":"America/New_York","isRequired":true,"uniqueKey":"timezone.oneOf.0","typeLabel":"string"},{"description":"User's timezone in IANA format","type":"null","example":"America/New_York","isRequired":true,"uniqueKey":"timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"timezone","typeLabel":"string | null"},"notificationPreferences":{"description":"User's notification preferences by type","type":"array","items":{"description":"A notification preference for a specific notification type","type":"object","properties":{"type":{"type":"string","enum":["cardTransaction.approved","cardTransaction.declined","credit.added"],"isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"email":{"description":"Whether email notifications are enabled for this type","default":true,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].email","typeLabel":"boolean"},"mobile":{"description":"Whether mobile notifications are enabled for this type","default":false,"type":"boolean","isRequired":true,"uniqueKey":"notificationPreferences.items.[INDEX].mobile","typeLabel":"boolean"}},"required":["type","email","mobile"],"uniqueKey":"notificationPreferences.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"notificationPreferences","typeLabel":"object[]"},"verification":{"description":"User's identity verification status and any pending requirements","type":"object","properties":{"status":{"type":"string","enum":["not_started","verified","failed","disabled","retry","under_review"],"isRequired":true,"uniqueKey":"verification.status","typeLabel":"enum\u003cstring>"},"failureReason":{"oneOf":[{"type":"string","enum":["verify_sms","documentary_verification","risk_check","kyc_check","address_invalid","selfie_check","watchlist_screening","vpn_detected","duplicate_identity",null],"description":"Failure reason for failed, retry, or under_review identity verification; null otherwise. A pending re-verification never downgrades a verified identity or exposes its failure reason here.","isRequired":true,"uniqueKey":"verification.failureReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["verify_sms","documentary_verification","risk_check","kyc_check","address_invalid","selfie_check","watchlist_screening","vpn_detected","duplicate_identity",null],"description":"Failure reason for failed, retry, or under_review identity verification; null otherwise. A pending re-verification never downgrades a verified identity or exposes its failure reason here.","isRequired":true,"uniqueKey":"verification.failureReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verification.failureReason","typeLabel":"enum\u003cstring> | null"},"duplicateIdentity":{"oneOf":[{"description":"Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator.","type":"object","properties":{"maskedEmail":{"description":"Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.","type":"string","example":"ja****oe@gmail.com","isRequired":true,"uniqueKey":"verification.duplicateIdentity.oneOf.0.maskedEmail","typeLabel":"string"}},"required":["maskedEmail"],"isRequired":true,"uniqueKey":"verification.duplicateIdentity.oneOf.0","typeLabel":"object"},{"description":"Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator.","type":"null","properties":{"maskedEmail":{"description":"Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.","type":"string","example":"ja****oe@gmail.com"}},"required":["maskedEmail"],"isRequired":true,"uniqueKey":"verification.duplicateIdentity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verification.duplicateIdentity","typeLabel":"object | null"},"country":{"oneOf":[{"description":"ISO 3166-1 alpha-2 country code where user was verified","type":"string","example":"US","isRequired":true,"uniqueKey":"verification.country.oneOf.0","typeLabel":"string"},{"description":"ISO 3166-1 alpha-2 country code where user was verified","type":"null","example":"US","isRequired":true,"uniqueKey":"verification.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verification.country","typeLabel":"string | null"},"requirement":{"description":"A requirement that must be fulfilled to access certain features","type":"object","properties":{"type":{"type":"string","enum":["identity_verification","terms_acceptance","additional_verification","document_submission","region_restriction","regional_compliance"],"isRequired":true,"uniqueKey":"verification.requirement.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["not_started","pending","completed","failed"],"isRequired":true,"uniqueKey":"verification.requirement.status","typeLabel":"enum\u003cstring>"},"description":{"description":"Human-readable description of what needs to be done","type":"string","example":"Verify your identity to unlock payment features","uniqueKey":"verification.requirement.description","typeLabel":"string"},"actionUrl":{"oneOf":[{"description":"URL where the user can complete this requirement. Optional because some requirements use an API flow, are pending, or require support; clients must branch on type and status when absent.","type":"string","example":"https://verify.example.com/start","uniqueKey":"verification.requirement.actionUrl.oneOf.0","typeLabel":"string"},{"description":"URL where the user can complete this requirement. Optional because some requirements use an API flow, are pending, or require support; clients must branch on type and status when absent.","type":"null","example":"https://verify.example.com/start","uniqueKey":"verification.requirement.actionUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"verification.requirement.actionUrl","typeLabel":"string | null"},"retryable":{"description":"Whether this requirement can be retried after failure. Absence is not permission to retry automatically.","type":"boolean","example":true,"uniqueKey":"verification.requirement.retryable","typeLabel":"boolean"}},"required":["type","status"],"uniqueKey":"verification.requirement","typeLabel":"object"}},"required":["status","failureReason","duplicateIdentity","country"],"isRequired":true,"uniqueKey":"verification","typeLabel":"object"},"capabilities":{"description":"User's available capabilities and their requirements","type":"array","items":{"description":"Individual capability with its own requirements and status","type":"object","properties":{"product":{"type":"string","enum":["fiat_to_crypto","crypto_to_fiat","bill_pay","crypto_card"],"isRequired":true,"uniqueKey":"capabilities.items.[INDEX].product","typeLabel":"enum\u003cstring>"},"name":{"description":"Human-readable name for this capability","type":"string","example":"ACH Bank Transfer","isRequired":true,"uniqueKey":"capabilities.items.[INDEX].name","typeLabel":"string"},"description":{"description":"Description of what this capability enables","type":"string","example":"Buy crypto using ACH bank transfer","isRequired":true,"uniqueKey":"capabilities.items.[INDEX].description","typeLabel":"string"},"status":{"type":"string","enum":["active","requirements_needed","not_available","pending"],"isRequired":true,"uniqueKey":"capabilities.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"requirements":{"description":"List of requirements that must be met to activate this capability","type":"array","items":{"description":"A requirement that must be fulfilled to access certain features","type":"object","properties":{"type":{"type":"string","enum":["identity_verification","terms_acceptance","additional_verification","document_submission","region_restriction","regional_compliance"],"isRequired":true,"uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["not_started","pending","completed","failed"],"isRequired":true,"uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"description":{"description":"Human-readable description of what needs to be done","type":"string","example":"Verify your identity to unlock payment features","uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX].description","typeLabel":"string"},"actionUrl":{"oneOf":[{"description":"URL where the user can complete this requirement. Optional because some requirements use an API flow, are pending, or require support; clients must branch on type and status when absent.","type":"string","example":"https://verify.example.com/start","uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX].actionUrl.oneOf.0","typeLabel":"string"},{"description":"URL where the user can complete this requirement. Optional because some requirements use an API flow, are pending, or require support; clients must branch on type and status when absent.","type":"null","example":"https://verify.example.com/start","uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX].actionUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX].actionUrl","typeLabel":"string | null"},"retryable":{"description":"Whether this requirement can be retried after failure. Absence is not permission to retry automatically.","type":"boolean","example":true,"uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX].retryable","typeLabel":"boolean"}},"required":["type","status"],"uniqueKey":"capabilities.items.[INDEX].requirements.items.[INDEX]","typeLabel":"object"},"example":[],"isRequired":true,"uniqueKey":"capabilities.items.[INDEX].requirements","typeLabel":"object[]"},"method":{"type":"string","enum":["ach_credit","ach_debit","wire","sepa_credit_transfer","rtp","push_to_card","canadian_eft"],"uniqueKey":"capabilities.items.[INDEX].method","typeLabel":"enum\u003cstring>"},"nextRequirement":{"type":"string","enum":["identity_verification","terms_acceptance","additional_verification","document_submission","region_restriction","regional_compliance"],"uniqueKey":"capabilities.items.[INDEX].nextRequirement","typeLabel":"enum\u003cstring>"}},"required":["product","name","description","status","requirements"],"uniqueKey":"capabilities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"capabilities","typeLabel":"object[]"}},"required":["id","email","firstName","signedUpAt","timezone","notificationPreferences","verification","capabilities"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"6ae897f0fdfe33df5171832c","email":"user@example.com","firstName":"John","signedUpAt":"2026-11-02T14:02:24.680Z","timezone":"America/New_York","notificationPreferences":[{"type":"cardTransaction.approved","email":true,"mobile":false}],"verification":{"status":"not_started","failureReason":"verify_sms","duplicateIdentity":{"maskedEmail":"ja****oe@gmail.com"},"country":"US","requirement":{"type":"identity_verification","status":"not_started","description":"Verify your identity to unlock payment features","actionUrl":"https://verify.example.com/start","retryable":true}},"capabilities":[{"product":"fiat_to_crypto","name":"ACH Bank Transfer","description":"Buy crypto using ACH bank transfer","status":"active","requirements":[],"method":"ach_credit","nextRequirement":"identity_verification"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3c111267-d213-4769-8ed7-f8fb253e705b":{"description":"Response for status 401","content":{"application/problem+json":{"schema":{"type":"object","properties":{"title":{"description":"A short, human-readable summary of the problem type","type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"description":"The HTTP status code","type":"number","example":401,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"type":{"default":"about:blank","description":"A URI reference that identifies the problem type","type":"string","example":"urn:problem-type:auth:unauthorized","uniqueKey":"type","typeLabel":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence","type":"string","example":"Bearer token required","uniqueKey":"detail","typeLabel":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence","type":"string","uniqueKey":"instance","typeLabel":"string"},"realm":{"description":"The authentication realm","type":"string","example":"API","uniqueKey":"realm","typeLabel":"string"},"scope":{"description":"The required scope for this resource","type":"string","example":"read:users","uniqueKey":"scope","typeLabel":"string"}},"required":["title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Unauthorized","status":401,"type":"urn:problem-type:auth:unauthorized","detail":"Bearer token required","instance":"\u003cstring>","realm":"API","scope":"read:users"}}},"exampleType":"generated"}},"exampleType":"generated"},"dfffb59c-320d-4527-9e2a-1c863b046e19":{"description":"Response for status 404","content":{"application/problem+json":{"schema":{"type":"object","properties":{"title":{"description":"A short, human-readable summary of the problem type","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"description":"The HTTP status code","type":"number","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"resourceType":{"description":"The type of resource that was not found","type":"string","example":"user","isRequired":true,"uniqueKey":"resourceType","typeLabel":"string"},"resourceId":{"description":"The identifier of the resource that was not found","type":"string","isRequired":true,"uniqueKey":"resourceId","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference that identifies the problem type","type":"string","uniqueKey":"type","typeLabel":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence","type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence","type":"string","uniqueKey":"instance","typeLabel":"string"}},"required":["title","status","resourceType","resourceId"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","status":404,"resourceType":"user","resourceId":"\u003cstring>","type":"about:blank","detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d2122a84-f5e6-45be-9416-61af2832f588":{"description":"Response for status 500","content":{"application/problem+json":{"schema":{"additionalProperties":true,"type":"object","properties":{"title":{"description":"A short, human-readable summary of the problem type","type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"description":"The HTTP status code","type":"number","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"type":{"default":"about:blank","description":"A URI reference that identifies the problem type","type":"string","example":"urn:problem-type:auth:unauthorized","uniqueKey":"type","typeLabel":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence","type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence","type":"string","example":"/errors/1234567890","uniqueKey":"instance","typeLabel":"string"},"code":{"description":"Machine-readable cause, present when exactly one thing failed. Branch on this, never on `detail`, which is human-facing copy and may change. For deposit limits the vocabulary matches the `reason` values the limits API returns pre-flight.","type":"string","example":"transaction_limit","uniqueKey":"code","typeLabel":"string"},"field":{"description":"The offending request field, present alongside `code`.","type":"string","example":"amountUsd","uniqueKey":"field","typeLabel":"string"},"retryable":{"description":"Whether retrying the same request later may succeed without changing its inputs.","type":"boolean","example":true,"uniqueKey":"retryable","typeLabel":"boolean"},"retryAfter":{"description":"Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead.","type":"number","example":5,"uniqueKey":"retryAfter","typeLabel":"number"},"suggestedAction":{"type":"string","enum":["auto_ramp","wait_for_settlement"],"uniqueKey":"suggestedAction","typeLabel":"enum\u003cstring>"},"clearsAt":{"oneOf":[{"format":"date-time","type":"string","description":"Earliest known time the current temporary condition may clear.","uniqueKey":"clearsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","description":"Earliest known time the current temporary condition may clear.","uniqueKey":"clearsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"clearsAt","typeLabel":"string\u003cdate-time> | null"},"availableAt":{"oneOf":[{"format":"date-time","type":"string","description":"When a temporarily ineligible funding source may become available again.","uniqueKey":"availableAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","description":"When a temporarily ineligible funding source may become available again.","uniqueKey":"availableAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"availableAt","typeLabel":"string\u003cdate-time> | null"},"permanent":{"description":"Whether the current funding-source restriction will not clear automatically.","type":"boolean","uniqueKey":"permanent","typeLabel":"boolean"}},"required":["title","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Unauthorized","status":400,"type":"urn:problem-type:auth:unauthorized","detail":"\u003cstring>","instance":"/errors/1234567890","code":"transaction_limit","field":"amountUsd","retryable":true,"retryAfter":5,"suggestedAction":"auto_ramp","clearsAt":"2023-11-07T05:31:56Z","availableAt":"2023-11-07T05:31:56Z","permanent":true}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7ed06737-b0f2-4011-98d8-8b619969322d":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT or ak_ user API key","description":"User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.","scopes":[],"schemeName":"bearerAuth"}},"8e18f9e0-2a8d-4eda-9011-86bd9f33ecd7":{"integratorJwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Integrator JWT token (prefix: spr_) for frontend integrator authentication. Obtained via token exchange endpoint.","scopes":[],"schemeName":"integratorJwt"}},"68b1b345-8903-4a82-8766-ee9a532a4f7c":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT or ak_ user API key","description":"User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.","scopes":[],"schemeName":"bearerAuth"},"hmacAuth":{"type":"apiKey","in":"header","name":"X-Signature","description":"HMAC signature authentication for backend integrators.\n\n**Required Headers:**\n- X-Integrator-Key: Integrator API key (format: ik_...)\n- X-Signature: HMAC signature (format: sha256={hex})\n- X-Timestamp: Unix timestamp in milliseconds\n- Authorization: Bearer {user-api-key}\n\n**Signature Algorithm:** HMAC-SHA256\n\n**Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash}\n- timestamp: Unix timestamp in milliseconds\n- METHOD: HTTP method in UPPERCASE (GET, POST, etc.)\n- path: Request path (e.g., /v1/transactions)\n- bodyHash: SHA256 hex digest of request body (empty string if no body)\n\n**Timestamp Tolerance:** ±5 minutes (300 seconds)\n\n**Example:**\nFor POST /v1/transactions with body {\"amount\":100} and timestamp 1234567890000:\nPayload: 1234567890000.POST./v1/transactions.{sha256(body)}\nSignature: sha256=abc123...","scopes":[],"schemeName":"hmacAuth"},"integratorKey":{"type":"apiKey","in":"header","name":"X-Integrator-Key","description":"Integrator API key (format: ik_...) used with HMAC authentication","scopes":[],"schemeName":"integratorKey"},"timestamp":{"type":"apiKey","in":"header","name":"X-Timestamp","description":"Unix timestamp in milliseconds for request freshness. Must be within 5 minutes of server time. The timestamp alone bounds but does not prevent an exact replay within that window. Use Idempotency-Key on supported mutations.","scopes":[],"schemeName":"timestamp"}}},"servers":{"0b678c23-1093-4a15-9b46-c01fe544a174":{"url":"https://platform.spritz.finance","description":"Production"},"933a41d1-9273-480b-a475-9963e51720f0":{"url":"https://sandbox.spritz.finance","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT or ak_ user API key","description":"User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Integrator JWT token (prefix: spr_) for frontend integrator authentication. Obtained via token exchange endpoint.","scopes":[],"schemeName":"integratorJwt"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Integrator JWT token (prefix: spr_) for frontend integrator authentication. Obtained via token exchange endpoint.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"integratorJwt","name":"Authorization"}],"title":"integratorJwt"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT or ak_ user API key","description":"User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"},{"scheme":{"type":"apiKey","in":"header","name":"X-Signature","description":"HMAC signature authentication for backend integrators.\n\n**Required Headers:**\n- X-Integrator-Key: Integrator API key (format: ik_...)\n- X-Signature: HMAC signature (format: sha256={hex})\n- X-Timestamp: Unix timestamp in milliseconds\n- Authorization: Bearer {user-api-key}\n\n**Signature Algorithm:** HMAC-SHA256\n\n**Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash}\n- timestamp: Unix timestamp in milliseconds\n- METHOD: HTTP method in UPPERCASE (GET, POST, etc.)\n- path: Request path (e.g., /v1/transactions)\n- bodyHash: SHA256 hex digest of request body (empty string if no body)\n\n**Timestamp Tolerance:** ±5 minutes (300 seconds)\n\n**Example:**\nFor POST /v1/transactions with body {\"amount\":100} and timestamp 1234567890000:\nPayload: 1234567890000.POST./v1/transactions.{sha256(body)}\nSignature: sha256=abc123...","scopes":[],"schemeName":"hmacAuth"},"schema":{"title":"X-Signature","type":"string","description":"HMAC signature authentication for backend integrators.\n\n**Required Headers:**\n- X-Integrator-Key: Integrator API key (format: ik_...)\n- X-Signature: HMAC signature (format: sha256={hex})\n- X-Timestamp: Unix timestamp in milliseconds\n- Authorization: Bearer {user-api-key}\n\n**Signature Algorithm:** HMAC-SHA256\n\n**Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash}\n- timestamp: Unix timestamp in milliseconds\n- METHOD: HTTP method in UPPERCASE (GET, POST, etc.)\n- path: Request path (e.g., /v1/transactions)\n- bodyHash: SHA256 hex digest of request body (empty string if no body)\n\n**Timestamp Tolerance:** ±5 minutes (300 seconds)\n\n**Example:**\nFor POST /v1/transactions with body {\"amount\":100} and timestamp 1234567890000:\nPayload: 1234567890000.POST./v1/transactions.{sha256(body)}\nSignature: sha256=abc123...","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"hmacAuth","name":"X-Signature"},{"scheme":{"type":"apiKey","in":"header","name":"X-Integrator-Key","description":"Integrator API key (format: ik_...) used with HMAC authentication","scopes":[],"schemeName":"integratorKey"},"schema":{"title":"X-Integrator-Key","type":"string","description":"Integrator API key (format: ik_...) used with HMAC authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"integratorKey","name":"X-Integrator-Key"},{"scheme":{"type":"apiKey","in":"header","name":"X-Timestamp","description":"Unix timestamp in milliseconds for request freshness. Must be within 5 minutes of server time. The timestamp alone bounds but does not prevent an exact replay within that window. Use Idempotency-Key on supported mutations.","scopes":[],"schemeName":"timestamp"},"schema":{"title":"X-Timestamp","type":"string","description":"Unix timestamp in milliseconds for request freshness. Must be within 5 minutes of server time. The timestamp alone bounds but does not prevent an exact replay within that window. Use Idempotency-Key on supported mutations.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"timestamp","name":"X-Timestamp"}],"title":"bearerAuth \u0026 hmacAuth \u0026 integratorKey \u0026 timestamp"}]},"originalFileLocation":"https://platform.spritz.finance/openapi.json"},"subdomain":"spritz","siteName":"Spritz","title":"Update the current authenticated user - Spritz","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T16:10:58.722Z","originalFileLocation":"api-reference/users/update-the-current-authenticated-user.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 the authenticated user\u0026#x27;s profile. Both fields are optional - include only what you want to change. Updatable fields: - timezone: User\u0026#x27;s timezone in IANA format (e.g., \u0026quot;America/New_York\u0026quot;) - notificationPreferences: Array of notification preference updates Partial updates for notification preferences: The notificationPreferences array supports partial updates at two levels: 1. Type-level: Only include notification types you want to modify. Types not included will keep their existing settings. 2. Field-level: For each type included, you must provide both email and mobile fields, but only the values you provide will be applied. Example - Update just one notification type: json { \u0026quot;notificationPreferences\u0026quot;: [ { \u0026quot;type\u0026quot;: \u0026quot;cardTransaction.approved\u0026quot;, \u0026quot;email\u0026quot;: false, \u0026quot;mobile\u0026quot;: true } ] } This updates only \u0026quot;cardTransaction.approved\u0026quot; preferences; all other notification types remain unchanged. Example - Update only timezone: json { \u0026quot;timezone\u0026quot;: \u0026quot;Europe/London\u0026quot; }\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spritz\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spritz/rPEYV4vnZMOH3BxC/_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/spritz/rPEYV4vnZMOH3BxC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spritz/rPEYV4vnZMOH3BxC/_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/spritz/rPEYV4vnZMOH3BxC/_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/spritz/rPEYV4vnZMOH3BxC/_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/spritz/rPEYV4vnZMOH3BxC/_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/spritz/rPEYV4vnZMOH3BxC/_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/spritz/rPEYV4vnZMOH3BxC/_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/spritz/rPEYV4vnZMOH3BxC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update the current authenticated user - Spritz\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates the authenticated user\u0026#x27;s profile. Both fields are optional - include only what you want to change. Updatable fields: - timezone: User\u0026#x27;s timezone in IANA format (e.g., \u0026quot;America/New_York\u0026quot;) - notificationPreferences: Array of notification preference updates Partial updates for notification preferences: The notificationPreferences array supports partial updates at two levels: 1. Type-level: Only include notification types you want to modify. Types not included will keep their existing settings. 2. Field-level: For each type included, you must provide both email and mobile fields, but only the values you provide will be applied. Example - Update just one notification type: json { \u0026quot;notificationPreferences\u0026quot;: [ { \u0026quot;type\u0026quot;: \u0026quot;cardTransaction.approved\u0026quot;, \u0026quot;email\u0026quot;: false, \u0026quot;mobile\u0026quot;: true } ] } This updates only \u0026quot;cardTransaction.approved\u0026quot; preferences; all other notification types remain unchanged. Example - Update only timezone: json { \u0026quot;timezone\u0026quot;: \u0026quot;Europe/London\u0026quot; }\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spritz\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spritz.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Update+the+current+authenticated+user\u0026amp;description=Updates+the+authenticated+user%27s+profile.+Both+fields+are+optional+-+include+only+what+you+want+to+change.%0A%0A**Updatable+fields%3A**%0A-+%60timezone%60%3A+User%27s+timezone+\u0026amp;theme=dbd2fff918d81440b96d8faf\u0026amp;signature=e74175ad55137a6a1d9a0ab2771b2213422a7a20d37ec745175fd55aacc2a5a6\">\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 the current authenticated user - Spritz\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates the authenticated user\u0026#x27;s profile. Both fields are optional - include only what you want to change. Updatable fields: - timezone: User\u0026#x27;s timezone in IANA format (e.g., \u0026quot;America/New_York\u0026quot;) - notificationPreferences: Array of notification preference updates Partial updates for notification preferences: The notificationPreferences array supports partial updates at two levels: 1. Type-level: Only include notification types you want to modify. Types not included will keep their existing settings. 2. Field-level: For each type included, you must provide both email and mobile fields, but only the values you provide will be applied. Example - Update just one notification type: json { \u0026quot;notificationPreferences\u0026quot;: [ { \u0026quot;type\u0026quot;: \u0026quot;cardTransaction.approved\u0026quot;, \u0026quot;email\u0026quot;: false, \u0026quot;mobile\u0026quot;: true } ] } This updates only \u0026quot;cardTransaction.approved\u0026quot; preferences; all other notification types remain unchanged. Example - Update only timezone: json { \u0026quot;timezone\u0026quot;: \u0026quot;Europe/London\u0026quot; }\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spritz.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Update+the+current+authenticated+user\u0026amp;description=Updates+the+authenticated+user%27s+profile.+Both+fields+are+optional+-+include+only+what+you+want+to+change.%0A%0A**Updatable+fields%3A**%0A-+%60timezone%60%3A+User%27s+timezone+\u0026amp;theme=dbd2fff918d81440b96d8faf\u0026amp;signature=e74175ad55137a6a1d9a0ab2771b2213422a7a20d37ec745175fd55aacc2a5a6\">\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/spritz/rPEYV4vnZMOH3BxC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spritz\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F35130\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users/update-the-current-authenticated-user.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spritz.finance/#organization\",\"name\":\"Spritz\",\"url\":\"https://docs.spritz.finance\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spritz/Oo-fWmzSaNcbhJum/logo/light.svg?fit=max\u0026auto=format\u0026n=Oo-fWmzSaNcbhJum\u0026q=85\u0026s=3f82e0ffd2d2c52feefac2c4033878c5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spritz.finance#website\",\"name\":\"Spritz\",\"url\":\"https://docs.spritz.finance\",\"publisher\":{\"@id\":\"https://docs.spritz.finance/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user#webpage\",\"url\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user\",\"name\":\"Update the current authenticated user\",\"description\":\"Updates the authenticated user's profile. Both fields are optional - include only what you want to change. Updatable fields: - timezone: User's timezone in IANA format (e.g., \\\"America/New_York\\\") - notificationPreferences: Array of notification preference updates Partial updates for notification preferences: The notificationPreferences array supports partial updates at two levels: 1. Type-level: Only include notification types you want to modify. Types not included will keep their existing settings. 2. Field-level: For each type included, you must provide both email and mobile fields, but only the values you provide will be applied. Example - Update just one notification type: json { \\\"notificationPreferences\\\": [ { \\\"type\\\": \\\"cardTransaction.approved\\\", \\\"email\\\": false, \\\"mobile\\\": true } ] } This updates only \\\"cardTransaction.approved\\\" preferences; all other notification types remain unchanged. Example - Update only timezone: json { \\\"timezone\\\": \\\"Europe/London\\\" }\",\"dateModified\":\"2026-11-02T16:10:58.722Z\",\"isPartOf\":{\"@id\":\"https://docs.spritz.finance#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Users\",\"item\":\"https://docs.spritz.finance/api-reference/users/get-the-current-authenticated-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update the current authenticated user\",\"item\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user#apireference\",\"headline\":\"Update the current authenticated user\",\"name\":\"Update the current authenticated user\",\"description\":\"Updates the authenticated user's profile. Both fields are optional - include only what you want to change. Updatable fields: - timezone: User's timezone in IANA format (e.g., \\\"America/New_York\\\") - notificationPreferences: Array of notification preference updates Partial updates for notification preferences: The notificationPreferences array supports partial updates at two levels: 1. Type-level: Only include notification types you want to modify. Types not included will keep their existing settings. 2. Field-level: For each type included, you must provide both email and mobile fields, but only the values you provide will be applied. Example - Update just one notification type: json { \\\"notificationPreferences\\\": [ { \\\"type\\\": \\\"cardTransaction.approved\\\", \\\"email\\\": false, \\\"mobile\\\": true } ] } This updates only \\\"cardTransaction.approved\\\" preferences; all other notification types remain unchanged. Example - Update only timezone: json { \\\"timezone\\\": \\\"Europe/London\\\" }\",\"url\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spritz.finance/api-reference/users/update-the-current-authenticated-user#webpage\"},\"dateModified\":\"2026-11-02T16:10:58.722Z\",\"publisher\":{\"@id\":\"https://docs.spritz.finance/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spritz.finance#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spritz\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Spritz\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/users/update-the-current-authenticated-user.md","siteName":"Spritz","nav":{"global":{"anchors":[{"anchor":"Help Center","icon":"life-ring","href":"https://help.spritz.finance/en/"},{"anchor":"Website","icon":"globe","href":"https://spritz.finance"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Auto-Ramp Accounts","pages":[{"title":"List auto-ramp accounts","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/auto-ramp-accounts/","href":"/api-reference/auto-ramp-accounts/list-auto-ramp-accounts"},{"title":"Create an auto-ramp account","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/auto-ramp-accounts/","href":"/api-reference/auto-ramp-accounts/create-an-auto-ramp-account"},{"title":"Get an auto-ramp account","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/auto-ramp-accounts/{id}","href":"/api-reference/auto-ramp-accounts/get-an-auto-ramp-account"},{"title":"Estimate the cost of a deposit","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/auto-ramp-accounts/{id}/estimate","href":"/api-reference/auto-ramp-accounts/estimate-the-cost-of-a-deposit"}]},{"group":"Auto-Ramp Addresses","pages":[{"title":"List auto-ramp addresses","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/auto-ramp-addresses/","href":"/api-reference/auto-ramp-addresses/list-auto-ramp-addresses"}]},{"group":"Off-Ramp Quotes","pages":[{"title":"Create an off-ramp quote","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/off-ramp-quotes/","href":"/api-reference/off-ramp-quotes/create-an-off-ramp-quote"},{"title":"Get an off-ramp quote","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/off-ramp-quotes/{quoteId}","href":"/api-reference/off-ramp-quotes/get-an-off-ramp-quote"},{"title":"Get transaction params for a quote","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/off-ramp-quotes/{quoteId}/transaction","href":"/api-reference/off-ramp-quotes/get-transaction-params-for-a-quote"},{"title":"Report the transaction sent for a quote","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/off-ramp-quotes/{quoteId}/submit","href":"/api-reference/off-ramp-quotes/report-the-transaction-sent-for-a-quote"}]},{"group":"Off-Ramps","pages":[{"title":"List off-ramps","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/off-ramps/","href":"/api-reference/off-ramps/list-off-ramps"},{"title":"Get an off-ramp","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/off-ramps/{offRampId}","href":"/api-reference/off-ramps/get-an-off-ramp"},{"title":"Refund an off-ramp","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/off-ramps/{offRampId}/refund","href":"/api-reference/off-ramps/refund-an-off-ramp"}]},{"group":"On-Ramps","pages":[{"title":"List on-ramps","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/on-ramps/","href":"/api-reference/on-ramps/list-on-ramps"},{"title":"List supported on-ramp pairs","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/on-ramps/supported-pairs","href":"/api-reference/on-ramps/list-supported-on-ramp-pairs"},{"title":"Get exchange rates","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/on-ramps/exchange-rates","href":"/api-reference/on-ramps/get-exchange-rates"},{"title":"Get an on-ramp","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/on-ramps/{onRampId}","href":"/api-reference/on-ramps/get-an-on-ramp"}]},{"group":"Bank Accounts","pages":[{"title":"List bank accounts","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/bank-accounts/","href":"/api-reference/bank-accounts/list-bank-accounts"},{"title":"Add a bank account","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bank-accounts/","href":"/api-reference/bank-accounts/add-a-bank-account"},{"title":"Get a bank account","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/bank-accounts/{accountId}","href":"/api-reference/bank-accounts/get-a-bank-account"},{"title":"Remove a bank account","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/bank-accounts/{accountId}","href":"/api-reference/bank-accounts/remove-a-bank-account"},{"title":"Get payment limits","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/bank-accounts/{accountId}/payment-limits","href":"/api-reference/bank-accounts/get-payment-limits"},{"title":"Create a bank account link token","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bank-accounts/link-token","href":"/api-reference/bank-accounts/create-a-bank-account-link-token"},{"title":"Complete bank account linking","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bank-accounts/link-complete","href":"/api-reference/bank-accounts/complete-bank-account-linking"}]},{"group":"Funding Sources","pages":[{"title":"List funding sources","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/funding-sources/","href":"/api-reference/funding-sources/list-funding-sources"},{"title":"Get deposit limits for a funding source","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/funding-sources/{fundingSourceId}/deposit-limits","href":"/api-reference/funding-sources/get-deposit-limits-for-a-funding-source"},{"title":"Get a funding source","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/funding-sources/{fundingSourceId}","href":"/api-reference/funding-sources/get-a-funding-source"},{"title":"Remove a funding source","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/funding-sources/{fundingSourceId}","href":"/api-reference/funding-sources/remove-a-funding-source"}]},{"group":"Deposits","pages":[{"title":"List deposits","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/deposits/","href":"/api-reference/deposits/list-deposits"},{"title":"Get a deposit","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/deposits/{depositId}","href":"/api-reference/deposits/get-a-deposit"},{"title":"Prepare a direct deposit authorization","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/deposits/direct/prepare","href":"/api-reference/deposits/prepare-a-direct-deposit-authorization"},{"title":"Create a direct deposit","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/deposits/direct","href":"/api-reference/deposits/create-a-direct-deposit"}]},{"group":"ACH Debit","pages":[{"title":"Check ACH debit eligibility","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/ach-debit/eligibility","href":"/api-reference/ach-debit/check-ach-debit-eligibility"}]},{"group":"Bills","pages":[{"title":"List bills","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/bills/","href":"/api-reference/bills/list-bills"},{"title":"List removed bills","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/bills/removed","href":"/api-reference/bills/list-removed-bills"},{"title":"Restore a removed bill","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/{billId}/restore","href":"/api-reference/bills/restore-a-removed-bill"},{"title":"Remove a bill","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/bills/{billId}","href":"/api-reference/bills/remove-a-bill"},{"title":"Activate bills","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/activate","href":"/api-reference/bills/activate-bills"},{"title":"Start bills verification","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/start_verification","href":"/api-reference/bills/start-bills-verification"},{"title":"Submit bills verification challenge","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/submit_verification/{activationId}","href":"/api-reference/bills/submit-bills-verification-challenge"},{"title":"Link card via token","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/token","href":"/api-reference/bills/link-card-via-token"},{"title":"Start a card update","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/{billId}/card-update-token","href":"/api-reference/bills/start-a-card-update"},{"title":"Complete a card update","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/{billId}/card-update-complete","href":"/api-reference/bills/complete-a-card-update"},{"title":"Update a bill's account number","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/bills/{billId}/account-number","href":"/api-reference/bills/update-a-bills-account-number"}]},{"group":"Cards","pages":[{"title":"List cards","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/cards/","href":"/api-reference/cards/list-cards"},{"title":"Get card program balance","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/cards/balance","href":"/api-reference/cards/get-card-program-balance"},{"title":"Get card","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/cards/{cardId}","href":"/api-reference/cards/get-card"},{"title":"List card transactions","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/cards/{cardId}/transactions","href":"/api-reference/cards/list-card-transactions"},{"title":"Get card PIN","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/cards/{cardId}/pin","href":"/api-reference/cards/get-card-pin"},{"title":"Update card PIN","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/cards/{cardId}/update_pin","href":"/api-reference/cards/update-card-pin"},{"title":"Update card status","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/cards/{cardId}/update_status","href":"/api-reference/cards/update-card-status"},{"title":"Update card spend limit","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/cards/{cardId}/update_limit","href":"/api-reference/cards/update-card-spend-limit"}]},{"group":"Debit Cards","pages":[{"title":"List debit cards","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/debit-cards/","href":"/api-reference/debit-cards/list-debit-cards"},{"title":"Add a debit card","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/debit-cards/","href":"/api-reference/debit-cards/add-a-debit-card"},{"title":"Get a debit card","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/debit-cards/{cardId}","href":"/api-reference/debit-cards/get-a-debit-card"},{"title":"Delete a debit card","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/debit-cards/{cardId}","href":"/api-reference/debit-cards/delete-a-debit-card"},{"title":"Complete debit card details","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json patch /v1/debit-cards/{cardId}/cardholder-info","href":"/api-reference/debit-cards/complete-debit-card-details"}]},{"group":"Integrator","pages":[{"title":"Exchange credentials for JWT token","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/integrator/tokens","href":"/api-reference/integrator/exchange-credentials-for-jwt-token"},{"title":"Get integrator profile","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/integrator/","href":"/api-reference/integrator/get-integrator-profile"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/integrator/users","href":"/api-reference/integrator/create-a-user"},{"title":"List ACH debit returns","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/integrator/ach-debit/returns","href":"/api-reference/integrator/list-ach-debit-returns"},{"title":"Get an ACH debit return","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/integrator/ach-debit/returns/{returnId}","href":"/api-reference/integrator/get-an-ach-debit-return"},{"title":"Get webhooks","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/integrator/webhooks","href":"/api-reference/integrator/get-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/integrator/webhooks","href":"/api-reference/integrator/create-webhook"},{"title":"Get webhook deliveries","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/integrator/webhooks/deliveries","href":"/api-reference/integrator/get-webhook-deliveries"},{"title":"Redeliver a webhook delivery","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/integrator/webhooks/deliveries/{deliveryId}/redeliver","href":"/api-reference/integrator/redeliver-a-webhook-delivery"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/integrator/webhooks/{webhookId}","href":"/api-reference/integrator/delete-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json patch /v1/integrator/webhooks/{webhookId}","href":"/api-reference/integrator/update-webhook"},{"title":"Update webhook secret","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/integrator/webhook-secret","href":"/api-reference/integrator/update-webhook-secret"},{"title":"Regenerate API secret","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/integrator/regenerate-secret","href":"/api-reference/integrator/regenerate-api-secret"}]},{"group":"Users","pages":[{"title":"Get the current authenticated user","description":"Returns the authenticated user's profile information.","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/users/me","href":"/api-reference/users/get-the-current-authenticated-user"},{"title":"Update the current authenticated user","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me","href":"/api-reference/users/update-the-current-authenticated-user"},{"title":"Start an email update","description":"Creates a pending email update session for the authenticated user and sends a one-time code to the requested email address.\n\n**Conflict** (`409`): branch on the problem `code`, not the title or detail. `EMAIL_IN_USE_IN_TENANT` means another account in the same tenant (the same partner, or Spritz itself) already uses this email address. `EMAIL_IN_USE_BY_LOGIN` means the address is already used to sign in to another Spritz account. Both are `retryable: false`: ask for a different address. `EMAIL_CHANGE_IN_PROGRESS` (`retryable: true`) means an earlier email change for this account has not finished yet; retry shortly. A `409` without `code` is an in-use conflict from a deployment that predates these codes; treat it as `retryable: false`. The problem never says which account holds the address.\n\nOther failures: `403` `EMAIL_CHANGE_FORBIDDEN` the login no longer resolves to this account; sign in again. `400` the address is not a valid email; `429` too many email update attempts for this account.","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me/email-update-sessions/","href":"/api-reference/users/start-an-email-update"},{"title":"Confirm an email update","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me/email-update-sessions/{sessionId}/confirm","href":"/api-reference/users/confirm-an-email-update"},{"title":"Create, resume, or retry an identity verification session","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me/verification-sessions/","href":"/api-reference/users/create-resume-or-retry-an-identity-verification-session"}]},{"group":"Compliance","pages":[{"title":"Get regional compliance requirements","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/users/me/compliance/requirements","href":"/api-reference/compliance/get-regional-compliance-requirements"},{"title":"Submit regional compliance fields","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me/compliance","href":"/api-reference/compliance/submit-regional-compliance-fields"}]},{"group":"Terms","pages":[{"title":"Accept terms of service","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/users/me/terms","href":"/api-reference/terms/accept-terms-of-service"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/api-keys/","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/api-keys/","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/api-keys/{keyId}","href":"/api-reference/api-keys/revoke-an-api-key"}]},{"group":"Device Authorization","pages":[{"title":"Initiate device authorization","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/device/authorize","href":"/api-reference/device-authorization/initiate-device-authorization"},{"title":"Poll for device authorization token","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/device/token","href":"/api-reference/device-authorization/poll-for-device-authorization-token"},{"title":"Get device authorization request info","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/device/info","href":"/api-reference/device-authorization/get-device-authorization-request-info"},{"title":"Approve device authorization","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/device/approve","href":"/api-reference/device-authorization/approve-device-authorization"}]},{"group":"Wallet Kit","pages":[{"title":"Get embedded wallet status","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/","href":"/api-reference/wallet-kit/get-embedded-wallet-status"},{"title":"Provision embedded wallet","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/","href":"/api-reference/wallet-kit/provision-embedded-wallet"},{"title":"List wallet accounts","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/accounts","href":"/api-reference/wallet-kit/list-wallet-accounts"},{"title":"List wallet token balances","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/balances","href":"/api-reference/wallet-kit/list-wallet-token-balances"},{"title":"Get wallet portfolio snapshots","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/portfolio/snapshots","href":"/api-reference/wallet-kit/get-wallet-portfolio-snapshots"},{"title":"List Solana wallet transfers","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/solana/transfers","href":"/api-reference/wallet-kit/list-solana-wallet-transfers"},{"title":"Prepare Solana transaction","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/solana/transactions/prepare","href":"/api-reference/wallet-kit/prepare-solana-transaction"},{"title":"Submit Solana transaction","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/solana/transactions/submit","href":"/api-reference/wallet-kit/submit-solana-transaction"},{"title":"Submit Solana transaction by id","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/solana/transactions/{txId}/submit","href":"/api-reference/wallet-kit/submit-solana-transaction-by-id"},{"title":"List wallet auth methods","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/auth-methods/","href":"/api-reference/wallet-kit/list-wallet-auth-methods"},{"title":"Commit add auth method","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/auth-methods/","href":"/api-reference/wallet-kit/commit-add-auth-method"},{"title":"Prepare add auth method","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/auth-methods/intents","href":"/api-reference/wallet-kit/prepare-add-auth-method"},{"title":"Prepare email OTP start","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/auth-methods/email/start/intents","href":"/api-reference/wallet-kit/prepare-email-otp-start"},{"title":"Commit email OTP start","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/auth-methods/email/start","href":"/api-reference/wallet-kit/commit-email-otp-start"},{"title":"Prepare remove auth method","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/wallet-kit/auth-methods/{id}/intents","href":"/api-reference/wallet-kit/prepare-remove-auth-method"},{"title":"Commit remove auth method","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/wallet-kit/auth-methods/{id}","href":"/api-reference/wallet-kit/commit-remove-auth-method"},{"title":"List Kamino yield vaults","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/vaults","href":"/api-reference/wallet-kit/list-kamino-yield-vaults"},{"title":"Get Kamino yield vault","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/vaults/{vaultId}","href":"/api-reference/wallet-kit/get-kamino-yield-vault"},{"title":"List Kamino yield vault history","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/vaults/{vaultId}/history","href":"/api-reference/wallet-kit/list-kamino-yield-vault-history"},{"title":"List Kamino yield positions","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/positions","href":"/api-reference/wallet-kit/list-kamino-yield-positions"},{"title":"Get Kamino yield position","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/positions/{vaultId}","href":"/api-reference/wallet-kit/get-kamino-yield-position"},{"title":"List Kamino yield position history","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/positions/{vaultId}/history","href":"/api-reference/wallet-kit/list-kamino-yield-position-history"},{"title":"Get Kamino yield position PnL","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/positions/{vaultId}/pnl","href":"/api-reference/wallet-kit/get-kamino-yield-position-pnl"},{"title":"List Kamino yield transactions","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/wallet-kit/yield/solana/kamino/transactions","href":"/api-reference/wallet-kit/list-kamino-yield-transactions"}]},{"group":"Sandbox","pages":[{"title":"Bypass KYC (sandbox only)","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/bypass-kyc","href":"/api-reference/sandbox/bypass-kyc-sandbox-only"},{"title":"Prepare a sandbox deposit under a program-control state","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/deposits/direct/prepare","href":"/api-reference/sandbox/prepare-a-sandbox-deposit-under-a-program-control-state"},{"title":"Create a sandbox direct deposit with a simulated outcome","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/deposits/direct","href":"/api-reference/sandbox/create-a-sandbox-direct-deposit-with-a-simulated-outcome"},{"title":"Read ACH debit sandbox exposure","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json get /v1/sandbox/ach-debit/exposure","href":"/api-reference/sandbox/read-ach-debit-sandbox-exposure"},{"title":"Set ACH debit sandbox exposure caps","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/ach-debit/exposure/cap","href":"/api-reference/sandbox/set-ach-debit-sandbox-exposure-caps"},{"title":"Link a deterministic sandbox bank account","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/bank-accounts/link","href":"/api-reference/sandbox/link-a-deterministic-sandbox-bank-account"},{"title":"Activate bills with a sandbox simulation","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/bills/activate","href":"/api-reference/sandbox/activate-bills-with-a-sandbox-simulation"},{"title":"Start sandbox bills verification","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/bills/start_verification","href":"/api-reference/sandbox/start-sandbox-bills-verification"},{"title":"Submit sandbox bills verification challenge","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/bills/submit_verification/{activationId}","href":"/api-reference/sandbox/submit-sandbox-bills-verification-challenge"},{"title":"Remove a funding source (sandbox only)","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json delete /v1/sandbox/funding-sources/{fundingSourceId}","href":"/api-reference/sandbox/remove-a-funding-source-sandbox-only"},{"title":"Simulate a deposit into an auto-ramp account (sandbox only)","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/auto-ramp-accounts/{id}/deposit","href":"/api-reference/sandbox/simulate-a-deposit-into-an-auto-ramp-account-sandbox-only"},{"title":"Reset sandbox bills activation","deprecated":null,"version":null,"openapi":"https://platform.spritz.finance/openapi.json post /v1/sandbox/bills/reset","href":"/api-reference/sandbox/reset-sandbox-bills-activation"}]}]}]},"basePath":"","title":"Update the current authenticated user - Spritz","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}