JUMP TOIntroductionAPI OverviewREST API GuideAuthenticateAPI IdempotencyRate LimitingTransaction Sources & DestinationsErrors & Data ObjectsAPI Responses and Error CodesTransaction StatusesStatusesSub-StatusesData ObjectsVault ObjectsExchange Account ObjectsFiat Account ObjectsNetwork Connection ObjectsInternal/External Wallet ObjectsContract ObjectsBlockchain & Asset ObjectsTransaction ObjectsTransaction Authorization ObjectsFee Estimation ObjectsTransaction Screening ObjectsRaw Signing ObjectsPayments ObjectsGas Station ObjectsUser ObjectWebhook ObjectNFT ObjectsWeb3 Connection ObjectsGeneral ObjectsHandle API ErrorsSDKs & Dev ToolsQuickstartPostman GuideTypeScript SDKPython SDKJava SDKJS SDK (Legacy)Python SDK (Legacy)EVM Web3 ProviderEVM Local JSON RPCHardhat PluginSolana Web3 AdapterHedera Token Service SDKDemo AppsRetail Demo ApplicationWebhooks & NotificationsWebhooks v1Configure Webhook URLsValidate RequestsResend Webhook NotificationsCode ExamplesWebhooks v1 Data ObjectsVault WebhooksExchange & Fiat Account WebhooksNetwork Connection WebhooksSmart Transfer WebhooksInternal, External & Contract Wallet WebhooksTransaction WebhooksNFT WebhooksOff Exchange WebhooksManage Your WorkspaceCreate API KeysConfigure Transaction Authorization PolicyManage WalletsCreate Vault AccountsCreate Vault WalletsCreate Omnibus StructureManage TransactionsCreate TransactionsBoost TransactionsSweep to OmnibusSelect UTXOsConsolidate UTXOsMonitoring Transaction StatusesManage Transaction FeesConfigure Gas StationEnable Auto FuelingSet the Gas Station valuesFund the Gas StationMonitor the Gas StationEstimate Transaction FeeManage TreasuryExecute Smart TransfersStake AssetsOverviewCreate a Staking PositionUnstake & WithdrawConnect to Exchanges & FIAT ProvidersComply with regulationValidate Travel RuleManage Smart ContractsUpload Contract TemplateIssue New ERC20F TokensSetting Up Roles in ERC20F TokensOperational Guide for ERC20F TokenIssue new ERC721F/ERC1155F TokensManage AssetsGet Supported AssetsAdd TokensManage NFTsDeploy an NFT CollectionMint an NFTRetrieve NFTsTransfer NFTsSIGN OFFChain MESSAGESTyped Message SigningStructure the API CallSign Typed Messages in EthereumSign Typed Messages in TronSign Typed Messages in BitcoinRAW SigningStructure the API CallCode ExamplesCaching SignaturesAutomate FlowsSet API Co-Signer Callback HandlerAuthenticating the Callback Handler RequestAPI Co-signer ManagementAPI Co-signer Deployment Options and Installation FlowAdd a New Co-signer to the WorkspaceInstall SGX Azure API Co-signerInstall SGX Azure Marketplace API Co-signerInstall SGX On-prem API Co-signerInstall SGX IBM Cloud API Co-signerInstall SGX Alibaba Cloud API Co-signerInstall AWS Nitro API Co-signerInstall Google Cloud Confidential Space API Co-signerUsing the Communal Test Co-signerSetup API Co-signer Callback HandlerEstablishing Secure Communication Between the Co-signer and the Callback HandlerCallback Handler Response ObjectApprove TransactionsApprove Configuration ChangesBasic Callback Handler Code ExampleUse the Plugin Based Callback HandlerValidate ETH Raw TransactionsOperating the API Co-signerAPI Co-signer MaintenanceSGX API Co-signer MaintenanceAWS Nitro API Co-signer MaintenanceGCP Confidential Space API Co-signer MaintenanceAPI Co-signers VersionsSGX API Co-signer Version HistoryAWS Nitro API Co-signer Version HistoryGCP Confidential Space API Co-signer Version HistoryAPI Co-signer TroubleshootingCreate PaymentsExecute PayoutsCreate Payment FlowsWorkflow Data ObjectsCreate Workflow ConfigurationCreate Workflow ExecutionLaunch Workflow ExecutionFireblocks APIWorkspace ManagementFreezepostList user groupsgetCreate user grouppostGet user groupgetUpdate user groupputDelete user groupdeleteList usersgetGet audit logsgetGet audit logsgetUpdate admin quorum thresholdputEnable or disable transactions to OTAputReturns current OTA statusgetReturns current workspace statusgetGet console usersgetCreate console userpostGet API KeysgetCreate API KeypostResets devicepostGet whitelisted ip addresses for an API KeygetPolicy Editor (Beta)Get the active policy and its validationgetGet the active draftgetUpdate the draft with a new set of rulesputSend publish request for a certain draft idpostSend publish request for a set of policy rulespostComplianceValidate Travel Rule TransactionpostValidate Full Travel Rule TransactionpostGet VASP detailsgetGet All VASPsgetAdd jsonDidKey to VASP detailsputTravel Rule - View Post-Screening PolicygetTravel Rule - View Screening PolicygetGet assigned VASP to vaultgetAssign VASP to vaultpostGet Travel Rule Screening Policy ConfigurationgetUpdate Travel Rule ConfigurationputGet AML Screening Policy ConfigurationgetUpdate AML ConfigurationputAML - View Screening PolicygetAML - View Post-Screening PolicygetScreening Configuration UpdateputBypass Screening PolicypostBlockchains & AssetsList all asset types supported by FireblocksgetRegister an assetpostSet asset pricepostValidate destination addressgetEstimate the required fee for an assetgetBlockchains & Assets (Beta)List assetsgetGet an asset by IDgetList blockchainsgetGet a Blockchain by IDgetVaultsGet vault accountsgetCreate a new vault accountpostGet vault accounts (Paginated)getGet a vault account by IDgetRename a vault accountputGet vault wallets (Paginated)getHide a vault account in the consolepostUnhide a vault account in the consolepostActivate a wallet in a vault accountpostSet an AML/KYT ID for a vault accountpostSet auto fueling to on or offpostGet the asset balance for a vault accountgetCreate a new vault walletpostRefresh asset balance datapostGet asset addressesgetCreate new asset deposit addresspostGet addresses (Paginated)getGet the max spendable amount in a transaction.getUpdate address descriptionputAssign AML customer reference IDpostConvert a segwit address to legacy formatpostGet UTXO unspent inputs informationgetGet the public key for a derivation pathgetGet an asset's public keygetGet asset balance for chosen assetsgetBulk creation of walletspostGet vault balance by an assetgetTransactionsGet transaction historygetCreate a new transactionpostEstimate transaction feepostGet a specific transaction by Fireblocks transaction IDgetGet a specific transaction by external transaction IDgetSet confirmation threshold by Fireblocks Transaction IDpostDrop ETH (EVM) transaction by IDpostCancel a transactionpostFreeze a transactionpostUnfreeze a transactionpostRescan an array of transactionspostSet confirmation threshold by transaction hashpostGas StationGet gas station settingsgetGet gas station settings by assetgetEdit gas station settingsputEdit gas station settings for an assetputWhitelisted Internal WalletsList internal walletsgetCreate an internal walletpostGet assets for internal walletgetDelete an internal walletdeleteSet an AML/KYT customer reference ID for internal walletpostGet an asset from an internal walletgetAdd an asset to an internal walletpostDelete a whitelisted addressdeleteWhitelisted External WalletsList external walletsgetCreate an external walletpostFind an external walletgetDelete an external walletdeleteSet an AML customer reference ID for an external walletpostGet an asset from an external walletgetAdd an asset to an external wallet.postDelete an asset from an external walletdeleteWhitelisted ContractsList Whitelisted ContractsgetCreate a Whitelisted ContractpostFind a Specific Whitelisted ContractgetDelete a Whitelisted ContractdeleteFind a whitelisted contract's assetgetAdd an Asset to a Whitelisted ContractpostDelete a Whitelisted Contract's AssetdeleteFireblocks NetworkList network connectionsgetCreates a new network connectionpostUpdate network connection routing policy.patchRetrieve third-party network routing validationgetGet a network connectiongetDeletes a network connection by IDdeleteGet all network IDsgetCreates a new Network IDpostReturns all enabled routing policy asset groupsgetGet both local IDs and discoverable remote IDsgetReturns specific network ID.getDeletes specific network ID.deleteUpdate network id routing policy.patchUpdate network ID's discoverability.patchUpdate network ID's name.patchSmart TransfersCreate TicketpostFind TicketgetSearch Ticket by IDgetSet expirationputAdd external ref. IDputSubmit ticketputFund ticket manuallyputFund dvp ticketputCancel TicketputCreate leg (term)postGet Smart Transfer ticket termgetUpdate ticket leg (term)putDelete ticket leg (term)deleteDefine funding sourceputSet funding source and approvalputManually add term transactionputSet user grouppostGet user groupgetGet smart transfers statisticgetExchange AccountsList exchange accountsgetList connected exchange accountsgetGet a specific exchange accountgetInternal transfer for exchange accountspostConvert exchange account fundspostGet an asset for an exchange accountgetGet public key to encrypt exchange credentialsgetFiat AccountsList fiat accountsgetFind a specific fiat accountgetRedeem funds to DDApostDeposit funds from DDApostTokenizationIssue a new tokenpostList all linked tokensgetLink a contractpostCreate a new collectionpostGet collectionsgetGet a collection by idgetDelete a collection linkdeleteGet collection token detailsgetMint tokenspostBurn tokenspostUnlink a tokendeleteReturn a linked tokengetContract TemplatesList all contract templatesgetUpload contract templatepostReturn contract template by idgetDelete a contract template by iddeleteReturn contract template's constructorgetReturn contract template's functiongetDeploy contractpostDeployed ContractsList deployed contracts datagetReturn deployed contract data by idgetReturn deployed contract datagetFetch the contract ABIpostSave contract ABIpostContract InteractionsReturn deployed contract's ABIgetCall a read functionpostCall a write functionpostGet transaction receiptgetStakingList supported chains for Fireblocks StakinggetGet chain-specific staking summarygetInitiate Stake OperationpostExecute an Unstake operationpostExecute a Withdraw operationpostExecute a Claim Rewards operationpostExecute a Split operationpostList staking positions detailsgetGet staking summary detailsgetGet staking summary details by vaultgetGet staking position detailsgetList staking providers detailsgetApprove staking terms of servicepostNFTsRefresh vault account tokensputList all owned tokens (paginated)getList all distinct owned tokens (paginated)getList owned collections (paginated)getRefresh token metadataputList token data by IDgetList tokens by IDsgetUpdate token ownership statusputUpdate tokens ownership statusputUpdate tokens ownership spam propertyputdApp ConnectionsList all open Web3 connectionsgetCreate a new Web3 connection.postRespond to a pending connectionputRemove an existing Web3 connectiondeleteJob ManagementReturn a list of jobs belonging to tenantgetGet job detailsgetPause a jobpostContinue a paused jobpostCancel a running jobpostReturn a list of tasks for given jobgetCosigners (Beta)Get all cosignersgetAdd cosignerpostGet cosignergetRename cosignerpatchGet all API keysgetGet API keygetPair API keyputUnpair API keydeleteUpdate API key callback handlerpatchGet request statusgetWebhooksResend failed webhookspostResend webhooks for a transaction by IDpostWebhooks V2 (Beta)Create new webhookpostUpdate webhookpatchDelete webhookdeleteOff ExchangeAdd CollateralpostRemove CollateralpostCreate Settlement for a TraderpostGet Settlements TransactionsgetFind a specific collateral exchange accountgetPayments - PayoutCreate a payout instruction setpostExecute a payout instruction setpostGet the status of a payout instruction setgetPayments - FlowsCreate payment flow configurationpostRetrieve workflow configurationgetDelete workflow configurationdeleteCreate workflow executionpostGet workflow execution detailsgetExecute the payments workflowpostKey Link (Beta)Add a new signing keypostGet list of signing keysgetGet a signing key by `keyId`getModify the signing keyIdpatchSet agent user idpatchAdd a new validation keypostGet list of registered validation keysgetGet a validation key by `keyId`getDisables a validation keypatchKeys (Beta)Get list of mpc keysgetGet list of mpc keys by `userId`getFireblocks NCWNon Custodial WalletsCreate a new walletpostList walletsgetGet a walletgetGet wallet Latest Backup detailsgetGet wallet key setup stategetEnable or disable a walletputGet the public key of an assetgetGet the public key for a derivation pathgetNon Custodial Wallet AccountsCreate a new accountpostGet accountsgetGet an accountgetNon Custodial Wallet AssetsRetrieve assetsgetRetrieve assetgetAdd asset to accountpostRefresh asset balanceputRetrieve asset balancegetRetrieve asset addressesgetRetrieve supported assetsgetNon Custodial Wallet DevicesGet registered devicesgetEnable or Disable deviceputGet device key setup stategetNon Custodial Wallets RPCInvoke RPCpostReturn a list of tasks for given jobget https://api.fireblocks.io/v1/batch/{jobId}/tasksReturn a list of tasks for given job
