vault-accounts-bulk

Bulk creation of new vault accounts

vault-accounts-{vaultAccountId}-hide

Hide a vault account in the console

vault-accounts-{vaultAccountId}-unhide

Unhide a vault account in the console

vault-accounts-{vaultAccountId}-{assetId}-activate

Activate a wallet in a vault account

vault-accounts-{vaultAccountId}-{assetId}-balance

Refresh asset balance data

vault-accounts-{vaultAccountId}-{assetId}-addresses-{addressId}-set_customer_ref_id

Assign AML customer reference ID

vault-accounts-{vaultAccountId}-{assetId}-addresses-{addressId}-create_legacy

Convert a segwit address to legacy format

vault-accounts-{vaultAccountId}-{assetId}-addresses-{addressId}

Update address description

vault-accounts-{vaultAccountId}-{assetId}-addresses

Get asset addresses Create new asset deposit address

vault-accounts-{vaultAccountId}-{assetId}-addresses_paginated

List addresses (Paginated)

vault-accounts-{vaultAccountId}-{assetId}-max_spendable_amount

Get the maximum spendable amount in a single transaction.

vault-accounts-{vaultAccountId}-{assetId}-unspent_inputs

Get UTXO unspent inputs information

vault-accounts-{vaultAccountId}-{assetId}-{change}-{addressIndex}-public_key_info

Get the public key for a vault account

vault-accounts-{vaultAccountId}-{assetId}

Get the asset balance for a vault account Create a new wallet

vault-accounts-{vaultAccountId}-set_customer_ref_id

Set an AML/KYT customer reference ID for a vault account

vault-accounts-{vaultAccountId}-set_auto_fuel

Turn autofueling on or off

vault-accounts-{vaultAccountId}

Find a vault account by ID Rename a vault account

List vault accounts Create a new vault account

vault-accounts_paged

List vault accounts (Paginated)

vault-asset_wallets

List asset wallets (Paginated)

vault-public_key_info

Get the public key information

vault-assets-bulk

Bulk creation of wallets

vault-assets-{assetId}

Get vault balance by asset

Get asset balance for chosen assets

workspace-freeze

Freeze Workspace

exchange_accounts-paged

Pagination list exchange accounts

exchange_accounts-{exchangeAccountId}-internal_transfer

Internal transfer for exchange accounts

exchange_accounts-{exchangeAccountId}-convert

Convert exchange account funds from the source asset to the destination asset.

exchange_accounts-{exchangeAccountId}-{assetId}

Find an asset for an exchange account

exchange_accounts-{exchangeAccountId}

Find a specific exchange account

exchange_accounts-credentials_public_key

Get public key to encrypt exchange credentials

exchange_accounts

List exchange accounts

fiat_accounts-{accountId}-redeem_to_linked_dda

Redeem funds to DDA

fiat_accounts-{accountId}-deposit_from_linked_dda

Deposit funds from DDA

fiat_accounts-{accountId}

Find a specific fiat account

List fiat accounts

network_connections-{connectionId}-set_routing_policy

Update network connection routing policy.

network_connections-{connectionId}-is_third_party_routing-{assetType}

Retrieve third-party network routing validation by asset type.

network_connections-{connectionId}

Get a network connection Deletes a network connection by ID

network_connections

List network connections Creates a new network connection

network_ids-routing_policy_asset_groups

Returns all enabled routing policy asset groups

network_ids-{networkId}-set_routing_policy

Update network id routing policy.

network_ids-{networkId}-set_discoverability

Update network ID's discoverability.

network_ids-{networkId}-set_name

Update network ID's name.

network_ids-{networkId}

Returns specific network ID.Deletes specific network ID.

Returns all network IDs, both local IDs and discoverable remote IDs Creates a new Network ID

internal_wallets-{walletId}-set_customer_ref_id

Set an AML/KYT customer reference ID for an internal wallet

internal_wallets-{walletId}-{assetId}

Get an asset from an internal wallet Add an asset to an internal wallet Delete a whitelisted address from an internal wallet

internal_wallets-{walletId}

Get assets for internal wallet Delete an internal wallet

internal_wallets

List internal wallets Create an internal wallet

key_link-signing_keys-{keyId}-agent_user_id

Set agent user id that can sign with the signing key identified by the Fireblocks provided `keyId`

key_link-signing_keys-{keyId}

Get a signing key by `keyId`Modify the signing by Fireblocks provided `keyId`

key_link-signing_keys

Add a new signing key Get list of signing keys

key_link-validation_keys-{keyId}

Get a validation key by `keyId`Disables a validation key

key_link-validation_keys

Add a new validation key Get list of registered validation keys

external_wallets-{walletId}-set_customer_ref_id

Set an AML customer reference ID for an external wallet

external_wallets-{walletId}-{assetId}

Get an asset from an external wallet Add an asset to an external wallet.Delete an asset from an external wallet

external_wallets-{walletId}

Find an external wallet Delete an external wallet

external_wallets

List external wallets Create an external wallet

contracts-{contractId}-{assetId}

Find a contract asset Add an asset to a contract Delete a contract asset

contracts-{contractId}

Find a specific contract Delete a contract

List contracts Create a contract

supported_assets

List all asset types supported by Fireblocks

assets-prices-{id}

Set asset price

Register an asset

transactions-estimate_fee

Estimate transaction fee

transactions-{txId}-set_confirmation_threshold

Set confirmation threshold by transaction ID

transactions-{txId}-drop

Drop ETH transaction by ID

transactions-{txId}-cancel

Cancel a transaction

transactions-{txId}-freeze

Freeze a transaction

transactions-{txId}-unfreeze

Unfreeze a transaction

transactions-{txId}

Find a specific transaction by Fireblocks transaction ID

transactions-external_tx_id-{externalTxId}

Find a specific transaction by external transaction ID

transactions-validate_address-{assetId}-{address}

Validate destination address

List transaction history Create a new transaction

txHash-{txHash}-set_confirmation_threshold

Set confirmation threshold by transaction hash

estimate_network_fee

Estimate the required fee for an asset

payments-payout-{payoutId}-actions-execute

Execute a payout instruction set

payments-payout-{payoutId}

Get the status of a payout instruction set

payments-payout

Create a payout instruction set

payments-workflow_config-{configId}

Retrieve workflow configuration Delete workflow configuration

payments-workflow_config

Create payment flow configuration

payments-workflow_execution-{workflowExecutionId}-actions-execute

Execute the payments workflow

payments-workflow_execution-{workflowExecutionId}

Get workflow execution details

payments-workflow_execution

Create workflow execution

gas_station-{assetId}

Get gas station settings by asset

gas_station-configuration-{assetId}

Edit gas station settings for an asset

gas_station-configuration

Edit gas station settings

Get gas station settings

management-user_groups-{groupId}

Get user group Update user group Delete user group

management-user_groups

List user groups Create user group

management-audit_logs

Enable or disable transactions to OTA Returns current OTA status

management-workspace_status

Returns current workspace status

management-users-{id}-reset_device

management-users

Get console users Create console user

management-api_users-{userId}-whitelist_ip_addresses

Gets whitelisted ip addresses

management-api_users

Get Api users Create Api user

off_exchange-add

off_exchange-remove

remove collateral

off_exchange-settlements-trader

create settlement for a trader

off_exchange-settlements-transactions

get settlements transactions from exchange

off_exchange-collateral_accounts-{mainExchangeAccountId}

Find a specific collateral exchange account

webhooks-resend-{txId}

Resend failed webhooks for a transaction by ID

webhooks-resend

Resend failed webhooks

tokenization-templates-{contractTemplateId}-constructor

Return contract template's constructor

tokenization-templates-{contractTemplateId}-function

Return contract template's function

tokenization-templates-{contractTemplateId}-deploy

Deploy contract

tokenization-templates-{contractTemplateId}

Return contract template by id Delete a contract template by id

tokenization-templates

List all contract templates Upload contract template

tokenization-contracts-{id}

Return deployed contract data by id

tokenization-contracts-{assetId}-{contractAddress}

Return deployed contract data

tokenization-contracts-fetch_abi

Fetch the contract ABI

tokenization-contracts-abi

Save contract ABI

tokenization-contracts

List deployed contracts data

tokenization-tokens-link

Link a contract

tokenization-tokens-{id}

Unlink a token Return a linked token

tokenization-tokens

Issue a new token List all linked tokens

tokenization-collections-{id}-tokens-{tokenId}

Get collection token details

tokenization-collections-{id}-tokens-mint

tokenization-collections-{id}-tokens-burn

tokenization-collections-{id}

Get a collection by id Delete a collection link

tokenization-collections

Create a new collection Get collections

contract_interactions-base_asset_id-{assetId}-contract_address-{contractAddress}-functions-read

Call a read function on a deployed contract

contract_interactions-base_asset_id-{assetId}-contract_address-{contractAddress}-functions-write

Call a write function on a deployed contract

contract_interactions-base_asset_id-{assetId}-contract_address-{contractAddress}-functions

Return deployed contract's ABI

staking-chains-{chainDescriptor}-chainInfo

staking-chains-{chainDescriptor}-{actionId}

staking-positions-summary-vaults

get Summary By Vault

staking-positions-summary

staking-positions-{id}

get Delegation By Id

staking-positions

get All Delegations

staking-providers-{providerId}-approveTermsOfService

approve Terms Of Service By Provider Id

staking-providers

Update admin quorum threshold

nfts-ownership-tokens-{id}-status

Update token ownership status

nfts-ownership-tokens-status

Update tokens ownership status

nfts-ownership-tokens-spam

Update tokens ownership spam property

nfts-ownership-tokens

Refresh vault account tokens List all owned tokens (paginated)

nfts-ownership-assets

List all distinct owned tokens (paginated)

nfts-ownership-collections

List owned collections (paginated)

nfts-tokens-{id}

Refresh token metadata List token data by ID

List tokens by IDs

connections-wc-{id}

Respond to a pending Web3 connection request.Remove an existing Web3 connection.

Create a new Web3 connection.

List all open Web3 connections.

screening-travel_rule-transaction-validate-full

Validate Full Travel Rule Transaction

screening-travel_rule-transaction-validate

Validate Travel Rule Transaction

screening-travel_rule-vasp-{did}

Get VASP details

screening-travel_rule-vasp-update

Add jsonDidKey to VASP details

screening-travel_rule-vasp

screening-travel_rule-post_screening_policy

Travel Rule - View Post-Screening Policy

screening-travel_rule-screening_policy

Travel Rule - View Screening Policy

screening-travel_rule-policy_configuration

Get Travel Rule Screening Policy Configuration Update Travel Rule Configuration

screening-aml-policy_configuration

Get AML Screening Policy Configuration Update AML Configuration

screening-aml-screening_policy

AML - View Screening Policy

screening-aml-post_screening_policy

AML - View Post-Screening Policy

screening-configurations

Tenant - Screening Configuration

tap-active_policy

Get the active policy and its validation

Get the active draft Update the draft with a new set of rules Send publish request for a certain draft id

Send publish request for a set of policy rules

smart-transfers-{ticketId}-expires-in

smart-transfers-{ticketId}-external-id

Add external ref. ID

smart-transfers-{ticketId}-submit

smart-transfers-{ticketId}-fulfill

Fund ticket manually

smart-transfers-{ticketId}-cancel

smart-transfers-{ticketId}-terms-{termId}-fund

Define funding source

smart-transfers-{ticketId}-terms-{termId}-manually-fund

Manually add term transaction

smart-transfers-{ticketId}-terms-{termId}

Search ticket by leg (term) ID Update ticket leg (term)Delete ticket leg (term)

smart-transfers-{ticketId}-terms

Create leg (term)

smart-transfers-{ticketId}

Search Tickets by ID

smart-transfers-settings-user-groups

Set user group Get user group

smart-transfers

Create Ticket Find Ticket

Return a list of jobs belonging to tenant

batch-{jobId}-pause

batch-{jobId}-continue

Continue a paused job

batch-{jobId}-cancel

Cancel a running job

batch-{jobId}-tasks

Return a list of tasks for given job

Get job details

cosigners-{cosignerId}-api_keys-{apiKeyId}

cosigners-{cosignerId}-api_keys

Get all API keys

cosigners-{cosignerId}

Get cosigner Rename cosigner

Get all cosigners

vault-accounts-bulk

Bulk creation of new vault accounts

vault-accounts-{vaultAccountId}-hide

Hide a vault account in the console

vault-accounts-{vaultAccountId}-unhide

Unhide a vault account in the console

vault-accounts-{vaultAccountId}-{assetId}-activate

Activate a wallet in a vault account

vault-accounts-{vaultAccountId}-{assetId}-balance

Refresh asset balance data

vault-accounts-{vaultAccountId}-{assetId}-addresses-{addressId}-set_customer_ref_id

Assign AML customer reference ID

vault-accounts-{vaultAccountId}-{assetId}-addresses-{addressId}-create_legacy

Convert a segwit address to legacy format

vault-accounts-{vaultAccountId}-{assetId}-addresses-{addressId}

Update address description

vault-accounts-{vaultAccountId}-{assetId}-addresses

Get asset addresses Create new asset deposit address

vault-accounts-{vaultAccountId}-{assetId}-addresses_paginated

List addresses (Paginated)

vault-accounts-{vaultAccountId}-{assetId}-max_spendable_amount

Get the maximum spendable amount in a single transaction.

vault-accounts-{vaultAccountId}-{assetId}-unspent_inputs

Get UTXO unspent inputs information

vault-accounts-{vaultAccountId}-{assetId}-{change}-{addressIndex}-public_key_info

Get the public key for a vault account

vault-accounts-{vaultAccountId}-{assetId}

Get the asset balance for a vault account Create a new wallet

vault-accounts-{vaultAccountId}-set_customer_ref_id

Set an AML/KYT customer reference ID for a vault account

vault-accounts-{vaultAccountId}-set_auto_fuel

Turn autofueling on or off

vault-accounts-{vaultAccountId}

Find a vault account by ID Rename a vault account

List vault accounts Create a new vault account

vault-accounts_paged

List vault accounts (Paginated)

vault-asset_wallets

List asset wallets (Paginated)

vault-public_key_info

Get the public key information

vault-assets-bulk

Bulk creation of wallets

vault-assets-{assetId}

Get vault balance by asset

Get asset balance for chosen assets

workspace-freeze

Freeze Workspace

exchange_accounts-paged

Pagination list exchange accounts

exchange_accounts-{exchangeAccountId}-internal_transfer

Internal transfer for exchange accounts

exchange_accounts-{exchangeAccountId}-convert

Convert exchange account funds from the source asset to the destination asset.

exchange_accounts-{exchangeAccountId}-{assetId}

Find an asset for an exchange account

exchange_accounts-{exchangeAccountId}

Find a specific exchange account

exchange_accounts-credentials_public_key

Get public key to encrypt exchange credentials

exchange_accounts

List exchange accounts

fiat_accounts-{accountId}-redeem_to_linked_dda

Redeem funds to DDA

fiat_accounts-{accountId}-deposit_from_linked_dda

Deposit funds from DDA

fiat_accounts-{accountId}

Find a specific fiat account

List fiat accounts

network_connections-{connectionId}-set_routing_policy

Update network connection routing policy.

network_connections-{connectionId}-is_third_party_routing-{assetType}

Retrieve third-party network routing validation by asset type.

network_connections-{connectionId}

Get a network connection Deletes a network connection by ID

network_connections

List network connections Creates a new network connection

network_ids-routing_policy_asset_groups

Returns all enabled routing policy asset groups

network_ids-{networkId}-set_routing_policy

Update network id routing policy.

network_ids-{networkId}-set_discoverability

Update network ID's discoverability.

network_ids-{networkId}-set_name

Update network ID's name.

network_ids-{networkId}

Returns specific network ID.Deletes specific network ID.

Returns all network IDs, both local IDs and discoverable remote IDs Creates a new Network ID

internal_wallets-{walletId}-set_customer_ref_id

Set an AML/KYT customer reference ID for an internal wallet

internal_wallets-{walletId}-{assetId}

Get an asset from an internal wallet Add an asset to an internal wallet Delete a whitelisted address from an internal wallet

internal_wallets-{walletId}

Get assets for internal wallet Delete an internal wallet

internal_wallets

List internal wallets Create an internal wallet

key_link-signing_keys-{keyId}-agent_user_id

Set agent user id that can sign with the signing key identified by the Fireblocks provided `keyId`

key_link-signing_keys-{keyId}

Get a signing key by `keyId`Modify the signing by Fireblocks provided `keyId`

key_link-signing_keys

Add a new signing key Get list of signing keys

key_link-validation_keys-{keyId}

Get a validation key by `keyId`Disables a validation key

key_link-validation_keys

Add a new validation key Get list of registered validation keys

external_wallets-{walletId}-set_customer_ref_id

Set an AML customer reference ID for an external wallet

external_wallets-{walletId}-{assetId}

Get an asset from an external wallet Add an asset to an external wallet.Delete an asset from an external wallet

external_wallets-{walletId}

Find an external wallet Delete an external wallet

external_wallets

List external wallets Create an external wallet

contracts-{contractId}-{assetId}

Find a contract asset Add an asset to a contract Delete a contract asset

contracts-{contractId}

Find a specific contract Delete a contract

List contracts Create a contract

supported_assets

List all asset types supported by Fireblocks

assets-prices-{id}

Set asset price

Register an asset

transactions-estimate_fee

Estimate transaction fee

transactions-{txId}-set_confirmation_threshold

Set confirmation threshold by transaction ID

transactions-{txId}-drop

Drop ETH transaction by ID

transactions-{txId}-cancel

Cancel a transaction

transactions-{txId}-freeze

Freeze a transaction

transactions-{txId}-unfreeze

Unfreeze a transaction

transactions-{txId}

Find a specific transaction by Fireblocks transaction ID

transactions-external_tx_id-{externalTxId}

Find a specific transaction by external transaction ID

transactions-validate_address-{assetId}-{address}

Validate destination address

List transaction history Create a new transaction

txHash-{txHash}-set_confirmation_threshold

Set confirmation threshold by transaction hash

estimate_network_fee

Estimate the required fee for an asset

payments-payout-{payoutId}-actions-execute

Execute a payout instruction set

payments-payout-{payoutId}

Get the status of a payout instruction set

payments-payout

Create a payout instruction set

payments-workflow_config-{configId}

Retrieve workflow configuration Delete workflow configuration

payments-workflow_config

Create payment flow configuration

payments-workflow_execution-{workflowExecutionId}-actions-execute

Execute the payments workflow

payments-workflow_execution-{workflowExecutionId}

Get workflow execution details

payments-workflow_execution

Create workflow execution

gas_station-{assetId}

Get gas station settings by asset

gas_station-configuration-{assetId}

Edit gas station settings for an asset

gas_station-configuration

Edit gas station settings

Get gas station settings

management-user_groups-{groupId}

Get user group Update user group Delete user group

management-user_groups

List user groups Create user group

management-audit_logs

Enable or disable transactions to OTA Returns current OTA status

management-workspace_status

Returns current workspace status

management-users-{id}-reset_device

management-users

Get console users Create console user

management-api_users-{userId}-whitelist_ip_addresses

Gets whitelisted ip addresses

management-api_users

Get Api users Create Api user

off_exchange-add

off_exchange-remove

remove collateral

off_exchange-settlements-trader

create settlement for a trader

off_exchange-settlements-transactions

get settlements transactions from exchange

off_exchange-collateral_accounts-{mainExchangeAccountId}

Find a specific collateral exchange account

webhooks-resend-{txId}

Resend failed webhooks for a transaction by ID

webhooks-resend

Resend failed webhooks

tokenization-templates-{contractTemplateId}-constructor

Return contract template's constructor

tokenization-templates-{contractTemplateId}-function

Return contract template's function

tokenization-templates-{contractTemplateId}-deploy

Deploy contract

tokenization-templates-{contractTemplateId}

Return contract template by id Delete a contract template by id

tokenization-templates

List all contract templates Upload contract template

tokenization-contracts-{id}

Return deployed contract data by id

tokenization-contracts-{assetId}-{contractAddress}

Return deployed contract data

tokenization-contracts-fetch_abi

Fetch the contract ABI

tokenization-contracts-abi

Save contract ABI

tokenization-contracts

List deployed contracts data

tokenization-tokens-link

Link a contract

tokenization-tokens-{id}

Unlink a token Return a linked token

tokenization-tokens

Issue a new token List all linked tokens

tokenization-collections-{id}-tokens-{tokenId}

Get collection token details

tokenization-collections-{id}-tokens-mint

tokenization-collections-{id}-tokens-burn

tokenization-collections-{id}

Get a collection by id Delete a collection link

tokenization-collections

Create a new collection Get collections

contract_interactions-base_asset_id-{assetId}-contract_address-{contractAddress}-functions-read

Call a read function on a deployed contract

contract_interactions-base_asset_id-{assetId}-contract_address-{contractAddress}-functions-write

Call a write function on a deployed contract

contract_interactions-base_asset_id-{assetId}-contract_address-{contractAddress}-functions

Return deployed contract's ABI

staking-chains-{chainDescriptor}-chainInfo

staking-chains-{chainDescriptor}-{actionId}

staking-positions-summary-vaults

get Summary By Vault

staking-positions-summary

staking-positions-{id}

get Delegation By Id

staking-positions

get All Delegations

staking-providers-{providerId}-approveTermsOfService

approve Terms Of Service By Provider Id

staking-providers

Update admin quorum threshold

nfts-ownership-tokens-{id}-status

Update token ownership status

nfts-ownership-tokens-status

Update tokens ownership status

nfts-ownership-tokens-spam

Update tokens ownership spam property

nfts-ownership-tokens

Refresh vault account tokens List all owned tokens (paginated)

nfts-ownership-assets

List all distinct owned tokens (paginated)

nfts-ownership-collections

List owned collections (paginated)

nfts-tokens-{id}

Refresh token metadata List token data by ID

List tokens by IDs

connections-wc-{id}

Respond to a pending Web3 connection request.Remove an existing Web3 connection.

Create a new Web3 connection.

List all open Web3 connections.

screening-travel_rule-transaction-validate-full

Validate Full Travel Rule Transaction

screening-travel_rule-transaction-validate

Validate Travel Rule Transaction

screening-travel_rule-vasp-{did}

Get VASP details

screening-travel_rule-vasp-update

Add jsonDidKey to VASP details

screening-travel_rule-vasp

screening-travel_rule-post_screening_policy

Travel Rule - View Post-Screening Policy

screening-travel_rule-screening_policy

Travel Rule - View Screening Policy

screening-travel_rule-policy_configuration

Get Travel Rule Screening Policy Configuration Update Travel Rule Configuration

screening-aml-policy_configuration

Get AML Screening Policy Configuration Update AML Configuration

screening-aml-screening_policy

AML - View Screening Policy

screening-aml-post_screening_policy

AML - View Post-Screening Policy

screening-configurations

Tenant - Screening Configuration

tap-active_policy

Get the active policy and its validation

Get the active draft Update the draft with a new set of rules Send publish request for a certain draft id

Send publish request for a set of policy rules

smart-transfers-{ticketId}-expires-in

smart-transfers-{ticketId}-external-id

Add external ref. ID

smart-transfers-{ticketId}-submit

smart-transfers-{ticketId}-fulfill

Fund ticket manually

smart-transfers-{ticketId}-cancel

smart-transfers-{ticketId}-terms-{termId}-fund

Define funding source

smart-transfers-{ticketId}-terms-{termId}-manually-fund

Manually add term transaction

smart-transfers-{ticketId}-terms-{termId}

Search ticket by leg (term) ID Update ticket leg (term)Delete ticket leg (term)

smart-transfers-{ticketId}-terms

Create leg (term)

smart-transfers-{ticketId}

Search Tickets by ID

smart-transfers-settings-user-groups

Set user group Get user group

smart-transfers

Create Ticket Find Ticket

Return a list of jobs belonging to tenant

batch-{jobId}-pause

batch-{jobId}-continue

Continue a paused job

batch-{jobId}-cancel

Cancel a running job

batch-{jobId}-tasks

Return a list of tasks for given job

Get job details

cosigners-{cosignerId}-api_keys-{apiKeyId}

cosigners-{cosignerId}-api_keys

Get all API keys

cosigners-{cosignerId}

Get cosigner Rename cosigner

Get all cosigners

Home Fireblocks APIpayments-workflow_execution-{workflowExecutionId}

payments-workflow_execution-{workflowExecutionId}

Number of APIs: 1

Get workflow execution details GET {{baseUrl}}/payments/workflow_execution/:workflowExecutionId

Execute the payments workflow

Get workflow execution details