Generated SDK #5347 (major)

[sdk-generation-automation]

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:

1. List reports

Update ConnectedAccountErrorResponse required fields

Products: Connected Accounts (Beta)

Scope: API + SDKs

• What's new
  Changes required fields from errorMessage/errorCode to message/code while keeping legacy fields as optional.

• Impact
  Customers must update error handling to use the new message and code fields.

Affected endpoints:

1. Get allowlist for connected account
2. Get a single allowlist entry for a connected account
3. Rename Connected Account
4. Get connected accounts
5. Create a connected account

Relocate participantsIdentificationPolicy to endpoint level

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  Moves the participantsIdentificationPolicy property 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:

1. Get trading provider by ID
2. Get providers

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:

1. List reports

Update PayID schema field requirements

Products: External wallets

Scope: API + SDKs

• What's new
  Makes the bsb field required in PayID payment info and makes accountNumber optional in PayID address to align with current payment processing requirements.

• Impact
  Customers must now provide the bsb field when creating PayID whitelist addresses.

Affected endpoints:

1. Add an asset to an external wallet.

Rename verified field to leiData in Address Registry

Products: Compliance

Scope: API + SDKs

• What's new
  Renames the verified field to leiData in the Address Registry legal entity schema to better indicate LEI data availability.

• Impact
  Existing integrations must update from verified to leiData when parsing legal entity responses.

Affected endpoints:

1. Look up legal entity by blockchain address

Add vaultAccountId and userId to Earn action response

Products: Earn (Beta)

Scope: API + SDKs

• What's new
  Adds required vaultAccountId and userId fields 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:

1. Get a single earn lending action
2. List earn lending actions

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:

1. Get allowlist for connected account
2. Sync allowlist for connected account
3. 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 the PolicyMetadata schema from a flat object to a dictionary keyed by policy type, allowing metadata for multiple policies in a single response.

• Impact
  Existing integrations parsing PolicyMetadata must update to handle the new map structure instead of direct properties.

Affected endpoints:

1. Get the active draft by policy type
2. Update the draft with a new set of rules by policy types
3. Send publish request for a certain draft id
4. 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 the vout field to index across UTXO API schemas to align with listUnspent and legacy input selection naming conventions.

• Impact
  Beta customers using UTXO selection or identifier APIs must update requests to use index instead of vout.

Affected endpoints:

1. Create a new transaction
2. Estimate transaction fee
3. Add Collateral
4. Remove Collateral

Rename vout to index in UTXO schemas

Products: UTXO Management (Beta)

Scope: API + SDKs

• What's new
  Renames the vout field to index across UTXO API schemas to align with listUnspent and legacy input selection naming conventions.

• Impact
  Beta customers using UTXO selection or identifier APIs must update requests to use index instead of vout.

Affected endpoints:

1. Attach or detach labels to/from UTXOs

Align Exposure schema with vault allocation slice

Products: Earn (Beta)

Scope: API + SDKs

• What's new
  Renames the assetAddress field to address and adds decimals, assetId, and amountUsd fields to provide richer exposure data. Adds exposureType enum 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 use address instead of assetAddress.

Affected endpoints:

1. Get list of earn opportunities

Relocate participantsIdentificationPolicy to endpoint level

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  Moves the participantsIdentificationPolicy property 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:

1. Get trading provider by ID
2. Get providers

Remove Tags cancel approval request endpoint

Products: Tags

Scope: API + SDKs

• What's new
  Removes the endpoint to cancel an approval request for Tags, which was previously used to cancel pending approval requests by ID.

• Impact
  Customers can no longer cancel tag approval requests via API.

Affected endpoints:

1. Cancel an approval request by id

Added

Add connected account creation endpoint (beta)

Products: Connected Accounts (Beta)

Scope: API + SDKs

• What's new
  Adds a beta endpoint to create connected accounts with RSA-encrypted credentials for exchange integrations.

• Impact
  Customers can programmatically create connected accounts using encrypted credentials.

Affected endpoints:

1. Get connected accounts
2. Create a connected account

Add rewardsBreakdown to Solana staking positions

Products: Staking

Scope: API + SDKs

• What's new
  Adds a rewardsBreakdown object to Solana blockchain data containing issuance rewards, MEV rewards, and last sync timestamp.

• Impact
  Customers can now view detailed breakdowns of staking rewards for Solana positions.

Affected endpoints:

1. Get position details
2. List staking positions
3. List staking positions (Paginated)

Add async Reports API endpoints (beta)

Products: Reports (Beta)

Scope: API + SDKs

• What's new
  Adds beta endpoints to create and list asynchronous report jobs with pagination, filtering, and sorting capabilities.

• Impact
  Customers can generate and retrieve reports asynchronously through the API.

Affected endpoints:

1. Create a report
2. List reports
3. Get report status

Add account holder address fields to payment schemas

Products: External wallets

Scope: API + SDKs

• What's new
  Adds optional address fields (accountHolderCity, accountHolderCountry, accountHolderPostalCode) to CHAPS and SEPA payment info schemas for enhanced address collection.

• Impact
  Customers can now provide more detailed account holder address information when creating whitelist addresses.

Affected endpoints:

1. Add an asset to an external wallet.

Add delete legal entity endpoint

Products: Compliance

Scope: API + SDKs

• What's new
  Adds a delete endpoint for legal entities that revokes the registration by changing its status to REVOKED. Only Admin and Non-Signing Admin roles can use this endpoint.

• Impact
  Customers can now programmatically revoke legal entity registrations through the API.

Affected endpoints:

1. Get a legal entity
2. Update legal entity
3. Delete a legal entity

Add name field to bulk vault account job status

Products: Vaults

Scope: API + SDKs

• What's new
  Documents the vault account name field in the bulk vault account creation job status response, and fixes the status enum values to match actual API behavior.

• Impact
  Customers can now see the vault account name in bulk creation job status responses.

Affected endpoints:

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

Add accrued yield field to earn position

Products: Earn (Beta)

Scope: API + SDKs

• What's new
  Adds an optional yield field to the Position schema representing accrued yield in principal token units as a decimal string, currently populated for Morpho positions only.

• Impact
  Customers can now read accrued yield directly from position data for supported earn positions.

Affected endpoints:

1. Get list of earn positions

Add tags field to transaction responses

Products: Transactions

Scope: API + SDKs

• What's new
  Adds a tags array field to transaction source and destination responses, exposing policy engine-evaluated tags with up to 20 tags per transaction endpoint.

• Impact
  Customers can view tags assigned by the policy engine on transaction sources and destinations.

Affected endpoints:

1. Get a specific transaction by external transaction ID
2. Get a specific transaction by Fireblocks transaction ID
3. Get transaction history

Add metadata envelope to allowlist entry response

Products: Connected Accounts (Beta)

Scope: API + SDKs

• What's new
  The allowlist entry endpoint now returns a response envelope containing both the entry data and account-level allowlist sync metadata.

• Impact
  Customers receive additional sync metadata when retrieving individual allowlist entries.

Affected endpoints:

1. Get a single allowlist entry for a connected account

Add requiresReasonForPayment field to provider manifest

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  Adds a boolean field to the provider manifest indicating when reason for payment information is required for compliance and reporting purposes.

• Impact
  Customers can check the provider manifest to determine if reason for payment is required before creating orders.

Affected endpoints:

1. Get trading provider by ID
2. Get providers

Restructure PolicyMetadata as map keyed by policy type

Products: Policy Editor V2 (Beta)

Scope: API + SDKs

• What's new
  Restructures the PolicyMetadata schema from a flat object to a dictionary keyed by policy type, allowing metadata for multiple policies in a single response.

• Impact
  Existing integrations parsing PolicyMetadata must update to handle the new map structure instead of direct properties.

Affected endpoints:

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

Add API user pairing token endpoint

Products: Api User

Scope: API + SDKs

• What's new
  Adds an endpoint to issue device pairing tokens for API users in pending activation status, available only to Owner, Admin, and Non-Signing Admin roles.

• Impact
  Customers can programmatically generate device pairing tokens for API users awaiting device setup.

Affected endpoints:

1. Issue API user pairing token

Add Reports API endpoints (beta)

Products: Reports (Beta)

Scope: API + SDKs

• What's new
  Adds beta endpoints to create and list asynchronous report jobs. Reports can be filtered by status and type, with paginated responses.

• Impact
  Customers can generate and manage downloadable reports programmatically through the API.

Affected endpoints:

1. Create a report
2. List reports
3. Get report status

Changed

Add rewardsBreakdown to Solana staking positions

Products: Staking

Scope: API + SDKs

• What's new
  Adds a rewardsBreakdown object to Solana blockchain data containing issuance rewards, MEV rewards, and last sync timestamp.

• Impact
  Customers can now view detailed breakdowns of staking rewards for Solana positions.

Affected endpoints:

1. Get position details
2. List staking positions
3. List staking positions (Paginated)

Policy Editor V2 is now generally available

Products: Policy Editor V2

Scope: API + SDKs

• What's new
  Removes the beta designation from Policy Editor V2 endpoints, indicating the feature is now production-ready.

• Impact
  Customers can use Policy Editor V2 endpoints with confidence as a stable, production feature.

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

Update PayID schema field requirements

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  Makes the bsb field required in PayID payment info and makes accountNumber optional in PayID address to align with current payment processing requirements.

• Impact
  Customers now have more flexibility when providing PayID address information.

Affected endpoints:

1. Create an order
2. Get order details

Update SourceOfFunds schema description

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  Clarifies that source of funds information should be provided when the provider manifest indicates it is required, removing specific provider references.

• Impact
  Customers get clearer guidance on when to provide source of funds information.

Affected endpoints:

1. Create an order

---

[github-actions]

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