# Layer 1 API Documentation

> Layer 1 documentation: digital assets, treasury, channels, webhooks, and approvals.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Create a blockchain address](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/create-addresses.md): Unique blockchain wallet addresses
- [Create a merchant account](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/creating-accounts.md): Adding your Merchants as part of the whitelabel Payment Services solution.
- [Create an asset pool](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/creating-an-asset-pool.md): Your collection of funds across networks
- [Deposit and withdraw funds](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/deposits-and-withdrawals.md): Seeing your assets move
- [Manage Smart Treasury](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/manage-smart-treasury.md): Automate liquidity top-ups in your Layer1 Wallet based on configurable thresholds and AI-powered forecasts.
- [Create tenant account and add users](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/tenant-and-user-creation.md): Getting access
- [Organise wallets, channels, and payment links](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/wallets-channels-payment-links.md): Account portal payments feature set
- [Get started with sandbox portal](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal.md): Explore the Layer1 back office portal in Sandbox
- [Overview](https://docs.bvnk.com/layer1/getting-started.md): The wallet service and blockchain node provider service, all bundled into one.
- [Auto-consolidate assets in master wallet](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/automatic-fund-conslidation.md): Auto-consolidation is a native feature of the Layer1 platform that automatically aggregates dispersed liquidity from multiple blockchain deposit wa...
- [Create a crypto address](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/create-a-new-crypto-address.md): Once you have an Asset Pool and `id` from the earlier request, you can generate crypto addresses within that Asset Pool. See the list of available ...
- [Create an asset pool](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/create-an-asset-pool.md): An Asset Pool is a collection of funds from various currencies and networks, all grouped together. That means all actions can be focused at the poo...
- [Receive deposit and ingest the webhooks](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/receive-deposit-and-ingest-the-webhooks.md): Once you share the address with a depositor, wait for the deposit to arrive. When Layer1 detects such a transaction, the following webhook types ar...
- [Recover funds sent on incorrect network](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/recover-funds-from-incorrect-network.md): The guide explains how to recover funds that were sent over the incorrect network.
- [Set up a webhook destination](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/set-up-a-webhook-destination.md): Webhooks allow you to subscribe to specific events or multiple events within a single destination.
- [Receive deposits](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses.md): This guide outlines the process for accepting deposits into a unique address created for the transaction.
- [Add a contact](https://docs.bvnk.com/layer1/use-cases/digital-assets/add-a-contact.md): Manage trusted withdrawal addresses for first- and third-party accounts to enable seamless transfers and reduce the risk of sending funds to incorr...
- [Approve withdrawals](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/approve-withdrawals.md): To set up approvals for your Layer1 account, first follow the steps outlined in the [Configure Approval for Withdrawals ](/layer1/use-cases/digital...
- [Configure approvals for withdrawals](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/configure-approval-settings.md): Approval settings allow you to configure rules to govern outgoing transactions from your asset pools. By setting volume-based thresholds, you can r...
- [Create withdrawal transaction](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/creating-the-withdrawal.md): To create a withdrawal transaction, send [`POST /digital/v1/transaction-requests`](/l1-api/digital-assets/create-transaction) request with the foll...
- [Receive withdrawal notifications](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/understanding-the-withdrawal-webhooks.md): Once the transaction has been submitted, the following webhooks are sent out for each stage of the withdrawal process.
- [Send withdrawals](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request.md): Create a transaction to withdraw crypto from your asset pool and send it to an external wallet.
- [Screen transactions](https://docs.bvnk.com/layer1/use-cases/digital-assets/screening-providers.md): Layer1 integrates with leading blockchain intelligence platforms to help identify and mitigate exposure to high-risk counterparties. Today, the pla...
- [Stake TRX to reduce gas fees](https://docs.bvnk.com/layer1/use-cases/digital-assets/staking.md): This step-by-step guide explains how staking works on the TRON network and how that saves you gas fees.
- [Digital assets](https://docs.bvnk.com/layer1/use-cases/digital-assets.md): Receive deposits, send withdrawals, manage asset pools, and screen transactions using the Layer1 Digital Assets API.
- [Create pay-in](https://docs.bvnk.com/layer1/use-cases/merchant-payments/building-a-checkout-for-crypto-payments-1/creating-a-payment-1.md): To initiate a payment process, send the [`POST /api/v1/pay/summary`](/l1-api/crypto-payments/payment-create) request with the following body parame...
- [Receive pay-in notifications](https://docs.bvnk.com/layer1/use-cases/merchant-payments/building-a-checkout-for-crypto-payments-1/listening-for-payment-in-webhooks-1.md): Layer1 sends out a series of webhooks to keep you informed on any lifecycle event for the payment you have created.
- [Accept digital asset payments](https://docs.bvnk.com/layer1/use-cases/merchant-payments/building-a-checkout-for-crypto-payments-1.md): This guide outlines the process for incorporating crypto payments into your workflow with Layer1 via API, allowing you to customise your own paymen...
- [Charge merchant fees](https://docs.bvnk.com/layer1/use-cases/merchant-payments/charge-merchant-fees.md): With Layer1’s Fee Service, you have all the tools to charge your merchants for the payment processing services you provide. Setting this up correct...
- [Payment in](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/creating-a-payment-in.md): Initiating the payment in flow
- [Directing the end-user to pay](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/directing-the-user-to-pay.md): Redirect the end-user to the Hosted Payments Page to complete the payment
- [Directing the end-user to payout](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/directing-the-user-to-payout.md): Redirect the user to the Hosted Payments Page so that they can complete the payment
- [Listening for payment in webhooks](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/listening-for-payment-in-webhooks.md): Get notified of all state changes in the payment journey
- [Listening for payout webhooks](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/listening-for-payout-webhooks.md): Get notified of all state changes in the payment journey
- [(Optional) Pre-selecting the digital asset to pay](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/optional-preselecting-digital-asset-to-pay.md): Skip a step in the journey by having the digital asset already selected
- [(Optional) Pre-selecting the digital asset to receive](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/optional-preselecting-digital-asset-to-receive.md): Skip a step in the journey by having the digital asset already selected
- [Handle payment in exceptions](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/payment-in-exception-scenarios-1.md): The final step is to build in handling for exceptions that may occur in the payment flow. We have discussed the types of webhooks in a previous pag...
- [Payout](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/payment-out.md): Initiating the payout flow
- [Hosted checkout for digital asset payments](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments.md): Use our hosted checkout experience or build your own
- [Create a payout](https://docs.bvnk.com/layer1/use-cases/merchant-payments/sending-crypto-payouts/create-a-pay-out-with-payment-out-details.md): To initiate a payment out, send the [`POST /api/v1/pay/summary`](/l1-api/crypto-payments/payment-create) request with `type` set to `OUT`. Remember...
- [Receive payout notifications](https://docs.bvnk.com/layer1/use-cases/merchant-payments/sending-crypto-payouts/listening-for-payout-webhooks.md): Layer1 sends out a series of webhooks to keep you informed on any lifecycle event for the payment you have created.
- [Send digital asset payouts](https://docs.bvnk.com/layer1/use-cases/merchant-payments/sending-crypto-payouts.md): This quick start guide aims to assist you in adding crypto payout capabilities to your product.
- [Set up payment processing](https://docs.bvnk.com/layer1/use-cases/merchant-payments/set-up-payment-processing.md): The following guide outlines the initial setup required to begin processing payments with the Merchant Payments Engine. These are one-time configur...
- [Merchant payments](https://docs.bvnk.com/layer1/use-cases/merchant-payments.md): The **Merchant Payment Engine** is a complete, off-the-shelf crypto checkout solution explicitly built for Layer1 tenants. It lets you instantly gi...
- [Add Ethereum wallet for USDT and USDC](https://docs.bvnk.com/layer1/use-cases/testing-your-integration/setting-up-a-metamask-ethereum-wallet-for-eth-and-usdt-erc20-tokens.md): Set Up a MetaMask Ethereum Wallet for ETH and USDT ERC20 tokens.
- [Add TronLink wallet for TRX and USDT](https://docs.bvnk.com/layer1/use-cases/testing-your-integration/setting-up-a-tronlink-wallet-for-trx-and-usdt-trc20-tokens.md): Set Up a TronLink Wallet for TRX and USDT TRC20 tokens.
- [Test blockchain integration](https://docs.bvnk.com/layer1/use-cases/testing-your-integration.md): Use a test network to check your integration with real blockchains.
- [Understanding the conversion flow](https://docs.bvnk.com/layer1/use-cases/trading/converting-or-trading-your-balances/understanding-the-conversion-flow.md): This section describes the lifecycle of a conversion and order on the Layer1 platform, outlining the different statuses a conversion goes through f...
- [Convert balances](https://docs.bvnk.com/layer1/use-cases/trading/converting-or-trading-your-balances.md): Using Layer1 you can convert balances held at your connected trading venues. With Layer1's API connections to the venues you are able to optimise c...
- [Add trading venues](https://docs.bvnk.com/layer1/use-cases/trading/trading-venues.md): Layer1 integrates with trading venues via the [XChange Java library](https://github.com/knowm/XChange). This provides consistent access to major ex...
- [Trading](https://docs.bvnk.com/layer1/use-cases/trading.md)
- [Manage balances](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/manage-balances.md): This guide provide a detailed description of all operations involving managed balances.
- [Manage funding sources](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/manage-funding-sources.md): To **add a funding source to a managed balance**, send a [`PUT /treasury/v1/managed-balances/{managedBalanceId}/eligible-sources/{sourceManagedBala...
- [Predict top-ups](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/predict-top-ups.md): Forecasting helps automate your treasury operations with data-backed intelligence. It ensures you always have the right funds, in the right place, ...
- [Quick start](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/quick-start.md): Use the Smart Treasury API to automate wallet funding and ensure constant liquidity without manual intervention. This guide walks you through three...
- [Receive notifications](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/receive-notification.md): When Layer1 detects a managed balance transaction , the following webhooks types are sent out:
- [View and adjust balance](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/view-and-adjust-balance.md): To **create a manual balance adjustment**, send a [`POST /treasury/v1/balance-adjustments`](/l1-api/treasury/execute-balance-adjustment-1) request ...
- [Automate treasury top-ups](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups.md): This guide explains how to integrate with the Smart Treasury APIs to automate top-ups, configure thresholds, and monitor liquidity.
- [Smart treasury](https://docs.bvnk.com/layer1/use-cases/treasury.md)
- [Dust classification](https://docs.bvnk.com/layer1/references/dust-classification.md): <div className="full-width-tables">
- [Reporting and reconciliation](https://docs.bvnk.com/layer1/references/reporting-reconciliation.md): Layer1 reporting tools help you track wallet activity, monitor balances, and export data to match against your internal financial records. Use this...
- [Roles and permissions](https://docs.bvnk.com/layer1/references/roles.md): User and API key role descriptions
- [Supported assets and networks](https://docs.bvnk.com/layer1/references/supported-assets-and-protocols.md): The supported digital assets on our platform, including details such as their code, protocols, and the required block confirmations for transactions.
- [Authentication](https://docs.bvnk.com/l1-api/api-overview/authentication.md): This guide explains how to generate and use RSA-based HTTP Message Signatures to securely authenticate API requests to Layer1.
- [Errors](https://docs.bvnk.com/l1-api/api-overview/errors.md): The following reference contains a list of error codes, their messages, and descriptions for errors that may be encountered when using the Layer1 API.
- [Webhooks](https://docs.bvnk.com/l1-api/api-overview/webhooks.md): Webhooks are critical for real-time notifications within our Layer1 platform, enabling automated updates related to payments, conversions, or new a...
- [Approvals](https://docs.bvnk.com/l1-api/approvals/approvals.md): Layer1 API for approvals management
- [Bulk vote](https://docs.bvnk.com/l1-api/approvals/bulk-vote.md): Submits the same vote decision (approve or reject) for multiple approval requests. Processes each request independently and returns detailed result...
- [Count approval requests](https://docs.bvnk.com/l1-api/approvals/count-approval-requests.md): Returns the total count of approval requests matching the specified criteria.
- [Get approval request status](https://docs.bvnk.com/l1-api/approvals/get-approval-request-status.md): Retrieves the current status and last update time for a specific approval request.
- [Get approval request details](https://docs.bvnk.com/l1-api/approvals/get-approval-request.md): Retrieves complete details of an approval request including votes, requirements, and context.
- [Get approval settings](https://docs.bvnk.com/l1-api/approvals/get-approval-settings.md): Retrieves current approval policy settings for a specific namespace.
- [List approval requests](https://docs.bvnk.com/l1-api/approvals/list-approval-requests.md): Retrieves a paginated and filterable list of approval requests with support for query-based search.
- [Vote on the request a policy and context name](https://docs.bvnk.com/l1-api/approvals/standing-vote.md): Holds a vote for the approval request whose context carries the values given, and applies it as soon as such a request is pending - a voter can dec...
- [Vote](https://docs.bvnk.com/l1-api/approvals/submit-vote.md): Submits an approval or rejection vote for a pending approval request. Returns updated status after evaluation.
- [Create or update approval settings](https://docs.bvnk.com/l1-api/approvals/upsert-approval-settings.md): Creates or updates approval policy settings for a specific namespace. Settings are validated before saving.
- [Asset Service](https://docs.bvnk.com/l1-api/assets/asset-service.md): Layer1 API for managing asset groups and custom assets
- [Get single asset group by code](https://docs.bvnk.com/l1-api/assets/get-asset-group.md): Retrieves a single asset group together with its enabled assets.
- [List all asset groups with enabled assets](https://docs.bvnk.com/l1-api/assets/get-asset-groups.md): Retrieves all asset groups together with their enabled assets for the authenticated tenant.
- [Get single asset](https://docs.bvnk.com/l1-api/assets/get-asset.md): Retrieves a single asset belonging to an asset group.
- [Update asset capabilities](https://docs.bvnk.com/l1-api/assets/patch-asset-capabilities.md): Updates specific capabilities (`depositEnabled`, `withdrawalEnabled`, `tradeEnabled`) of a custom asset.
- [Enable or disable all assets in an asset group](https://docs.bvnk.com/l1-api/assets/toggle-asset-group-state.md): Toggles the enabled state for all assets in a given asset group.
- [Enable or disable a single asset](https://docs.bvnk.com/l1-api/assets/toggle-asset-state.md): Toggles the enabled state for a single asset in a given asset group.
- [Create or update a custom asset](https://docs.bvnk.com/l1-api/assets/upsert-asset.md): Creates or updates a custom asset within an asset group.
- [Assign Contact to Merchant Channel](https://docs.bvnk.com/l1-api/channels/assign-contact.md): Assigns a contact to a merchant channel by updating the compliance data on its address. Accepts either an existing contactId, or inline complianceD...
- [backfillHistoricalConversions](https://docs.bvnk.com/l1-api/channels/backfill-historical-conversions.md): backfillHistoricalConversions
- [Channel](https://docs.bvnk.com/l1-api/channels/channel.md): Layer1 API making management of crypto assets simple and easy
- [Close Merchant Channel](https://docs.bvnk.com/l1-api/channels/close-channel.md): Closes a merchant channel by its UUID.
- [Create Merchant Channel](https://docs.bvnk.com/l1-api/channels/create-channel.md): Creates a new merchant channel with the provided details.
- [createHistoricalConversion](https://docs.bvnk.com/l1-api/channels/create-historical-conversion.md): createHistoricalConversion
- [depositWebhookEvents](https://docs.bvnk.com/l1-api/channels/deposit-webhook-events.md): depositWebhookEvents
- [getById](https://docs.bvnk.com/l1-api/channels/get-by-id.md): getById
- [getFailedMessagesByStatus](https://docs.bvnk.com/l1-api/channels/get-failed-messages-by-status.md): getFailedMessagesByStatus
- [Get Merchant Channel Payment by ID](https://docs.bvnk.com/l1-api/channels/get-merchant-channel-payment-by-id.md): Retrieves a specific merchant channel payment by its UUID.
- [Get Merchant Channel by UUID](https://docs.bvnk.com/l1-api/channels/get-merchant-channel.md): Retrieves a specific merchant channel by its UUID.
- [getRequiredRates](https://docs.bvnk.com/l1-api/channels/get-required-rates.md): getRequiredRates
- [Get Merchant Channel Spot Rates by UUID](https://docs.bvnk.com/l1-api/channels/get-spot-rates.md): Retrieves spot rates for a specific merchant channel by its UUID.
- [ignore](https://docs.bvnk.com/l1-api/channels/ignore.md): ignore
- [List Merchant Channel Payments](https://docs.bvnk.com/l1-api/channels/list-merchant-channel-payments.md): Retrieves a list of merchant channel payments based on the provided filters.
- [List Merchant Channels](https://docs.bvnk.com/l1-api/channels/list-merchant-channels.md): Retrieves a list of merchant channels based on the provided filters.
- [markAsFailed](https://docs.bvnk.com/l1-api/channels/mark-as-failed.md): markAsFailed
- [resendWebhook](https://docs.bvnk.com/l1-api/channels/resend-webhook.md): resendWebhook
- [retry](https://docs.bvnk.com/l1-api/channels/retry.md): retry
- [start](https://docs.bvnk.com/l1-api/channels/start.md): start
- [stop](https://docs.bvnk.com/l1-api/channels/stop.md): stop
- [tradeWebhookEvents](https://docs.bvnk.com/l1-api/channels/trade-webhook-events.md): tradeWebhookEvents
- [Update Merchant Channel](https://docs.bvnk.com/l1-api/channels/update-channel.md): Updates the reference of a merchant channel by its UUID.
- [Add payment instrument](https://docs.bvnk.com/l1-api/contacts/add-instrument.md): Adds a new payment instrument (such as a crypto address) to an existing contact. This operation may require approval depending on the trusted addre...
- [Contacts](https://docs.bvnk.com/l1-api/contacts/contacts.md): Layer1 API for managing contacts and their payment instruments
- [Create contact](https://docs.bvnk.com/l1-api/contacts/create.md): Creates a new contact. The contact can have multiple payment instruments such as crypto addresses.
- [Get contacts by IDs](https://docs.bvnk.com/l1-api/contacts/get-contacts-by-ids.md): Retrieves multiple contacts by their IDs in a single request. Specify contact IDs as a comma-separated list in the 'ids' query parameter.
- [Get contact](https://docs.bvnk.com/l1-api/contacts/get.md): Retrieves a single contact by ID.
- [List payment instruments](https://docs.bvnk.com/l1-api/contacts/list-instruments.md): Retrieves a paginated list of payment instruments for a specific contact.
- [List payment instruments](https://docs.bvnk.com/l1-api/contacts/list.md): Retrieves a paginated list of payment instruments across all contacts. Supports advanced search using Lucene-like query syntax for filtering by ins...
- [Remove payment instrument](https://docs.bvnk.com/l1-api/contacts/remove-instrument.md): Removes a payment instrument from a contact. This operation may require approval depending on the trusted address approval settings.
- [Update payment instrument](https://docs.bvnk.com/l1-api/contacts/update-instrument.md): Updates an existing payment instrument for a contact. This operation may require approval depending on the trusted address approval settings.
- [Update contact](https://docs.bvnk.com/l1-api/contacts/update.md): Updates an existing contact's information.
- [Create Merchant Channel](https://docs.bvnk.com/l1-api/crypto-payments/create-channel.md): Creates a new merchant channel with the provided details.
- [Crypto Payment API Endpoints](https://docs.bvnk.com/l1-api/crypto-payments/crypto-payment-api-endpoints.md): Crypto Payments API making management of crypto assets simple and easy
- [Get Merchant Channel Payment by ID](https://docs.bvnk.com/l1-api/crypto-payments/get-merchant-channel-payment-by-id.md): Retrieves a specific merchant channel payment by its UUID.
- [Get Merchant Channel by UUID](https://docs.bvnk.com/l1-api/crypto-payments/get-merchant-channel.md): Retrieves a specific merchant channel by its UUID.
- [Get Merchant Channel Spot Rates by UUID](https://docs.bvnk.com/l1-api/crypto-payments/get-spot-rates.md): Retrieves spot rates for a specific merchant channel by its UUID.
- [List Merchant Channel Payments](https://docs.bvnk.com/l1-api/crypto-payments/list-merchant-channel-payments.md): Retrieves a list of merchant channel payments based on the provided filters.
- [List Merchant Channels](https://docs.bvnk.com/l1-api/crypto-payments/list-merchant-channels.md): Retrieves a list of merchant channels based on the provided filters.
- [Accept Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-accept.md): Accepts a pending payment with currency or payout information.
- [Create Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-create.md): Creates a payment, either type IN or type OUT.
- [List Payments](https://docs.bvnk.com/l1-api/crypto-payments/payment-list.md): Retrieves a list of payments on a specific Merchant ID.
- [Validate Address](https://docs.bvnk.com/l1-api/crypto-payments/payment-out-validate.md): Validates that a crypto address is correct.
- [Get Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-read.md): Retrieves details of a specific payment using the UUID of the payment.
- [Update Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-update.md): Updates a pending payment with currency or payout information.
- [Read smart contract state](https://docs.bvnk.com/l1-api/digital-assets/call-contract.md): Calls a view or pure method and returns its decoded return values. No transaction is created, no fee is incurred and no funds move.
- [Claim blockchain transaction](https://docs.bvnk.com/l1-api/digital-assets/claim-transaction.md): Claims an existing blockchain transaction.
- [Create a new address](https://docs.bvnk.com/l1-api/digital-assets/create-address.md): Creates a crypto address.
- [Create addresses synchronously across all supporting networks](https://docs.bvnk.com/l1-api/digital-assets/create-addresses.md): Creates a keypair, then concurrently creates addresses on all networks supporting the given asset or assets. Pass `asset` for one asset, `assets` f...
- [Create asset pool](https://docs.bvnk.com/l1-api/digital-assets/create-asset-pool.md): Creates a new asset pool, which serves as a collection of assets.
- [Query point-in-time balances](https://docs.bvnk.com/l1-api/digital-assets/create-balance-query.md): Retrieves point-in-time balance state for a bounded list of resource IDs. ADDRESS and POOL queries are supported. ADDRESS IDs that are not found or...
- [Create consolidation request](https://docs.bvnk.com/l1-api/digital-assets/create-consolidation-request.md): Create a new address-level consolidation request to sweep funds from a specified address to the master address.
- [Deploy a smart contract](https://docs.bvnk.com/l1-api/digital-assets/create-contract-deployment.md): Deploys a registered smart contract artifact from an address in the given asset pool. The deployment is processed asynchronously; poll the returned...
- [Invoke a smart contract method](https://docs.bvnk.com/l1-api/digital-assets/create-contract-invocation.md): Invokes a state-changing method on a smart contract from an address in the given asset pool. Read-only methods must be queried through contract cal...
- [Create an export job](https://docs.bvnk.com/l1-api/digital-assets/create-export.md): Starts a CSV export. Use the required query parameter 'type' to select either a transaction or balance export.
- [Create key pair](https://docs.bvnk.com/l1-api/digital-assets/create-key-pair.md): Creates a new key pair from which different addresses can be created
- [Create return transaction request](https://docs.bvnk.com/l1-api/digital-assets/create-return-transaction-request.md): Create a new blockchain transaction meant to return previously deposited funds
- [Create staking request](https://docs.bvnk.com/l1-api/digital-assets/create-staking-transaction.md): Create a new blockchain staking transaction
- [Create transaction request](https://docs.bvnk.com/l1-api/digital-assets/create-transaction.md): Creates a blockchain transaction.
- [Delete asset pool](https://docs.bvnk.com/l1-api/digital-assets/delete-asset-pool.md): Deletes an asset pool with given ID if it doesn't have created addresses or transactions.
- [Digital Asset](https://docs.bvnk.com/l1-api/digital-assets/digital-asset.md): Layer1 API making management of crypto assets simple and easy
- [Estimate transaction fee](https://docs.bvnk.com/l1-api/digital-assets/estimate-transaction-fee.md): Estimate fee to send blockchain transaction.
- [Execute an action on an address](https://docs.bvnk.com/l1-api/digital-assets/execute-address-action.md): Executes an action on a crypto address. Supported actions: CREATE_TAG — creates a new destination tag on a tag-based network address (e.g. Ripple/X...
- [Execute an action on a transaction request](https://docs.bvnk.com/l1-api/digital-assets/execute-transaction-request-action.md): Executes an action on a transaction request. Supported actions: REJECT — rejects a transaction request that is awaiting funds, before it reaches th...
- [Get point-in-time address balance](https://docs.bvnk.com/l1-api/digital-assets/get-address-balances-at-point-in-time.md): Retrieves balance state of an address at a specific timestamp
- [Get address](https://docs.bvnk.com/l1-api/digital-assets/get-address.md): Retrieves details of the specific address.
- [Get asset pool balances at point in time](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool-balances-at-point-in-time.md): Retrieves the aggregated balance state of an asset pool at a specific historical point in time.
- [Get max asset pool withdrawable balance](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool-max-withdrawable-amount.md): Retrieves the maximum approximate withdrawable amount for a specified network and asset. **Note**: Fees are not included in this calculation.
- [Get asset pool summary](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool-summary.md): Retrieve authenticated summary across all asset pools.
- [Get asset pool](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool.md): Retrieves a specific asset pool by its unique ID.
- [Get a contract deployment](https://docs.bvnk.com/l1-api/digital-assets/get-contract-deployment.md): Retrieves a deployment, including its status and — once confirmed — the address the contract was created at.
- [Get a contract invocation](https://docs.bvnk.com/l1-api/digital-assets/get-contract-invocation.md): Retrieves an invocation, including its status and, once broadcast, its transaction hash.
- [Get smart contract artifact](https://docs.bvnk.com/l1-api/digital-assets/get-contract.md): Retrieves a smart contract artifact by id, if it is visible to the caller's tenant (owned by that tenant or available to every tenant). Bytecode is...
- [Get export with a download link](https://docs.bvnk.com/l1-api/digital-assets/get-export.md): Retrieves export details, including a short-lived download link, using the export ID.
- [List all exports](https://docs.bvnk.com/l1-api/digital-assets/get-exports.md): Retrieves a paginated list of exports based on type and pagination settings.
- [Get key pair](https://docs.bvnk.com/l1-api/digital-assets/get-key-pair.md): Retrieve a key pair given id
- [Get all networks](https://docs.bvnk.com/l1-api/digital-assets/get-networks.md): Get all supported networks and their assets. By default, only enabled networks are returned.
- [Get transaction](https://docs.bvnk.com/l1-api/digital-assets/get-transaction-by-id.md): Retrieves a transaction by its ID.
- [Get transaction request](https://docs.bvnk.com/l1-api/digital-assets/get-transaction-request-by-id.md): Retrieves a transaction request by its ID.
- [List addresses](https://docs.bvnk.com/l1-api/digital-assets/list-addresses-v-2.md): Retrieves a cursor-paginated list of crypto addresses. Follow `nextCursor` from each response to page forward; the last page omits it and reports `...
- [List asset pools](https://docs.bvnk.com/l1-api/digital-assets/list-asset-pools.md): Retrieves a paginated list of asset pools.
- [List smart contract artifacts](https://docs.bvnk.com/l1-api/digital-assets/list-contracts.md): Retrieves a paginated list of smart contract artifacts visible to the caller's tenant (its own artifacts plus artifacts available to every tenant)....
- [List deposits requiring remediation](https://docs.bvnk.com/l1-api/digital-assets/list-deposits-requiring-remediation.md): Retrieves a paginated list of deposit transactions for the authenticated tenant that require remediation (e.g. missing compliance details).
- [List key pairs](https://docs.bvnk.com/l1-api/digital-assets/list-key-pairs.md): Retrieve paginated list of key-pairs belonging to a asset pool
- [List screening results](https://docs.bvnk.com/l1-api/digital-assets/list-screenings.md): Retrieves a paginated list of the most recent transfers along with their screening results.
- [List address tags](https://docs.bvnk.com/l1-api/digital-assets/list-tags.md): Retrieves a paginated list of address tags.
- [List transaction requests](https://docs.bvnk.com/l1-api/digital-assets/list-transaction-requests.md): Retrieves a paginated list of transaction requests.
- [List transactions](https://docs.bvnk.com/l1-api/digital-assets/list-transactions.md): Retrieves a paginated list of transactions.
- [Approve, reject, bypass, or remediate screening of a transfer](https://docs.bvnk.com/l1-api/digital-assets/manually-action-transfer.md): Approves or rejects a held transfer, bypasses screening for a pending one, or remediates a transfer. The required scope depends on the requested ac...
- [Patch address](https://docs.bvnk.com/l1-api/digital-assets/patch-address.md): Partially updates an address using JSON Merge Patch (RFC 7396). Supports patching `metadata`. Within metadata, keys with non-null values are set, k...
- [Patch key pair](https://docs.bvnk.com/l1-api/digital-assets/patch-key-pair.md): Partially updates a key pair using JSON Merge Patch (RFC 7396). Only the `metadata` field can be patched. Within metadata, keys with non-null value...
- [Update asset pool](https://docs.bvnk.com/l1-api/digital-assets/update-asset-pool.md): Updates a specific asset pool property by its ID.
- [Validate address](https://docs.bvnk.com/l1-api/digital-assets/validate-address.md): Validate a blockchain address.
- [Cancel conversion](https://docs.bvnk.com/l1-api/trade/cancel-conversion.md): Attempt to cancel an in-progress conversion. Only conversions with status PENDING or PROCESSING can be cancelled.
- [Create conversion export](https://docs.bvnk.com/l1-api/trade/create-conversion-export.md): Initiates an asynchronous job to export conversion data for the specified date range. The export will be generated in the requested format and uplo...
- [Create conversion](https://docs.bvnk.com/l1-api/trade/create-conversion.md): Creates a new conversion request to exchange one asset for another. The conversion will be processed asynchronously.
- [Create a venue deposit address directly](https://docs.bvnk.com/l1-api/trade/create-venue-deposit-address.md): Creates a new deposit address by directly providing all required details. This is a synchronous operation that stores the address immediately witho...
- [Delete a venue deposit address](https://docs.bvnk.com/l1-api/trade/delete-venue-deposit-address.md): Deletes an existing deposit address for a specific venue, asset, network, and address combination. This operation is idempotent - deleting a non-ex...
- [Estimate conversion](https://docs.bvnk.com/l1-api/trade/estimate-conversion.md): Get an accurate estimate of the conversion result including expected output amount, fees, and execution time
- [List possible destination assets](https://docs.bvnk.com/l1-api/trade/find-possible-destination-assets.md): Retrieve a list of assets that can be converted to from the specified source asset, considering available trading symbols
- [Get all indicative exchange rates](https://docs.bvnk.com/l1-api/trade/get-all-indicative-rates.md): Retrieve all available indicative exchange rates for a given base currency. This endpoint returns exchange rates from the specified base asset to a...
- [Get venue balance summary aggregated by asset across available venues](https://docs.bvnk.com/l1-api/trade/get-balance-summary.md): Get venue balance summary
- [Get conversion](https://docs.bvnk.com/l1-api/trade/get-conversion.md): Retrieve detailed information about a specific conversion using its unique identifier
- [Get export with a download link](https://docs.bvnk.com/l1-api/trade/get-export.md): Retrieves export details, including a short-lived download link, using the export ID.
- [List all exports](https://docs.bvnk.com/l1-api/trade/get-exports.md): Retrieves a paginated list of exports based on type and pagination settings.
- [Get indicative exchange rate](https://docs.bvnk.com/l1-api/trade/get-indicative-rate.md): Retrieve an indicative exchange rate between two assets using mid-market/ticker rates. The rate is calculated based on current market data and prov...
- [Get aggregated order book](https://docs.bvnk.com/l1-api/trade/get-market-data-aggregated-order-book.md): Retrieve an aggregated order book that combines data from multiple venues for a given trading symbol. The aggregation includes venue information an...
- [Get market data order books](https://docs.bvnk.com/l1-api/trade/get-market-data-order-books.md): Retrieve a list of order books for a given trading symbol. Order books contain bid and ask orders with price levels and quantities. If a venue is s...
- [Get market data tickers](https://docs.bvnk.com/l1-api/trade/get-market-data-tickers.md): Retrieve a list of tickers for a given trading symbol. Tickers contain current market data including last price, bid/ask prices, volume, and high/l...
- [Get live venue quotes](https://docs.bvnk.com/l1-api/trade/get-market-data-venue-quotes.md): Fetch live quotes from a quote-executing venue. Unrecognized query parameters are relayed to the venue as venue-specific options.
- [Get venue deposit](https://docs.bvnk.com/l1-api/trade/get-venue-deposit.md): Retrieve a single venue deposit
- [Get venue withdrawal](https://docs.bvnk.com/l1-api/trade/get-venue-withdrawal.md): Retrieve detailed information about a specific withdrawal using its unique identifier
- [List venue balances](https://docs.bvnk.com/l1-api/trade/list-balances.md): List venue balances
- [List conversions](https://docs.bvnk.com/l1-api/trade/list-conversions.md): Retrieve a paginated list of conversions with optional filtering using Lucene query syntax
- [List venue deposit addresses](https://docs.bvnk.com/l1-api/trade/list-venue-deposit-addresses.md): Retrieve a paginated list of deposit addresses across all venues with optional filtering by venue, asset, status, and other criteria
- [List venue deposits](https://docs.bvnk.com/l1-api/trade/list-venue-deposits.md): Retrieve paginated list of venue deposits
- [List venue withdrawals](https://docs.bvnk.com/l1-api/trade/list-venue-withdrawals.md): Retrieve a paginated list of venue withdrawals with optional filtering by asset and venue
- [List venues](https://docs.bvnk.com/l1-api/trade/list-venues.md): Retrieve a list of trading venues
- [Request a new venue deposit address](https://docs.bvnk.com/l1-api/trade/request-venue-deposit-address.md): Creates a request for a new deposit address at a specific venue for the given asset. The address generation is processed asynchronously and the add...
- [Request venue withdrawal](https://docs.bvnk.com/l1-api/trade/request-venue-withdrawal.md): Creates a new withdrawal request to transfer funds from a venue to a blockchain address or fiat destination. The withdrawal will be processed async...
- [Trading](https://docs.bvnk.com/l1-api/trade/trading.md): Layer1 API making management of crypto assets simple and easy
- [Update venue settings](https://docs.bvnk.com/l1-api/trade/update-venue.md): Update venue properties like trading enabled status
- [Create managed balance with optional eligible sources](https://docs.bvnk.com/l1-api/treasury/create-managed-balance.md): Create a new managed balance with the ability to provide eligible sources upfront
- [Remove managed balance](https://docs.bvnk.com/l1-api/treasury/delete-managed-balance.md): Delete a managed balance by ID. Allowed only if balanced is not referenced anywhere as a source.
- [Delete cached processing profile](https://docs.bvnk.com/l1-api/treasury/delete-processing-profile.md): Remove the cached processing profile mapping for a specific managed balance
- [Trigger a manual top-up](https://docs.bvnk.com/l1-api/treasury/execute-balance-adjustment-1.md): Execute a balance adjustment for a managed balance
- [Trigger a manual top-up](https://docs.bvnk.com/l1-api/treasury/execute-balance-adjustment.md): Execute a balance adjustment for a managed balance
- [Get activity logs for a managed balance](https://docs.bvnk.com/l1-api/treasury/get-activity-logs.md): Retrieve a paginated list of activity logs for a specific managed balance within a date range. The date range cannot exceed 3 months. Activity logs...
- [List managed balances](https://docs.bvnk.com/l1-api/treasury/get-all-managed-balances.md): Retrieve a paginated list of all managed balances
- [Get current balance](https://docs.bvnk.com/l1-api/treasury/get-current-balance.md): Retrieve the current balance for a specific managed balance
- [Get eligible sources for a managed balance](https://docs.bvnk.com/l1-api/treasury/get-eligible-sources.md): Retrieve all eligible sources with their details and priorities for a managed balance
- [Get linked managed balances](https://docs.bvnk.com/l1-api/treasury/get-linked-managed-balances.md): Retrieve a list of managed balances that are linked to the specified managed balance
- [Get revisions for a managed balance](https://docs.bvnk.com/l1-api/treasury/get-managed-balance-revisions.md): Retrieve a paginated list of revisions for a specific managed balance by ID
- [Get managed balance](https://docs.bvnk.com/l1-api/treasury/get-managed-balance.md): Retrieve a specific managed balance by ID
- [Get processing profile](https://docs.bvnk.com/l1-api/treasury/get-processing-profile.md): Retrieve the processing profile mapped to a specific managed balance
- [Get treasury operations](https://docs.bvnk.com/l1-api/treasury/get-treasury-operations.md): Retrieve a paginated list of treasury operations for the authenticated tenant
- [Update managed balance property](https://docs.bvnk.com/l1-api/treasury/patch-managed-balance-property.md): Update a specific property (monitoring-enabled or forecast-enabled) for a managed balance
- [Update threshold for a managed balance](https://docs.bvnk.com/l1-api/treasury/patch-thresholds.md): Update thresholds for a managed balance
- [Remove funding source for a managed balance](https://docs.bvnk.com/l1-api/treasury/remove-eligible-source.md): Remove an eligible source from a managed balance
- [Get templates to create a managed balance](https://docs.bvnk.com/l1-api/treasury/retrieve-managed-balance-templates.md): Retrieve templates for managed balance creation for the authenticated tenant
- [Treasury](https://docs.bvnk.com/l1-api/treasury/treasury.md): Layer1 API for treasury management
- [Add funding source for a managed balance](https://docs.bvnk.com/l1-api/treasury/upsert-eligible-source.md): Add or update an eligible source for a managed balance
- [Update managed balance](https://docs.bvnk.com/l1-api/treasury/upsert-managed-balance.md): Create a new managed balance or update an existing one
- [validate](https://docs.bvnk.com/l1-api/treasury/validate.md): validate
- [Approval request status changed](https://docs.bvnk.com/l1-api/webhook-events/approval-request-status-changed.md): Triggered when the status of an approval request changes to a final state.
- [Approval request vote required](https://docs.bvnk.com/l1-api/webhook-events/approval-request-vote-required.md): Triggered when an approval request requires a user's vote.
- [API audit event](https://docs.bvnk.com/l1-api/webhook-events/audit-api.md): This webhook is sent for necessary, predefined API calls configured on the API gateway.
- [Authentication login audit event](https://docs.bvnk.com/l1-api/webhook-events/audit-auth-login.md): This webhook captures user and client login events recorded by Keycloak.
- [Cryptocurrency address created](https://docs.bvnk.com/l1-api/webhook-events/crypto-address-created.md): Triggered when a new cryptocurrency address is created.
- [Consolidation status change](https://docs.bvnk.com/l1-api/webhook-events/crypto-consolidation-status-change.md): Triggered when the status of a cryptocurrency consolidation changes.
- [Deposit status change](https://docs.bvnk.com/l1-api/webhook-events/crypto-deposit-status-change.md): Triggered when the status of a cryptocurrency deposit changes.
- [Withdrawal status change](https://docs.bvnk.com/l1-api/webhook-events/crypto-withdrawal-status-change.md): Triggered when the status of a cryptocurrency withdrawal changes.
- [Digital balance updated](https://docs.bvnk.com/l1-api/webhook-events/digital-balance-updated.md): Triggered when a digital asset balance is updated.
- [Layer1 Webhooks API](https://docs.bvnk.com/l1-api/webhook-events/layer-1-webhooks-api.md): Layer1 Webhooks API provides real-time notifications for various events across the Layer1 platform.
- [Trade conversion created](https://docs.bvnk.com/l1-api/webhook-events/trade-conversion-created.md): Triggered when a new trade conversion is created.
- [Trade conversion state change](https://docs.bvnk.com/l1-api/webhook-events/trade-conversion-state-changed.md): Triggered when the state of a trade conversion changes.
- [Create a new destination](https://docs.bvnk.com/l1-api/webhooks/create-destination-1.md): Allows admin to create a new destination for a provided account
- [Create a new destination](https://docs.bvnk.com/l1-api/webhooks/create-destination.md): Creates a new destination
- [Hook](https://docs.bvnk.com/l1-api/webhooks/hook.md): Layer1 API making management of crypto assets simple and easy
- [List destinations for a specific account](https://docs.bvnk.com/l1-api/webhooks/list-destinations-1.md): Allows admin to retrieve paginated list of destinations for a specific account
- [List destinations](https://docs.bvnk.com/l1-api/webhooks/list-destinations.md): Retrieve paginated list of destinations
- [List events](https://docs.bvnk.com/l1-api/webhooks/list-events.md): Retrieve paginated list of events
- [Remove an existing destination](https://docs.bvnk.com/l1-api/webhooks/remove-destination-1.md): Removes an existing destination
- [Remove a destination](https://docs.bvnk.com/l1-api/webhooks/remove-destination.md): Allows admin to permanently remove a destination for a provided account
- [Replay events](https://docs.bvnk.com/l1-api/webhooks/replay-events.md): Replay completed events by re-publishing them.
- [Update a new destination](https://docs.bvnk.com/l1-api/webhooks/update-destination-1.md): Allows admin to update certain details of a destination for a provided account
- [Update the existing destination](https://docs.bvnk.com/l1-api/webhooks/update-destination.md): Updates the existing destination
- [Layer 1 documentation](https://docs.bvnk.com/layer1.md): Redirect to Layer 1 overview