API Responses

HTTP Status Code

  • 200 - OK - Request processed as expected.
  • 400 - INVALID_REQUEST - Request is not well-formed, violates schema or incorrect fields.
  • 401 - NOT_AUTHORIZED - The API key doesn't match the signature or doesn't have permissions to perform the request.
  • 403 - FORBIDDEN - The API key's permissions doesn't match the needed permission to complete the request.
  • 404 - RESOURCE_NOT_FOUND - The requested resource doesn't exist.
  • 429 - RATE_LIMIT_REACHED - Too many requests. Blocked due to rate limiting.
  • 5XX - Something went wrong on Fireblocks' end

API Error Codes

The following table contains all the error codes relevant to API calls.
When performing calls to APIs, the best practice is to review this table for the relevant features that will run as part of your API.

Below, we've created an easy-to-understand separation of errors based on the HTTP code used as part of the response:

4xx related error codes

Error CodeHTTP Status CodeRelevant FeaturesIssue and Remediation
-2401AllMissing API Key in the JWT
Verify that you specify the API key
-3401AllThe entire JWT is missing
Uncommon - Potential code change, or bad parameters passed to Fireblocks SDK constructor
-4401AllWrong URL in the JWT
Uncommon - Potential code change to the Fireblocks SDK source code on your device
-6401AllWrong User in the JWT
The user that is being used as part of the request is incorrect, verify that the correct user is being used
1000400VaultGetVaultAccounts request has invalid values
Check that you pass a valid minAmountThreshold (if you pass it) and only one of namePrefix, nameSuffix if you pass it
1002400VaultCreate Vault Account failed
Verify that the values provided to the create vault account request are valid and conform to the types specified in the API Docs
1004404VaultVault account Id was not found
Verify that the vault account you're trying to query is valid and exists
1006404Asset, BalanceAsset doesn't exist
The asset requested for the given vault account does not exist, verify that the vault account contains the asset you're requested.
1008400Wallet, Asset (EOS Specific)EOS Wallet Creation failed
The eosAccountName parameter is invalid
1010400WalletRenaming a deposit address failed
You're trying to add an address to a blockchain which does not support more than 1 address (such as ETH)
1013400VaultVault account renaming failed
Verify that the parameters passed to the vault account renaming operation are valid
1015400WalletRename a deposit address failed
Verify that the parameters that were passed are valid and that the asset you're trying to rename exists
1016400WalletRename a deposit address failed
The rename operation failed due to a backend issue - open a ticket to support
1017400VaultHide vault account failed
The vault account you requested to hide does not exist, please verify you're using the correct vault account id
1019400VaultHide on a hidden vault account request
You're requesting to hide a vault account that is already hidden, please verify you're using the correct vault account id
1020400VaultUnhide vault account failed
The vault account you requested to unhide does not exist, please verify you're using the correct vault account id
1022400VaultUnhide on a visible vault account request
You're requesting to unhide a vault account that is not hidden, please verify you're using the correct vault account id
1023400, 404WalletGet legacy address failed
There is no legacy address used for this specific asset
1024400, 404WalletGet legacy address for an asset without one
The asset you're trying to get the legacy address for does not have one (for example ETH)
1025400Asset, Vault, WalletUsage of an unsupported asset
The asset you specified in your request is invalid, please check it against the supported asset list
1026400Asset, Vault, WalletCreation of a wallet that already exists
You've requested to create a wallet for an asset that already has a wallet in the vault account, please check you're using the correct asset and correct asset
1027400Asset, BalanceRequested max spendable amount for asset that doesn't support that request
You've requested to know the max spendable amount for an asset which does not support this request, verify you're using one of the assets according to the API docs
1028400Asset, BalanceMax Spendable Amount invalid value
The parameters you provided for the request are invalid, please verify you provided the correct type of values as well as a valid asset and vault account id
1031400Asset, BalanceGet balance by assets
The request to balance of assets in all vault accounts is invalid, only one of accountNamePrefix and accountNameSuffix can be provided
1032400, 404Asset, BalanceGet balances by assets or get balance for asset failed
The asset requested does not exist in the vault account
1034400WalletCreate testnet asset failed
You're requested to create a testnet asset on a workspace that is does not have testnet support
1035400AssetActivate wallet failed
The request to activate the wallet failed, please open a ticket to support
1037400VaultGet vault accounts endpoint is disabled
Workspaces created after May 2022 do not support the get vault accounts endpoint, use the paged request
1038400Wallet, AssetAdding a token without base asset
Before adding a token to the vault account, please create a base asset wallet
1039400Wallet, AssetInsufficient base asset for token wallet
Before creating a token asset, make sure you have sufficient base asset to cover token transactions
1040401VaultUnauthorized user to create vault account
The user that's trying to add a vault account does not have the proper permissions needed to create a vault account, make sure you use the correct user
1103400Exchange, FiatNo such exchange / fiat account id
The exchange or fiat account Id does not exist, make sure you're using the correct one
1105400ExchangeExchange account for asset by Id does not exist
The exchange account's asset does not exist for the specified exchange account id, make sure you're using the correct exchange account id and asset
1106400Exchange TransfersNo such exchange account id
The exchange account Id specified does not exist
1108408ExchangeExchange timeout when adding an account
We faced an internal timeout when trying to add the exchange account
1111400Exchange TransfersExchange convert failed
Failed to perform a convert operation, please check the message reply to understand the issue
1202400Internal WalletsCreate internal wallet failed
Internal wallet name must be specified, not empty and to not already exist in a different wallet
1204400Internal WalletsGet internal wallet by id failed
The internal wallet specified does not exist, make sure you're querying the correct internal wallet id
1206400Internal WalletsDelete internal wallet failed
Failed to delete the internal wallet, please make sure you've specified the correct internal wallet parameters
1208400Internal WalletsCreate an internal wallet failed
Failed to create an internal wallet, please verify you've provided the correct parameters for the creation as per the API docs
1209400Internal WalletsGetting the wallet's asset failed
The internal wallet based off the Id and asset specified does not exist, please make sure you're using the correct asset and wallet id
1212400Internal WalletsDeleting specific asset from wallet failed
Please verify that you specified the correct wallet id and asset id for deletion
1213400Internal WalletsCreate an unsupported asset address in a wallet
The asset you're trying to add to the wallet is not supported, verify the asset you're trying to use
1214400Internal WalletsCreate an asset from a different network in the wallet
The asset you're trying to add to the wallet is in a different network (mainnet or testnet) and your workspace does not support this network, please verify the network of the asset and your workspace correlate
1215400Internal WalletsAdd an asset in a wallet that already has it
You're trying to add an asset to the internal wallet but it already has this asset, please make sure you're adding a new asset and not one that already exists
1216400Internal WalletsAdd an asset with an invalid address to the wallet
You're trying to add an asset to the internal wallet, but the address does not match the asset's conventions, please check the address you're trying to add
1302400External WalletsCreate external wallet failed
External wallet name must be specified, not empty and to not already exist in a different wallet
1304400External WalletsGet external wallet by Id failed
The external wallet requested does not exist, please make sure you're using the correct wallet Id
1306400External WalletsDelete internal wallet failed
Failed to delete the external wallet, please make sure you've specified the correct internal wallet parameters
1308400External WalletsCreate an internal wallet failed
Failed to create an external wallet, please verify you've provided the correct parameters for the creation as per the API docs
1309400External WalletsGetting the wallet's asset failed
The external wallet based off the Id and asset specified does not exist, please make sure you're using the correct asset and wallet id
1312400External WalletsDeleting specific asset from wallet failed
Please verify that you specified the correct wallet id and asset id for deletion
1313400External WalletsCreate an unsupported asset address in a wallet
The asset you're trying to add to the wallet is not supported, verify the asset you're trying to use
1314400External WalletsCreate an asset from a different network in the wallet
The asset you're trying to add to the wallet is in a different network (mainnet or testnet) and your workspace does not support this network, please verify the network of the asset and your workspace correlate
1315400External WalletsAdd an asset in a wallet that already has it
You're trying to add an asset to the external wallet but it already has this asset, please make sure you're adding a new asset and not one that already exists
1316400External WalletsAdd an asset with an invalid address to the wallet
You're trying to add an asset to the external wallet, but the address does not match the asset's conventions, please check the address you're trying to add
1351400External WalletsCreate external wallet failed
External wallet name must be specified, not empty and to not already exist in a different wallet
1354400External WalletsGet external wallet by Id failed
The external wallet requested does not exist, please make sure you're using the correct wallet Id
1356400External WalletsDelete internal wallet failed
Failed to delete the external wallet, please make sure you've specified the correct internal wallet parameters
1358400External WalletsCreate an internal wallet failed
Failed to create an external wallet, please verify you've provided the correct parameters for the creation as per the API docs
1359400External WalletsGetting the wallet's asset failed
The external wallet based off the Id and asset specified does not exist, please make sure you're using the correct asset and wallet id
1362400External WalletsDeleting specific asset from wallet failed
Please verify that you specified the correct wallet id and asset id for deletion
1363400External WalletsCreate an unsupported asset address in a wallet
The asset you're trying to add to the wallet is not supported, verify the asset you're trying to use
1364400External WalletsCreate an asset from a different network in the wallet
The asset you're trying to add to the wallet is in a different network (mainnet or testnet) and your workspace does not support this network, please verify the network of the asset and your workspace correlate
1365400External WalletsAdd an asset in a wallet that already has it
You're trying to add an asset to the external wallet but it already has this asset, please make sure you're adding a new asset and not one that already exists
1366400External WalletsAdd an asset with an invalid address to the wallet
You're trying to add an asset to the external wallet, but the address does not match the asset's conventions, please check the address you're trying to add
1401400TransactionThe operation requested is not supported
The operation argument that you provided in the create transaction is not supported, please verify it's correct
1402400TransactionSource balance insufficient
Balance of the source account is not sufficient to cover the transaction
1403400TransactionDestination balance is insufficient
Some blockchains (such as NEAR) require a minimal amount of asset to be activated, you tried to pass less than the minimal amount, to a vault account which does not have such a wallet, thus the wallet can't be created
Please verify you're transferring a sufficient amount, or have the destination create a wallet and deposit a sufficient amount of base asset
1404400TransactionInvalid Peer type
When creating the transaction, verify the the type of the source and destination are valid and one of the defined enums in the API docs
1405404TransactionNo such transaction
The transaction Id you used to try and get the transaction object is invalid and was not found in the system, make sure you're using the correct transaction Id
1406400TransactionFailed to cancel transaction
Cancelling the transaction failed for some reason, please open a support ticket
1407400TransactionUser can't create a transaction
The user trying to create the transaction does not have sufficient permissions to do so, please verify the user's permission level and that you're using the correct user
1408400TransactionPaged get tried to change direction
When getting transactions in a paged fashion, you can only go in one direction (forward or backwards) and can't change direction mid execution.
Make sure you're only querying the information in one direction
1409400TransactionTransaction creation parameters are invalid
Here is a list of items to check:
1. The asset type is valid and is supported
2. You can only specify destination or destinations, not both
3. For OTA you must specify the address
4. Typed messages only supported BTC, LTC, DASH and ETH
5. AML Customer reference ID is can only use -_: and alpha-numeric
6. You can not have more than 650 destinations in the destinations parameters
1410400TransactionTransaction destination wallet does not exist
The destination is sending the transaction to an external/internal/contract wallet by an Id, but the Id specified does not exist, check the Id you're using is correct
1411400TransactionTransaction destination wallet asset does not exist
The destination is sending the transaction to an external/internal/contract wallet by an Id, but the asset used in the transaction does not exist, check that the asset has an address in the wallet Id
1412400TransactionTransaction destination wallet address is suspended
The destination is an external/internal/contract wallet which was not approved yet, approve it and the try again
1421400TransactionConfirmation number change failed
Changing the number of confirmations for the transaction failed, please verify that the transaction exists otherwise open a support ticket
1422400TransactionConfirmation number change failed
Changing the number of confirmations for the transaction by transaction hash failed, please make sure you're using the correct transaction hash, otherwise open a support ticket
1423400, 404TransactionGet transaction by transaction hash failed
Couldn't find a transaction with the specified transaction hash, please verify the transaction hash and try again
1424400Transaction, Network ConnectionDestination address invalid
Here is a list of parameters to check:
1. The address used is invalid for the asset you're using
2. The target (in case of a network transfer) does not contain a wallet for the specified asset
3. You're using the internal/external/contract wallet for a different workspace than the one you're performing the transaction on
4. You trying to send a transaction to a network connection which you do not have
5. You're using destinations one of the destinations is a network connections - this is not supported
1425400TransactionMissing a tag
You're trying to send a transaction to an address that requires a tag, please verify you're providing a tag
1426400TransactionUnfreeze failed
You tried to unfreeze a transaction, but it is not rejected nor failed by AML therefore it can't be unfrozen
1427400TransactionSource type of transaction is invalid
You tried to send a transaction with the source being invalid, verify that the source is one of: VAULT_ACCOUNT, EXCHANGE_ACCOUNT, GAS_STATION or FIAT_ACCOUNT
1428400TransactionDestination of transaction is invalid
The destination type of one of the destinations is not one of the defined enum in the API docs, verify that it is correct and try again
1429400Asset, TransactionValidate address failed
The asset you tried to use for the validate_address endpoint is not supported
1431400Asset, TransactionValidate address didn't find an address
The address provided to the validate_address endpoint is invalid.
1432400TransactionInvalid amount specified
The amount must be a number of a numeric string, verify it is so
1433400TransactionInvalid tag specified
The tag / memo specified does not comply with the rules of the blockchain, verify the tag / memo is valid
1434400TransactionFreeze failed
Freeze can only be done in confirming or completed state, the transaction you're trying to freeze is in neither of those states thus can't be frozen
1435400TransactionList unspent for unknown asset
You tried to get the unspent inputs (UTXO) for an asset that does not have such values or no UTXOs exist
1437400Exchange, TransactionUnsupported transfer
Direct transfers (Exchange to OTA) is not supported for Kraken exchange
1438400TransactionExternal Tx ID Duplicate
The externalTxId specified in the transaction was already used in the past, please use a different one
1439404TransactionNo such External Tx ID
The external Tx ID used does not exist, please verify the external Tx ID you're using
1440400TransactionDrop for unsupported blockchain
You're trying to run a drop transaction request for a blockchain that is not ETC or ETH
1441400TransactionReplace by fee too low
You're attempting to perform a RBF transaction but the gas price you specified is too low, please check it and submit a higher gas price
1443400TransactionToo late for RBF
You're trying to replace by fee, but the transaction was already mined
1445403TransactionUser can't freeze
The user that's trying to perform a freeze does not have the permissions to perform this, check the user's permissions and that you're using the correct user
1446403TransactionUser can't unfreeze
The user that's trying to perform a unfreeze does not have the permissions to perform this, check the user's permissions and that you're using the correct user
1448400TransactionFee payer is not allowed for asset
You're trying to define a fee payer for an asset which does not support it, please check whether the asset you're using allows for a fee payer configuration
1449400TransactionFee payer can't pay
The defined fee payer does not have a wallet with the base asset to pay the fee, verify that you specified the correct fee payer and check that it contains a base asset wallet with a sufficient amount to pay for the transaction
1450400TransactionTransactions are blocked for this blockchain
We have temporarily disabled transactions for the specified blockchain, check the status page for more details
1451400TransactionTransaction confirmations don't match Fireblocks restrictions
Fireblocks requires a specific number or a minimum number of confirmations for some blockchains. Manually setting confirmations for a transaction must meet these requirements. For more, see Deposit Control & Confirmation Policy.
1502400Asset, TransactionTrying to use a deprecated asset
The asset specified in the transaction is deprecated and can't be used, please check the asset and use a different one
1503400Asset, Balance, TransactionUnsupported asset
The asset specified is not supported, please check the asset you've specified
1601404Network ConnectionNetwork Connection Id does not exist
The network connection you're trying to query by id does not exist, please check the Id you're using
1603400Network ConnectionDelete Network Connection but id is not specified
The delete network connection request does not have a connectionId parameter specified, please make sure one is provided and is exists
1604400Network ConnectionCreate a network connection failed
The network connection creation failed, check the error message for more information and open a support ticket if insufficient
1605404Network ConnectionGet Network Connection for unknown id
The network connection Id provided could not be found, please verify you're using the correct id
1606404Network ConnectionDelete network connection for unknown id
The network connection Id provided could not be found, please verify you're using the correct id
1607400Network ConnectionSetting the routing policy for a network connection failed
Verify that you used the proper parameters for the call
1608404Network ConnectionSet routing policy for an unknown network connection id
The id you provided for the call was not found, verify you're using the correct id and it exists
1609400Network ConnectionValidating routing policy failed
The attempt to validate whether the network connection's routing will lead to a third party or not for a given asset failed, please verify you passed the correct parameters and open a support ticket if needed
1610404Network ConnectionValidating routing policy for an unknown network connection id
The id you provided for the call was not found, verify you're using the correct id and it exists
1706400FIAT AccountsFIAT Account id provided is unknown
The exchange account id you provided was not found, please verify you're using the correct account id
1708400FIAT AccountsFIAT Account id provided is unknown
The exchange account id you provided was not found, please verify you're using the correct account id
1901400Asset, TransactionEstimate fee for unknown asset
The asset you specified for the estimate fee call is unknown, please make sure you're using a supported and known asset
1902400Asset, TransactionEstimate fee for an invalid asset
The asset you specified does not support the estimate fee call, please make sure you're using a supported and allowed asset
1904400Asset, TransactionEstimate fee with invalid parameters
Make sure when calling estimate fee you do not have destination and destinations parameters both used, and that the source parameter is a vault account
1905400Asset, TransactionEstimate fee failed due to insufficient funds
The funds you have in the source vault are not sufficient, and thus the estimate fee call failed, make sure you have sufficient base asset in the source vault and try again
2002400Public KeyPublic key could not be found
Make sure that the information you provided to the public key query is valid and a wallet for this asset exists in the specified vault account
2101400Gas StationInvalid gas station parameters
When editing gas station configuration make sure you provide both gasCap and gasThreshold
2110400Gas StationInvalid asset for gas station
When editing gas station configuration, the asset you specified is not supported for this operation, make sure you're using a support and valid asset
2201400Balance, Private LedgerLock/Release allocation for unsupported asset
The asset you specified in the lock or release allocation call is not supported, make sure it is a valid and supported asset
2202400Balance, Private LedgerLock/Release Allocation for unknown account
The virtual account you specified does not exist, please make sure you're using a valid virtual account that exists
2204400Private Ledger, Off-ExchangeAllocation not allowed
The vault account you specified does not have off-exchange set-up, therefore locking allocation is not allowed, make sure you have off-exchange set and then try again
2205400Private Ledger, BalanceInsufficient amount for fee in allocation
The call you're trying to perform requires that a sufficient amount for the fee bank is also allocated, the allocation amount you've specified does not meet this demand, please increase the allocation amount
2501400WebhooksResend webhook for specific tx id failed
Make sure one of the parameters resendCreated and resendUpdated is marked as true and try again
2602404Off-ExchangeUnknown virtual account id
Virtual account id specified does not exist, make sure you're using a virtual account id that exists
2604404Off-ExchangeUnknown virtual account id
Virtual account id specified does not exist, make sure you're using a virtual account id that exists
2702403UsersInsufficient permissions for operation
The user that's trying to perform this call does not have sufficient permissions for it, make sure you're using the correct user and they have the proper permissions to view the user list
2814400Fee PayerFee Payer not configured
No fee payer was configured for this workspace, configure one and try again
2816400Fee PayerAsset wallet does not exist
You've attempted to set a fee payer by specifying a vault account and asset, however the specified asset does not have a wallet in the specified vault account, please create a wallet in the specified vault account and fund it then try again
2817400Fee PayerNon-base asset
You've specified a fee payer asset which is not the base asset, this is not allowed, please specify the base asset and try again
2818400Fee PayerUnsupported asset
You've tried to set a fee payer for an asset which is not supported, please verify you're using a supported asset and try again
2902403AuditsGetting audits is not allowed
The user trying to get the audits is not allowed to due so due to a permissions matter, make sure that the user has the proper permissions and that you're using the correct user
9001400WalletInvalid customer reference id
The customer reference id specified is invalid, make sure it only consists of \-\_:a-zA-Z0-9
9003400TransactionInvalid idempotency key length
The idempotency key must be no longer than 40 characters, please verify that if you've specified one, it has a proper length
9005400TransactionA transaction with the same idempotency key is in progress
Please wait until the previous transaction for this idempotency key is done before issuing a new one
9006400Network ConnectionMissing required parameter in request body
The request you've sent is missing the isDiscoverable parameter in the body, make sure it exists and is a boolean then try again
9007404Network ConnectionUnknown network id
The network id specified could not be found, please verify it exists and try again
9009400Network ConnectionParameters passed are invalid
The parameters passed to the set_routing_policy call are invalid, please make sure they are correct and conform to the API docs then try again
11001400AllThe specified vault account is invalid
Please make sure that the vault account you've specified is correct, valid and exists
12000400AllCloud provider issue
There is an issue with one of our cloud providers, please check the status page for more details

5XX related error codes

Error CodeRelevant FeaturesIssue and Remediation
1001VaultGet Vault accounts paged failed
1003VaultCreate vault account failed
1005VaultGet vault account failed
1007Asset, BalanceGet balance for vault account and asset failed
1009Wallet, AssetCreate wallet for asset failed
1011WalletAdding a new address failed
1012WalletGetting the addresses for the given asset failed
1014VaultRenaming a vault account failed
1018VaultHide vault account failed
1021VaultUnhide vault account failed
1029, 1030Asset, BalanceGet max spendable amount failed
1033AssetGet balance for assets or specific asset failed
1036AssetFetching max BIP44 index used failed
1101Exchange, FiatFailed to get exchange / fiat accounts
1102ExchangeFailed to get exchange account by Id
1104ExchangeFailed to get exchange account by Id and asset
1107Exchange TransfersFailed to perform an exchange account transfer (internal transfer)
1110Exchange TransfersConvert operation failed
1201Internal WalletsFailed to get internal wallets
1202Internal WalletsFailed to create an internal wallet
1203Internal WalletsFailed to get internal wallet by Id
1205Internal WalletsFailed to delete internal wallet
1207Internal WalletsFailed to create an internal wallet by asset
1210Internal WalletsFailed to get wallet by asset and wallet id
1211Internal WalletsFailed to delete specific asset from wallet
1301External WalletsFailed to get external wallets
1302External WalletsFailed to create an external wallet
1303External WalletsFailed to get external wallet by Id
1305External WalletsFailed to delete external wallet
1307External WalletsFailed to create an external wallet by asset
1310External WalletsFailed to get wallet by asset and wallet id
1311External WalletsFailed to delete specific asset from wallet
1350External WalletsFailed to get external wallets
1352External WalletsFailed to create an external wallet
1353External WalletsFailed to get external wallet by Id
1355External WalletsFailed to delete external wallet
1357External WalletsFailed to create an external wallet by asset
1360External WalletsFailed to get wallet by asset and wallet id
1361External WalletsFailed to delete specific asset from wallet
1404TransactionTransaction creation or get failed
1430Asset, TransactionValidate destination address endpoint failed
1436TransactionList unspent inputs (UTXO) failed
1444TransactionFailed to get the transactions list
1447TransactionFailed to get transaction by external Tx Id
1501AssetGet supported assets failed
1702FIAT AccountsGet FIAT account by id failed
1707FIAT AccountsRedeem funds to DDA failed
1709FIAT AccountsDeposit funds from DDA failed
1903Asset, TransactionEstimate fee calculation failed
2001Public KeyGetting public key information failed*
2102Gas StationSetting gas station information failed
2203Balance, Private LedgerLock allocation call failed
2501WebhookResend webhook failed
2601Off-ExchangeGet off-exchange failed
2603Off-ExchangeCouldn't settle off-exchange with provided virtual account id
2605Off-ExchangeFailed to get off-exchange with specified id
2701UsersFailed to get users for workspace
2813Fee PayerFailed to get fee payer
2815Fee PayerSetting the fee payer failed
2819Fee PayerDeleting fee payer configuration failed
2901AuditsFailed to get audits