For AI agents: the docs index is at https://fireblocks.readme.io/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Fireblocks Developer Portal
Explore & DesignDevelop & IntegrateChangelog
API ReferenceTry in SandboxFireblocks Developer Portal
Develop & Integrate
API ReferenceTry in Sandbox
Explore & DesignDevelop & IntegrateChangelog

Introduction

  • API Overview
  • REST API Guide
  • Authenticate
  • API Idempotency
  • Rate Limiting
  • Transaction Sources & Destinations

Errors & Data Objects

  • API responses and error codes
  • Transaction Statuses
    • Statuses
    • Sub-Statuses
  • Data Objects
    • Vault Objects
    • Exchange Account Objects
    • Fiat Account Objects
    • Network Connection Objects
    • Internal/External Wallet Objects
    • Contract Objects
    • Blockchain & Asset Objects
    • Transaction Objects
    • Transaction Authorization Objects
    • Fee Estimation Objects
    • Transaction Screening Objects
    • Raw Signing Objects
    • Payments Objects
    • Gas Station Objects
    • User Object
    • Webhook Object
    • NFT Objects
    • Web3 Connection Objects
    • General Objects
  • Handle API Errors
  • Audit Log Events
  • Embedded Wallet Errors
    • Common errors
    • EW API errors
    • Android SDK errors
    • iOS SDK errors
    • JavaScript SDK errors

SDKs & Dev Tools

  • SDK Migration Guide
  • Postman Guide
  • TypeScript SDK
  • Python SDK
  • Java SDK
  • JS SDK (Legacy)
  • Python SDK (Legacy)
  • EVM Web3 Provider
  • EVM Local JSON RPC
  • Fireblocks Hardhat Plugin
  • Solana Web3 Connection Adapter
  • Hedera Token Service SDK

Demo Apps

  • Retail Demo Application
    • Introduction
    • Structure
    • Setup

Webhooks

  • Overview
  • Getting started
    • Configuring webhooks
    • Protecting webhooks
      • IP Allowlisting
      • Validating webhooks
      • Balance validation
    • Responses & retries
  • Resending & troubleshooting webhook notifications
  • Webhook & notification structures
    • Webhook object structure
    • Webhook notification structure
    • Event types
      • Transaction events
      • Wallet events
      • Embedded Wallet events
      • CeFi events
      • Whitelist events
      • Tokenization events
      • Smart Transfer events
      • Network connection events
      • Off Exchange events
      • Order events
  • Best practices for webhooks
  • Webhooks v1
    • Migration Guide
    • Configure Webhook URLs
    • Validate Requests
    • Resend Webhook Notifications
    • Code Examples
    • Webhooks v1 Data Objects
      • Vault Webhooks
      • Exchange & Fiat Account Webhooks
      • Network Connection Webhooks
      • Smart Transfer Webhooks
      • Internal, External & Contract Wallet Webhooks
      • Transaction Webhooks
      • NFT Webhooks
      • Off Exchange Webhooks
      • Automation Webhooks

Manage Your Workspace

  • Create API keys
  • Configure Policies

Manage Wallets

  • Create Vault Accounts
  • Create Vault Wallets
  • Create Omnibus Structure

Manage Transactions

  • Create Transactions
  • Boost Transactions
  • Sweep to Omnibus
  • Select UTXOs
  • Consolidate UTXOs
  • Monitoring Transaction Statuses

Manage Transaction Fees

  • Configure Gas Station
    • Enable Auto Fueling
    • Set the Gas Station values
    • Fund the Gas Station
    • Monitor the Gas Station
  • Estimate Transaction Fee

Manage Treasury

  • Execute Smart Transfers
  • Stake Assets
    • Overview
    • Create a Staking Position
    • Unstake & Withdraw
  • Connect to Exchanges & Fiat Providers

Comply with regulation

  • Travel Rule with Notabene - Validate Travel Rule
  • How to Use Fireblocks TypeScript SDK with Travel Rule Messages
  • Travel Rule Support Integration Guide
  • Address Registry

Manage Smart Contracts

  • Upload Contract Template
  • Deploying and Interacting with Solana Tokens
  • Issue New ERC20F Tokens
  • Setting Up Roles in ERC20F Tokens
  • Operational Guide for ERC20F Token
  • Issue new ERC721F/ERC1155F Tokens
  • Interact with Solana Programs
  • SDK - Multichain Deployment
  • Bridging ERC20F Tokens with LayerZero Adapters

Manage Assets

  • List Supported Assets
  • Add Tokens
  • Manage NFTs
    • Deploy an NFT Collection
    • Mint an NFT
    • Retrieve NFTs
    • Transfer NFTs

Sign Offchain Messages

  • Typed Message Signing
    • Structure the API Call
    • Sign Typed Messages in Ethereum
    • Sign Typed Messages in Tron
    • Sign Typed Messages in Bitcoin
  • RAW Signing
    • Structure the API Call
    • Code Examples
  • Caching Signatures

Automate Flows

  • API Co-signer Management
    • API Co-signer Deployment Options and Installation Flow
      • Add a new Co-signer to the workspace
      • Install SGX Azure API Co-signer
      • Install SGX Azure Marketplace API Co-signer
      • Install SGX On-prem API Co-signer
      • Install SGX IBM Cloud API Co-signer
      • Install SGX Alibaba Cloud API Co-signer
      • Install AWS Nitro API Co-signer
      • Install Google Cloud Confidential Space API Co-signer
    • Using the Communal Test Co-signer
    • Operating the API Co-signer
    • API Co-signer Maintenance
      • SGX API Co-signer Maintenance
      • AWS Nitro API Co-signer Maintenance
      • GCP Confidential Space API Co-signer Maintenance
    • API Co-signers Versions
      • SGX API Co-signer Version History
      • AWS Nitro API Co-signer Version History
      • GCP Confidential Space API Co-signer Version History
    • API Co-signer Troubleshooting
  • API Co-signer Callback Handler
    • Securing communication
    • Callback Handler response object
    • Reference
      • Approve transactions
      • Approve configuration changes
    • Implementation guides
      • Basic Callback Handler example
      • Validate ETH raw transactions
      • Plugin-based Callback Handler

Create Payments

  • Execute Payouts
  • Create Payment Flows
    • Workflow Data Objects
    • Create Workflow Configuration
    • Create Workflow Execution
    • Launch Workflow Execution

Fireblocks API

  • Admin Quorum
    • Update admin quorum thresholdput
  • API User Keys
    • Get API Keysget
    • Create API Keypost
    • Issue API user pairing tokenpost
  • Audit Logs
    • Get audit logsget
  • Blockchains & Assets
    • List assetsget
    • Register an assetpost
    • Get an assetget
    • Update the user’s metadata for an assetpatch
    • Set asset pricepost
    • List blockchainsget
    • Get a Blockchain by IDget
    • List assets (Legacy)get
  • Compliance
    • Travel Rule - View Post-Screening Policyget
    • Travel Rule - View Screening Policyget
    • Update Travel Rule Configurationput
    • Update AML Configurationput
    • AML - View Screening Policyget
    • AML - View Post-Screening Policyget
    • Tenant - Screening Configurationput
    • Bypass Screening Policypost
    • Provides all the compliance details for the given screened transaction.get
    • Set AML Verdict (BYORK Super Light)post
    • Look up legal entity by blockchain addressget
    • Get address registry participation status for the authenticated workspaceget
    • Opt the workspace in to the address registrypost
    • Opt the workspace out of the address registrydel
    • List vault-level address registry opt-outs (paginated)get
    • Add vault accounts to the address registry opt-out listpost
    • Remove all vault-level address registry opt-outs for the workspacedel
    • Get whether a vault account is opted out of the address registryget
    • Remove a single vault account from the address registry opt-out listdel
    • Register a new legal entitypost
    • List legal entities (Paginated)get
    • Get a legal entityget
    • Update legal entityput
    • Assign vault accounts to a legal entitypost
    • List vault accounts for a legal entity (Paginated)get
    • Get BYORK Light verdictget
    • Set BYORK Light verdictpost
    • Get BYORK Light configurationget
    • Activate BYORK Lightpost
    • Deactivate BYORK Lightpost
    • Set BYORK Light timeoutsput
    • List counterparty groupsget
    • Create a counterparty grouppost
    • Get a counterparty groupget
    • Update a counterparty grouppatch
    • Delete a counterparty groupdel
    • Activate ARS (Address Registry Screening)post
    • Deactivate ARS (Address Registry Screening)post
    • Delete a legal entitydel
  • Compliance Screening Configuration
    • Get Travel Rule Screening Policy Configurationget
    • Get AML Screening Policy Configurationget
  • Connected Accounts (Beta)
    • Get connected accountsget
    • Get connected accountget
    • Get balances for an accountget
    • Get exchange rates for an accountget
    • Get supported trading pairs for an accountget
    • Disconnect connected accountdel
    • Rename Connected Accountpost
    • Get allowlist for connected accountget
    • Sync allowlist for connected accountpost
    • Get a single allowlist entry for a connected accountget
    • Add a connected accountpost
  • Console User
    • Get console usersget
    • Create console userpost
  • Contract Interactions
    • Return deployed contract's ABIget
    • Call a read function on a deployed contractpost
    • Call a write function on a deployed contractpost
    • Get transaction receiptget
    • Decode a function call data, error, or event logpost
    • Get contract address by transaction hashget
  • Contract Templates
    • List all contract templatesget
    • Upload contract templatepost
    • Return contract template by idget
    • Delete a contract template by iddel
    • Return contract template's constructorget
    • Return contract template's functionget
    • Deploy contractpost
    • Get supported blockchains for the templateget
  • Contracts
    • List Whitelisted Contractsget
    • Add a contractpost
    • Find a Specific Whitelisted Contractget
    • Delete a contractdel
    • Find a whitelisted contract's assetget
    • Add an asset to a whitelisted contractpost
    • Delete an asset from a whitelisted contractdel
  • Cosigners (Beta)
    • Get all cosignersget
    • Add cosignerpost
    • Get cosignerget
    • Rename cosignerpatch
    • Get all API keysget
    • Get API keyget
    • Pair API keyput
    • Unpair API keydel
    • Update API key callback handlerpatch
    • Get request statusget
  • Deployed Contracts
    • List deployed contracts dataget
    • Return deployed contract data by idget
    • Return deployed contract dataget
    • Fetch the contract ABIpost
    • Save contract ABIpost
  • Earn (Beta)
    • List earn lending actionsget
    • Create and execute a lending action (deposit or withdraw)post
    • Get a single earn lending actionget
    • Get list of earn opportunitiesget
    • Get list of earn positionsget
    • Get list of earn providersget
    • Approve earn provider terms of servicepost
  • Embedded Wallets
    • Retrieve supported assetsget
    • List walletsget
    • Create a new walletpost
    • Get a walletget
    • Retrieve assetget
    • Add asset to accountpost
    • Refresh asset balanceput
    • Retrieve asset balanceget
    • Retrieve asset addressesget
    • Create a new accountpost
    • Get a accountget
    • Get wallet Latest Backup detailsget
    • Get Embedded Wallet Deviceget
    • Get device key setup stateget
    • Get the public key for a derivation pathget
    • Get the public key of an assetget
    • Get the public key of an assetget
    • Update wallet statuspatch
    • Assign a walletpost
    • Retrieve assetsget
    • Update device statuspatch
    • Get registered devices - paginatedget
    • Get wallet key setup stateget
  • Exchange accounts
    • List exchange accountsget
    • Add an exchange accountpost
    • List connected exchange accountsget
    • Get a specific exchange accountget
    • Internal transfer for exchange accountspost
    • Convert exchange account fundspost
    • Get an asset for an exchange accountget
    • Get public key to encrypt exchange credentialsget
  • Job Management
  • External wallets
    • List external walletsget
    • Create an external walletpost
    • Find an external walletget
    • Delete an external walletdel
    • Set an AML customer reference ID for an external walletpost
    • Get an asset from an external walletget
    • Add an asset to an external wallet.post
    • Delete an asset from an external walletdel
  • Fiat accounts
    • List fiat accountsget
    • Find a specific fiat accountget
    • Redeem funds to DDApost
    • Deposit funds from DDApost
  • Gas stations
    • Get gas station settingsget
    • Get gas station settings by assetget
    • Edit gas station settingsput
    • Edit gas station settings for an assetput
  • Genie (Beta)
    • Create a Genie sessionpost
    • Send a message to a Genie sessionpost
  • Internal wallets
    • List internal walletsget
    • Create an internal walletpost
    • Get assets for internal walletget
    • Delete an internal walletdel
    • List assets in an internal wallet (Paginated)get
    • Set an AML/KYT customer reference ID for internal walletpost
    • Get an asset from an internal walletget
    • Add an asset to an internal walletpost
    • Delete a whitelisted addressdel
  • Key Link (Beta)
    • Add a new signing keypost
    • Get list of signing keysget
    • Get a signing key by `keyId`get
    • Modify the signing keyIdpatch
    • Set agent user idpatch
    • Add a new validation keypost
    • Get list of registered validation keysget
    • Get a validation key by `keyId`get
    • Disables a validation keypatch
  • Keys (Beta)
    • Get list of mpc keysget
    • Get list of mpc keys by `userId`get
  • Network connections
    • List network connectionsget
    • Create a new network connectionpost
    • Update network connection routing policy.patch
    • Retrieve third-party network routing validationget
    • Get a network connectionget
    • Delete a network connection by IDdel
    • Get all network IDsget
    • Creates a new Network IDpost
    • Return all enabled routing policy asset groupsget
    • Get both local IDs and discoverable remote IDsget
    • Return specific network ID.get
    • Delete specific network ID.del
    • Update network id routing policy.patch
    • Update network ID's discoverability.patch
    • Update network ID's name.patch
  • NFTs
    • Refresh vault account tokensput
    • List all owned tokens (paginated)get
    • List all distinct owned tokens (paginated)get
    • List owned collections (paginated)get
    • Refresh token metadataput
    • List token data by IDget
    • List tokens by IDsget
    • Update token ownership statusput
    • Update tokens ownership statusput
    • Update tokens ownership spam propertyput
  • Off exchanges
    • Add Collateralpost
    • Remove Collateralpost
    • Create Settlement for a Traderpost
    • Get Settlements Transactionsget
    • Find a specific collateral exchange accountget
  • Onchain Data
    • List of active roles for a given contract address and base asset IDget
    • Get the current state of addresses in an access registryget
    • Summary of access registry stateget
    • Fetch onchain transactions for a contractget
    • Get historical total supply data for a contractget
    • Get historical balance data for a specific account in a contractget
    • Get summary for the token contractget
    • Get latest balances for all addresses holding tokens from a contractget
  • OTA (Beta)
    • Enable or disable transactions to OTAput
    • Returns current OTA statusget
  • Payments - Flows
    • Create payment flow configurationpost
    • Retrieve workflow configurationget
    • Delete workflow configurationdel
    • Create workflow executionpost
    • Get workflow execution detailsget
    • Execute the payments workflowpost
  • Payments - Payout
    • Create a payout instruction setpost
    • Execute a payout instruction setpost
    • Get the status of a payout instruction setget
  • Policy Editor V1 - formerly TAP
    • Get the active policy and its validationget
    • Get the active draftget
    • Update the draft with a new set of rulesput
    • Send publish request for a certain draft idpost
    • Send publish request for a set of policy rulespost
  • Policy Editor V2
    • Get the active policy and its validation by policy typeget
    • Get the active draft by policy typeget
    • Update the draft with a new set of rules by policy typesput
    • Send publish request for a certain draft idpost
    • Calculate the AOT quota for a policy rulepost
  • Reports (Beta)
    • Create a reportpost
    • List reportsget
    • Get report statusget
  • Reset device
    • Resets devicepost
  • Smart Transfer
    • Create Ticketpost
    • Find Ticketget
    • Search Ticket by IDget
    • Set expirationput
    • Add external ref. IDput
    • Submit ticketput
    • Fund ticket manuallyput
    • Fund dvp ticketput
    • Cancel Ticketput
    • Create leg (term)post
    • Get Smart Transfer ticket termget
    • Update ticket leg (term)put
    • Delete ticket leg (term)del
    • Define funding sourceput
    • Set funding source and approvalput
    • Manually add term transactionput
    • Set user grouppost
    • Get user groupget
    • Get smart transfers statisticget
  • Staking
    • List supported staking chainsget
    • Get chain-level staking parametersget
    • Initiate or add to existing stakepost
    • Initiate unstakepost
    • Withdraw staked fundspost
    • Claim accrued rewardspost
    • Split a staking positionpost
    • Merge staking positionspost
    • List staking positionsget
    • Get positions summaryget
    • Get positions summary by vaultget
    • Get position detailsget
    • List staking providersget
    • Approve provider terms of servicepost
    • Consolidate staking positions (ETH validator consolidation)post
    • List staking positions (Paginated)get
    • List related transactions for a positionget
  • Tags
    • Create a new tagpost
    • Get list of tagsget
    • Get a tagget
    • Update a tagpatch
    • Delete a tagdel
    • Get an approval request by idget
  • Tokenization
    • Issue a new tokenpost
    • List all linked tokensget
    • Get the total count of linked tokensget
    • Link a contractpost
    • Unlink a tokendel
    • Return a linked tokenget
    • Get deterministic address for contract deploymentpost
    • Issue a token on one or more blockchainspost
    • Reissue a multichain tokenpost
    • Deploy LayerZero adapterspost
    • Remove LayerZero adaptersdel
    • Set LayerZero peerspost
    • Remove LayerZero peersdel
    • Get LayerZero peersget
    • Set LayerZero DVN configurationpost
    • Get LayerZero DVN configurationget
    • Validate LayerZero channel configurationget
    • Create a new collectionpost
    • Get collectionsget
    • Get a collection by idget
    • Delete a collection linkdel
    • Get collection token detailsget
    • Mint tokenspost
    • Burn tokenspost
    • Get current state of addresses in an access registryget
    • Get summary of an access registryget
    • Get onchain summary for a tokenget
    • Get historical total supply for a tokenget
    • Get latest balances for all holders of a tokenget
    • Get the latest balance for a specific accountget
    • Get balance history for a specific accountget
    • Get onchain transfers for a tokenget
    • Get onchain transactions for a tokenget
    • Get active RBAC roles for a tokenget
  • Trading (Beta)
    • Get providersget
    • Create a quotepost
    • Create an orderpost
    • Get ordersget
    • Get order detailsget
    • Get trading provider by IDget
    • Get ratespost
    • Get all offerspost
    • Get order requirement details for an orderget
    • Submit a response to an order requirementpost
    • Upload a file for an order requirementpost
  • Transactions
    • Get transaction historyget
    • Create a new transactionpost
    • Estimate transaction feepost
    • Get a specific transaction by Fireblocks transaction IDget
    • Get a specific transaction by external transaction IDget
    • Set confirmation threshold by Fireblocks Transaction IDpost
    • Drop ETH (EVM) transaction by IDpost
    • Cancel a transactionpost
    • Freeze a transactionpost
    • Unfreeze a transactionpost
    • Validate destination addressget
    • Set confirmation threshold by transaction hashpost
    • Estimate the required fee for an assetget
  • Travel Rule
    • Validate Travel Rule Transactionpost
    • Validate Full Travel Rule Transactionpost
    • Get VASP detailsget
    • Get All VASPsget
    • Add jsonDidKey to VASP detailsput
    • Get assigned VASP to vaultget
    • Assign VASP to vaultpost
    • Create Trust Network Proof of Addresspost
    • Retrieve Trust Network Proof of Address Signatureget
  • TRSupport
    • List available TRSupport partnersget
    • Create customerpost
    • Get all customersget
    • Get customer by IDget
    • Update customerput
    • Delete customerdel
    • Get customer integrationsget
    • Get customer integration by IDget
    • Create customer integrationpost
    • Connect customer integrationput
    • Disconnect customer integrationdel
    • Get public key for PII encryptionget
    • Test connectionpost
    • List VASPsget
    • Get VASP by IDget
    • List supported assetsget
    • Get supported asset by IDget
    • Assess Travel Rule requirementpost
    • Create Travel Rule Messagepost
    • Get TRM by IDget
    • Cancel Travel Rule Messagepost
    • Redirect Travel Rule Messagepost
    • Get TRLink policyget
    • Set transaction travel rule message IDpost
    • Set destination travel rule message IDpost
    • Manual decision for missing TRMpost
    • Get required actions for a TRMget
    • Resolve action for a TRMpost
  • User groups (Beta)
    • List user groupsget
    • Create user grouppost
    • Get user groupget
    • Update user groupput
    • Delete user groupdel
  • Users
    • List usersget
  • UTXO Management (Beta)
    • List unspent outputs (UTXOs)get
    • Attach or detach labels to/from UTXOspatch
  • Vaults
    • Get vault accountsget
    • Create a new vault accountpost
    • Get vault accounts (Paginated)get
    • Get a vault account by IDget
    • Rename a vault accountput
    • Get vault wallets (Paginated)get
    • Hide a vault account in the consolepost
    • Unhide a vault account in the consolepost
    • Activate a wallet in a vault accountpost
    • Set an AML/KYT ID for a vault accountpost
    • Set auto fueling to on or offpost
    • Get the asset balance for a vault accountget
    • Create a new vault walletpost
    • Refresh asset balance datapost
    • Get asset addressesget
    • Create new asset deposit addresspost
    • Get addresses (Paginated)get
    • Get max spendable amount in a transactionget
    • Update address descriptionput
    • Assign AML customer reference IDpost
    • Convert a segwit address to legacy formatpost
    • Get UTXO unspent inputs informationget
    • Bulk creation of new vault accountspost
    • Get job status of bulk creation of new vault accountsget
    • Bulk creation of new deposit addressespost
    • Attach or detach tags from vault accountspost
    • Get the job status of the bulk deposit address creationget
    • Get the public key for a derivation pathget
    • Get an asset's public keyget
    • Get asset balance for chosen assetsget
    • Get vault balance by an assetget
    • Get maximum BIP44 index usedget
    • Get USDC Gateway wallet infoget
    • Activate a USDC Gateway walletpost
    • Deactivate a USDC Gateway walletpost
    • Look up a vault account by blockchain addressget
  • Web3 connections
    • List all open Web3 connections.get
    • Create a new Web3 connection.post
    • Respond to a pending Web3 connection request.put
    • Remove an existing Web3 connection.del
  • Webhooks
    • Resend failed webhookspost
    • Resend webhooks for a transaction by IDpost
  • Webhooks V2
    • Create a new webhookpost
    • Get all webhooksget
    • Get webhook by idget
    • Update webhookpatch
    • Delete webhookdel
    • Get webhook metricsget
    • Get all notifications by webhook idget
    • Get notification by idget
    • Get notification attemptsget
    • Resend notification by idpost
    • Resend notifications by resource Idpost
    • Resend failed notificationspost
    • Get resend job statusget
    • Resend notifications by querypost
    • Get resend by query job statusget
    • Get mTLS CSRget
  • Whitelist API Key IP Addresses
    • Get whitelisted ip addresses for an API Keyget
  • Workspace
    • Freezepost
    • Get workspaceget
  • Workspace Status (Beta)
    • Returns current workspace statusget

API Co-signers Versions

Below are the version details for each of the Co-signer types:

  • SGX Co-signer version history
  • AWS Nitro Co-signer version history
  • Google Cloud Confidential Space Co-signer version history

Updated about 1 year ago


GCP Confidential Space API Co-signer Maintenance
SGX API Co-signer Version History
Did this page help you?

Updated about 1 year ago


GCP Confidential Space API Co-signer Maintenance
SGX API Co-signer Version History
Did this page help you?

Feedback Help Center Status Privacy policy Terms of use Fireblocks.com