Releases: fireblocks/fireblocks-cli
Release list
v10.0.0
Changelog
2026-09-08
Breaking Change
Fix validBefore/validAfter semantics in TRLink policy rules
Products: Transactions
Scope: API + SDKs
-
What's new
Corrects the documentation for validBefore and validAfter fields to accurately describe their behavior as relative durations (seconds since wait/screening step started) rather than absolute Unix timestamps. -
Impact
Customers should update their implementations to use relative durations in seconds instead of Unix timestamps for these fields.
Affected endpoints:
- Get a specific transaction by external transaction ID
- Get a specific transaction by Fireblocks transaction ID
- Get transaction history
Fix validBefore/validAfter semantics in TRLink policy rules
Products: TRLink
Scope: API + SDKs
-
What's new
Corrects the documentation for validBefore and validAfter fields to accurately describe their behavior as relative durations (seconds since wait/screening step started) rather than absolute Unix timestamps. -
Impact
Customers should update their implementations to use relative durations in seconds instead of Unix timestamps for these fields.
Affected endpoints:
Fix validBefore/validAfter semantics in TRLink policy rules
Products: Compliance
Scope: API + SDKs
-
What's new
Corrects the documentation for validBefore and validAfter fields to accurately describe their behavior as relative durations (seconds since wait/screening step started) rather than absolute Unix timestamps. -
Impact
Customers should update their implementations to use relative durations in seconds instead of Unix timestamps for these fields.
Affected endpoints:
Remove type field from security finding responses
Products: Security Posture Management
Scope: API + SDKs
-
What's new
Removes thetypefield from security finding schemas and updates example data to reflect a different finding scenario. -
Impact
Clients should no longer expect thetypefield in security finding responses and must update any code that depends on this field.
Affected endpoints:
Added
Add contacts list endpoint
Products: Contacts
Scope: API + SDKs
-
What's new
Adds a paginated endpoint to list workspace address book contacts with filtering by name, type, tags, access control, container, and archive status. -
Impact
Customers can programmatically retrieve and filter their address book contacts through the API.
Affected endpoints:
Add feeCurrency field for Tempo transactions (beta)
Products: Off exchanges, Transactions
Scope: API + SDKs
-
What's new
Adds an optionalfeeCurrencyfield to the transaction request schema, allowing users to specify which asset to use for paying network fees on Tempo-based transactions. -
Impact
Customers using Tempo can now control which asset pays transaction fees.
Affected endpoints:
Add AMOUNT_ABOVE_MAXIMUM failure reason
Products: Trading (Beta)
Scope: API + SDKs
-
What's new
Adds a new enum value to indicate when a trading operation fails because the requested amount exceeds the maximum allowed limit. -
Impact
Customers can now programmatically detect and handle amount-too-large errors in trading operations.
Affected endpoints:
v9.0.0
Changelog
2026-09-01
Breaking Change
Fix validBefore/validAfter semantics in TRLink policy rules
Products: Transactions
Scope: API + SDKs
-
What's new
Corrects the documentation for validBefore and validAfter fields to accurately describe their behavior as relative durations (seconds since wait/screening step started) rather than absolute Unix timestamps. -
Impact
Customers should update their implementations to use relative durations in seconds instead of Unix timestamps for these fields.
Affected endpoints:
- Get a specific transaction by external transaction ID
- Get a specific transaction by Fireblocks transaction ID
- Get transaction history
Fix validBefore/validAfter semantics in TRLink policy rules
Products: TRLink
Scope: API + SDKs
-
What's new
Corrects the documentation for validBefore and validAfter fields to accurately describe their behavior as relative durations (seconds since wait/screening step started) rather than absolute Unix timestamps. -
Impact
Customers should update their implementations to use relative durations in seconds instead of Unix timestamps for these fields.
Affected endpoints:
Fix validBefore/validAfter semantics in TRLink policy rules
Products: Compliance
Scope: API + SDKs
-
What's new
Corrects the documentation for validBefore and validAfter fields to accurately describe their behavior as relative durations (seconds since wait/screening step started) rather than absolute Unix timestamps. -
Impact
Customers should update their implementations to use relative durations in seconds instead of Unix timestamps for these fields.
Affected endpoints:
Remove type field from security finding responses
Products: Security Posture Management
Scope: API + SDKs
-
What's new
Removes thetypefield from security finding schemas and updates example data to reflect a different finding scenario. -
Impact
Clients should no longer expect thetypefield in security finding responses and must update any code that depends on this field.
Affected endpoints:
Added
Add contacts list endpoint
Products: Contacts
Scope: API + SDKs
-
What's new
Adds a paginated endpoint to list workspace address book contacts with filtering by name, type, tags, access control, container, and archive status. -
Impact
Customers can programmatically retrieve and filter their address book contacts through the API.
Affected endpoints:
Add feeCurrency field for Tempo transactions (beta)
Products: Off exchanges, Transactions
Scope: API + SDKs
-
What's new
Adds an optionalfeeCurrencyfield to the transaction request schema, allowing users to specify which asset to use for paying network fees on Tempo-based transactions. -
Impact
Customers using Tempo can now control which asset pays transaction fees.
Affected endpoints:
Add AMOUNT_ABOVE_MAXIMUM failure reason
Products: Trading (Beta)
Scope: API + SDKs
-
What's new
Adds a new enum value to indicate when a trading operation fails because the requested amount exceeds the maximum allowed limit. -
Impact
Customers can now programmatically detect and handle amount-too-large errors in trading operations.
Affected endpoints:
v8.0.0
Changelog
2026-08-26
Breaking Change
Remove deprecated FSPM category filter values
Products: Security Posture Management
Scope: API + SDKs
-
What's new
Removes ACCESS_CONTROL, ADMIN_MANAGEMENT, SECURITY, and CONFIGURATION values from the category filter parameter and updates the endpoint description text. -
Impact
API requests using the removed category filter values will receive validation errors.
Affected endpoints:
Added
Add FSPM security finding update endpoint
Products: Security Posture Management
Scope: API + SDKs
-
What's new
Adds an endpoint to accept or reopen FSPM security findings by setting the status to ACCEPTED or OPEN, with a required reason when accepting. -
Impact
Customers can programmatically manage FSPM finding statuses through the API.
Affected endpoints:
Add FSPM security finding details endpoint
Products: Security Posture Management
Scope: API + SDKs
-
What's new
Adds an endpoint to retrieve detailed information about a specific FSPM security finding by its ID, including compliance requirements, risk explanation, and mitigation guidance. -
Impact
Customers can now fetch complete details for individual security findings programmatically.
Affected endpoints:
v7.0.0
Changelog
2026-08-18
Breaking Change
Fix Travel Rule legalPerson name schema for IVMS101 compliance
Products: Off exchanges, Transactions, Travel Rule
Scope: API + SDKs
-
What's new
Fixes the Travel Rule legal person name schema to use the IVMS101-compliant array structure with proper name type codes (LEGL, SHRT, TRAD) instead of the incorrect flat object format. -
Impact
Customers must update Travel Rule integrations to use the new array-based name identifier structure.
Affected endpoints:
- Validate Full Travel Rule Transaction
- Create a new transaction
- Estimate transaction fee
- Add Collateral
- Remove Collateral
Fix Travel Rule legalPerson name schema for IVMS101 compliance
Products: Travel Rule
Scope: API + SDKs
-
What's new
Fixes the Travel Rule legal person name schema to use the IVMS101-compliant array structure with proper name type codes (LEGL, SHRT, TRAD) instead of the incorrect flat object format. -
Impact
Customers must update Travel Rule integrations to use the new array-based name identifier structure.
Affected endpoints:
Added
Add ETH staking consolidation and withdrawal ETA fields
Products: Staking
Scope: API + SDKs
-
What's new
Adds three new optional fields toEthereumBlockchainData:estimatedSourceExitTime,estimatedConsolidationTime, andestimatedWithdrawalTimeto surface timing estimates for in-flight ETH validator consolidations and withdrawals. -
Impact
Customers can now track estimated completion times for pending ETH staking consolidations and withdrawals via the API.
Affected endpoints:
Add gaslessInfo to transaction responses
Products: Transactions
Scope: API + SDKs
-
What's new
Adds a newgaslessInfoobject to transaction responses containing relay and meta-transaction details including tenant and vault account information. -
Impact
Customers can identify meta-transactions and see which relay tenant sponsored the gas fees.
Affected endpoints:
- Get a specific transaction by external transaction ID
- Get a specific transaction by Fireblocks transaction ID
- Get transaction history
Add new ReasonForPaymentEnum values
Products: Trading (Beta)
Scope: API + SDKs
-
What's new
Adds three new payment reason values:CORPORATE_INVESTMENT,INTER_COMPANY_TRANSFER, andOFFICE_OPERATING_EXPENSESto support additional corporate payment use cases. -
Impact
Customers can now specify additional payment reasons when creating trading orders.
Affected endpoints:
Add FSPM security findings endpoint
Products: Security Posture Management
Scope: API + SDKs
-
What's new
Adds an endpoint to retrieve paginated security posture findings for a workspace, with filtering by severity, category, and status. -
Impact
Customers with Security Admin or Security Auditor roles can programmatically retrieve security posture findings.
Affected endpoints:
Fixed
Document Owner and Viewer roles for staking endpoints
Products: Staking
Scope: API + SDKs
-
What's new
Adds missing Owner and Viewer roles to endpoint permission documentation for staking list endpoints. These roles were already permitted at runtime but not documented. -
Impact
Customers with Owner or Viewer roles now see accurate permission documentation for staking endpoints.
Affected endpoints:
v6.0.0
Changelog
2026-08-10
Breaking Change
Make ContractAttributes fields optional
Products: Contract Templates
Scope: API + SDKs
-
What's new
Removes the required constraint fromuseCases,standards, andauditorfields in theContractAttributesschema to match actual API behavior where these fields may be absent for non-EVM templates. -
Impact
SDK-generated types for these fields change from required/non-nullable to optional/nullable, requiring code updates where these fields are accessed.
Affected endpoints:
Changed
Expand TravelRuleVASP response schema documentation
Products: Travel Rule
Scope: API + SDKs
-
What's new
Documents additional fields returned by the Travel Rule VASP endpoints, including GLEIF registry data, compliance phases, and regulatory status. Also clarifiesfieldsparameter behavior and notes that unrecognized fields should be ignored. -
Impact
Customers can now use the full set of VASP fields returned by the API.
Affected endpoints:
v5.0.0
Changelog
2026-08-02
Breaking Change
Rename issuance field to inflation in staking rewards
Products: Staking
Scope: API + SDKs
-
What's new
Renames theissuancereward field toinflationin Solana staking rewards breakdown to better reflect the reward source. -
Impact
Customers using theissuancefield inSolanaRewardsBreakdownresponses must update their code to useinflationinstead.
Affected endpoints:
Make rewardsAmount nullable in staking schemas
Products: Staking
Scope: API + SDKs
-
What's new
TherewardsAmountfield can now be null for Cosmos-family chains where reward tracking is not supported, instead of returning a misleading zero value. -
Impact
SDK consumers using strict type checking may need to update their code to handle null values for this field.
Affected endpoints:
Remove deprecated estimatedAnnualReward from staking
Products: Staking
Scope: API + SDKs
-
What's new
Removes the deprecatedestimatedAnnualRewardfield from theAdditionalInfoschema, aligning the spec with actual staking service behavior. -
Impact
Clients should stop referencingestimatedAnnualRewardas it has not been populated since November 2025.
Affected endpoints:
Added
Add estimatedActivationTime to ETH staking positions
Products: Staking
Scope: API + SDKs
-
What's new
Adds optionalestimatedActivationTimefield toEthereumBlockchainDataschema, showing when pending ETH positions will activate. -
Impact
Customers can now see estimated activation times for pending or activating ETH staking positions.
Affected endpoints:
Add custom HTTP headers support for webhooks
Products: Webhooks V2
Scope: API + SDKs
-
What's new
Adds an optionalcustomHeadersfield to webhook configuration, allowing customers to attach up to 10 custom HTTP headers to webhook notifications. -
Impact
Customers can configure webhooks with custom headers for enhanced integration flexibility.
Affected endpoints:
Add new FailureReason enum values for CPN off-ramp orders
Products: Trading (Beta)
Scope: API + SDKs
-
What's new
AddsMISSING_DESTINATION_DETAILSandMISSING_WORKSPACE_DETAILSenum values to indicate when CPN off-ramp orders fail due to missing whitelisted destination or workspace institutional details. -
Impact
Customers can now identify specific reasons for CPN off-ramp order failures related to missing configuration details.
Affected endpoints:
Add OAuth 2.0 authentication support for webhooks
Products: Webhooks V2
Scope: API + SDKs
-
What's new
Adds optional OAuth 2.0 client credentials configuration to webhooks, enabling automatic bearer token authentication when delivering webhook events. -
Impact
Customers can now configure webhooks to authenticate with OAuth 2.0-protected endpoints.
Affected endpoints:
Add fiat off-ramp payment rails for six regions
Products: Trading (Beta)
Scope: API + SDKs
-
What's new
Adds OpenAPI schemas and destination types for CIPS (China), NEQUI (Colombia), FPS_UK (UK), FPS_HK (Hong Kong), InstaPay, and PesoNet (Philippines) payment rails. -
Impact
Customers can use these new payment rails for fiat off-ramp transfers to China, Colombia, UK, Hong Kong, and the Philippines.
Affected endpoints:
Changed
Add whitelisted address schemas for six CPN rails
Products: External wallets
Scope: API + SDKs
-
What's new
Adds payment info schemas for CIPS, NEQUI, FPS_UK, FPS_HK, INSTA_PAY, and PESONET rails to support external wallet whitelisting. -
Impact
Customers can now configure whitelisted addresses for these six payment rails.
Affected endpoints:
Add fiat off-ramp payment rails for six regions
Products: Trading (Beta)
Scope: API + SDKs
-
What's new
Adds OpenAPI schemas and destination types for CIPS (China), NEQUI (Colombia), FPS_UK (UK), FPS_HK (Hong Kong), InstaPay, and PesoNet (Philippines) payment rails. -
Impact
Customers can use these new payment rails for fiat off-ramp transfers to China, Colombia, UK, Hong Kong, and the Philippines.
Affected endpoints:
- Create an order
- Get order details
- Get all offers
- Create a quote
- Get rates
- Get trading provider by ID
- Get providers
v4.0.0
Changelog
2026-07-23
Breaking Change
Removed sort option from connected account allowlist
Products: Connected Accounts (Beta)
Scope: API + SDKs
- What's new
The sortBy option has been removed from the connected account allowlist endpoint. It previously accepted addedAt or lastSyncedAt.
- Impact
Customers passing sortBy to this endpoint will now receive an error and must remove the parameter.
Affected endpoints:
- Get allowlist for connected account
New Namespace: Blockchain Link (Beta)
Products: Blockchain Link (Beta)
Scope: API + SDKs
- What's new
Adds a full namespace for registering and managing tenant-owned blockchains, including activation and validation workflows, billing info, and the UI test wallet address.
Affected endpoints:
- Create a new blockchain
- Get a blockchain by ID
- Update a blockchain
- Delete a blockchain
- List blockchains with pagination and filtering
- Activate a blockchain
- Trigger validation workflow
- Get tenant billing info
- Get the test wallet address
Earn API graduated from Beta to General Availability
Products: Earn
Scope: API + SDKs
- What's new
The Earn endpoints are now generally available and no longer marked as beta.
Affected endpoints:
- Create and execute a lending action
- Get a single earn lending action
- List earn lending actions
- Get list of earn opportunities
- Get list of earn positions
- Get list of earn providers
- Approve earn provider terms of service
New: USDC Gateway deposit automation for vault accounts
Products: Vaults
Scope: API + SDKs
- What's new
Adds endpoints to configure scheduled, automatic deposits into the USDC Gateway wallet for a vault account.
Affected endpoints:
- Set up a USDC Gateway deposit automation
- Read the USDC Gateway deposit automations
- Change a USDC Gateway deposit automation
- Stop a USDC Gateway deposit automation's schedule
New: Get public key for connected account credential encryption
Products: Connected Accounts (Beta)
Scope: API + SDKs
- What's new
Adds an endpoint returning the RSA public key used to encrypt the creds field before calling the connected account creation endpoint. Also corrects the documented path for retrieving this key.
Affected endpoints:
- Get public key to encrypt connected account credentials
New: Rescreen a rejected transaction
Products: Compliance
Scope: API + SDKs
- What's new
Adds an endpoint to resubmit an incoming transaction that was rejected or failed AML screening back into pending screening.
Affected endpoints:
- Rescreen a rejected transaction
New: Policy rule quota calculation
Products: Policy Editor V2 (Beta)
Scope: API + SDKs
- What's new
Adds an endpoint to calculate the Amount-Over-Time (AOT) quota for a specific policy rule.
Affected endpoints:
- Calculate the AOT quota for a policy rule
Enhancements
Products: Tags, UTXO Management (Beta), Vaults
Scope: API + SDKs
-
What's new
Get tags: newallowedEntityTypefilter (vault_account,contact).Get UTXOs: newtxHashandtxIdfilters.Get max spendable amount: new UTXO Manager filters —includeAllLabels,includeAnyLabels,excludeAnyLabels,address,minAmount,maxAmount(Beta).
Affected endpoints:
- Get tags
- Get UTXOs
- Get max spendable amount
v3.0.0
Changelog
2026-07-01
Breaking Change
Connected account creation renamed to 'add'
Products: Connected Accounts (Beta)
Scope: API + SDKs
-
What's new
The endpoint for creating a connected account has been updated to use 'add' terminology, replacing the previous 'create' naming throughout. -
Impact
Existing integrations that call the connected account creation endpoint will need to be updated to use the new 'add' naming.
Affected endpoints:
v2.0.0
Changelog
2026-06-28
Breaking Change
Restructure Reports API response schemas (beta)
Products: Reports (Beta)
Scope: API + SDKs
-
What's new
Introduces a base report job schema and separates list responses from detail responses, removing short-lived download links from list items. -
Impact
Customers must call the individual report endpoint to obtain download URLs instead of getting them from list responses.
Affected endpoints:
Update ConnectedAccountErrorResponse required fields
Products: Connected Accounts (Beta)
Scope: API + SDKs
-
What's new
Changes required fields fromerrorMessage/errorCodetomessage/codewhile keeping legacy fields as optional. -
Impact
Customers must update error handling to use the newmessageandcodefields.
Affected endpoints:
- Get allowlist for connected account
- Get a single allowlist entry for a connected account
- Rename Connected Account
- Get connected accounts
- Create a connected account
Relocate participantsIdentificationPolicy to endpoint level
Products: Trading (Beta)
Scope: API + SDKs
-
What's new
Moves theparticipantsIdentificationPolicyproperty from the manifest root to individual endpoint configurations (order, quote, rate), enabling per-endpoint KYC/AML policy definitions. -
Impact
Customers must now read identification policies from endpoint-specific locations instead of the manifest root.
Affected endpoints:
Restructure Reports API response schemas (beta)
Products: Reports (Beta)
Scope: API + SDKs
-
What's new
Introduces a base report job schema and separates list responses from detail responses, removing short-lived download links from list items. -
Impact
Customers must call the individual report endpoint to obtain download URLs instead of getting them from list responses.
Affected endpoints:
Update PayID schema field requirements
Products: External wallets
Scope: API + SDKs
-
What's new
Makes thebsbfield required in PayID payment info and makesaccountNumberoptional in PayID address to align with current payment processing requirements. -
Impact
Customers must now provide thebsbfield when creating PayID whitelist addresses.
Affected endpoints:
Rename verified field to leiData in Address Registry
Products: Compliance
Scope: API + SDKs
-
What's new
Renames theverifiedfield toleiDatain the Address Registry legal entity schema to better indicate LEI data availability. -
Impact
Existing integrations must update fromverifiedtoleiDatawhen parsing legal entity responses.
Affected endpoints:
Add vaultAccountId and userId to Earn action response
Products: Earn (Beta)
Scope: API + SDKs
-
What's new
Adds requiredvaultAccountIdanduserIdfields to the Earn GetActionResponse schema, identifying which vault account and user executed each action. -
Impact
Customers can now see which vault account and user initiated each Earn action.
Affected endpoints:
Add Binance support to connected accounts allowlist | Add metadata envelope to allowlist entry response
Products: Connected Accounts (Beta)
Scope: API + SDKs
-
What's new
Connected accounts allowlist endpoints now support Binance accounts in addition to CoinbaseExchange. The allowlist entry endpoint now returns a response envelope containing both the entry data and account-level allowlist sync metadata. -
Impact
Customers can use allowlist endpoints with Binance connected accounts. Customers receive additional sync metadata when retrieving individual allowlist entries.
Affected endpoints:
- Get allowlist for connected account
- Sync allowlist for connected account
- Get a single allowlist entry for a connected account
Restructure PolicyMetadata as map keyed by policy type
Products: Policy Editor V2 (Beta)
Scope: API + SDKs
-
What's new
Restructures thePolicyMetadataschema from a flat object to a dictionary keyed by policy type, allowing metadata for multiple policies in a single response. -
Impact
Existing integrations parsingPolicyMetadatamust update to handle the new map structure instead of direct properties.
Affected endpoints:
- Get the active draft by policy type
- Update the draft with a new set of rules by policy types
- Send publish request for a certain draft id
- Get the active policy and its validation by policy type
Rename vout to index in UTXO schemas
Products: Off exchanges, Transactions
Scope: API + SDKs
-
What's new
Renames thevoutfield toindexacross UTXO API schemas to align withlistUnspentand legacy input selection naming conventions. -
Impact
Beta customers using UTXO selection or identifier APIs must update requests to useindexinstead ofvout.
Affected endpoints:
Rename vout to index in UTXO schemas
Products: UTXO Management (Beta)
Scope: API + SDKs
-
What's new
Renames thevoutfield toindexacross UTXO API schemas to align withlistUnspentand legacy input selection naming conventions. -
Impact
Beta customers using UTXO selection or identifier APIs must update requests to useindexinstead ofvout.
Affected endpoints:
Align Exposure schema with vault allocation slice
Products: Earn (Beta)
Scope: API + SDKs
-
What's new
Renames theassetAddressfield toaddressand addsdecimals,assetId, andamountUsdfields to provide richer exposure data. AddsexposureTypeenum to describe what exposure rows represent and increases the exposure array limit from 10 to 20 items. -
Impact
Customers reading exposure data must update to useaddressinstead ofassetAddress.
Affected endpoints:
...v1.0.10
dump new version 1.0.10