Generated SDK #3222 (major)

[sdk-generation-automation]

Changelog

2026-05-05

Breaking Change

Change PolicyMetadata schema to a map keyed by policy type

Products: Policy Editor V2 (Beta)

Scope: API + SDKs

• What's new
  The PolicyMetadata schema has been restructured from a flat object with explicit properties to a dictionary where each key is a policy type identifier and each value conforms to the new PolicyMetadataEntry schema. This change accurately reflects how metadata is returned when multiple policy types are queried simultaneously.

• Impact
  Update client code to access metadata values using a policy type key (e.g., metadata["TRANSFER"].editedBy) instead of top-level properties; SDK-generated types will change and clients must regenerate and update their dependencies.

Affected endpoints:

1. Get the active policy and its validation by policy type
2. Get the active draft by policy type
3. Update the draft with a new set of rules by policy types
4. Send publish request for a certain draft id

Remove tagIds and approvalRequestId from bulk vault job status

Products: Vaults

Scope: API + SDKs

• What's new
  The tagIds and approvalRequestId fields have been removed from the CreateMultipleVaultAccountsJobStatus response schema returned by the bulk vault account creation job status endpoint. Clients that relied on these fields to retrieve tag attachment results or approval request IDs must update their code.

• Impact
  Remove any code that reads tagIds or approvalRequestId from the bulk vault account creation job status response, as these fields are no longer present.

Affected endpoints:

1. Get job status of bulk creation of new vault accounts

Remove email field and WAVE provider from MomoPaymentInfo schema

Products: External wallets

Scope: API + SDKs

• What's new
  The required email field and the WAVE enum value from the provider field have been removed from the MomoPaymentInfo schema used when adding assets to external wallets. Clients that previously included email in the request body or specified WAVE as the provider value must update their integration.

• Impact
  Remove email from any MomoPaymentInfo request payloads and update any code that passes WAVE as the provider to use a supported value (M_PESA, AIRTEL, MTN, or TIGO).

Affected endpoints:

1. Add an asset to an external wallet.

Remove WAIT enum value from TRLinkMissingTrmAction schema

Products: TRLink

Scope: API + SDKs

• What's new
  The WAIT enum value has been removed from the TRLinkMissingTrmAction schema, leaving ACCEPT and REJECT as the only valid values for missing TRM rule actions. This change affects the policy response which returns missing TRM rules containing an action field.

• Impact
  Update any client code that sends or expects the WAIT value in missing TRM rule actions; the only valid values are now ACCEPT and REJECT.

Affected endpoints:

1. Get TRLink policy

Add WAVE provider and required email to MomoPaymentInfo

Products: External wallets

Scope: API + SDKs

• What's new
  The MomoPaymentInfo schema now supports WAVE as an additional mobile money provider and introduces a new required email field for the account holder. These changes expand provider coverage for African mobile payment services while capturing email information for MOMO transactions.

• Impact
  Update all client integrations that submit MOMO payment information to include the required email field; existing provider values remain valid and WAVE may now also be used.

Affected endpoints:

1. Add an asset to an external wallet.

Remove approveTermsOfService endpoint from earn providers

Products: Earn (Beta)

Scope: API + SDKs

• What's new
  The POST /earn/providers/{providerId}/approve_terms_of_service endpoint has been removed from the API. This endpoint was previously used to approve a lending provider's terms of service before creating earn actions.

• Impact
  Remove any calls to this endpoint from your integration, as it is no longer available and will return an error if called.

Affected endpoints:

1. Approve earn provider terms of service

Added

Add orderCreationRequirements to QuotePropertiesDetails schema

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  A new optional orderCreationRequirements string field has been added to the QuotePropertiesDetails schema returned by the create quote endpoint. This field contains a JSON Schema Draft-7 document describing the fields required when creating an order for the given quote.

• Impact
  Clients can now inspect orderCreationRequirements in quote responses to pre-validate their order payload structure before submitting a create order request.

Affected endpoints:

1. Create a quote

Add tagIds and approvalRequestId to bulk vault job status

Products: Vaults

Scope: API + SDKs

• What's new
  Two new optional fields, tagIds and approvalRequestId, have been added to the CreateMultipleVaultAccountsJobStatus schema returned by the bulk vault account creation job status endpoint. These fields expose the list of tag IDs successfully attached to each created vault account and the approval request ID for jobs that involve protected tags.

• Impact
  Clients polling bulk vault account job status can now read tag attachment results and the associated approval request ID directly from the response without additional lookups.

Affected endpoints:

1. Get job status of bulk creation of new vault accounts

Add optional participantsIdentification to CreateQuote schema

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  The CreateQuote request schema now includes an optional participantsIdentification field for specifying KYC/AML originator and beneficiary details. This mirrors the existing field on CreateOrderRequest and enables participant identification at the quote stage.

• Impact
  Clients calling POST /trading/quotes may now include participantsIdentification to satisfy provider identification policies; existing requests without this field are unaffected.

Affected endpoints:

1. Create a quote

Add manual decision endpoint for TRLink NoTRM transactions

Products: TRLink

Scope: API + SDKs

• What's new
  A new POST endpoint allows compliance operators to manually accept or reject transaction destinations stuck in the NoTRM screening step without waiting for a TRP webhook or policy timeout. This gives operators direct control to unblock stalled TRLink screening flows on a per-transaction basis.

• Impact
  Use the new endpoint to programmatically unblock transactions by submitting an ACCEPT or REJECT action for destinations in NoTRM status; the response includes per-destination outcome details.

Affected endpoints:

1. Manual decision for missing TRM

Add TRLink required actions and manual decision endpoints

Products: TRLink

Scope: API + SDKs

• What's new
  Three new TRLink endpoints enable retrieving required actions for a Travel Rule Message, submitting data to resolve pending actions, and manually accepting or rejecting destinations stuck in NoTRM status. These additions give compliance teams full programmatic control over TRM action resolution and manual override workflows.

• Impact
  Use the new endpoints to manage TRM action resolution and submit manual decisions without waiting for TRM webhooks or policy timeouts.

Affected endpoints:

1. Manual decision for missing TRM
2. Get required actions for a TRM
3. Resolve action for a TRM

Add counterparty groups CRUD endpoints

Products: Counterparty Groups

Scope: API + SDKs

• What's new
  New endpoints under /counterparty_groups enable full lifecycle management of counterparty groups, including listing, creating, retrieving, updating, and deleting. This gives teams programmatic control over how counterparties are organized and classified for compliance and routing purposes.

• Impact
  Use the new counterparty group endpoints to create, retrieve, update, and delete counterparty groups via the API without any changes required to existing integrations.

Affected endpoints:

1. List counterparty groups
2. Create a counterparty group
3. Get a counterparty group
4. Update a counterparty group
5. Delete a counterparty group

Add Circle Gateway wallet management endpoints

Products: Vaults

Scope: API + SDKs

• What's new
  Three new beta endpoints have been added under /vault/accounts/{vaultAccountId}/circle_gateway to retrieve, activate, and deactivate Circle Gateway wallets linked to a vault account. This enables programmatic management of Circle Gateway wallets directly through the Fireblocks API.

• Impact
  Use the new endpoints to retrieve wallet info, activate a new or existing Circle Gateway wallet, or deactivate it for a given vault account.

Affected endpoints:

1. Get Circle Gateway wallet info
2. Activate a Circle Gateway wallet
3. Deactivate a Circle Gateway wallet

Add tagIds and approvalRequestId to bulk vault job status

Products: Vaults

Scope: API + SDKs

• What's new
  Two new optional fields, tagIds and approvalRequestId, have been added to the CreateMultipleVaultAccountsJobStatus schema returned by the bulk vault account creation job status endpoint. These fields expose the list of tag IDs successfully attached to each created vault account and the approval request ID for jobs that involve protected tags.

• Impact
  Clients polling bulk vault account job status can now read tag attachment results and the associated approval request ID directly from the response without additional lookups.

Affected endpoints:

1. Get job status of bulk creation of new vault accounts

Changed

Add Canton support to getMaxSpendableAmount

Products: Vaults

Scope: API + SDKs

• What's new
  The GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount endpoint now supports Canton assets. Canton uses a direct label-based query to determine the maximum spendable amount from active holdings, bypassing the BTC/ADA UTXO two-step flow.

• Impact
  Requests for Canton-based assets will now return maxSpendableAmount instead of a 400 Unsupported Asset error.

Affected endpoints:

1. Get max spendable amount in a transaction

---

[github-actions]

We've received your request. Thanks for your patience. (Note that this SDK code is auto generated)