To enable your users to deposit, and withdraw funds from a Byzantine vault, the flow is slightly different depending on the authentication method used and the currency of the deposit or withdrawal.
User wants to use Passkey
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Byzantine Finance","colors":{"primary":"#702963","light":"#E199D3","dark":"#cd55b7"},"logo":{"light":"https://mintcdn.com/byzantinefinance/fFIrlJyu_2rx0s2h/logo/dark_logo.png?fit=max\u0026auto=format\u0026n=fFIrlJyu_2rx0s2h\u0026q=85\u0026s=c43aec517b1eeb07c5d662c510c348d5","dark":"https://mintcdn.com/byzantinefinance/fFIrlJyu_2rx0s2h/logo/light_logo.png?fit=max\u0026auto=format\u0026n=fFIrlJyu_2rx0s2h\u0026q=85\u0026s=3d73a04d2f177a5c5fcc4d74faa62ede"},"favicon":"https://mintcdn.com/byzantinefinance/36NrM9jzigjPERnG/favicon.ico?fit=max\u0026auto=format\u0026n=36NrM9jzigjPERnG\u0026q=85\u0026s=7648bef49c14f9b5b6f64f326431283f","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript"],"prefill":true}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:info@byzantine.fi","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://byzantine.fi"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"fr","href":"fr"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"byzantinefinance","hasAudioNarration":false,"actualSubdomain":"byzantinefinance","customDomains":["docs.byzantine.fi"],"gitSource":{"type":"github","owner":"byzantine-finance","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad6522c77f54b755aaccdc5","collectionId":"8d1589ad-8693-446a-abc7-c2877edffe17","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad6522c77f54b755aaccdc5"},"entitlements":{},"buildId":"6ad6522c77f54b755aaccdc5","clientVersion":"0.0.3908","searchFilterCounts":[{"language":"en","tag":"API reference","count":87},{"language":"en","tag":"API endpoints","count":55},{"language":"en","tag":"Integrator API","count":32},{"language":"en","tag":"Transactions","count":18},{"language":"en","tag":"Academy","count":17},{"language":"fr","tag":"Académie","count":17},{"language":"en","tag":"Welcome!","count":15},{"language":"fr","tag":"Bienvenue !","count":15},{"language":"en","tag":"Account management","count":14},{"language":"en","tag":"Account creation","count":11},{"language":"en","tag":"Webhooks","count":10},{"language":"en","tag":"Customer management","count":10},{"language":"fr","tag":"FAQ","count":6},{"language":"fr","tag":"Comment utiliser Byzantine","count":6},{"language":"fr","tag":"À propos de Byzantine","count":5},{"language":"fr","tag":"Protection des actifs","count":5},{"language":"fr","tag":"Actifs numériques 101","count":4},{"language":"fr","tag":"Configuration du compte et sécurité","count":3},{"language":"fr","tag":"Commencer","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","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":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/deposit-overview","slug":"/api-reference/deposit-overview","pageMetadata":{"title":"High level overview","description":"High level overview of the deposit process.","href":"/api-reference/deposit-overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"High level overview of the deposit process.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{OptimizedImage,Tab,Tabs}=_components;if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To enable your users to deposit, and withdraw funds from a Byzantine vault, the flow is slightly different depending on the authentication method used and the currency of the deposit or withdrawal.`}),`\n`,_jsx(Tabs,{children:_jsx(Tab,{title:`User wants to use Passkey`,id:`user-wants-to-use-passkey`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/byzantinefinance/AxAvvX33HdzfOQDJ/images/passkey-deposit.png?fit=max\u0026auto=format\u0026n=AxAvvX33HdzfOQDJ\u0026q=85\u0026s=34ea5a7e55d1698fd08db1bc51969088`,alt:`Deposit overview`,\"data-og-width\":`2079`,width:`2079`,\"data-og-height\":`853`,height:`853`,\"data-path\":`images/passkey-deposit.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/byzantinefinance/AxAvvX33HdzfOQDJ/images/passkey-deposit.png?w=280\u0026fit=max\u0026auto=format\u0026n=AxAvvX33HdzfOQDJ\u0026q=85\u0026s=1ec22650ae49985125c56e01d4b5f0eb 280w, https://mintcdn.com/byzantinefinance/AxAvvX33HdzfOQDJ/images/passkey-deposit.png?w=560\u0026fit=max\u0026auto=format\u0026n=AxAvvX33HdzfOQDJ\u0026q=85\u0026s=6a65c99fd132f64c980f45fe98d99a80 560w, https://mintcdn.com/byzantinefinance/AxAvvX33HdzfOQDJ/images/passkey-deposit.png?w=840\u0026fit=max\u0026auto=format\u0026n=AxAvvX33HdzfOQDJ\u0026q=85\u0026s=a414cbc0c78c1bb5bc87b5e37430d5fc 840w, https://mintcdn.com/byzantinefinance/AxAvvX33HdzfOQDJ/images/passkey-deposit.png?w=1100\u0026fit=max\u0026auto=format\u0026n=AxAvvX33HdzfOQDJ\u0026q=85\u0026s=a36d1a3ca87e365d3454dcd84439d475 1100w, https://mintcdn.com/byzantinefinance/AxAvvX33HdzfOQDJ/images/passkey-deposit.png?w=1650\u0026fit=max\u0026auto=format\u0026n=AxAvvX33HdzfOQDJ\u0026q=85\u0026s=023057bfe4bc30dedf6ac23564a8f03b 1650w, https://mintcdn.com/byzantinefinance/AxAvvX33HdzfOQDJ/images/passkey-deposit.png?w=2500\u0026fit=max\u0026auto=format\u0026n=AxAvvX33HdzfOQDJ\u0026q=85\u0026s=4a7fa91d1ea1d5577d98a8d564ab9a61 2500w`})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"High level overview","description":"High level overview of the deposit process.","href":"/api-reference/deposit-overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/byzantinefinance/8361d7bc2f630c6c/integrator-auth.js"],"subdomain":"byzantinefinance","siteName":"Byzantine Finance","title":"High level overview - Byzantine Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/deposit-overview","matchLevel":0},"fr":{"href":"/fr","matchLevel":4}}},"lastModified":"2026-02-27T09:06:34.617Z","originalFileLocation":"api-reference/deposit-overview.mdx","locale":"en"},"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=\"High level overview of the deposit process.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Byzantine Finance\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"High level overview - Byzantine Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"High level overview of the deposit process.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Byzantine Finance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byzantine.fi/api-reference/deposit-overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"High level overview - Byzantine Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"High level overview of the deposit process.\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/byzantinefinance/7mu313ao3NfCm_vj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Byzantine Finance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#702963\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byzantine.fi/api-reference/deposit-overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/deposit-overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.byzantine.fi/#organization\",\"name\":\"Byzantine Finance\",\"url\":\"https://docs.byzantine.fi\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/byzantinefinance/fFIrlJyu_2rx0s2h/logo/dark_logo.png?fit=max\u0026auto=format\u0026n=fFIrlJyu_2rx0s2h\u0026q=85\u0026s=c43aec517b1eeb07c5d662c510c348d5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.byzantine.fi#website\",\"name\":\"Byzantine Finance\",\"url\":\"https://docs.byzantine.fi\",\"publisher\":{\"@id\":\"https://docs.byzantine.fi/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.byzantine.fi/api-reference/deposit-overview#webpage\",\"url\":\"https://docs.byzantine.fi/api-reference/deposit-overview\",\"name\":\"High level overview\",\"description\":\"High level overview of the deposit process.\",\"dateModified\":\"2026-02-27T09:06:34.617Z\",\"isPartOf\":{\"@id\":\"https://docs.byzantine.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzantine.fi/api-reference/deposit-overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzantine.fi/api-reference/deposit-overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integrator API\",\"item\":\"https://docs.byzantine.fi/api-reference/getting-started\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://docs.byzantine.fi/api-reference/transactions-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"High level overview\",\"item\":\"https://docs.byzantine.fi/api-reference/deposit-overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.byzantine.fi/api-reference/deposit-overview#article\",\"headline\":\"High level overview\",\"name\":\"High level overview\",\"description\":\"High level overview of the deposit process.\",\"url\":\"https://docs.byzantine.fi/api-reference/deposit-overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzantine.fi/api-reference/deposit-overview#webpage\"},\"dateModified\":\"2026-02-27T09:06:34.617Z\",\"publisher\":{\"@id\":\"https://docs.byzantine.fi/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.byzantine.fi#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Byzantine Finance\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Byzantine Finance","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Welcome!","icon":"book","pages":[{"title":"Welcome!","href":""}]},{"tab":"Academy","icon":"graduation-cap","pages":[{"title":"Academy","href":"/documentation/about-byzantine/what-is-byzantine"}]},{"tab":"API reference","icon":"code","groups":[{"group":"Integrator API","pages":[{"group":"Getting started","pages":[{"title":"Getting started","icon":"play","href":"/api-reference/getting-started"},{"title":"Byzantine SDK","icon":"code","href":"/api-reference/byzantine-sdk"},{"title":"API authentication","href":"/api-reference/api-authentication"},{"title":"Sandbox","href":"/api-reference/sandbox"},{"title":"Concepts","href":"/api-reference/concepts"}]},{"title":"Authentication methods","href":"/api-reference/authentication-methods"},{"group":"Account creation","pages":[{"title":"High level overview","href":"/api-reference/kyc-kyb-overview"},{"title":"Terms and Conditions","href":"/api-reference/terms-and-conditions"},{"title":"Multi-accounts","href":"/api-reference/multi-accounts"},{"title":"Individuals - KYC","href":"/api-reference/kyc"},{"title":"Legal entities - KYB","href":"/api-reference/kyb"},{"title":"Required documents","href":"/api-reference/accepted-documents"},{"title":"Verification statuses","href":"/api-reference/verification-statuses"},{"group":"Lists","pages":[{"title":"Countries","href":"/api-reference/lists/countries"},{"title":"Occupation codes","href":"/api-reference/lists/occupation-codes"},{"title":"Company industry codes","href":"/api-reference/lists/industry-codes"},{"title":"Entity number types by country","href":"/api-reference/lists/company-number-types"}]}]},{"title":"Account activation","href":"/api-reference/account-activation"},{"group":"Account management","pages":[{"title":"Overview","href":"/api-reference/management-overview"},{"title":"Multi-users account","href":"/api-reference/multi-users-account"},{"title":"Bank account","href":"/api-reference/bank-account"}]},{"group":"Transactions","pages":[{"title":"Overview","description":"How deposits, withdrawals, and related flows work across passkey auth.","href":"/api-reference/transactions-overview"},{"group":"Deposit","pages":[{"title":"High level overview","href":"/api-reference/deposit-overview"},{"title":"Technical implementation","description":"How to make a deposit into a Byzantine vault.","href":"/api-reference/deposit-technical"}]},{"group":"Withdrawal","pages":[{"title":"High level overview","href":"/api-reference/withdrawal-overview"},{"title":"Technical implementation","href":"/api-reference/withdrawal-technical"}]},{"title":"Stablecoin transfer","href":"/api-reference/transfer"},{"title":"Tracking transactions","href":"/api-reference/tracking-transactions"},{"title":"Idle balance","href":"/api-reference/account-balances-idle"}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Customer webhooks","href":"/api-reference/webhooks/customers"},{"title":"Transaction webhooks (available soon)","href":"/api-reference/webhooks/transactions"}]}]},{"group":"API endpoints","pages":[{"title":"Overview","href":"/api-reference/endpoints-overview"},{"title":"Sandbox authentication","href":"/api-reference/sandbox-auth"},{"title":"Changelog","href":"/api-reference/changelog"},{"group":"API health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/health","href":"/api-reference/api-health/health-check"}]},{"group":"Customer management","pages":[{"title":"List all customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-customers","href":"/api-reference/customer-management/list-all-customers"},{"title":"Get details of a single user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-user-details","href":"/api-reference/customer-management/get-details-of-a-single-user"},{"title":"Get details of a single entity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-entity-details","href":"/api-reference/customer-management/get-details-of-a-single-entity"},{"title":"Get details of a single associated person","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-associated-person-details","href":"/api-reference/customer-management/get-details-of-a-single-associated-person"},{"group":"Customer creation","pages":[{"title":"Create individual account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-individual-account","href":"/api-reference/customer-management/create-individual-account"},{"title":"Create entity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-entity-account","href":"/api-reference/customer-management/create-entity"},{"title":"Update an individual account's user details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/submit/update-individual-account","href":"/api-reference/customer-management/update-an-individual-accounts-user-details"},{"title":"Update an entity account's company details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/submit/update-entity-account","href":"/api-reference/customer-management/update-an-entity-accounts-company-details"},{"title":"Add an associated person to an entity account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/add-associated-person","href":"/api-reference/customer-management/add-an-associated-person-to-an-entity-account"},{"title":"Update an associated person's details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/submit/update-associated-person","href":"/api-reference/customer-management/update-an-associated-persons-details"}]}]},{"group":"Account management","pages":[{"title":"Get single account balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-account-balances","href":"/api-reference/account-management/get-single-account-balances"},{"title":"Get details of a single account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-account-details","href":"/api-reference/account-management/get-details-of-a-single-account"},{"group":"Bank accounts","pages":[{"title":"List bank accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-bank-accounts","href":"/api-reference/account-management/list-bank-accounts"},{"title":"Add bank account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/add-bank-account","href":"/api-reference/account-management/add-bank-account"}]},{"group":"Multi-users account","pages":[{"title":"List invitations by account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-invitations-by-account-id","href":"/api-reference/account-management/list-invitations-by-account"},{"title":"List invitations by email","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-invitations-by-email","href":"/api-reference/account-management/list-invitations-by-email"},{"title":"List all invitations across every account of the authenticated integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-all-invitations","href":"/api-reference/account-management/list-all-invitations-across-every-account-of-the-authenticated-integrator"},{"group":"Add team member","pages":[{"title":"Step 1 Get invite users payload (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-invite-users-payload-passkey","href":"/api-reference/account-management/step-1-get-invite-users-payload-passkey"},{"title":"Step 2 Send invitations (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/invite-users","href":"/api-reference/account-management/step-2-send-invitations-passkey"}]},{"group":"User roles","pages":[{"title":"Step 1 Get update role payload (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-update-users-role-payload-passkey","href":"/api-reference/account-management/step-1-get-update-role-payload-passkey"},{"title":"Step 2 Update users role (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/update-users-role","href":"/api-reference/account-management/step-2-update-users-role-passkey"}]}]}]},{"group":"Products","pages":[{"title":"List all products","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/top-vaults","href":"/api-reference/products/list-all-products"},{"title":"Get single product APY","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/apy/{vault_id}","href":"/api-reference/products/get-single-product-apy"},{"title":"Get single vault history","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/history/{vault_id}","href":"/api-reference/products/get-single-vault-history"},{"title":"Get all assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/assets","href":"/api-reference/products/get-all-assets"}]},{"group":"Transactions","pages":[{"title":"List all transactions across every account of the authenticated integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-all-transactions","href":"/api-reference/transactions/list-all-transactions-across-every-account-of-the-authenticated-integrator"},{"title":"List all transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-transactions","href":"/api-reference/transactions/list-all-transactions"},{"title":"Get single transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-transaction","href":"/api-reference/transactions/get-single-transaction"},{"group":"Passkey flow","pages":[{"title":"Get activate account payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-activate-account-payload-passkey","href":"/api-reference/transactions/get-activate-account-payload"},{"title":"Get deposit payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-deposit-payload-passkey","href":"/api-reference/transactions/get-deposit-payload"},{"title":"Get withdraw payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-withdraw-payload-passkey","href":"/api-reference/transactions/get-withdraw-payload"},{"title":"Get vault upgrade payload (Base -> Ethereum)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-vault-upgrade-payload-passkey","href":"/api-reference/transactions/get-vault-upgrade-payload-base->-ethereum"},{"title":"Get transfer payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-transfer-payload-passkey","href":"/api-reference/transactions/get-transfer-payload"},{"title":"Get cancellation payload for a withdrawal request","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-cancel-withdrawal-payload-passkey","href":"/api-reference/transactions/get-cancellation-payload-for-a-withdrawal-request"},{"title":"Sign payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/sign-payload-passkey","href":"/api-reference/transactions/sign-payload"}]}]},{"group":"Webhooks","pages":[{"title":"Create a webhook subscription.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/webhooks/subscriptions","href":"/api-reference/webhooks/create-a-webhook-subscription"},{"title":"List webhook subscriptions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/webhooks/subscriptions","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Update a webhook subscription.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/webhooks/subscriptions/{subscription_id}","href":"/api-reference/webhooks/update-a-webhook-subscription"},{"title":"Delete a webhook subscription.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json delete /v1/webhooks/subscriptions/{subscription_id}","href":"/api-reference/webhooks/delete-a-webhook-subscription"},{"title":"Send a signed test webhook.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/webhooks/subscriptions/{subscription_id}/test","href":"/api-reference/webhooks/send-a-signed-test-webhook"},{"title":"List webhook delivery history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/webhooks/deliveries","href":"/api-reference/webhooks/list-webhook-delivery-history"},{"title":"Retry a webhook delivery.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/webhooks/deliveries/{delivery_id}/retry","href":"/api-reference/webhooks/retry-a-webhook-delivery"}]},{"group":"Events","pages":[{"title":"Lists persisted lifecycle events owned by the authenticated integrator, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/events","href":"/api-reference/events/lists-persisted-lifecycle-events-owned-by-the-authenticated-integrator-newest-first"}]},{"group":"OTP authentication","pages":[{"title":"Step 1 Initialize OTP (send email)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/init-otp","href":"/api-reference/otp-authentication/step-1-initialize-otp-send-email"},{"title":"Step 2 Authenticate with OTP code","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/otp-auth","href":"/api-reference/otp-authentication/step-2-authenticate-with-otp-code"},{"title":"Step 3 Create passkeys (OTP auth)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-authenticators-otp","href":"/api-reference/otp-authentication/step-3-create-passkeys-otp-auth"}]},{"group":"Integrator key management","pages":[{"title":"Get current integrator credential capabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/integrator/whoami","href":"/api-reference/integrator-key-management/get-current-integrator-credential-capabilities"},{"title":"List integrator credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/integrator/credentials","href":"/api-reference/integrator-key-management/list-integrator-credentials"},{"title":"Issue a credential for the authenticated integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/integrator/credentials","href":"/api-reference/integrator-key-management/issue-a-credential-for-the-authenticated-integrator"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/integrator/credentials/{pubkey}","href":"/api-reference/integrator-key-management/update-a-credential"},{"title":"Delete an integrator credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json delete /v1/integrator/credentials/{pubkey}","href":"/api-reference/integrator-key-management/delete-an-integrator-credential"}]}]}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr"}]}]},"title":"High level overview - Byzantine Finance","buildId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","deploymentId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-DQ5W4Q2v.js","PlusIcon-jZ8vgk6R.js","lightbox-handle-r17bVUz3.js"]}