# Byzantine Finance

## Docs

- [Account setup](https://docs.byzantine.fi/account-setup.md)
- [Required documents](https://docs.byzantine.fi/api-reference/accepted-documents.md)
- [Account activation](https://docs.byzantine.fi/api-reference/account-activation.md): Activating an account for enabling transactions.
- [Idle balance](https://docs.byzantine.fi/api-reference/account-balances-idle.md): Stablecoin balance that is sitting in the user's wallet.
- [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.
- [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.
- [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).
- [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.
- [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.
- [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 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 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.
- [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.
- [API authentication](https://docs.byzantine.fi/api-reference/api-authentication.md): Authentication for the Byzantine API.
- [Health check](https://docs.byzantine.fi/api-reference/api-health/health-check.md): Returns the health status of the API
- [Authentication methods](https://docs.byzantine.fi/api-reference/authentication-methods.md): Methods to ensure user ownership over their wallet.
- [Bank account](https://docs.byzantine.fi/api-reference/bank-account.md): Managing bank accounts for Byzantine accounts via the Integrator API.
- [Byzantine SDK](https://docs.byzantine.fi/api-reference/byzantine-sdk.md): Official TypeScript SDK for integrator API authentication, WebAuthn, and API method wrappers.
- [Concepts](https://docs.byzantine.fi/api-reference/concepts.md): Key concepts in the Byzantine infrastructure.
- [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)
- [Create entity account](https://docs.byzantine.fi/api-reference/customer-management/create-entity-account.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.
- [Create individual account](https://docs.byzantine.fi/api-reference/customer-management/create-individual-account.md): `email` must be unique at each call of the endpoint. You can use the `+` sign to make them unique, e.g. alice+1@example.com. It is possible to create an individual account with only the following details and then call the `update-individual-account` to complete the application: - `firstName` - `last…
- [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 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
- [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…
- [Update an associated person's details](https://docs.byzantine.fi/api-reference/customer-management/update-an-associated-persons-details.md)
- [Update an entity account's company details](https://docs.byzantine.fi/api-reference/customer-management/update-an-entity-accounts-company-details.md)
- [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.
- [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.
- [Overview](https://docs.byzantine.fi/api-reference/endpoints-overview.md)
- [Getting started](https://docs.byzantine.fi/api-reference/getting-started.md)
- [Legal entities - KYB](https://docs.byzantine.fi/api-reference/kyb.md)
- [Individuals - KYC](https://docs.byzantine.fi/api-reference/kyc.md)
- [High level overview](https://docs.byzantine.fi/api-reference/kyc-kyb-overview.md): High level overview of the KYC and KYB process.
- [Entity number types by country](https://docs.byzantine.fi/api-reference/lists/company-number-types.md)
- [Countries](https://docs.byzantine.fi/api-reference/lists/countries.md)
- [Company industry codes](https://docs.byzantine.fi/api-reference/lists/industry-codes.md)
- [Occupation codes](https://docs.byzantine.fi/api-reference/lists/occupation-codes.md)
- [Overview](https://docs.byzantine.fi/api-reference/management-overview.md): Manage existing Byzantine accounts, users, and authenticators after creation.
- [Multi-accounts](https://docs.byzantine.fi/api-reference/multi-accounts.md): A single user can be associated with multiple Byzantine accounts.
- [Multi-users account](https://docs.byzantine.fi/api-reference/multi-users-account.md): Managing multi-users Byzantine accounts via the Integrator API.
- [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.
- [Get all assets](https://docs.byzantine.fi/api-reference/products/get-all-assets.md)
- [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.
- [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.
- [Sandbox](https://docs.byzantine.fi/api-reference/sandbox.md)
- [Terms and Conditions](https://docs.byzantine.fi/api-reference/terms-and-conditions.md): Accept Byzantine terms before creating a user or entity account.
- [Overview](https://docs.byzantine.fi/api-reference/transactions-overview.md): How deposits, withdrawals, and related flows work across passkey auth.
- [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 single transaction](https://docs.byzantine.fi/api-reference/transactions/get-single-transaction.md)
- [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 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.
- [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 with "created" status.
- [Sign payload](https://docs.byzantine.fi/api-reference/transactions/sign-payload.md): Sign a payload allowing Byzantine to make, execute and sponsor the transaction.
- [Verification statuses](https://docs.byzantine.fi/api-reference/verification-statuses.md): Verification statuses during the KYC and KYB process.
- [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.
- [Create & secure your account](https://docs.byzantine.fi/create-your-account.md)
- [Currency & yield](https://docs.byzantine.fi/currency-and-yield.md)
- [Deposits & withdrawals](https://docs.byzantine.fi/deposits-and-withdrawals.md)
- [Deposits and Withdrawals](https://docs.byzantine.fi/documentation/about-byzantine/deposits-and-withdrawals.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.
- [Byzantine Prime - product details](https://docs.byzantine.fi/documentation/about-byzantine/product-details.md)
- [The digital asset opportunity](https://docs.byzantine.fi/documentation/about-byzantine/the-digital-asset-opportunity.md)
- [What is Byzantine Prime?](https://docs.byzantine.fi/documentation/about-byzantine/what-is-byzantine.md)
- [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.
- [Insurance](https://docs.byzantine.fi/documentation/asset-protection/insurance.md): How Byzantine Prime's optional insurance coverage works and what it protects against.
- [Regulatory framework](https://docs.byzantine.fi/documentation/asset-protection/regulatory-framework.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.
- [Security audits](https://docs.byzantine.fi/documentation/asset-protection/security-audits.md)
- [Security mechanisms](https://docs.byzantine.fi/documentation/asset-protection/security-mechanisms.md)
- [Overcollateralisation & liquidation](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.
- [What is digital credit?](https://docs.byzantine.fi/documentation/digital-assets-101/what-is-digital-credit.md)
- [What is MiCA?](https://docs.byzantine.fi/documentation/digital-assets-101/what-is-mica.md)
- [What is a stablecoin?](https://docs.byzantine.fi/documentation/digital-assets-101/whats-a-stablecoin.md)
- [Identity verification - organisation](https://docs.byzantine.fi/for-organisation-accounts.md)
- [For wealth managers](https://docs.byzantine.fi/for-wealth-managers.md)
- [Get to know your dashboard](https://docs.byzantine.fi/get-to-know-your-dashboard.md)
- [Welcome!](https://docs.byzantine.fi/index.md)
- [KYB process](https://docs.byzantine.fi/kyb-process.md)
- [Making your first deposit](https://docs.byzantine.fi/making-your-first-deposit.md)
- [Passkey reset](https://docs.byzantine.fi/passkey-reset.md): How to troubleshoot passkey issues and reset your passkey with help from Byzantine.
- [Security & compliance](https://docs.byzantine.fi/security-and-compliance.md)
- [Technical questions](https://docs.byzantine.fi/technical-questions.md)
- [Users & roles](https://docs.byzantine.fi/users-and-roles.md)
- [Withdrawals](https://docs.byzantine.fi/withdrawals.md)

## OpenAPI Specs

- [openapi-integrator](https://docs.byzantine.fi/api-reference/openapi-integrator.json)

## Optional

- [API reference](https://docs.byzantine.fi/api-reference/getting-started)