Generated SDK #9605 (major)

[sdk-generation-automation]

Changelog

2026-04-20

Breaking Change

Change otherNames items type in GleifData from string to object

Products: Compliance

Scope: API + SDKs

• What's new
  The otherNames array items in the GleifData schema have changed from plain strings to objects containing name and language fields (both required). This provides richer context for alternative legal entity names by including the associated language code.

• Impact
  Update client code that reads otherNames from GLEIF data — values are now objects {name: string, language: string} instead of plain strings.

Affected endpoints:

1. Register a new legal entity
2. List legal entities (Paginated)
3. Get a legal entity
4. Update legal entity

Trading API — PII identification policy + provider-by-ID alignment

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  Adds optional manifest.participantsIdentificationPolicy on Manifest (shared manifest model; list and detail use the same provider + manifest schemas when the backend includes the field), so providers can publish a default plus override PII rules with multi-dimensional matching (asset, rail, flowDirection). Each active rule is a JSON Schema (draft-07) string that validates participantsIdentification. GET /trading/providers/{providerId} is aligned with unified-order-api: the 200 body is TradingProvider (same polymorphic shape as the list), not a separate TradingProviderDetails / details-only tree. Dependencies: builds on / stays in sync with unified-order-api (same trading provider + manifest semantics). Reference: https://gitlab.com/fireblocks/shell/common/unified-order-api/-/merge_requests/67. Related groundwork: FA-5457 (manifest / providers), as applicable to this stack. Covered by tests / spec validation (e.g. yarn api-spec-lint); aligned with API standards; ready for production (with comms on breaking response shape). Closes FA-5823.

• Impact
  Consume manifest.participantsIdentificationPolicy from provider payloads when present; use supportedEndpoints and the resolved schema (defaultSchema or winning override schema) for participantsIdentification on in-scope flows. Regenerate or update SDKs so getTradingProviderById uses TradingProvider. Update clients that reference removed provider-details types or outdated TransferRail enum values.

Affected endpoints:

1. Get trading provider by ID

Replace 403 with 400 for Address Registry opt-in errors

Products: Compliance

Scope: API + SDKs

• What's new
  The 403 Forbidden response for workspace opt-in failures has been removed from the Address Registry endpoints, with the 400 Bad Request response updated to cover this case (error code 2140). This aligns the documented API contract with the actual server behavior on production environments.

• Impact
  Clients that currently handle 403 for the "workspace not opted in" scenario must update their error handling to expect 400 with error code 2140 instead.

Affected endpoints:

1. Look up legal entity by blockchain address
2. [Deprecated] Look up legal entity by address (query parameter)

Remove slip44 from TRLinkAssetFormat and rename amount schemas

Products: TRLink

Scope: API + SDKs

• What's new
  The slip44 value has been removed from the TRLinkAssetFormat enum, and the TRLinkAmountRange and TRLinkCurrency schemas have been renamed to ScreeningPolicyAmountRange and ScreeningPolicyCurrency. These changes affect Travel Rule Message creation, retrieval, and TRLink policy endpoints.

• Impact
  Update SDK code that references TRLinkAmountRange or TRLinkCurrency types to use ScreeningPolicyAmountRange and ScreeningPolicyCurrency, and remove any handling of the slip44 asset format value.

Affected endpoints:

1. Create Travel Rule Message
2. Get TRM by ID
3. Get TRLink policy

Remove sortBy, order, and prev from legal entity endpoints

Products: Compliance

Scope: API + SDKs

• What's new
  The sortBy and order query parameters have been removed from the List legal entities endpoint, and the prev pagination cursor field has been removed from ListLegalEntitiesResponse and ListVaultsForRegistrationResponse. Clients relying on these fields for sorting or backward pagination must update their integrations.

• Impact
  Remove any usage of the sortBy and order query parameters when calling the list legal entities endpoint, and stop reading the prev field from paginated responses for both legal entity and vault assignment listing.

Affected endpoints:

1. List legal entities (Paginated)
2. List vault accounts for a legal entity (Paginated)

Remove deprecated GET /v1/address_registry/legal_entity endpoint

Products: Compliance

Scope: API + SDKs

• What's new
  The deprecated GET /v1/address_registry/legal_entity endpoint and its associated AddressRegistryLegalEntityLegacy response schema have been removed from the OpenAPI specification. Clients should migrate to GET /v1/address_registry/legal_entities/{address}, which provides a richer response including verification status, LEI, Travel Rule providers, and contact email.

• Impact
  Clients relying on the removed endpoint will no longer find it in the spec; update integrations to use GET /v1/address_registry/legal_entities/{address} instead.

Affected endpoints:

1. [Deprecated] Look up legal entity by address (query parameter)

Added

Add approveTermsOfService endpoint for earn providers

Products: Earn (Beta)

Scope: API + SDKs

• What's new
  A new POST endpoint at /earn/providers/{providerId}/approve_terms_of_service enables workspaces to approve a lending provider's terms of service. This must be called once per workspace for each provider where isTermsApprovalRequired is true, before creating or executing any earn actions with that provider.

• Impact
  Integrate this endpoint into your earn onboarding flow — call it once per eligible provider before initiating earn actions; no changes are required for existing integrations.

Affected endpoints:

1. Approve earn provider terms of service

Add optional legalNameLanguage field to GleifData schema

Products: Compliance

Scope: API + SDKs

• What's new
  A new optional legalNameLanguage field has been added to the GleifData schema, representing the two-letter ISO 639-1 language code for the entity's legal name. This enriches GLEIF data returned across legal entity endpoints with language context for the official legal name.

• Impact
  No action required; client code will continue to work as-is and can optionally read the new legalNameLanguage field from GLEIF data responses.

Affected endpoints:

1. Register a new legal entity
2. List legal entities (Paginated)
3. Get a legal entity
4. Update legal entity

Add optional utxoSelectionParams to TransactionRequest

Products: Transactions

Scope: API + SDKs

• What's new
  A new optional utxoSelectionParams field has been added to the TransactionRequest schema, enabling fine-grained UTXO filtering and explicit input selection for UTXO-based blockchain transactions. This beta field supports label-based filters, amount ranges, address constraints, and force-inclusion or exclusion of specific UTXOs.

• Impact
  Pass utxoSelectionParams in create transaction and estimate fee requests to control which UTXOs are selected, improving coin control without breaking existing integrations.

Affected endpoints:

1. Create a new transaction
2. Estimate transaction fee

Add UTXO listing and label management endpoints (Beta)

Products: UTXO Management (Beta)

Scope: API + SDKs

• What's new
  New endpoints enable paginated listing of unspent transaction outputs (UTXOs) with rich filtering options by labels, statuses, and amounts, and allow attaching or detaching custom labels to/from UTXOs. These endpoints are part of the beta UTXO Management feature for UTXO-based blockchain assets.

• Impact
  Use the new GET unspent outputs endpoint to query and filter UTXOs, and the PATCH labels endpoint to organize UTXOs with custom labels for improved coin control workflows.

Affected endpoints:

1. List unspent outputs (UTXOs)
2. Attach or detach labels to/from UTXOs

Add VIRTUAL_ACCOUNT to TransferPeerPathSubType enum

Products: Transactions

Scope: API + SDKs

• What's new
  The VIRTUAL_ACCOUNT value has been added to the TransferPeerPathSubType enum used in transaction source and destination peer path subType fields. Clients can now specify VIRTUAL_ACCOUNT as a subType when creating transactions or estimating fees.

• Impact
  Use VIRTUAL_ACCOUNT as the subType on source or destination peer paths in transaction requests to target virtual accounts.

Affected endpoints:

1. Create a new transaction
2. Estimate transaction fee

Add resend webhook notifications by query endpoints

Products: Webhooks V2

Scope: API + SDKs

• What's new
  Two new endpoints allow resending webhook notifications using flexible query filters including statuses, event types, time range, and resource ID. The accompanying job status endpoint enables polling the progress of asynchronous resend operations.

• Impact
  Use the new resend-by-query endpoint to trigger targeted notification resends without knowing exact notification IDs, and poll job progress via the job status endpoint.

Affected endpoints:

1. Resend notifications by query
2. Get resend by query job status

Extend FailureReason enum with new trading failure codes

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  Eight new values have been added to the FailureReason enum: PROVIDER_INTERNAL_ERROR, UNSUPPORTED_BASE_ASSET, UNSUPPORTED_QUOTE_ASSET, AMOUNT_BELOW_MINIMUM, PII_MISSING, EXTERNAL_SOURCE_NOT_SUPPORTED, UNSUPPORTED_REGION, and DESTINATION_NOT_WHITELISTED. These codes allow order failure responses to convey more granular detail about why a trading order did not succeed.

• Impact
  Clients consuming the failure.reason field in order responses may now receive these new enum values and should update their handling logic to avoid unexpected behavior.

Affected endpoints:

1. Create an order
2. Get order details

Add Earn (Beta) endpoints for deposits, withdrawals, and positions

Products: Earn (Beta)

Scope: API + SDKs

• What's new
  Six new endpoints have been introduced under the Earn (Beta) category, covering deposit and withdrawal actions, plan previews, and paginated listing of opportunities, positions, and providers. These endpoints allow clients to programmatically interact with earn vaults and markets via the /earn/* paths.

• Impact
  Integrate the new Earn endpoints to deposit and withdraw assets, preview earn actions before execution, and query available opportunities, positions, and providers with cursor-based pagination.

Affected endpoints:

1. Deposit assets into an earn opportunity
2. Withdraw assets from an earn opportunity
3. Plan an earn action (deposit or withdraw)
4. Get list of earn opportunities
5. Get list of earn positions
6. Get list of earn providers

Add BYORK Light screening verdict and configuration endpoints

Products: Compliance

Scope: API + SDKs

• What's new
  New endpoints under /screening/byork enable programmatic management of BYORK Light screening verdicts and configuration settings. Compliance teams can now poll and submit ACCEPT/REJECT verdicts and control activation, deactivation, and timeout parameters via API.

• Impact
  Use the new /screening/byork/verdict endpoints to manage transaction screening decisions and the /screening/byork/config endpoints to activate, deactivate, and adjust BYORK Light settings.

Affected endpoints:

1. Get BYORK Light verdict
2. Set BYORK Light verdict
3. Get BYORK Light configuration
4. Activate BYORK Light
5. Deactivate BYORK Light
6. Set BYORK Light timeouts

Changed

Add CONNECTED_ACCOUNT to TransferPeerPathType enum

Products: Transactions

Scope: API + SDKs

• What's new
  The CONNECTED_ACCOUNT enum value has been added to the TransferPeerPathType schema, enabling connected accounts to be used as the source or destination type in transactions. This expands transaction routing to support connected account types alongside exchange accounts.

• Impact
  Clients can now specify CONNECTED_ACCOUNT as the type field when creating or estimating transactions; transaction list and detail responses may now return CONNECTED_ACCOUNT as a peer type value.

Affected endpoints:

1. Get transaction history
2. Create a new transaction
3. Get a specific transaction by Fireblocks transaction ID
4. Estimate transaction fee

---

[github-actions]

Your request has been noted. We'll get back to you soon. (Note that this SDK code is auto generated)