# Byzantine Finance

## Welcome!

- [Welcome to Byzantine](https://docs.byzantine.fi/index.md)

### Getting started

- [Create & secure your account](https://docs.byzantine.fi/create-your-account.md)
- [Identity verification - organisation](https://docs.byzantine.fi/for-organisation-accounts.md)

### How to use Byzantine

- [Get to know your dashboard](https://docs.byzantine.fi/get-to-know-your-dashboard.md)
- [Making your first deposit](https://docs.byzantine.fi/making-your-first-deposit.md)
- [Users & roles](https://docs.byzantine.fi/users-and-roles.md)
- [Withdrawals](https://docs.byzantine.fi/withdrawals.md)
- [Passkey reset](https://docs.byzantine.fi/passkey-reset.md): How to troubleshoot passkey issues and reset your passkey with help from Byzantine.
- [For wealth managers](https://docs.byzantine.fi/for-wealth-managers.md)

### FAQ

- [Account setup](https://docs.byzantine.fi/account-setup.md)
- [KYB process](https://docs.byzantine.fi/kyb-process.md)
- [Deposits & withdrawals](https://docs.byzantine.fi/deposits-and-withdrawals.md)
- [Currency & yield](https://docs.byzantine.fi/currency-and-yield.md)
- [Security & compliance](https://docs.byzantine.fi/security-and-compliance.md)
- [Technical questions](https://docs.byzantine.fi/technical-questions.md)

## Academy

### About Byzantine

- [What is Byzantine Prime?](https://docs.byzantine.fi/documentation/about-byzantine/what-is-byzantine.md)
- [Why returns can be higher](https://docs.byzantine.fi/documentation/about-byzantine/the-digital-asset-opportunity.md)
- [Byzantine Prime - key details](https://docs.byzantine.fi/documentation/about-byzantine/product-details.md)
- [How it works](https://docs.byzantine.fi/documentation/about-byzantine/how-it-works.md): A step-by-step look at how your funds flow through Byzantine Prime.
- [Deposits and withdrawals](https://docs.byzantine.fi/documentation/about-byzantine/deposits-and-withdrawals.md)

### Asset protection

- [Security mechanisms](https://docs.byzantine.fi/documentation/asset-protection/security-mechanisms.md)
- [Risk framework](https://docs.byzantine.fi/documentation/asset-protection/risk-framework.md): Every material risk in Byzantine Prime is mapped to a measurable control.
- [Regulatory framework](https://docs.byzantine.fi/documentation/asset-protection/regulatory-framework.md)
- [Security audits](https://docs.byzantine.fi/documentation/asset-protection/security-audits.md)
- [Insurance](https://docs.byzantine.fi/documentation/asset-protection/insurance.md): How Byzantine Prime's optional insurance coverage works and what it protects against.

### Account setup & security

- [Creating your account](https://docs.byzantine.fi/documentation/account-management/account-creation.md)
- [KYC and KYB](https://docs.byzantine.fi/documentation/account-management/kyc-and-kyb.md)
- [Understanding passkeys](https://docs.byzantine.fi/documentation/account-management/passkeys.md): What passkeys are, why Byzantine uses them, and how they keep your account secure.

### Digital assets 101

- [Understanding EUR- and USD-linked units](https://docs.byzantine.fi/documentation/digital-assets-101/whats-a-stablecoin.md)
- [MiCA, in plain English](https://docs.byzantine.fi/documentation/digital-assets-101/what-is-mica.md)
- [How borrower interest creates returns](https://docs.byzantine.fi/documentation/digital-assets-101/what-is-digital-credit.md)
- [Why borrowers provide more than they borrow](https://docs.byzantine.fi/documentation/digital-assets-101/overcollateralisation-and-liquidation.md): How the collateral system protects depositors and what happens when it is tested.

## API reference

### Integrator API

- [Authentication methods](https://docs.byzantine.fi/api-reference/authentication-methods.md): Methods to ensure user ownership over their wallet.
- [Account activation](https://docs.byzantine.fi/api-reference/account-activation.md): Activating an account for enabling transactions.

#### Getting started

- [Getting started](https://docs.byzantine.fi/api-reference/getting-started.md)
- [Byzantine SDK](https://docs.byzantine.fi/api-reference/byzantine-sdk.md): Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.
- [API authentication](https://docs.byzantine.fi/api-reference/api-authentication.md): Authentication for the Byzantine API.
- [Sandbox](https://docs.byzantine.fi/api-reference/sandbox.md)
- [Concepts](https://docs.byzantine.fi/api-reference/concepts.md): Key concepts in the Byzantine infrastructure.

#### Account creation

- [High level overview](https://docs.byzantine.fi/api-reference/kyc-kyb-overview.md): High level overview of the KYC and KYB process.
- [Terms and Conditions](https://docs.byzantine.fi/api-reference/terms-and-conditions.md): Accept Byzantine terms before creating a user or entity account.
- [Multi-accounts](https://docs.byzantine.fi/api-reference/multi-accounts.md): A single user can be associated with multiple Byzantine accounts.
- [Individuals - KYC](https://docs.byzantine.fi/api-reference/kyc.md)
- [Legal entities - KYB](https://docs.byzantine.fi/api-reference/kyb.md)
- [Required documents](https://docs.byzantine.fi/api-reference/accepted-documents.md)
- [Verification statuses](https://docs.byzantine.fi/api-reference/verification-statuses.md): Verification statuses during the KYC and KYB process.

##### Lists

- [Countries](https://docs.byzantine.fi/api-reference/lists/countries.md)
- [Occupation codes](https://docs.byzantine.fi/api-reference/lists/occupation-codes.md)
- [Company industry codes](https://docs.byzantine.fi/api-reference/lists/industry-codes.md)
- [Entity number types by country](https://docs.byzantine.fi/api-reference/lists/company-number-types.md)

#### Account management

- [Overview](https://docs.byzantine.fi/api-reference/management-overview.md): Manage existing Byzantine accounts, users, and authenticators after creation.
- [Multi-users account](https://docs.byzantine.fi/api-reference/multi-users-account.md): Managing multi-users Byzantine accounts via the Integrator API.
- [Bank account](https://docs.byzantine.fi/api-reference/bank-account.md): Managing bank accounts for Byzantine accounts via the Integrator API.

#### Transactions

- [Overview](https://docs.byzantine.fi/api-reference/transactions-overview.md): How deposits, withdrawals, and related flows work across passkey auth.
- [Stablecoin transfer](https://docs.byzantine.fi/api-reference/transfer.md): How to transfer assets from a Byzantine account to any wallet.
- [Tracking transactions](https://docs.byzantine.fi/api-reference/tracking-transactions.md): Transaction types, lifecycle statuses, and how to list them across all your accounts.
- [Idle balance](https://docs.byzantine.fi/api-reference/account-balances-idle.md): Stablecoin balance that is sitting in the user's wallet.

##### Deposit

- [High level overview](https://docs.byzantine.fi/api-reference/deposit-overview.md): High level overview of the deposit process.
- [Technical implementation](https://docs.byzantine.fi/api-reference/deposit-technical.md): How to make a deposit into a Byzantine vault.

##### Withdrawal

- [High level overview](https://docs.byzantine.fi/api-reference/withdrawal-overview.md): High level overview of the withdrawal process.
- [Technical implementation](https://docs.byzantine.fi/api-reference/withdrawal-technical.md): How to make a withdrawal from a Byzantine vault.

#### Webhooks

- [Overview](https://docs.byzantine.fi/api-reference/webhooks/overview.md): Receive signed customer and transaction lifecycle events from Byzantine.
- [Customer webhooks](https://docs.byzantine.fi/api-reference/webhooks/customers.md): Customer onboarding (KYC/KYB) lifecycle webhook events.
- [Transaction webhooks (available soon)](https://docs.byzantine.fi/api-reference/webhooks/transactions.md): Deposit and withdrawal lifecycle webhook events.

### API endpoints

- [Overview](https://docs.byzantine.fi/api-reference/endpoints-overview.md)
- [Sandbox authentication](https://docs.byzantine.fi/api-reference/sandbox-auth.md): Activate request signing for the interactive API playground
- [Changelog](https://docs.byzantine.fi/api-reference/changelog.md): Release notes for the Byzantine API.

#### API health

- [Health check](https://docs.byzantine.fi/api-reference/api-health/health-check.md): Returns the health status of the API

#### Customer management

- [List all customers](https://docs.byzantine.fi/api-reference/customer-management/list-all-customers.md): Returns business customers (entities with their team members) and/or individual customers (users without an entity). Use the `customer_type` query parameter to filter: - `business`: only business customers - `individual`: only individual customers - `all` (default): both business and individual cust…
- [Get details of a single user](https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-user.md): This endpoint returns comprehensive information about a user including: - Basic user information (name, email, address) - Verification status - Associated accounts details
- [Get details of a single entity](https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-entity.md): This endpoint returns comprehensive information about a business entity including: - Basic business information (name, email, addresses) - Associated account details - Team members (users who are part of the team) - Associated persons (beneficiaries and representatives) - Pending invitations (invita…
- [Get details of a single associated person](https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-associated-person.md): This endpoint returns the full record of one beneficiary or representative of an entity: - Personal information (name, contact, birth details, residential address) - Beneficiary details (type, title held at the business, ownership share) - Verification status and the documents still missing

##### Customer creation

- [Create individual account](https://docs.byzantine.fi/api-reference/customer-management/create-individual-account.md): The account beneficiary is the person described in `user_info` (the KYC subject). `root_users` are the signers: the owner themselves (same email), or a wealth manager / CGP operating on the owner's behalf.
- [Create entity](https://docs.byzantine.fi/api-reference/customer-management/create-entity.md): `email` and `associatedPersons.email` must be unique at each call of the endpoint. For emails, you can use the `+` sign to make them unique, e.g. byzcorp+1@example.com.
- [Update an individual account's user details](https://docs.byzantine.fi/api-reference/customer-management/update-an-individual-accounts-user-details.md): It is possible to call this endpoint as many times as necessary to submit additional information/documents to complete the account. Only the `accountId` is required.
- [Update an entity account's company details](https://docs.byzantine.fi/api-reference/customer-management/update-an-entity-accounts-company-details.md)
- [Add an associated person to an entity account](https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account.md)
- [Update an associated person's details](https://docs.byzantine.fi/api-reference/customer-management/update-an-associated-persons-details.md)

#### Account management

- [Get single account balances](https://docs.byzantine.fi/api-reference/account-management/get-single-account-balances.md): Fetch all vault positions for a specific account from the indexer. Returns balance information including vault details and current price per share. If chain_id is not specified, returns balances for all chains. If include_test_vaults is not specified, defaults to false (excludes test vaults).
- [Get details of a single account](https://docs.byzantine.fi/api-reference/account-management/get-details-of-a-single-account.md): Returns details for a specific account including name, type, wallet address, and associated entity information if applicable.

##### Bank accounts

- [List bank accounts](https://docs.byzantine.fi/api-reference/account-management/list-bank-accounts.md): Fetch all associated bank accounts for a specific Byzantine account ID.
- [Add bank account](https://docs.byzantine.fi/api-reference/account-management/add-bank-account.md): Add a bank account to withdraw to. At least one bank account must be added before any off-ramp withdrawal can be initated.

##### Multi-users account

- [List invitations by account](https://docs.byzantine.fi/api-reference/account-management/list-invitations-by-account.md): Fetch all invitations associated with a specific Byzantine account ID. Returns invitation details including the invited user's name and email, account name, and inviter name.
- [List invitations by email](https://docs.byzantine.fi/api-reference/account-management/list-invitations-by-email.md): Fetch all invitations for a specific email address.
- [List all invitations across every account of the authenticated integrator](https://docs.byzantine.fi/api-reference/account-management/list-all-invitations-across-every-account-of-the-authenticated-integrator.md): Returns invitations across all accounts owned by the integrator, paginated and ordered (DESC by default).

###### Add team member

- [Step 1 Get invite users payload (passkey)](https://docs.byzantine.fi/api-reference/account-management/step-1-get-invite-users-payload-passkey.md): Get the payload to sign in order to invite users to an existing account. Part of the passkey authentication flow.
- [Step 2 Send invitations (passkey)](https://docs.byzantine.fi/api-reference/account-management/step-2-send-invitations-passkey.md): Send an invitation to users to join a Byzantine account. If the users did not yet do a KYC on Byzantine, an email will ask them to do so.

###### User roles

- [Step 1 Get update role payload (passkey)](https://docs.byzantine.fi/api-reference/account-management/step-1-get-update-role-payload-passkey.md): Get the payload to sign in order to update users' roles within a Byzantine account. Part of the passkey authentication flow.
- [Step 2 Update users role (passkey)](https://docs.byzantine.fi/api-reference/account-management/step-2-update-users-role-passkey.md): Update the roles of users of a Byzantine account. This action must be approved by the current root quorum.

#### Products

- [List all products](https://docs.byzantine.fi/api-reference/products/list-all-products.md): Returns a list of all Byzantine vaults from configuration. "Vaults" are deposit products, the main entities in the Byzantine protocol.
- [Get single product APY](https://docs.byzantine.fi/api-reference/products/get-single-product-apy.md): Calculate APY for daily, weekly, monthly, and yearly periods with fallback to oldest available data.
- [Get single vault history](https://docs.byzantine.fi/api-reference/products/get-single-vault-history.md): Returns hourly aggregated share price data for a vault.
- [Get all assets](https://docs.byzantine.fi/api-reference/products/get-all-assets.md)

#### Transactions

- [List all transactions across every account of the authenticated integrator](https://docs.byzantine.fi/api-reference/transactions/list-all-transactions-across-every-account-of-the-authenticated-integrator.md): Returns transactions across all accounts owned by the integrator, paginated and ordered (DESC by default). Excludes transactions still in an internal status (`created`, `claimed`).
- [List all transactions](https://docs.byzantine.fi/api-reference/transactions/list-all-transactions.md): Returns all deposit, withdrawal, and approval transactions with pending or completed status. Excludes transactions still in an internal status (`created`, `claimed`).
- [Get single transaction](https://docs.byzantine.fi/api-reference/transactions/get-single-transaction.md): Transactions still awaiting signature (unsigned drafts) return 404: they only become visible once `sign-payload` has succeeded.

##### Passkey flow

- [Get activate account payload](https://docs.byzantine.fi/api-reference/transactions/get-activate-account-payload.md): Get the authorization to sign to activate the account with EIP 7702 allowing gas sponsorship.
- [Get deposit payload](https://docs.byzantine.fi/api-reference/transactions/get-deposit-payload.md): Get the payload to sign in order to make a deposit. Part of the passkey authentication flow.
- [Get withdraw payload](https://docs.byzantine.fi/api-reference/transactions/get-withdraw-payload.md): Get the payload to sign in order to make a withdrawal. Part of the passkey authentication flow.
- [Get vault upgrade payload (Base -> Ethereum)](https://docs.byzantine.fi/api-reference/transactions/get-vault-upgrade-payload-base->-ethereum.md): Returns two raw payloads to sign with one passkey prompt: a withdraw from the Base vault and a deposit on the destination Ethereum vault. The destination vault address is derived from a static mapping on the source vault address.
- [Get transfer payload](https://docs.byzantine.fi/api-reference/transactions/get-transfer-payload.md): Get the payload to sign in order to transfer assets from the account's wallet to any destination wallet. Part of the passkey authentication flow.
- [Get cancellation payload for a withdrawal request](https://docs.byzantine.fi/api-reference/transactions/get-cancellation-payload-for-a-withdrawal-request.md): Get the payload to sign in order to cancel a queued withdrawal. Part of the passkey authentication flow.
- [Sign payload](https://docs.byzantine.fi/api-reference/transactions/sign-payload.md): Sign a payload allowing Byzantine to make, execute and sponsor the transaction.

#### Webhooks

- [Create a webhook subscription.](https://docs.byzantine.fi/api-reference/webhooks/create-a-webhook-subscription.md): Registers an integrator-owned webhook endpoint, validates its HTTPS/DNS safety metadata, creates an active P-256 signing key, and returns the public verification key for future deliveries.
- [List webhook subscriptions.](https://docs.byzantine.fi/api-reference/webhooks/list-webhook-subscriptions.md): Returns all webhook subscriptions owned by the authenticated integrator, including each subscription's active public signing key.
- [Update a webhook subscription.](https://docs.byzantine.fi/api-reference/webhooks/update-a-webhook-subscription.md): Updates an integrator-owned webhook subscription. URL changes are revalidated for endpoint safety before being persisted.
- [Delete a webhook subscription.](https://docs.byzantine.fi/api-reference/webhooks/delete-a-webhook-subscription.md): Deletes a webhook subscription owned by the authenticated integrator and cascades its webhook delivery records according to the database outbox schema.
- [Send a signed test webhook.](https://docs.byzantine.fi/api-reference/webhooks/send-a-signed-test-webhook.md): Creates a durable `webhook.test` event and delivery record, signs the exact outbound JSON body with the subscription's active P-256 key, and attempts delivery to the configured endpoint.
- [List webhook delivery history.](https://docs.byzantine.fi/api-reference/webhooks/list-webhook-delivery-history.md): Returns recent webhook delivery records for the authenticated integrator with their source event payloads and recorded delivery attempts.
- [Retry a webhook delivery.](https://docs.byzantine.fi/api-reference/webhooks/retry-a-webhook-delivery.md): Manually retries a retryable webhook delivery owned by the authenticated integrator. Disabled subscriptions and terminal, succeeded, or in-flight deliveries are rejected.

#### Events

- [Lists persisted lifecycle events owned by the authenticated integrator, newest first.](https://docs.byzantine.fi/api-reference/events/lists-persisted-lifecycle-events-owned-by-the-authenticated-integrator-newest-first.md)

#### OTP authentication

- [Step 1 Initialize OTP (send email)](https://docs.byzantine.fi/api-reference/otp-authentication/step-1-initialize-otp-send-email.md)
- [Step 2 Authenticate with OTP code](https://docs.byzantine.fi/api-reference/otp-authentication/step-2-authenticate-with-otp-code.md): Returns a session ID that can be used to submit an authenticated action.
- [Step 3 Create passkeys (OTP auth)](https://docs.byzantine.fi/api-reference/otp-authentication/step-3-create-passkeys-otp-auth.md): Adds passkeys to a user's account by authenticating with a previously established OTP session.

#### Integrator key management

- [Get current integrator credential capabilities](https://docs.byzantine.fi/api-reference/integrator-key-management/get-current-integrator-credential-capabilities.md): Returns the authenticated integrator id, credential access scope, label, and capability flags for frontend UX.
- [List integrator credentials](https://docs.byzantine.fi/api-reference/integrator-key-management/list-integrator-credentials.md): Returns every credential owned by the authenticated integrator, oldest first: public key, access scope, active status, label, and creation time. Private keys are returned only in the creation response and are not stored by the API, so they never appear in this list.
- [Issue a credential for the authenticated integrator](https://docs.byzantine.fi/api-reference/integrator-key-management/issue-a-credential-for-the-authenticated-integrator.md): Generates a new credential keypair and stores the public key as an active credential with the requested access scope (`read_only` by default). The private key is returned only in this creation response and is not stored by the API. Requires a read-write credential.
- [Update a credential](https://docs.byzantine.fi/api-reference/integrator-key-management/update-a-credential.md): Partially updates a credential owned by the authenticated integrator: `label`, `active`, and `accessScope` can each be changed independently; omitted fields are left untouched. The credential signing the current request can only change its own label, not its own `active` status or access scope, so a…
- [Delete an integrator credential](https://docs.byzantine.fi/api-reference/integrator-key-management/delete-an-integrator-credential.md): Permanently removes a credential owned by the authenticated integrator; the associated public key stops authenticating immediately. The credential signing the current request cannot delete itself, so an integrator always keeps at least one working read-write credential. Requires a read-write credent…

## OpenAPI Specs

- [openapi-integrator](/api-reference/openapi-integrator.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [French (32 pages)](https://docs.byzantine.fi/_llms/fr.md): Documentation for French.