Jump to Content
Explore & Design
Develop & Integrate
API Reference
Try in Sandbox
Develop & Integrate
API Reference
Try in Sandbox
Explore & Design
Develop & Integrate
Transaction Screening Objects
All
Pages
Start typing to search…
JUMP TO
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
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 (TRSupport) Integration Guide
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
Set API Co-Signer Callback Handler
Authenticating the Callback Handler Request
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
Setup API Co-signer Callback Handler
Establishing Secure Communication Between the Co-signer and the Callback Handler
Callback Handler Response Object
Approve Transactions
Approve Configuration Changes
Basic Callback Handler Code Example
Use the Plugin Based Callback Handler
Validate ETH Raw Transactions
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
Create Payments
Execute Payouts
Create Payment Flows
Workflow Data Objects
Create Workflow Configuration
Create Workflow Execution
Launch Workflow Execution
Fireblocks API
Vaults
Get vault accounts
get
Create a new vault account
post
Get vault accounts (Paginated)
get
Get a vault account by ID
get
Rename a vault account
put
Get vault wallets (Paginated)
get
Hide a vault account in the console
post
Unhide a vault account in the console
post
Activate a wallet in a vault account
post
Set an AML/KYT ID for a vault account
post
Set auto fueling to on or off
post
Get the asset balance for a vault account
get
Create a new vault wallet
post
Refresh asset balance data
post
Get asset addresses
get
Create new asset deposit address
post
Get addresses (Paginated)
get
Get max spendable amount in a transaction
get
Update address description
put
Assign AML customer reference ID
post
Convert a segwit address to legacy format
post
Get UTXO unspent inputs information
get
Bulk creation of new vault accounts
post
Get job status of bulk creation of new vault accounts
get
Bulk creation of new deposit addresses
post
Attach or detach tags from vault accounts
post
Get the job status of the bulk deposit address creation
get
Get the public key for a derivation path
get
Get an asset's public key
get
Get asset balance for chosen assets
get
Get vault balance by an asset
get
Get maximum BIP44 index used
get
Connected Accounts (Beta)
Get connected accounts
get
Get connected account
get
Get balances for an account
get
Get exchange rates for an account
get
Get supported trading pairs for an account
get
Disconnect connected account
del
Rename Connected Account
post
Keys (Beta)
Get list of mpc keys
get
Get list of mpc keys by `userId`
get
Blockchains & Assets
List assets (Legacy)
get
List assets
get
Register an asset
post
Get an asset
get
Update the user’s metadata for an asset
patch
Set asset price
post
List blockchains
get
Get a Blockchain by ID
get
Transactions
Get transaction history
get
Create a new transaction
post
Estimate transaction fee
post
Get a specific transaction by Fireblocks transaction ID
get
Get a specific transaction by external transaction ID
get
Set confirmation threshold by Fireblocks Transaction ID
post
Drop ETH (EVM) transaction by ID
post
Cancel a transaction
post
Freeze a transaction
post
Unfreeze a transaction
post
Validate destination address
get
Set confirmation threshold by transaction hash
post
Estimate the required fee for an asset
get
Payments - Payout
Create a payout instruction set
post
Execute a payout instruction set
post
Get the status of a payout instruction set
get
Payments - Flows
Create payment flow configuration
post
Retrieve workflow configuration
get
Delete workflow configuration
del
Create workflow execution
post
Get workflow execution details
get
Execute the payments workflow
post
Webhooks
Resend failed webhooks
post
Resend webhooks for a transaction by ID
post
Webhooks V2
Create a new webhook
post
Get all webhooks
get
Get webhook by id
get
Update webhook
patch
Delete webhook
del
Get webhook metrics
get
Get all notifications by webhook id
get
Get notification by id
get
Get notification attempts
get
Resend notification by id
post
Resend notifications by resource Id
post
Resend failed notifications
post
Get resend job status
get
Contract Templates
List all contract templates
get
Upload contract template
post
Return contract template by id
get
Delete a contract template by id
del
Return contract template's constructor
get
Return contract template's function
get
Deploy contract
post
Get supported blockchains for the template
get
Deployed Contracts
List deployed contracts data
get
Return deployed contract data by id
get
Return deployed contract data
get
Fetch the contract ABI
post
Save contract ABI
post
Tags
Create a tag
post
Get list of tags
get
Get a tag
get
Update a tag
patch
Delete a tag
del
Get an approval request by id
get
Cancel an approval request by id
post
Contract Interactions
Return deployed contract's ABI
get
Call a read function on a deployed contract
post
Call a write function on a deployed contract
post
Get transaction receipt
get
Decode a function call data, error, or event log
post
Get contract address by transaction hash
get
Trading (Beta)
Get providers
get
Create a quote
post
Create an order
post
Get orders
get
Get order details
get
NFTs
Refresh vault account tokens
put
List all owned tokens (paginated)
get
List all distinct owned tokens (paginated)
get
List owned collections (paginated)
get
Refresh token metadata
put
List token data by ID
get
List tokens by IDs
get
Update token ownership status
put
Update tokens ownership status
put
Update tokens ownership spam property
put
Compliance
Travel Rule - View Post-Screening Policy
get
Travel Rule - View Screening Policy
get
Update Travel Rule Configuration
put
Update AML Configuration
put
AML - View Screening Policy
get
AML - View Post-Screening Policy
get
Tenant - Screening Configuration
put
Calling the "Bypass Screening Policy" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
post
Provides all the compliance details for the given screened transaction.
get
Set AML Verdict for Manual Screening Verdict.
post
Policy Editor V2
Get the active policy and its validation by policy type
get
Get the active draft by policy type
get
Update the draft with a new set of rules by policy types
put
Send publish request for a certain draft id
post
Policy Editor V1 - formerly TAP
Get the active policy and its validation
get
Get the active draft
get
Update the draft with a new set of rules
put
Send publish request for a certain draft id
post
Send publish request for a set of policy rules
post
Job Management
Return a list of jobs belonging to tenant
get
Get job details
get
Pause a job
post
Continue a paused job
post
Cancel a running job
post
Return a list of tasks for given job
get
Cosigners (Beta)
Get all cosigners
get
Add cosigner
post
Get cosigner
get
Rename cosigner
patch
Get all API keys
get
Get API key
get
Pair API key
put
Unpair API key
del
Update API key callback handler
patch
Get request status
get
Assets
Embedded Wallets
Retrieve supported assets
get
List wallets
get
Create a new wallet
post
Get a wallet
get
Retrieve asset
get
Add asset to account
post
Refresh asset balance
put
Retrieve asset balance
get
Retrieve asset addresses
get
Create a new account
post
Get a account
get
Get wallet Latest Backup details
get
Get Embedded Wallet Device
get
Get device key setup state
get
Get the public key for a derivation path
get
Get the public key of an asset
get
Get the public key of an asset
get
Tokenization
Issue a new token
post
List all linked tokens
get
Get the total count of linked tokens
get
Link a contract
post
Unlink a token
del
Return a linked token
get
Get deterministic address for contract deployment
post
Issue a token on one or more blockchains
post
Reissue a multichain token
post
Deploy LayerZero adapters
post
Remove LayerZero adapters
del
Set LayerZero peers
post
Remove LayerZero peers
del
Get LayerZero peers
get
Set LayerZero DVN configuration
post
Get LayerZero DVN configuration
get
Validate LayerZero channel configuration
get
Create a new collection
post
Get collections
get
Get a collection by id
get
Delete a collection link
del
Get collection token details
get
Mint tokens
post
Burn tokens
post
TRSupport
List available TRSupport partners
get
Create customer
post
Get all customers
get
Get customer by ID
get
Update customer
put
Delete customer
del
Get customer integrations
get
Get customer integration by ID
get
Create customer integration
post
Connect customer integration
put
Disconnect customer integration
del
Get public key for PII encryption
get
Test connection
post
List VASPs
get
Get VASP by ID
get
List supported assets
get
Get supported asset by ID
get
Assess Travel Rule requirement
post
Create Travel Rule Message
post
Get TRM by ID
get
Cancel Travel Rule Message
post
Redirect Travel Rule Message
post
Get TRLink policy
get
Set transaction travel rule message ID
post
Set destination travel rule message ID
post
Workspace
Freeze
post
Exchange accounts
List exchange accounts
get
Add an exchange account
post
List connected exchange accounts
get
Get a specific exchange account
get
Internal transfer for exchange accounts
post
Convert exchange account funds
post
Get an asset for an exchange account
get
Get public key to encrypt exchange credentials
get
Fiat accounts
List fiat accounts
get
Find a specific fiat account
get
Redeem funds to DDA
post
Deposit funds from DDA
post
Network connections
List network connections
get
Creates a new network connection
post
Update network connection routing policy.
patch
Retrieve third-party network routing validation
get
Get a network connection
get
Deletes a network connection by ID
del
Get all network IDs
get
Creates a new Network ID
post
Returns all enabled routing policy asset groups
get
Get both local IDs and discoverable remote IDs
get
Returns specific network ID.
get
Deletes specific network ID.
del
Update network id routing policy.
patch
Update network ID's discoverability.
patch
Update network ID's name.
patch
Internal wallets
List internal wallets
get
Create an internal wallet
post
Get assets for internal wallet
get
Delete an internal wallet
del
List assets in an internal wallet (Paginated)
get
Set an AML/KYT customer reference ID for internal wallet
post
Get an asset from an internal wallet
get
Add an asset to an internal wallet
post
Delete a whitelisted address
del
Key Link (Beta)
Add a new signing key
post
Get list of signing keys
get
Get a signing key by `keyId`
get
Modify the signing keyId
patch
Set agent user id
patch
Add a new validation key
post
Get list of registered validation keys
get
Get a validation key by `keyId`
get
Disables a validation key
patch
External wallets
List external wallets
get
Create an external wallet
post
Find an external wallet
get
Delete an external wallet
del
Set an AML customer reference ID for an external wallet
post
Get an asset from an external wallet
get
Add an asset to an external wallet.
post
Delete an asset from an external wallet
del
Contracts
List Whitelisted Contracts
get
Add a contract
post
Find a Specific Whitelisted Contract
get
Delete a contract
del
Find a whitelisted contract's asset
get
Add an asset to a whitelisted contract
post
Delete an asset from a whitelisted contract
del
Gas stations
Get gas station settings
get
Get gas station settings by asset
get
Edit gas station settings
put
Edit gas station settings for an asset
put
User groups (Beta)
List user groups
get
Create user group
post
Get user group
get
Update user group
put
Delete user group
del
Users
List users
get
Audit Logs
Get audit logs
get
Off exchanges
Add Collateral
post
Remove Collateral
post
Create Settlement for a Trader
post
Get Settlements Transactions
get
Find a specific collateral exchange account
get
Staking
List supported staking chains
get
Get chain-level staking parameters
get
Initiate or add to existing stake
post
Initiate unstake
post
Withdraw staked funds
post
Claim accrued rewards
post
Split a staking position
post
Merge staking positions
post
List staking positions
get
Get positions summary
get
Get positions summary by vault
get
Get position details
get
List staking providers
get
Approve provider terms of service
post
Admin Quorum
Update admin quorum threshold
put
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
Travel Rule
Validate Travel Rule Transaction
post
Validate Full Travel Rule Transaction
post
Get VASP details
get
Get All VASPs
get
Add jsonDidKey to VASP details
put
Get assigned VASP to vault
get
Assign VASP to vault
post
Compliance Screening Configuration
Get Travel Rule Screening Policy Configuration
get
Get AML Screening Policy Configuration
get
OTA (Beta)
Enable or disable transactions to OTA
put
Returns current OTA status
get
Workspace Status (Beta)
Returns current workspace status
get
Console User
Get console users
get
Create console user
post
Api User
Get API Keys
get
Create API Key
post
Reset device
Resets device
post
whitelist ip addresses
Get whitelisted ip addresses for an API Key
get
Smart Transfer
Create Ticket
post
Find Ticket
get
Search Ticket by ID
get
Set expiration
put
Add external ref. ID
put
Submit ticket
put
Fund ticket manually
put
Fund dvp ticket
put
Cancel Ticket
put
Create leg (term)
post
Get Smart Transfer ticket term
get
Update ticket leg (term)
put
Delete ticket leg (term)
del
Define funding source
put
Set funding source and approval
put
Manually add term transaction
put
Set user group
post
Get user group
get
Get smart transfers statistic
get
Onchain Data
List of active roles for a given contract address and base asset ID
get
Get the current state of addresses in an access registry
get
Summary of access registry state
get
Fetch onchain transactions for a contract
get
Get historical total supply data for a contract
get
Get historical balance data for a specific account in a contract
get
Get summary for the token contract
get
Get latest balances for all addresses holding tokens from a contract
get
Transaction Screening Objects
Ask AI
