Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.
The Byzantine Integrator SDK (@byzantine/integrator-sdk) is the official client library for integrating with the Byzantine API. It handles authentication, WebAuthn (passkeys), and provides typed wrappers for API operations so you can focus on your product logic instead of low-level HTTP and crypto.
ECDSA request signing and header generation (X-Pubkey, X-Timestamp, X-Signature) so you can call the API without implementing the signature scheme yourself.
WebAuthn (passkey) support
Create and use passkeys for end-user authentication: passkey creation, credential storage, and transaction signing flows.
API method wrappers
Typed methods that map to Byzantine API endpoints, keeping request/response shapes consistent.
Initialize the client with your Integrator Private Key (from the Byzantine team). The same client can be used for both API-key–signed requests and, when configured, WebAuthn flows.
import { ByzantineClient } from '@byzantine/integrator-sdk';const client = new ByzantineClient({ integratorPrivateKey: process.env.INTEGRATOR_PRIVATE_KEY!,});
For endpoints requiring integrator authentication, the SDK generates the signed request headers:
getStamp(method, pathAndQuery, body) - Returns an object with X-Pubkey, X-Timestamp, X-Signature, and Content-Type that you pass as request headers.
Generate a fresh stamp for each authenticated call (sandbox or production). The public vault APY and history endpoints do not require an integrator stamp. Full signing details are in API authentication.
Beyond raw request signing, the SDK exposes methods that wrap Byzantine API endpoints. Use these for a consistent, typed interface to vault data, accounts, deposits, withdrawals, and user management without building request URLs and bodies by hand. Refer to the OpenAPI specification and the SDK’s exported types for the full list of supported operations.
{"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":"6ae9ca7b156f2fde8c4bdf08","collectionId":"bb9de0e8-91ee-4664-a8e2-83972801e1c3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9ca7b156f2fde8c4bdf08"},"entitlements":{},"buildId":"6ae9ca7b156f2fde8c4bdf08","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"API reference","count":88},{"language":"en","tag":"API endpoints","count":56},{"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},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/byzantine-sdk","slug":"/api-reference/byzantine-sdk","pageMetadata":{"title":"Byzantine SDK","description":"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.","icon":"code","href":"/api-reference/byzantine-sdk"},"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: \"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.\"\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={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,CodeBlock,Heading,Table,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`Byzantine Integrator SDK`}),` (`,_jsx(_components.code,{children:`@byzantine/integrator-sdk`}),`) is the official client library for integrating with the Byzantine API. It handles authentication, WebAuthn (passkeys), and provides typed wrappers for API operations so you can focus on your product logic instead of low-level HTTP and crypto.`]}),`\n`,_jsx(Heading,{level:`2`,id:`what-the-sdk-provides`,children:`What the SDK provides`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Capability`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Integrator API authentication`})}),_jsxs(_components.td,{children:[`ECDSA request signing and header generation (`,_jsx(_components.code,{children:`X-Pubkey`}),`, `,_jsx(_components.code,{children:`X-Timestamp`}),`, `,_jsx(_components.code,{children:`X-Signature`}),`) so you can call the API without implementing the signature scheme yourself.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`WebAuthn (passkey) support`})}),_jsx(_components.td,{children:`Create and use passkeys for end-user authentication: passkey creation, credential storage, and transaction signing flows.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`API method wrappers`})}),_jsx(_components.td,{children:`Typed methods that map to Byzantine API endpoints, keeping request/response shapes consistent.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`installation`,children:`Installation`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @byzantine/integrator-sdk`})]}),`\n`]})})}),`\n`,_jsx(Card,{title:`Package on npm`,icon:`box`,horizontal:true,href:`https://www.npmjs.com/package/@byzantine/integrator-sdk`}),`\n`,_jsx(Heading,{level:`2`,id:`quick-start`,children:`Quick start`}),`\n`,_jsxs(_components.p,{children:[`Initialize the client with your `,_jsx(_components.strong,{children:`Integrator Private Key`}),` (from the Byzantine team). The same client can be used for both API-key–signed requests and, when configured, WebAuthn flows.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ByzantineClient`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '@byzantine/integrator-sdk'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` client`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` ByzantineClient`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` integratorPrivateKey:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` process`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`env`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`INTEGRATOR_PRIVATE_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`!`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/api-reference/api-authentication`,children:`API authentication`}),` for full details and examples.`]}),`\n`,_jsx(Heading,{level:`2`,id:`integrator-api-authentication`,children:`Integrator API authentication`}),`\n`,_jsx(_components.p,{children:`For endpoints requiring integrator authentication, the SDK generates the signed request headers:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`getStamp(method, pathAndQuery, body)`})}),` - Returns an object with `,_jsx(_components.code,{children:`X-Pubkey`}),`, `,_jsx(_components.code,{children:`X-Timestamp`}),`, `,_jsx(_components.code,{children:`X-Signature`}),`, and `,_jsx(_components.code,{children:`Content-Type`}),` that you pass as request headers.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Generate a fresh stamp for each authenticated call (sandbox or production). The public `,_jsx(_components.a,{href:`/api-reference/vault-performance`,children:`vault APY and history endpoints`}),` do not require an integrator stamp. Full signing details are in `,_jsx(_components.a,{href:`/api-reference/api-authentication`,children:`API authentication`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`webauthn-passkey-authentication`,children:`WebAuthn (passkey) authentication`}),`\n`,_jsx(_components.p,{children:`For end-user–owned wallets and transaction approval, the SDK supports WebAuthn:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Passkey creation`}),` - Register passkeys for users and attach them to Byzantine accounts during `,_jsx(_components.a,{href:`/api-reference/authentication-methods`,children:`account creation`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Transaction signing`}),` - Get WebAuthn signatures for transaction payloads via the SDK so users approve with their passkey instead of a shared secret.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Configuration (e.g. `,_jsx(_components.code,{children:`rpId`}),`, `,_jsx(_components.code,{children:`rpName`}),`, timeouts) and flows for discoverable vs non-discoverable credentials are documented in `,_jsx(_components.a,{href:`/api-reference/authentication-methods`,children:`Authentication methods`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`api-method-wrappers`,children:`API method wrappers`}),`\n`,_jsxs(_components.p,{children:[`Beyond raw request signing, the SDK exposes methods that wrap Byzantine API endpoints. Use these for a consistent, typed interface to vault data, accounts, deposits, withdrawals, and user management without building request URLs and bodies by hand. Refer to the `,_jsx(_components.a,{href:`/api-reference/openapi-integrator.json`,children:`OpenAPI specification`}),` and the SDK’s exported types for the full list of supported operations.`]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/api-authentication`,children:`API authentication`}),` - Header format, signature scheme, and manual implementation.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/authentication-methods`,children:`Authentication methods`}),` - Passkey creation and WebAuthn transaction flows.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/sandbox`,children:`Sandbox`}),` - Test your integration against the sandbox environment.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`openapi-integrator.json`,children:`OpenAPI specification`}),` - Full API surface for code generation and reference.`]}),`\n`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.strong,{children:`Keep your Integrator Private Key secure.`}),` `]})]})}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":"Byzantine SDK","description":"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.","icon":"code","href":"/api-reference/byzantine-sdk"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What the SDK provides","slug":"what-the-sdk-provides","depth":2,"children":[]},{"title":"Installation","slug":"installation","depth":2,"children":[]},{"title":"Quick start","slug":"quick-start","depth":2,"children":[]},{"title":"Integrator API authentication","slug":"integrator-api-authentication","depth":2,"children":[]},{"title":"WebAuthn (passkey) authentication","slug":"webauthn-passkey-authentication","depth":2,"children":[]},{"title":"API method wrappers","slug":"api-method-wrappers","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/byzantinefinance/8361d7bc2f630c6c/integrator-auth.js"],"subdomain":"byzantinefinance","siteName":"Byzantine Finance","title":"Byzantine SDK - Byzantine Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/byzantine-sdk","matchLevel":0},"fr":{"href":"/fr","matchLevel":4}}},"lastModified":"2026-10-21T16:45:18.415Z","originalFileLocation":"api-reference/byzantine-sdk.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=\"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.\">\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=\"Byzantine SDK - Byzantine Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.\">\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/byzantine-sdk\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://byzantinefinance.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Byzantine+SDK\u0026amp;description=Official+TypeScript+SDK+for+integrator+API+authentication%2C+WebAuthn%2C+and+API+method+wrappers.\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=86be356867d37c136c1620581ab715e87088f3aa6998a94f6261ca4df94c9a35\">\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=\"Byzantine SDK - Byzantine Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://byzantinefinance.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Byzantine+SDK\u0026amp;description=Official+TypeScript+SDK+for+integrator+API+authentication%2C+WebAuthn%2C+and+API+method+wrappers.\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=86be356867d37c136c1620581ab715e87088f3aa6998a94f6261ca4df94c9a35\">\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/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/byzantine-sdk\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/byzantine-sdk.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/byzantine-sdk#webpage\",\"url\":\"https://docs.byzantine.fi/api-reference/byzantine-sdk\",\"name\":\"Byzantine SDK\",\"description\":\"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.\",\"dateModified\":\"2026-10-21T16:45:18.415Z\",\"isPartOf\":{\"@id\":\"https://docs.byzantine.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzantine.fi/api-reference/byzantine-sdk#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzantine.fi/api-reference/byzantine-sdk#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integrator API\",\"item\":\"https://docs.byzantine.fi/api-reference/getting-started\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting started\",\"item\":\"https://docs.byzantine.fi/api-reference/getting-started\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Byzantine SDK\",\"item\":\"https://docs.byzantine.fi/api-reference/byzantine-sdk\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.byzantine.fi/api-reference/byzantine-sdk#article\",\"headline\":\"Byzantine SDK\",\"name\":\"Byzantine SDK\",\"description\":\"Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.\",\"url\":\"https://docs.byzantine.fi/api-reference/byzantine-sdk\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzantine.fi/api-reference/byzantine-sdk#webpage\"},\"dateModified\":\"2026-10-21T16:45:18.415Z\",\"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","description":null,"href":"/api-reference/getting-started"},{"title":"Byzantine SDK","icon":"code","href":"/api-reference/byzantine-sdk"},{"title":"API authentication","description":"Authentication for the Byzantine API.","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","href":"/api-reference/transactions-overview"},{"group":"Deposit","pages":[{"title":"High level overview","href":"/api-reference/deposit-overview"},{"title":"Technical implementation","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","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":"Vault APY and history","href":"/api-reference/vault-performance"},{"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","href":"/api-reference/products/get-single-product-apy"},{"title":"Get single product APY history","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/apy-history","href":"/api-reference/products/get-single-product-apy-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"}]}]},"basePath":"","title":"Byzantine SDK - Byzantine Finance","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":[],"chunks":[]}
