# Fireblocks Developer Docs: API API Endpoints ## API Endpoints - [API Endpoints Overview](https://developers.fireblocks.com/reference/api-endpoints-overview.md) - [API / API Endpoints / Compliance (42 pages)](https://developers.fireblocks.com/_llms/api/api-endpoints/compliance.md): Documentation for API / API Endpoints / Compliance. - [API / API Endpoints / Tokenization (34 pages)](https://developers.fireblocks.com/_llms/api/api-endpoints/tokenization.md): Documentation for API / API Endpoints / Tokenization. - [API / API Endpoints / TRLink (28 pages)](https://developers.fireblocks.com/_llms/api/api-endpoints/tr-link.md): Documentation for API / API Endpoints / TRLink. - [API / API Endpoints / Vaults (41 pages)](https://developers.fireblocks.com/_llms/api/api-endpoints/vaults.md): Documentation for API / API Endpoints / Vaults. ### Admin Quorum - [Update admin quorum threshold](https://developers.fireblocks.com/api-reference/admin-quorum/update-admin-quorum-threshold.md): Update admin quorum threshold ### Api User - [Get API Keys](https://developers.fireblocks.com/api-reference/api-user/get-api-keys.md): List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. - [Create API Key](https://developers.fireblocks.com/api-reference/api-user/create-api-key.md): Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). Endpoint Permission: Admin, Non-Signing Admin. - [Issue API user pairing token](https://developers.fireblocks.com/api-reference/api-user/issue-api-user-pairing-token.md): Issues a device pairing token for the given user and returns the user's info along with the token. - The API user must be in PENDING_ACTIVATION status. If the user is already set up (enabled), the request is rejected with a 409 Conflict. - Please note that this endpoint is available only for API key… ### Approvals (Beta) - [List approval requests](https://developers.fireblocks.com/api-reference/approvals-beta/list-approval-requests.md): Retrieve the pending approval requests the authenticated API user is eligible to act on, including requests the user has already approved that are still pending overall. - [Get a single approval request](https://developers.fireblocks.com/api-reference/approvals-beta/get-a-single-approval-request.md): Retrieve full detail for a single approval request by ID, including the payload to sign and, when requested, the request's `quorumStatus`. - [Approve an approval request](https://developers.fireblocks.com/api-reference/approvals-beta/approve-an-approval-request.md): Approve a pending approval request as the authenticated API user. The caller signs the request's signable data with the private key of a registered approval API key and submits the base64url-encoded signature, optionally with the key ID. The server verifies the signature against the registered publi… - [Reject an approval request](https://developers.fireblocks.com/api-reference/approvals-beta/reject-an-approval-request.md): Reject a pending approval request as the authenticated API user. No signature is required (unlike approve). The caller must be eligible to act on the request; rejecting finalizes the request as rejected per the approval policy. - [List approval keys](https://developers.fireblocks.com/api-reference/approvals-beta/list-approval-keys.md): List the approval public keys registered for the specified API user. - [Register an approval key](https://developers.fireblocks.com/api-reference/approvals-beta/register-an-approval-key.md): Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion. - [Delete an approval key](https://developers.fireblocks.com/api-reference/approvals-beta/delete-an-approval-key.md): Delete (revoke) an approval public key for the specified API user. Revoking the last key disables the API user's ability to sign approvals. ### Audit Logs - [Get audit logs](https://developers.fireblocks.com/api-reference/audit-logs/get-audit-logs.md): Retrieve audit log events for the workspace with optional filtering, date range, sorting, and cursor-based pagination. ### Blockchain link (Beta) - [List blockchains with pagination and filtering](https://developers.fireblocks.com/api-reference/blockchain-link-beta/list-blockchains-with-pagination-and-filtering.md): Returns the tenant's blockchains, paginated and filterable by state, network environment, and free-text search, with configurable sorting. - [Create a new blockchain](https://developers.fireblocks.com/api-reference/blockchain-link-beta/create-a-new-blockchain.md): Registers a new tenant-managed blockchain from the supplied declared properties. The blockchain starts in the CREATED state and must be activated separately before it can be used. - [Get a blockchain by ID](https://developers.fireblocks.com/api-reference/blockchain-link-beta/get-a-blockchain-by-id.md): Returns a single blockchain owned by the tenant, identified by its ID. - [Update a blockchain](https://developers.fireblocks.com/api-reference/blockchain-link-beta/update-a-blockchain.md): Updates the declared properties of an existing blockchain identified by its ID. Only the fields supplied in the request are modified. - [Delete a blockchain](https://developers.fireblocks.com/api-reference/blockchain-link-beta/delete-a-blockchain.md): Permanently removes a blockchain identified by its ID. The blockchain must not be in an active lifecycle state. - [Activate a blockchain (triggers activation workflow)](https://developers.fireblocks.com/api-reference/blockchain-link-beta/activate-a-blockchain-triggers-activation-workflow.md): Starts the asynchronous activation workflow for the blockchain identified by its ID, transitioning it towards the ACTIVATED state. - [Trigger validation workflow](https://developers.fireblocks.com/api-reference/blockchain-link-beta/trigger-validation-workflow.md): Starts the asynchronous validation workflow for a blockchain and its associated validation session. - [Get tenant billing info](https://developers.fireblocks.com/api-reference/blockchain-link-beta/get-tenant-billing-info.md): Returns the tenant's blockchain activation limit and current usage. tenant_id is derived from the JWT token context. - [Get the test wallet address](https://developers.fireblocks.com/api-reference/blockchain-link-beta/get-the-test-wallet-address.md): Returns the Ethereum address derived from the configured external wallet private key, used by the UI for test transfers. tenant_id is derived from the JWT token context. ### Blockchains & assets - [List assets](https://developers.fireblocks.com/api-reference/blockchains-&-assets/list-assets.md): Retrieves a paginated list of all assets supported by Fireblocks in your workspace - [Register an asset](https://developers.fireblocks.com/api-reference/blockchains-&-assets/register-an-asset.md): Register a new asset to a workspace and return the newly created asset's details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR - Solana - Sui - TON - [Get an asset](https://developers.fireblocks.com/api-reference/blockchains-&-assets/get-an-asset.md): Returns an asset by ID or legacyID. - [Update the user’s metadata for an asset](https://developers.fireblocks.com/api-reference/blockchains-&-assets/update-the-user’s-metadata-for-an-asset.md): Update the user’s metadata for an asset. - [Set asset price](https://developers.fireblocks.com/api-reference/blockchains-&-assets/set-asset-price.md): Set asset price for the given asset id. Returns the asset price response. - [List blockchains](https://developers.fireblocks.com/api-reference/blockchains-&-assets/list-blockchains.md): Returns all blockchains supported by Fireblocks. - [Get a Blockchain by ID](https://developers.fireblocks.com/api-reference/blockchains-&-assets/get-a-blockchain-by-id.md): Returns a blockchain by ID or legacyID. - [List assets (Legacy)](https://developers.fireblocks.com/api-reference/blockchains-&-assets/list-assets-legacy.md): **This legacy endpoint has not been deprecated but it should not be used in your operations. Instead, use the new [List assets](https://developers.fireblocks.com/reference/listassets) endpoint for better performance and to retrieve more detailed asset information.** ### Canton (Beta) - [Make a Canton call](https://developers.fireblocks.com/api-reference/canton-beta/make-a-canton-call.md): Submits one Canton call. `type` names the call and selects the shape of `payload`. An unknown or missing `type`, or a `payload` missing a required field, is a `400`. A field that does not belong to the selected `type` is ignored rather than rejected. A `501` has two different causes, and the distinc… - [Answer an offer](https://developers.fireblocks.com/api-reference/canton-beta/answer-an-offer.md): ONE endpoint for every offer domain. Two layers of discrimination, nested: `domain` selects `response`, and inside `response` the `responseType` selects the variant. Both layers are closed, so an onboarding response type sent under `domain: ALLOCATION` is a `400`. {"domain":"ONBOARDING","response":{… ### Compliance Screening Configuration - [Get AML Screening Policy Configuration](https://developers.fireblocks.com/api-reference/compliance-screening-configuration/get-aml-screening-policy-configuration.md): Retrieves the configuration for Travel Rule screening policy. - [Get Travel Rule Screening Policy Configuration](https://developers.fireblocks.com/api-reference/compliance-screening-configuration/get-travel-rule-screening-policy-configuration.md): Retrieves the configuration for Travel Rule screening policy. ### Compliance Orchestrator (Beta) - [Trigger a Compliance Orchestrator screening](https://developers.fireblocks.com/api-reference/compliance-orchestrator-beta/trigger-a-compliance-orchestrator-screening.md): Starts a compliance screening against an active workflow and returns a `screeningId`. The screening runs asynchronously — poll `GET /v1/compliance/orchestrator/screenings/{screeningId}` for the result. - [Get a Compliance Orchestrator screening's result](https://developers.fireblocks.com/api-reference/compliance-orchestrator-beta/get-a-compliance-orchestrator-screenings-result.md): Returns the result of a screening started by `POST /v1/compliance/orchestrator/screenings`, with a result per workflow step and an audit log. Safe to poll: a screening still in flight reports `PENDING` or `RUNNING`. Only screenings owned by the requesting tenant are returned. - [Get a Compliance Orchestrator workflow](https://developers.fireblocks.com/api-reference/compliance-orchestrator-beta/get-a-compliance-orchestrator-workflow.md): Returns a workflow's status and its steps in execution order. Read it to see what a given `workflowId` will screen, and which fields its rules may reference. - [Update a Compliance Orchestrator workflow's status](https://developers.fireblocks.com/api-reference/compliance-orchestrator-beta/update-a-compliance-orchestrator-workflows-status.md): Moves a workflow between `DRAFT` and `ACTIVE`. A workflow must be `ACTIVE` before `POST /v1/compliance/orchestrator/screenings` will accept a screening against it. Returns the workflow's id and new status, not its full configuration. ### Connected Accounts - [Get connected accounts](https://developers.fireblocks.com/api-reference/connected-accounts/get-connected-accounts.md): Returns all connected accounts. - [Add a connected account](https://developers.fireblocks.com/api-reference/connected-accounts/add-a-connected-account.md): Creates a new connected account for the authenticated tenant. - [Get connected account](https://developers.fireblocks.com/api-reference/connected-accounts/get-connected-account.md): Retrieve detailed information about a specific connected account by ID. - [Disconnect connected account](https://developers.fireblocks.com/api-reference/connected-accounts/disconnect-connected-account.md): Disconnect a connected account by ID. - [Get allowlist for connected account](https://developers.fireblocks.com/api-reference/connected-accounts/get-allowlist-for-connected-account.md): Retrieves the address allowlist for a specified connected account. - [Get a single allowlist entry for a connected account](https://developers.fireblocks.com/api-reference/connected-accounts/get-a-single-allowlist-entry-for-a-connected-account.md): Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. - [Sync allowlist for connected account](https://developers.fireblocks.com/api-reference/connected-accounts/sync-allowlist-for-connected-account.md): Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. - [Get balances for an account](https://developers.fireblocks.com/api-reference/connected-accounts/get-balances-for-an-account.md): Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). - [Update connected account credentials](https://developers.fireblocks.com/api-reference/connected-accounts/update-connected-account-credentials.md): Replace the API credentials (secret + API key) of a connected account. - [Get supported trading pairs for an account](https://developers.fireblocks.com/api-reference/connected-accounts/get-supported-trading-pairs-for-an-account.md): Retrieve all asset trading pairs supported by a specific connected account, including the pair type (`quote`, `market`, `onOffRamp`). - [Get exchange rates for an account](https://developers.fireblocks.com/api-reference/connected-accounts/get-exchange-rates-for-an-account.md): Retrieve current exchange rates for converting between specific assets in a connected account. - [Rename Connected Account](https://developers.fireblocks.com/api-reference/connected-accounts/rename-connected-account.md): Rename a connected account by account ID. - [Get public key to encrypt connected account credentials](https://developers.fireblocks.com/api-reference/connected-accounts/get-public-key-to-encrypt-connected-account-credentials.md): Returns the RSA public key used to encrypt the `creds` field before calling `POST /connected_accounts`. ### Console User - [Get console users](https://developers.fireblocks.com/api-reference/console-user/get-console-users.md): Get console users for your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. - [Create console user](https://developers.fireblocks.com/api-reference/console-user/create-console-user.md): Create console users in your workspace - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Learn more about Fireblocks Users management in the following [guide](https://developers.fireblocks.com/docs/manage-users). Endpoint Permission: Admin, Non… - [Request deletion of a console user](https://developers.fireblocks.com/api-reference/console-user/request-deletion-of-a-console-user.md): Requests deletion of a console user. The request is asynchronous: it goes through the workspace's configured "Delete users" approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes. - Track progress by polling G… ### Contacts - [List contacts](https://developers.fireblocks.com/api-reference/contacts/list-contacts.md): Returns a paginated list of the workspace's address book contacts. ### Contract Interactions - [Decode a function call data, error, or event log](https://developers.fireblocks.com/api-reference/contract-interactions/decode-a-function-call-data-error-or-event-log.md): Decode a function call data, error, or event log from a deployed contract by blockchain native asset id and contract address. - [Return deployed contract's ABI](https://developers.fireblocks.com/api-reference/contract-interactions/return-deployed-contracts-abi.md): Return deployed contract's ABI by blockchain native asset id and contract address. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. - [Call a read function on a deployed contract](https://developers.fireblocks.com/api-reference/contract-interactions/call-a-read-function-on-a-deployed-contract.md): Call a read function on a deployed contract by blockchain native asset id and contract address - [Call a write function on a deployed contract](https://developers.fireblocks.com/api-reference/contract-interactions/call-a-write-function-on-a-deployed-contract.md): Call a write function on a deployed contract by blockchain native asset id and contract address. This creates an onchain transaction, thus it is an async operation. It returns a transaction id that can be polled for status check - [Get contract address by transaction hash](https://developers.fireblocks.com/api-reference/contract-interactions/get-contract-address-by-transaction-hash.md): Retrieve the contract address by blockchain native asset ID and transaction hash - [Get transaction receipt](https://developers.fireblocks.com/api-reference/contract-interactions/get-transaction-receipt.md): Retrieve the transaction receipt by blockchain native asset ID and transaction hash > **Note** > This functionality is exclusively available for EVM (Ethereum Virtual Machine) compatible chains. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. ### Contract Templates - [List all contract templates](https://developers.fireblocks.com/api-reference/contract-templates/list-all-contract-templates.md): Return minimal representation of all the contract templates available for the workspace. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Upload contract template](https://developers.fireblocks.com/api-reference/contract-templates/upload-contract-template.md): Upload a new contract template. This contract template will be available for the workspace - [Return contract template by id](https://developers.fireblocks.com/api-reference/contract-templates/return-contract-template-by-id.md): Return detailed information about the contract template - [Delete a contract template by id](https://developers.fireblocks.com/api-reference/contract-templates/delete-a-contract-template-by-id.md): Delete a contract by id. allowed only for private contract templates. Notice: it is irreversible! - [Return contract template's constructor](https://developers.fireblocks.com/api-reference/contract-templates/return-contract-templates-constructor.md): Return contract template's constructor ABI - [Deploy contract](https://developers.fireblocks.com/api-reference/contract-templates/deploy-contract.md): Deploy a new contract by contract template id. If you wish to deploy a token (ERC20, ERC721 etc), and create asset please use POST /tokenization - [Return contract template's function](https://developers.fireblocks.com/api-reference/contract-templates/return-contract-templates-function.md): Return contract template`s function ABI by signature - [Get supported blockchains for the template](https://developers.fireblocks.com/api-reference/contract-templates/get-supported-blockchains-for-the-template.md): Get supported blockchains for the template ### Contracts - [List Whitelisted Contracts](https://developers.fireblocks.com/api-reference/contracts/list-whitelisted-contracts.md): Gets a list of whitelisted contracts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Add a contract](https://developers.fireblocks.com/api-reference/contracts/add-a-contract.md): Adds a contract to the workspace whitelist. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Find a Specific Whitelisted Contract](https://developers.fireblocks.com/api-reference/contracts/find-a-specific-whitelisted-contract.md): Returns a whitelisted contract by Fireblocks Contract ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Delete a contract](https://developers.fireblocks.com/api-reference/contracts/delete-a-contract.md): Deletes a contract by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Find a whitelisted contract's asset](https://developers.fireblocks.com/api-reference/contracts/find-a-whitelisted-contracts-asset.md): Returns a whitelisted contract's asset by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Add an asset to a whitelisted contract](https://developers.fireblocks.com/api-reference/contracts/add-an-asset-to-a-whitelisted-contract.md): Adds an asset to a whitelisted contract. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Delete an asset from a whitelisted contract](https://developers.fireblocks.com/api-reference/contracts/delete-an-asset-from-a-whitelisted-contract.md): Deletes a whitelisted contract asset by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Cosigners (Beta) - [Get all cosigners](https://developers.fireblocks.com/api-reference/cosigners-beta/get-all-cosigners.md): Get all workspace cosigners (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - [Add cosigner](https://developers.fireblocks.com/api-reference/cosigners-beta/add-cosigner.md): Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired Endpoint Permission: Admin and Non-Signing Admin. - [Get cosigner](https://developers.fireblocks.com/api-reference/cosigners-beta/get-cosigner.md): Get a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - [Rename cosigner](https://developers.fireblocks.com/api-reference/cosigners-beta/rename-cosigner.md): Rename a cosigner by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - [Get all API keys](https://developers.fireblocks.com/api-reference/cosigners-beta/get-all-api-keys.md): Get all cosigner paired API keys (paginated). **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - [Get API key](https://developers.fireblocks.com/api-reference/cosigners-beta/get-api-key.md): Get an API key by ID. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin and Non-Signing Admin. - [Pair API key](https://developers.fireblocks.com/api-reference/cosigners-beta/pair-api-key.md): Pair an API key to a cosigner Endpoint Permission: Admin and Non-Signing Admin. - [Unpair API key](https://developers.fireblocks.com/api-reference/cosigners-beta/unpair-api-key.md): Unpair an API key from a cosigner Endpoint Permission: Admin and Non-Signing Admin. - [Update API key callback handler](https://developers.fireblocks.com/api-reference/cosigners-beta/update-api-key-callback-handler.md): Update the callback handler of an API key Endpoint Permission: Admin and Non-Signing Admin. - [Get request status](https://developers.fireblocks.com/api-reference/cosigners-beta/get-request-status.md): Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin. ### Deployed Contracts - [List deployed contracts data](https://developers.fireblocks.com/api-reference/deployed-contracts/list-deployed-contracts-data.md): Return a filtered lean representation of the deployed contracts data on all blockchains (paginated) - [Return deployed contract data](https://developers.fireblocks.com/api-reference/deployed-contracts/return-deployed-contract-data.md): Return deployed contract data by blockchain native asset id and contract address - [Return deployed contract data by id](https://developers.fireblocks.com/api-reference/deployed-contracts/return-deployed-contract-data-by-id.md): Return deployed contract data by id - [Save contract ABI](https://developers.fireblocks.com/api-reference/deployed-contracts/save-contract-abi.md): Save contract ABI for the tenant - [Fetch the contract ABI](https://developers.fireblocks.com/api-reference/deployed-contracts/fetch-the-contract-abi.md): Fetch the ABI. If not found fetch the ABI from the block explorer ### Earn - [List earn lending actions](https://developers.fireblocks.com/api-reference/earn/list-earn-lending-actions.md): Returns a paginated list of lending actions (deposits and withdrawals) for the authenticated tenant. - [Create and execute a lending action (deposit or withdraw)](https://developers.fireblocks.com/api-reference/earn/create-and-execute-a-lending-action-deposit-or-withdraw.md): Creates and runs a sequence of on-chain steps for either a deposit into or a withdrawal from an earn vault/market. Specify the operation with `action` in the request body (`DEPOSIT` or `WITHDRAW`). - [Get a single earn lending action](https://developers.fireblocks.com/api-reference/earn/get-a-single-earn-lending-action.md): Returns one lending action by its action sequence id (tenant-scoped). - [Get list of earn opportunities](https://developers.fireblocks.com/api-reference/earn/get-list-of-earn-opportunities.md): Get list of earn opportunities (vaults). - [Get list of earn positions](https://developers.fireblocks.com/api-reference/earn/get-list-of-earn-positions.md): Get list of earn positions for accounts tracked for this workspace. Optional query parameters filter by chain, provider, and pagination. - [Get list of earn providers](https://developers.fireblocks.com/api-reference/earn/get-list-of-earn-providers.md): Get list of earn providers. - [Approve earn provider terms of service](https://developers.fireblocks.com/api-reference/earn/approve-earn-provider-terms-of-service.md): Approves earn provider terms of service for this workspace (one-time per tenant). When `isTermsApprovalRequired` is true on a provider (see list providers), call this once before creating or executing earn actions with providers that require it. After success, `GET /earn/providers` reflects `isTerms… ### Embedded Wallets - [Get the public key of an asset](https://developers.fireblocks.com/api-reference/embedded-wallets/get-the-public-key-of-an-asset.md): Gets the public key of an asset associated with a specific account within a Non-Custodial Wallet - [List wallets](https://developers.fireblocks.com/api-reference/embedded-wallets/list-wallets.md): Get all Non Custodial Wallets - [Create a new wallet](https://developers.fireblocks.com/api-reference/embedded-wallets/create-a-new-wallet.md): Create new Non Custodial Wallet - [Get a wallet](https://developers.fireblocks.com/api-reference/embedded-wallets/get-a-wallet.md): Get a wallet - [Create a new account](https://developers.fireblocks.com/api-reference/embedded-wallets/create-a-new-account.md): Create a new account under a specific Non Custodial Wallet - [Get a account](https://developers.fireblocks.com/api-reference/embedded-wallets/get-a-account.md): Get a specific account under a specific Non Custodial Wallet - [Retrieve assets](https://developers.fireblocks.com/api-reference/embedded-wallets/retrieve-assets.md): Retrieve assets for a specific account under a specific Non Custodial Wallet - [Retrieve asset](https://developers.fireblocks.com/api-reference/embedded-wallets/retrieve-asset.md): Get asset under a specific account, under a specific Non Custodial Wallet - [Add asset to account](https://developers.fireblocks.com/api-reference/embedded-wallets/add-asset-to-account.md): Get the addresses of a specific asset, under a specific account, under a specific Non Custodial Wallet - [Get the public key of an asset](https://developers.fireblocks.com/api-reference/embedded-wallets/get-the-public-key-of-an-asset-1.md): Gets the public key of an asset associated with a specific account within a Non-Custodial Wallet - [Retrieve asset addresses](https://developers.fireblocks.com/api-reference/embedded-wallets/retrieve-asset-addresses.md): Get the addresses of a specific asset, under a specific account, under a specific Non Custodial Wallet - [Retrieve asset balance](https://developers.fireblocks.com/api-reference/embedded-wallets/retrieve-asset-balance.md): Get balance for specific asset, under a specific account - [Refresh asset balance](https://developers.fireblocks.com/api-reference/embedded-wallets/refresh-asset-balance.md): Refresh the balance of an asset in a specific account - [Assign a wallet](https://developers.fireblocks.com/api-reference/embedded-wallets/assign-a-wallet.md): Assign a specific Non Custodial Wallet to a user - [Get wallet Latest Backup details](https://developers.fireblocks.com/api-reference/embedded-wallets/get-wallet-latest-backup-details.md): Get wallet Latest Backup details, including the deviceId, and backup time - [Get registered devices - paginated](https://developers.fireblocks.com/api-reference/embedded-wallets/get-registered-devices--paginated.md): Get a paginated list of registered devices for a specific Non Custodial Wallet - [Get Embedded Wallet Device](https://developers.fireblocks.com/api-reference/embedded-wallets/get-embedded-wallet-device.md): Get specific device for a specific s Wallet - [Get device key setup state](https://developers.fireblocks.com/api-reference/embedded-wallets/get-device-key-setup-state.md): Get the state of the specific device setup key under a specific Non Custodial Wallet - [Update device status](https://developers.fireblocks.com/api-reference/embedded-wallets/update-device-status.md): Update the enabled/disabled status of a specific device for a Non Custodial Wallet - [Get the public key for a derivation path](https://developers.fireblocks.com/api-reference/embedded-wallets/get-the-public-key-for-a-derivation-path.md): Gets the public key information based on derivation path and signing algorithm within a Non-Custodial Wallet - [Get wallet key setup state](https://developers.fireblocks.com/api-reference/embedded-wallets/get-wallet-key-setup-state.md): Get the key setup state for a specific Non Custodial Wallet, including required algorithms and device setup status - [Update wallet status](https://developers.fireblocks.com/api-reference/embedded-wallets/update-wallet-status.md): Update the enabled/disabled status of a specific Non Custodial Wallet - [Retrieve supported assets](https://developers.fireblocks.com/api-reference/embedded-wallets/retrieve-supported-assets.md): Get all the available supported assets for the Non-Custodial Wallet ### Exchange accounts - [List exchange accounts](https://developers.fireblocks.com/api-reference/exchange-accounts/list-exchange-accounts.md): DEPRECATED - Please use the `/exchange_accounts/paged` endpoint. Endpoint Permission: Admin, Non-Signing Admin. - [Add an exchange account](https://developers.fireblocks.com/api-reference/exchange-accounts/add-an-exchange-account.md): Add an exchange account to exchanges. - [Get a specific exchange account](https://developers.fireblocks.com/api-reference/exchange-accounts/get-a-specific-exchange-account.md): Returns an exchange account by ID. Endpoint Permission: Admin, Non-Signing Admin. - [Get an asset for an exchange account](https://developers.fireblocks.com/api-reference/exchange-accounts/get-an-asset-for-an-exchange-account.md): Returns an asset for an exchange account. Endpoint Permission: Admin, Non-Signing Admin. - [Convert exchange account funds](https://developers.fireblocks.com/api-reference/exchange-accounts/convert-exchange-account-funds.md): Convert exchange account funds from the source asset to the destination asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported conversions. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-… - [Internal transfer for exchange accounts](https://developers.fireblocks.com/api-reference/exchange-accounts/internal-transfer-for-exchange-accounts.md): Transfers funds between trading accounts under the same exchange account. Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers). Endpoint Permission: Admin, Non-Signing Admin. - [Get public key to encrypt exchange credentials](https://developers.fireblocks.com/api-reference/exchange-accounts/get-public-key-to-encrypt-exchange-credentials.md): Return public key - [List connected exchange accounts](https://developers.fireblocks.com/api-reference/exchange-accounts/list-connected-exchange-accounts.md): Returns a list of the connected exchange accounts in your workspace. Endpoint Permission: Admin, Non-Signing Admin. ### External wallets - [List external wallets](https://developers.fireblocks.com/api-reference/external-wallets/list-external-wallets.md): Gets a list of external wallets under the workspace. - [Create an external wallet](https://developers.fireblocks.com/api-reference/external-wallets/create-an-external-wallet.md): Creates a new external wallet with the requested name. - [Find an external wallet](https://developers.fireblocks.com/api-reference/external-wallets/find-an-external-wallet.md): Returns an external wallet by ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Delete an external wallet](https://developers.fireblocks.com/api-reference/external-wallets/delete-an-external-wallet.md): Deletes an external wallet by ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Get an asset from an external wallet](https://developers.fireblocks.com/api-reference/external-wallets/get-an-asset-from-an-external-wallet.md): Returns an external wallet by wallet ID and asset ID. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Add an asset to an external wallet.](https://developers.fireblocks.com/api-reference/external-wallets/add-an-asset-to-an-external-wallet.md): Adds an asset to an existing external wallet. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Delete an asset from an external wallet](https://developers.fireblocks.com/api-reference/external-wallets/delete-an-asset-from-an-external-wallet.md): Deletes an external wallet asset by ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Set an AML customer reference ID for an external wallet](https://developers.fireblocks.com/api-reference/external-wallets/set-an-aml-customer-reference-id-for-an-external-wallet.md): Sets an AML/KYT customer reference ID for the specific external wallet. External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Fiat accounts - [List fiat accounts](https://developers.fireblocks.com/api-reference/fiat-accounts/list-fiat-accounts.md): Returns all fiat accounts. Endpoint Permission: Admin, Non-Signing Admin. - [Find a specific fiat account](https://developers.fireblocks.com/api-reference/fiat-accounts/find-a-specific-fiat-account.md): Returns a fiat account by ID. Endpoint Permission: Admin, Non-Signing Admin. - [Deposit funds from DDA](https://developers.fireblocks.com/api-reference/fiat-accounts/deposit-funds-from-dda.md): Deposits funds from the linked DDA. - [Redeem funds to DDA](https://developers.fireblocks.com/api-reference/fiat-accounts/redeem-funds-to-dda.md): Redeems funds to the linked DDA. ### Gas stations - [Get gas station settings](https://developers.fireblocks.com/api-reference/gas-stations/get-gas-station-settings.md): Returns gas station settings and ETH balance. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Get gas station settings by asset](https://developers.fireblocks.com/api-reference/gas-stations/get-gas-station-settings-by-asset.md): Returns gas station settings and balances for a requested asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Edit gas station settings](https://developers.fireblocks.com/api-reference/gas-stations/edit-gas-station-settings.md): Configures gas station settings for ETH. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Edit gas station settings for an asset](https://developers.fireblocks.com/api-reference/gas-stations/edit-gas-station-settings-for-an-asset.md): Configures gas station settings for a requested asset. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Genie (Beta) - [Create a Genie session](https://developers.fireblocks.com/api-reference/genie-beta/create-a-genie-session.md): Starts a new conversation with Genie, the Fireblocks AI assistant. Returns a `sessionId` — pass it when sending messages, and reuse it across calls to keep one continuous conversation. - [Send a message to a Genie session](https://developers.fireblocks.com/api-reference/genie-beta/send-a-message-to-a-genie-session.md): Sends a question to Genie and returns a single answer. Reuse the `sessionId` from the original session on follow-up messages to continue the conversation with prior context. ### Internal wallets - [List internal wallets](https://developers.fireblocks.com/api-reference/internal-wallets/list-internal-wallets.md): Gets a list of internal wallets. - [Create an internal wallet](https://developers.fireblocks.com/api-reference/internal-wallets/create-an-internal-wallet.md): Creates a new internal wallet with the requested name. Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets) - [Get assets for internal wallet](https://developers.fireblocks.com/api-reference/internal-wallets/get-assets-for-internal-wallet.md): Returns information for an internal wallet. - [Delete an internal wallet](https://developers.fireblocks.com/api-reference/internal-wallets/delete-an-internal-wallet.md): Deletes an internal wallet by ID. - [Get an asset from an internal wallet](https://developers.fireblocks.com/api-reference/internal-wallets/get-an-asset-from-an-internal-wallet.md): Returns information for an asset in an internal wallet. - [Add an asset to an internal wallet](https://developers.fireblocks.com/api-reference/internal-wallets/add-an-asset-to-an-internal-wallet.md): Adds an asset to an existing internal wallet. - [Delete a whitelisted address](https://developers.fireblocks.com/api-reference/internal-wallets/delete-a-whitelisted-address.md): Deletes a whitelisted address (for an asset) from an internal wallet. - [List assets in an internal wallet (Paginated)](https://developers.fireblocks.com/api-reference/internal-wallets/list-assets-in-an-internal-wallet-paginated.md): Returns a paginated response of assets in an internal wallet. - [Set an AML/KYT customer reference ID for internal wallet](https://developers.fireblocks.com/api-reference/internal-wallets/set-an-amlkyt-customer-reference-id-for-internal-wallet.md): Sets an AML/KYT customer reference ID for the specific internal wallet. ### Key Link (Beta) - [Get list of signing keys](https://developers.fireblocks.com/api-reference/key-link-beta/get-list-of-signing-keys.md): Returns the list of signing keys in the workspace - [Add a new signing key](https://developers.fireblocks.com/api-reference/key-link-beta/add-a-new-signing-key.md): Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. - [Get a signing key by `keyId`](https://developers.fireblocks.com/api-reference/key-link-beta/get-a-signing-key-by-`keyid`.md): Returns a signing key if it exists, identified by the specified `keyId`. - [Modify the signing keyId](https://developers.fireblocks.com/api-reference/key-link-beta/modify-the-signing-keyid.md): Allows assigning the signing key to a vault account, if it hasn't been assigned to any other vault accounts yet. - [Set agent user id](https://developers.fireblocks.com/api-reference/key-link-beta/set-agent-user-id.md): Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. - [Get list of registered validation keys](https://developers.fireblocks.com/api-reference/key-link-beta/get-list-of-registered-validation-keys.md): Returns the list of validation keys in the workspace - [Add a new validation key](https://developers.fireblocks.com/api-reference/key-link-beta/add-a-new-validation-key.md): Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. - [Get a validation key by `keyId`](https://developers.fireblocks.com/api-reference/key-link-beta/get-a-validation-key-by-`keyid`.md): Returns a validation key if it exists, identified by the specified `keyId`. - [Disables a validation key](https://developers.fireblocks.com/api-reference/key-link-beta/disables-a-validation-key.md): Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. ### Keys (Beta) - [Get list of mpc keys](https://developers.fireblocks.com/api-reference/keys-beta/get-list-of-mpc-keys.md): Returns a list of MPC signing keys of the workspace. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. - [Get list of mpc keys by `userId`](https://developers.fireblocks.com/api-reference/keys-beta/get-list-of-mpc-keys-by-`userid`.md): Returns a list of MPC signing keys of a specific user. For each key, the list of players associated with it is attached. **Note:** This endpoint is currently in beta and might be subject to changes. ### Network connections - [List network connections](https://developers.fireblocks.com/api-reference/network-connections/list-network-connections.md): Returns all network connections. - [Create a new network connection](https://developers.fireblocks.com/api-reference/network-connections/create-a-new-network-connection.md): Initiates a new network connection. **Note:** This API call is subject to Flexible Routing Schemes. - [Get a network connection](https://developers.fireblocks.com/api-reference/network-connections/get-a-network-connection.md): Gets a network connection by ID. - [Delete a network connection by ID](https://developers.fireblocks.com/api-reference/network-connections/delete-a-network-connection-by-id.md): Deletes an existing network connection specified by its connection ID. - [Retrieve third-party network routing validation](https://developers.fireblocks.com/api-reference/network-connections/retrieve-third-party-network-routing-validation.md): The Fireblocks Network allows for flexibility around incoming deposits. A receiver can receive network deposits to locations other than Fireblocks. This endpoint validates whether future transactions are routed to the displayed recipient or to a 3rd party. - [Update network connection routing policy.](https://developers.fireblocks.com/api-reference/network-connections/update-network-connection-routing-policy.md): Updates an existing network connection's routing policy. - [Get all network IDs](https://developers.fireblocks.com/api-reference/network-connections/get-all-network-ids.md): Retrieves a list of all local and discoverable remote network IDs. - [Creates a new Network ID](https://developers.fireblocks.com/api-reference/network-connections/creates-a-new-network-id.md): Create a new Network ID. - [Return specific network ID.](https://developers.fireblocks.com/api-reference/network-connections/return-specific-network-id.md): Returns specific network ID. - [Delete specific network ID.](https://developers.fireblocks.com/api-reference/network-connections/delete-specific-network-id.md): Deletes a network by its ID. - [Update network ID's discoverability.](https://developers.fireblocks.com/api-reference/network-connections/update-network-ids-discoverability.md): Update whether or not the network ID is discoverable by others. - [Update network ID's name.](https://developers.fireblocks.com/api-reference/network-connections/update-network-ids-name.md): Updates name of a specified network ID. - [Update network id routing policy.](https://developers.fireblocks.com/api-reference/network-connections/update-network-id-routing-policy.md): Updates the routing policy of a specified network ID. - [Return all enabled routing policy asset groups](https://developers.fireblocks.com/api-reference/network-connections/return-all-enabled-routing-policy-asset-groups.md): Returns all enabled routing policy asset groups - [Get both local IDs and discoverable remote IDs](https://developers.fireblocks.com/api-reference/network-connections/get-both-local-ids-and-discoverable-remote-ids.md): Retrieves a list of all local and discoverable remote network IDs. Can be filtered. ### NFTs - [List all distinct owned tokens (paginated)](https://developers.fireblocks.com/api-reference/nfts/list-all-distinct-owned-tokens-paginated.md): Returns all owned distinct tokens (for your tenant) and their data in your workspace. - [List owned collections (paginated)](https://developers.fireblocks.com/api-reference/nfts/list-owned-collections-paginated.md): Returns all collections in your workspace - [List all owned tokens (paginated)](https://developers.fireblocks.com/api-reference/nfts/list-all-owned-tokens-paginated.md): Returns all tokens and their data in your workspace. - [Refresh vault account tokens](https://developers.fireblocks.com/api-reference/nfts/refresh-vault-account-tokens.md): Updates all tokens and balances per blockchain and vault account. Learn more about Fireblocks NFT management in the following [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). - [Update token ownership status](https://developers.fireblocks.com/api-reference/nfts/update-token-ownership-status.md): Updates token status for a tenant, in all tenant vaults. - [Update tokens ownership spam property](https://developers.fireblocks.com/api-reference/nfts/update-tokens-ownership-spam-property.md): Updates tokens spam property for a tenant's token ownerships, in all tenant vaults. - [Update tokens ownership status](https://developers.fireblocks.com/api-reference/nfts/update-tokens-ownership-status.md): Updates tokens status for a tenant, in all tenant vaults. - [List tokens by IDs](https://developers.fireblocks.com/api-reference/nfts/list-tokens-by-ids.md): Returns the requested tokens data. - [List token data by ID](https://developers.fireblocks.com/api-reference/nfts/list-token-data-by-id.md): Returns the requested token data. - [Refresh token metadata](https://developers.fireblocks.com/api-reference/nfts/refresh-token-metadata.md): Updates the latest token metadata. ### Off exchanges - [Add Collateral](https://developers.fireblocks.com/api-reference/off-exchanges/add-collateral.md): Add collateral and create deposit request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Find a specific collateral exchange account](https://developers.fireblocks.com/api-reference/off-exchanges/find-a-specific-collateral-exchange-account.md): Returns a collateral account by mainExchangeAccountId. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Remove Collateral](https://developers.fireblocks.com/api-reference/off-exchanges/remove-collateral.md): Remove collateral, create withdraw request. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Create Settlement for a Trader](https://developers.fireblocks.com/api-reference/off-exchanges/create-settlement-for-a-trader.md): Create settlement for a trader. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Get Settlements Transactions](https://developers.fireblocks.com/api-reference/off-exchanges/get-settlements-transactions.md): Get settlements transactions from exchange. Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Onchain Data - [Get the current state of addresses in an access registry](https://developers.fireblocks.com/api-reference/onchain-data/get-the-current-state-of-addresses-in-an-access-registry.md): Returns the current state of addresses in the specified access registry. Only addresses that are currently active (added but not removed) are included. - [Summary of access registry state](https://developers.fireblocks.com/api-reference/onchain-data/summary-of-access-registry-state.md): Returns a summary of the current state of the access registry for the specified baseAssetId and accessRegistryAddress. - [Get historical balance data for a specific account in a contract](https://developers.fireblocks.com/api-reference/onchain-data/get-historical-balance-data-for-a-specific-account-in-a-contract.md): Returns the paginated balance history of the specified account in a contract with optional date range and interval filtering. - [Get latest balances for all addresses holding tokens from a contract](https://developers.fireblocks.com/api-reference/onchain-data/get-latest-balances-for-all-addresses-holding-tokens-from-a-contract.md): Returns the latest balance for each unique address with support for numeric balance sorting. The `prev` cursor is reserved for future support. - [List of active roles for a given contract address and base asset ID](https://developers.fireblocks.com/api-reference/onchain-data/list-of-active-roles-for-a-given-contract-address-and-base-asset-id.md): Returns a list of currently active roles for the specified baseAssetId and contractAddress. - [Get summary for the token contract](https://developers.fireblocks.com/api-reference/onchain-data/get-summary-for-the-token-contract.md): Returns the total number of unique addresses holding balances and the total supply for the specified contract. - [Get historical total supply data for a contract](https://developers.fireblocks.com/api-reference/onchain-data/get-historical-total-supply-data-for-a-contract.md): Returns the paginated total supply history of the specified contract with optional date range and interval filtering. - [Fetch onchain transactions for a contract](https://developers.fireblocks.com/api-reference/onchain-data/fetch-onchain-transactions-for-a-contract.md): Returns a paginated list of onchain transactions for the specified contract address and base asset ID, optionally filtered by date range. ### OTA (Beta) - [Returns current OTA status](https://developers.fireblocks.com/api-reference/ota-beta/returns-current-ota-status.md): Returns current OTA status - [Enable or disable transactions to OTA](https://developers.fireblocks.com/api-reference/ota-beta/enable-or-disable-transactions-to-ota.md): Enable or disable transactions to One Time Addresses (Non Whitelisted addresses). Learn more about [One Time Addresses](https://support.fireblocks.io/hc/en-us/articles/4409104568338-One-Time-Address-OTA-feature) ### Payments - Flows - [Create payment flow configuration](https://developers.fireblocks.com/api-reference/payments--flows/create-payment-flow-configuration.md): Generate a new configuration ID to be used for initiating executions in subsequent phases. This configuration should include the operations you intend to incorporate into the workflow, such as TRANSFER, CONVERT, and DISBURSE, in addition to your pre-screening preferences, which are disabled by defau… - [Retrieve workflow configuration](https://developers.fireblocks.com/api-reference/payments--flows/retrieve-workflow-configuration.md): Retrieve a previously created workflow configuration using the specified "configId". - [Delete workflow configuration](https://developers.fireblocks.com/api-reference/payments--flows/delete-workflow-configuration.md): Delete a configuration using the specified "configId". - [Create workflow execution](https://developers.fireblocks.com/api-reference/payments--flows/create-workflow-execution.md): Validate the "workflow-config" previously created by utilizing the unique "configId". This step requires the mandatory field amount, and allows for modifications to other fields defined via the "workflow-config" endpoint, including pre-screening preferences. A response containing the "workflowExecut… - [Get workflow execution details](https://developers.fireblocks.com/api-reference/payments--flows/get-workflow-execution-details.md): Retrieve details of a previously initiated workflow execution by specifying the "workflowExecutionId" - [Execute the payments workflow](https://developers.fireblocks.com/api-reference/payments--flows/execute-the-payments-workflow.md): Launch the execution of a pre-configured workflow, identified by "workflowExecutionId", once it reaches the READY_FOR_LAUNCH state. The workflow undergoes several phases during execution - EXECUTION_IN_PROGRESS - Marks the start of the workflow execution. EXECUTION_COMPLETED or EXECUTION_FAILED - In… ### Payments - Payout - [Create a payout instruction set](https://developers.fireblocks.com/api-reference/payments--payout/create-a-payout-instruction-set.md): **Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. - [Get the status of a payout instruction set](https://developers.fireblocks.com/api-reference/payments--payout/get-the-status-of-a-payout-instruction-set.md): **Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. These endpoints are currently in beta and might be subject to changes. If you want to learn… - [Execute a payout instruction set](https://developers.fireblocks.com/api-reference/payments--payout/execute-a-payout-instruction-set.md): **Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts. ### Policy Editor (Beta) - [Get the active policy and its validation](https://developers.fireblocks.com/api-reference/policy-editor-beta/get-the-active-policy-and-its-validation.md): Legacy Endpoint – Returns the active policy and its validation. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `getActivePolicy` endpoint under policy/paths provides policy type-specific operations and improved functionality. - These endpoin… - [Get the active draft](https://developers.fireblocks.com/api-reference/policy-editor-beta/get-the-active-draft.md): Legacy Endpoint – Returns the active draft and its validation. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `getDraft` endpoint under policy/paths provides policy type-specific operations and improved functionality. - These endpoints are c… - [Update the draft with a new set of rules](https://developers.fireblocks.com/api-reference/policy-editor-beta/update-the-draft-with-a-new-set-of-rules.md): Legacy Endpoint – Update the draft and return its validation. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `updateDraft` endpoint under policy/paths provides policy type-specific operations and improved functionality. - These endpoints are… - [Send publish request for a certain draft id](https://developers.fireblocks.com/api-reference/policy-editor-beta/send-publish-request-for-a-certain-draft-id.md): Legacy Endpoint – Send publish request of certain draft id and returns the response. **Note:** - This endpoint will remain available for the foreseeable future and is not deprecated. - The `publishDraft` endpoint under policy/paths provides improved functionality and better performance. - These en… - [Send publish request for a set of policy rules](https://developers.fireblocks.com/api-reference/policy-editor-beta/send-publish-request-for-a-set-of-policy-rules.md): Send publish request of set of policy rules and returns the response. **Note:** These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@… ### Policy Editor V2 - [Get the active policy and its validation by policy type](https://developers.fireblocks.com/api-reference/policy-editor-v2/get-the-active-policy-and-its-validation-by-policy-type.md): Returns the active policy and its validation for a specific policy type. - [Get the active draft by policy type](https://developers.fireblocks.com/api-reference/policy-editor-v2/get-the-active-draft-by-policy-type.md): Returns the active draft and its validation for a specific policy type. - [Update the draft with a new set of rules by policy types](https://developers.fireblocks.com/api-reference/policy-editor-v2/update-the-draft-with-a-new-set-of-rules-by-policy-types.md): Update the draft and return its validation for specific policy types. - [Send publish request for a certain draft id](https://developers.fireblocks.com/api-reference/policy-editor-v2/send-publish-request-for-a-certain-draft-id.md): Send publish request of certain draft id and returns the response. ### Policy Editor V2 (Beta) - [Calculate the AOT quota for a policy rule](https://developers.fireblocks.com/api-reference/policy-editor-v2-beta/calculate-the-aot-quota-for-a-policy-rule.md): Returns the Amount Over Time (AOT) quota calculated for a specific policy rule. ### Reports (Beta) - [List reports](https://developers.fireblocks.com/api-reference/reports-beta/list-reports.md): Returns a paginated list of report jobs scoped to the calling tenant. - [Create a report](https://developers.fireblocks.com/api-reference/reports-beta/create-a-report.md): Creates a new asynchronous report job and returns a receipt containing the report ID. Poll `GET /v1/reports/{reportId}` to check status. When `status` is `COMPLETED`, the poll response includes a fresh pre-signed download URL in `links.downloadUrl`. - [Get report status](https://developers.fireblocks.com/api-reference/reports-beta/get-report-status.md): Returns the current status of a report job. Check the `status` field to determine the outcome. ### Reset device - [Resets device](https://developers.fireblocks.com/api-reference/reset-device/resets-device.md): Resets mobile device for given console user, that user will need to do mobile onboarding again. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Security Posture Management - [Get FSPM security findings](https://developers.fireblocks.com/api-reference/security-posture-management/get-fspm-security-findings.md): Returns a paginated list of FSPM security findings for the workspace. Endpoint Roles: Security Admin, Security Auditor. - [Get a FSPM security finding by ID](https://developers.fireblocks.com/api-reference/security-posture-management/get-a-fspm-security-finding-by-id.md): Returns a single FSPM security finding for the workspace, redacted to the public field set. Endpoint Roles: Security Admin, Security Auditor. - [Update a FSPM security finding by ID](https://developers.fireblocks.com/api-reference/security-posture-management/update-a-fspm-security-finding-by-id.md): Accepts or reopens a finding for the workspace. When accepting a finding (`status: "ACCEPTED"`), `statusUpdatedReason` is required. Endpoint Roles: Security Admin. ### Smart Transfer - [Fund dvp ticket](https://developers.fireblocks.com/api-reference/smart-transfer/fund-dvp-ticket.md): Create or fulfill dvp ticket order - [Set funding source and approval](https://developers.fireblocks.com/api-reference/smart-transfer/set-funding-source-and-approval.md): Set funding source for ticket term and creating approving transaction for contract to transfer asset - [Get smart transfers statistic](https://developers.fireblocks.com/api-reference/smart-transfer/get-smart-transfers-statistic.md): Get smart transfer statistic - [Find Ticket](https://developers.fireblocks.com/api-reference/smart-transfer/find-ticket.md): Find tickets by their title or ticker. You can also query all tickets without filters by not providing any input parameters. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Create Ticket](https://developers.fireblocks.com/api-reference/smart-transfer/create-ticket.md): Creates a new Smart Transfer ticket. Learn more about Fireblocks Smart Transfers [here](https://developers.fireblocks.com/docs/execute-smart-transfers). - [Search Ticket by ID](https://developers.fireblocks.com/api-reference/smart-transfer/search-ticket-by-id.md): Find Smart Transfer ticket by id. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Cancel Ticket](https://developers.fireblocks.com/api-reference/smart-transfer/cancel-ticket.md): Cancel Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Set expiration](https://developers.fireblocks.com/api-reference/smart-transfer/set-expiration.md): Set expiration date on Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Add external ref. ID](https://developers.fireblocks.com/api-reference/smart-transfer/add-external-ref-id.md): Set external id Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Fund ticket manually](https://developers.fireblocks.com/api-reference/smart-transfer/fund-ticket-manually.md): Manually fulfill ticket, in case when all terms (legs) are funded manually. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Submit ticket](https://developers.fireblocks.com/api-reference/smart-transfer/submit-ticket.md): Submit Smart Transfer ticket - change status into ready for approval if auto approval is not turned on, or OPEN if auto approval is on. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Create leg (term)](https://developers.fireblocks.com/api-reference/smart-transfer/create-leg-term.md): Creates new smart transfer ticket term (when the ticket status is DRAFT). Learn more about Fireblocks Smart Transfers in the following [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Get Smart Transfer ticket term](https://developers.fireblocks.com/api-reference/smart-transfer/get-smart-transfer-ticket-term.md): Find a specific term of a specific Smart Transfer ticket. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Update ticket leg (term)](https://developers.fireblocks.com/api-reference/smart-transfer/update-ticket-leg-term.md): Update ticket term (when ticket status is DRAFT) - [Delete ticket leg (term)](https://developers.fireblocks.com/api-reference/smart-transfer/delete-ticket-leg-term.md): Delete ticket term when ticket is in DRAFT status - [Define funding source](https://developers.fireblocks.com/api-reference/smart-transfer/define-funding-source.md): Set funding source for ticket term (in case of ASYNC tickets, this will execute transfer immediately). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Manually add term transaction](https://developers.fireblocks.com/api-reference/smart-transfer/manually-add-term-transaction.md): Manually set ticket term transaction. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Get user group](https://developers.fireblocks.com/api-reference/smart-transfer/get-user-group.md): Get Smart Transfer user groups. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Set user group](https://developers.fireblocks.com/api-reference/smart-transfer/set-user-group.md): Set Smart Transfers user group to receive email notifications for Smart Transfers. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Staking - [List supported staking chains](https://developers.fireblocks.com/api-reference/staking/list-supported-staking-chains.md): Returns an alphabetical list of blockchains supported for staking by the current workspace context. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Get chain-level staking parameters](https://developers.fireblocks.com/api-reference/staking/get-chain-level-staking-parameters.md): Returns chain-specific staking information such as epoch/slot cadence, lockup or unbonding periods, fee/reward mechanics, and other operational constraints. - [Claim accrued rewards](https://developers.fireblocks.com/api-reference/staking/claim-accrued-rewards.md): Claims available staking rewards for the specified chain and vault. Supported chains: Solana and Polygon (POL/Matic). Behavior depends on protocol reward distribution. - [Consolidate staking positions (ETH validator consolidation)](https://developers.fireblocks.com/api-reference/staking/consolidate-staking-positions-eth-validator-consolidation.md): Consolidates the source staking position into the destination, merging the balance into the destination and closing the source position once complete. Both positions must be from the same vault account (i.e. same withdrawal credentials). On chain, this translates into a consolidation transaction, w… - [Merge staking positions](https://developers.fireblocks.com/api-reference/staking/merge-staking-positions.md): Merges the source stake account into the destination, consolidating the balance into the destination and closing the source account once complete. Both accounts must be from the same validator provider and of same vault account.. Supported chains: Solana (SOL). Endpoint Permission: Owner, Admin, Non… - [Split a staking position](https://developers.fireblocks.com/api-reference/staking/split-a-staking-position.md): Splits a staking position by creating a new stake account with the requested amount, while keeping the original account with the remaining balance. Supported chains: Solana (SOL). - [Initiate or add to existing stake](https://developers.fireblocks.com/api-reference/staking/initiate-or-add-to-existing-stake.md): Creates a new staking position and returns its unique ID. For Ethereum compounding validator (EIP-7251): when the 'id' of an existing compounding validator position is provided, adds to that position; otherwise creates a new position. For Ethereum legacy validator: creates a new position regardless… - [Initiate unstake](https://developers.fireblocks.com/api-reference/staking/initiate-unstake.md): Submits a chain-specific unstake request. - [Withdraw staked funds](https://developers.fireblocks.com/api-reference/staking/withdraw-staked-funds.md): Withdraws funds that have completed the unbonding period. Typically requires the position to be deactivated first (unstake → unbond → withdraw). Amount and timing vary by chain protocol. - [List staking positions](https://developers.fireblocks.com/api-reference/staking/list-staking-positions.md): Returns all staking positions with core details: amounts, rewards, status, chain, and vault. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [List staking positions (Paginated)](https://developers.fireblocks.com/api-reference/staking/list-staking-positions-paginated.md): Returns staking positions with core details: amounts, rewards, status, chain, and vault. It supports cursor-based pagination for efficient data retrieval. This endpoint always returns a paginated response with {data, next} structure. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Appr… - [Get position details](https://developers.fireblocks.com/api-reference/staking/get-position-details.md): Returns full details for a single staking position: amounts, rewards, status, chain, and vault. - [List related transactions for a position](https://developers.fireblocks.com/api-reference/staking/list-related-transactions-for-a-position.md): Returns enriched transaction history for a staking position with cursor-based pagination. Includes in-flight transactions with status pending. The in-flight transaction is always returned first; completed and failed history is ordered by the order parameter. - [Get positions summary](https://developers.fireblocks.com/api-reference/staking/get-positions-summary.md): Returns an aggregated cross-vault summary: active/inactive counts, total staked, and total rewards per chain. - [Get positions summary by vault](https://developers.fireblocks.com/api-reference/staking/get-positions-summary-by-vault.md): Returns per-vault aggregates: status breakdown, total staked, and total rewards per chain. - [List staking providers](https://developers.fireblocks.com/api-reference/staking/list-staking-providers.md): Returns all available staking providers with metadata such as name, ID, and supported chains. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Approve provider terms of service](https://developers.fireblocks.com/api-reference/staking/approve-provider-terms-of-service.md): Approves the provider's terms of service. Must be called once before performing any staking operation with this provider. ### Tags - [Get list of tags](https://developers.fireblocks.com/api-reference/tags/get-list-of-tags.md): Retrieve a paged list of all tags according to filters. - [Create a new tag](https://developers.fireblocks.com/api-reference/tags/create-a-new-tag.md): Create a new tag. Endpoint Permissions: For protected tags: ADMIN,NON_SIGNING_ADMIN,OWNER. For non protected tags: ADMIN,NON_SIGNING_ADMIN,OWNER,SIGNER,EDITOR,APPROVER. - [Get a tag](https://developers.fireblocks.com/api-reference/tags/get-a-tag.md): Retrieve an existing tag by ID. - [Delete a tag](https://developers.fireblocks.com/api-reference/tags/delete-a-tag.md): Delete the specified tag. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver. - [Update a tag](https://developers.fireblocks.com/api-reference/tags/update-a-tag.md): Update an existing specified tag. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver. - [Get an approval request by id](https://developers.fireblocks.com/api-reference/tags/get-an-approval-request-by-id.md): Get an approval request by id ### Trading (Beta) - [Get all offers](https://developers.fireblocks.com/api-reference/trading-beta/get-all-offers.md): Retrieve all available offers across the workspace for a given asset pair. Always operates in open scope — no provider or account selection required. Returns a mix of indicative rates and committed quotes as applicable per provider. - [Get orders](https://developers.fireblocks.com/api-reference/trading-beta/get-orders.md): Retrieve a paginated list of orders with optional filtering by account, provider, status, and time range. - [Create an order](https://developers.fireblocks.com/api-reference/trading-beta/create-an-order.md): Create an order to buy or sell an asset. If no source is given, an external source will be use. - [Get order details](https://developers.fireblocks.com/api-reference/trading-beta/get-order-details.md): Retrieve detailed information about a specific order by its ID. - [Get order requirement details for an order](https://developers.fireblocks.com/api-reference/trading-beta/get-order-requirement-details-for-an-order.md): Fetch order requirement details for an order that is in `AWAITING_INFORMATION` status. - [Submit a response to an order requirement](https://developers.fireblocks.com/api-reference/trading-beta/submit-a-response-to-an-order-requirement.md): Submit the user's textual response to an order requirement on an order that is in `AWAITING_INFORMATION` status. - [Upload a file for an order requirement](https://developers.fireblocks.com/api-reference/trading-beta/upload-a-file-for-an-order-requirement.md): Upload a single file (multipart/form-data) in response to an order requirement on an order that is in `AWAITING_INFORMATION` status. Call this endpoint once per required file. - [Get providers](https://developers.fireblocks.com/api-reference/trading-beta/get-providers.md): Retrieve a list of all available external providers supporting trading activities through the platform. - [Get trading provider by ID](https://developers.fireblocks.com/api-reference/trading-beta/get-trading-provider-by-id.md): Retrieve a single provider by ID. - [Create a quote](https://developers.fireblocks.com/api-reference/trading-beta/create-a-quote.md): Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations. - [Get rates](https://developers.fireblocks.com/api-reference/trading-beta/get-rates.md): Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes. ### Transactions - [Estimate the required fee for an asset](https://developers.fireblocks.com/api-reference/transactions/estimate-the-required-fee-for-an-asset.md): Gets the estimated required fee for an asset. Fireblocks fetches, calculates and caches the result every 30 seconds. Customers should query this API while taking the caching interval into consideration. Notes: - The `networkFee` parameter is the `gasPrice` with a given delta added, multiplied by the… - [Get transaction history](https://developers.fireblocks.com/api-reference/transactions/get-transaction-history.md): Get the transaction history for your workspace. - [Create a new transaction](https://developers.fireblocks.com/api-reference/transactions/create-a-new-transaction.md): Creates a new transaction. This endpoint can be used for regular Transfers, Contract Calls, Raw & Typed message signing. - For Transfers, the required parameters are: `assetId`, `source`, `destination` and `amount`. - For Contract Calls, the required parameters are: `operation.CONTRACT_CALL`, `asset… - [Get a specific transaction by Fireblocks transaction ID](https://developers.fireblocks.com/api-reference/transactions/get-a-specific-transaction-by-fireblocks-transaction-id.md): Get a specific transaction data by Fireblocks Transaction ID Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Cancel a transaction](https://developers.fireblocks.com/api-reference/transactions/cancel-a-transaction.md): Cancels a transaction by Fireblocks Transaction ID. - [Drop ETH (EVM) transaction by ID](https://developers.fireblocks.com/api-reference/transactions/drop-eth-evm-transaction-by-id.md): Drops a stuck ETH (EVM) transaction and creates a replacement transaction with 0 amount. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Freeze a transaction](https://developers.fireblocks.com/api-reference/transactions/freeze-a-transaction.md): Freezes a transaction by ID. - [Set confirmation threshold by Fireblocks Transaction ID](https://developers.fireblocks.com/api-reference/transactions/set-confirmation-threshold-by-fireblocks-transaction-id.md): Overrides the required number of confirmations for transaction completion Fireblocks Transaction ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Unfreeze a transaction](https://developers.fireblocks.com/api-reference/transactions/unfreeze-a-transaction.md): Unfreezes a transaction by Fireblocks Transaction ID and makes the transaction available again. Endpoint Permission: Admin, Non-Signing Admin. - [Estimate transaction fee](https://developers.fireblocks.com/api-reference/transactions/estimate-transaction-fee.md): Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. **Note**: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is… - [Get a specific transaction by external transaction ID](https://developers.fireblocks.com/api-reference/transactions/get-a-specific-transaction-by-external-transaction-id.md): Returns transaction by external transaction ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Validate destination address](https://developers.fireblocks.com/api-reference/transactions/validate-destination-address.md): Checks if an address is valid and active (for XRP, DOT, XLM, and EOS). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. - [Set confirmation threshold by transaction hash](https://developers.fireblocks.com/api-reference/transactions/set-confirmation-threshold-by-transaction-hash.md): Overrides the required number of confirmations for transaction completion by transaction hash. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. ### Transactions (Beta) - [Create a Tempo transfer transaction](https://developers.fireblocks.com/api-reference/transactions-beta/create-a-tempo-transfer-transaction.md): Creates a new Tempo transfer transaction. ### Travel Rule - [Create Trust Network Proof of Address](https://developers.fireblocks.com/api-reference/travel-rule/create-trust-network-proof-of-address.md): Creates a cryptographic proof of address ownership for TRUST network. - [Retrieve Trust Network Proof of Address Signature](https://developers.fireblocks.com/api-reference/travel-rule/retrieve-trust-network-proof-of-address-signature.md): Retrieves the TRUST-compatible encoded signature for a proof of address transaction. Send this signature directly to TRUST for verification. - [Validate Travel Rule Transaction](https://developers.fireblocks.com/api-reference/travel-rule/validate-travel-rule-transaction.md): Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary's jurisdiction. **Deprecation Notice** This endpoint will be deprecated soon in favor of the [validate full](https://developers.fireblocks.com/reference/validatefulltravelrul… - [Validate Full Travel Rule Transaction](https://developers.fireblocks.com/api-reference/travel-rule/validate-full-travel-rule-transaction.md): Validate Full Travel Rule transactions. - [Get All VASPs](https://developers.fireblocks.com/api-reference/travel-rule/get-all-vasps.md): Get All VASPs. - [Get VASP details](https://developers.fireblocks.com/api-reference/travel-rule/get-vasp-details.md): Get VASP Details. - [Add jsonDidKey to VASP details](https://developers.fireblocks.com/api-reference/travel-rule/add-jsondidkey-to-vasp-details.md): Update VASP Details. - [Get assigned VASP to vault](https://developers.fireblocks.com/api-reference/travel-rule/get-assigned-vasp-to-vault.md): Get assigned VASP Did for a specific vault. Returns empty string vaspDid value in response if none assigned. - [Assign VASP to vault](https://developers.fireblocks.com/api-reference/travel-rule/assign-vasp-to-vault.md): Sets the VASP Did for a specific vault. Pass empty string to remove existing one. ### User groups (Beta) - [List user groups](https://developers.fireblocks.com/api-reference/user-groups-beta/list-user-groups.md): Get all user groups in your workspace - [Create user group](https://developers.fireblocks.com/api-reference/user-groups-beta/create-user-group.md): Create a new user group. Users with the Viewer role cannot be added to groups. Endpoint Permission: Admin, Non-Signing Admin. - [Get user group](https://developers.fireblocks.com/api-reference/user-groups-beta/get-user-group.md): Get a user group by ID. - [Update user group](https://developers.fireblocks.com/api-reference/user-groups-beta/update-user-group.md): Update a user group by ID. - [Delete user group](https://developers.fireblocks.com/api-reference/user-groups-beta/delete-user-group.md): Delete a user group by ID. ### Users - [List users](https://developers.fireblocks.com/api-reference/users/list-users.md): List all users for the workspace. ### UTXO Management (Beta) - [Attach or detach labels to/from UTXOs](https://developers.fireblocks.com/api-reference/utxo-management-beta/attach-or-detach-labels-tofrom-utxos.md): Attach or detach labels to/from UTXOs in a vault account. Labels can be used for organizing and filtering UTXOs. - [Get vault and asset UTXO selection config](https://developers.fireblocks.com/api-reference/utxo-management-beta/get-vault-and-asset-utxo-selection-config.md): Returns the config stored at this vault-and-asset scope, if any, and the effective strategy after workspace fallback and runtime resolution. `ADAPTIVE` is the recommended strategy. When no row is stored at this scope and none is inherited from the workspace (source `DEFAULT`), `effective` is `ADAPTI… - [Upsert vault and asset UTXO selection config](https://developers.fireblocks.com/api-reference/utxo-management-beta/upsert-vault-and-asset-utxo-selection-config.md): Creates or updates the UTXO selection strategy for this vault account and asset. `ADAPTIVE` is recommended. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin. - [List unspent outputs (UTXOs)](https://developers.fireblocks.com/api-reference/utxo-management-beta/list-unspent-outputs-utxos.md): Returns a paginated list of unspent transaction outputs (UTXOs) for a UTXO-based asset in a vault account, with optional filters for labels, statuses, amounts, and more. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Si… - [Get UTXO selection config](https://developers.fireblocks.com/api-reference/utxo-management-beta/get-utxo-selection-config.md): Returns the workspace-level configured selection strategy and the effective strategy after runtime resolution. `ADAPTIVE` is the recommended strategy. When no row is stored (source `DEFAULT`), `effective` is `ADAPTIVE` if adaptive selection is serving for this workspace, otherwise `ASC`. **Note:** T… - [Upsert UTXO selection config](https://developers.fireblocks.com/api-reference/utxo-management-beta/upsert-utxo-selection-config.md): Creates or updates the workspace-level UTXO selection strategy. `ADAPTIVE` is recommended. **Note:** These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin. ### Web3 connections - [List all open Web3 connections.](https://developers.fireblocks.com/api-reference/web3-connections/list-all-open-web3-connections.md): Get open Web3 connections. - [Create a new Web3 connection.](https://developers.fireblocks.com/api-reference/web3-connections/create-a-new-web3-connection.md): Initiate a new Web3 connection. - [Respond to a pending Web3 connection request.](https://developers.fireblocks.com/api-reference/web3-connections/respond-to-a-pending-web3-connection-request.md): Submit a response to *approve* or *reject* an initiated Web3 connection. * Note: This call is used to complete your `POST /v1/connections/wc/` request. - [Remove an existing Web3 connection.](https://developers.fireblocks.com/api-reference/web3-connections/remove-an-existing-web3-connection.md): Remove a Web3 connection ### Webhooks - [Resend failed webhooks](https://developers.fireblocks.com/api-reference/webhooks/resend-failed-webhooks.md): Resends all failed webhook notifications. - [Resend webhooks for a transaction by ID](https://developers.fireblocks.com/api-reference/webhooks/resend-webhooks-for-a-transaction-by-id.md): Resends webhook notifications for a transaction by its unique identifier. ### Webhooks V2 - [Get all webhooks](https://developers.fireblocks.com/api-reference/webhooks-v2/get-all-webhooks.md): Get all webhooks (paginated). - [Create a new webhook](https://developers.fireblocks.com/api-reference/webhooks-v2/create-a-new-webhook.md): Creates a new webhook, which will be triggered on the specified events - [List the uploaded mTLS configurations](https://developers.fireblocks.com/api-reference/webhooks-v2/list-the-uploaded-mtls-configurations.md): Lists the workspace's mTLS configurations, newest first. Pass `ids` to ask about particular ones instead — useful for resolving the `webhookMtlsId` values on a set of webhooks in one call. - [Create an mTLS configuration](https://developers.fireblocks.com/api-reference/webhooks-v2/create-an-mtls-configuration.md): Stores a certificate signed against the CSR from `GET /v1/webhooks_settings/mtls_csr` and returns its id, which is then set as `webhookMtlsId` on a webhook or on OAuth credentials. The private key the certificate was issued for is derived from the certificate, so it is never named by the caller. - [Get mTLS CSR](https://developers.fireblocks.com/api-reference/webhooks-v2/get-mtls-csr.md): Returns the Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. - [Get an mTLS configuration by id](https://developers.fireblocks.com/api-reference/webhooks-v2/get-an-mtls-configuration-by-id.md): Retrieve one stored mTLS configuration by its id. - [Delete an mTLS configuration](https://developers.fireblocks.com/api-reference/webhooks-v2/delete-an-mtls-configuration.md): Deletes an mTLS configuration. By default the delete is refused while the configuration is still in use: if any webhook or OAuth credentials reference it, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of what references it. This protects a shared… - [Update an mTLS configuration](https://developers.fireblocks.com/api-reference/webhooks-v2/update-an-mtls-configuration.md): Renames a configuration, replaces its certificate, or both. Only the fields present in the request are changed; anything omitted is left as it is, and a request with neither field is rejected with a `400`. - [Get all OAuth credentials](https://developers.fireblocks.com/api-reference/webhooks-v2/get-all-oauth-credentials.md): Lists every OAuth credential set for the workspace. Client secrets are never returned. - [Create OAuth credentials](https://developers.fireblocks.com/api-reference/webhooks-v2/create-oauth-credentials.md): Creates a reusable OAuth client credential set. Attach it to a webhook by passing the returned id as that webhook's `webhookOauthId`. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. The client secret is write-only and is never returned. - [Get OAuth credentials by id](https://developers.fireblocks.com/api-reference/webhooks-v2/get-oauth-credentials-by-id.md): Retrieve an OAuth credential set by its id. The client secret is never returned. - [Delete OAuth credentials](https://developers.fireblocks.com/api-reference/webhooks-v2/delete-oauth-credentials.md): Deletes an OAuth credential set. By default the delete is refused while the credentials are still in use: if any webhook references them, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of the referencing webhooks. This protects a shared credential… - [Update OAuth credentials](https://developers.fireblocks.com/api-reference/webhooks-v2/update-oauth-credentials.md): Updates only the fields present in the request; anything omitted is left as it is. Sending `clientSecret` on its own rotates the secret for every webhook using these credentials. - [Get webhook by id](https://developers.fireblocks.com/api-reference/webhooks-v2/get-webhook-by-id.md): Retrieve a webhook by its id - [Delete webhook](https://developers.fireblocks.com/api-reference/webhooks-v2/delete-webhook.md): Delete a webhook by its id - [Update webhook](https://developers.fireblocks.com/api-reference/webhooks-v2/update-webhook.md): Update a webhook by its id - [Get webhook metrics](https://developers.fireblocks.com/api-reference/webhooks-v2/get-webhook-metrics.md): Get webhook metrics by webhook id and metric name - [Get all notifications by webhook id](https://developers.fireblocks.com/api-reference/webhooks-v2/get-all-notifications-by-webhook-id.md): Get all notifications by webhook id (paginated) - [Get notification by id](https://developers.fireblocks.com/api-reference/webhooks-v2/get-notification-by-id.md): Get notification by id - [Get notification attempts](https://developers.fireblocks.com/api-reference/webhooks-v2/get-notification-attempts.md): Get notification attempts by notification id - [Resend notification by id](https://developers.fireblocks.com/api-reference/webhooks-v2/resend-notification-by-id.md): Resend notification by ID - [Resend notifications by query](https://developers.fireblocks.com/api-reference/webhooks-v2/resend-notifications-by-query.md): Resend notifications matching the given query filters (statuses, events, time range, resource ID) - [Get resend by query job status](https://developers.fireblocks.com/api-reference/webhooks-v2/get-resend-by-query-job-status.md): Get the status of a resend by query job - [Resend notifications by resource Id](https://developers.fireblocks.com/api-reference/webhooks-v2/resend-notifications-by-resource-id.md): Resend notifications by resource Id - [Resend failed notifications](https://developers.fireblocks.com/api-reference/webhooks-v2/resend-failed-notifications.md): Resend all failed notifications for a webhook in the last 24 hours - [Get resend job status](https://developers.fireblocks.com/api-reference/webhooks-v2/get-resend-job-status.md): Get the status of a resend job ### whitelist ip addresses - [Get whitelisted ip addresses for an API Key](https://developers.fireblocks.com/api-reference/whitelist-ip-addresses/get-whitelisted-ip-addresses-for-an-api-key.md): Get a list of the whitelisted IP addresses for a specific API Key - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. ### Workspace - [Get workspace](https://developers.fireblocks.com/api-reference/workspace/get-workspace.md): Returns the workspace ID and name for the authenticated user. - [Freeze](https://developers.fireblocks.com/api-reference/workspace/freeze.md): Freezes a Workspace so that ALL operations by ANY user are blocked. You should only perform this action when the workspace faces imminent risk, such as when you have a security breach. To unfreeze a workspace, the workspace Owner must submit a request to Fireblocks Support. **NOTE:** - This operati… ### Workspace Status (Beta) - [Returns current workspace status](https://developers.fireblocks.com/api-reference/workspace-status-beta/returns-current-workspace-status.md): Returns current workspace status (Beta). **Note**: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. ## OpenAPI Specs - [openapi](https://swagger.fireblocks.com/openapi.yaml)