--- title: "Create Vault" method: POST path: "/api/v1/vaults" tags: ["Vaults"] --- # Create Vault `POST /api/v1/vaults` Create a new vault. ## Request body - union - CreateAptosVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'aptos', required — Aptos vault type. - CreateArchVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `type` 'arch', required — Arch vault type. - CreateBlackBoxVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'black_box', required — Black Box vault type. - `key_type` 'ecdsa_stark' | 'ecdsa_secp256k1' | 'eddsa_ed25519' | 'schnorr_secp256k1', required — The key type of the signing scheme used by the vault. Can be:
  • `ecdsa_stark`
  • `ecdsa_secp256k1`
  • `eddsa_ed25519`
  • `schnorr_secp256k1`
- CreateCantonVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'canton', required — Canton vault type. - CreateCosmosVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'cosmos', required — Cosmos vault type. - CreateEvmVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'evm', required — EVM vault type. - CreateSafeVaultRequest — Request to create a Safe vault via POST /api/v1/vaults. - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `type` 'safe', required — Safe vault type. - `address` string, required — The address of the Safe multisig wallet to import. - CreateSolanaVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'solana', required — Solana vault type. - CreateStacksVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `type` 'stacks', required — Stacks vault type. - CreateStarknetVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'starknet', required — Starknet vault type. - CreateStellarVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'stellar', required — Stellar vault type. - CreateSuiVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'sui', required — Sui vault type. - CreateTonVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'ton', required — TON vault type. - CreateTronVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `import_options` union — Import options: use for organizations with imported keys, to create a vault from an external public key and chain code. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - `type` 'tron', required — TRON vault type. - CreateUtxoVaultRequest - `name` string, required — The name of the vault. - `end_user_id` string, uuid — The end user id to create a vault for.This field is required for end-user vault creation, otherwise, it's optional. If not provided, the organization's default keyset will be used. - `vault_group_id` string, uuid — The group to add this vault to. If not provided, the vault will be created in the Default vault group. - `type` 'utxo', required — UTXO vault type. - `chain` 'bitcoin_mainnet' | 'bitcoin_testnet' | 'bitcoin_testnet_v4' | 'dogecoin_mainnet' | 'bitcoin_cash_mainnet' | 'pearl_testnet' | 'pearl_mainnet', required - `import_options` union — Import options: for organizations with imported keys for organizations with external signer keys. - ImportVaultDefaultOptions - `origin` 'imported_keys', required — Discriminator for imported-key vault creation. - `derivation_path` string — The BIP-32 derivation path of the vault. - `key_id` string, uuid, required — The ID of the imported key to use for the vault. - ExternalVaultImportOptions - `origin` 'external_signer', required — Discriminator for external signer vault creation. - `public_key_compressed` string, required — Base64-encoded compressed public key. - `chain_code` string — Base64-encoded 32-byte BIP32 chain code. - `import_vault` ImportVaultUtxoOptions - `default_address_derivation_path` string — The BIP-32 derivation path of the default address. - `default_address_name` string, required — The name of the default address. - `key_id` string, uuid, required — The ID of the imported key to use for the default address. ## Response `201` Successful Response - union - AptosVault — Represents an Aptos vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'aptos', required — Aptos vault type. - `address` string, required — The address of the vault on Aptos chain types. - ArchVault — Represents a Arch vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'arch', required — Arch vault type. - `arch_address` string, required — The address of the vault on Arch chain. - `arch_mainnet_deposit_address` UtxoAddressBalance, required - `address` UtxoAddress, required - `type` 'utxo', required - `address` string, required — The UTXO string address. - `address_type` 'legacy' | 'p2sh' | 'segwit' | 'taproot' | 'merkleroot', required - `chain` UtxoChain, required - `chain_type` 'utxo', required — The type of the chain. - `unique_id` 'bitcoin_mainnet' | 'bitcoin_testnet' | 'bitcoin_testnet_v4' | 'dogecoin_mainnet' | 'bitcoin_cash_mainnet' | 'pearl_testnet' | 'pearl_mainnet', required - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `arch_testnet_deposit_address` UtxoAddressBalance, required - `address` UtxoAddress, required - `type` 'utxo', required - `address` string, required — The UTXO string address. - `address_type` 'legacy' | 'p2sh' | 'segwit' | 'taproot' | 'merkleroot', required - `chain` UtxoChain, required - `chain_type` 'utxo', required — The type of the chain. - `unique_id` 'bitcoin_mainnet' | 'bitcoin_testnet' | 'bitcoin_testnet_v4' | 'dogecoin_mainnet' | 'bitcoin_cash_mainnet' | 'pearl_testnet' | 'pearl_mainnet', required - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `bitcoin_mainnet_address` UtxoAddressBalance, required - `address` UtxoAddress, required - `type` 'utxo', required - `address` string, required — The UTXO string address. - `address_type` 'legacy' | 'p2sh' | 'segwit' | 'taproot' | 'merkleroot', required - `chain` UtxoChain, required - `chain_type` 'utxo', required — The type of the chain. - `unique_id` 'bitcoin_mainnet' | 'bitcoin_testnet' | 'bitcoin_testnet_v4' | 'dogecoin_mainnet' | 'bitcoin_cash_mainnet' | 'pearl_testnet' | 'pearl_mainnet', required - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `bitcoin_testnet_address` UtxoAddressBalance, required - `address` UtxoAddress, required - `type` 'utxo', required - `address` string, required — The UTXO string address. - `address_type` 'legacy' | 'p2sh' | 'segwit' | 'taproot' | 'merkleroot', required - `chain` UtxoChain, required - `chain_type` 'utxo', required — The type of the chain. - `unique_id` 'bitcoin_mainnet' | 'bitcoin_testnet' | 'bitcoin_testnet_v4' | 'dogecoin_mainnet' | 'bitcoin_cash_mainnet' | 'pearl_testnet' | 'pearl_mainnet', required - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - BlackBoxVault — Represents a Black Box vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'black_box', required — Black Box vault type. - `details` union, required - EcdsaStarkBlackBoxVault - `type` 'ecdsa_stark', required — ECDSA over the Stark curve signing scheme. - `public_key` string — The stark public key, represented in hex format. - `stark_key` string, required — The stark public key, represented in hex format. - EcdsaSecp256k1BlackBoxVault - `type` 'ecdsa_secp256k1', required — ECDSA over the secp256k1 curve signing scheme. - EddsaED25519BlackBoxVault - `type` 'eddsa_ed25519', required — Ed25519 signing scheme. - SchnorrSecp256k1BlackBoxValue - `type` 'schnorr_secp256k1', required — Schnorr over the secp256k1 curve signing scheme. - CantonVault - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'canton', required — Canton vault type. - `address` string, required — The address of the vault on Canton chain types. - `chain_state_map` object, required — Map of Canton chain type to state data (registration and approval states). - CosmosVault — Represents a Cosmos vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'cosmos', required — Cosmos vault type. - `main_address` string, required — The address of the vault on Cosmos chains (hex representation without chain prefix). - `evm_address` string, required — The address of the vault on Cosmos chains that uses ethermint public key format, (hex representation without 0x). - `chains_addresses` CosmosBechAddressEnrichedChain[], required — List of addresses of the vault on each chain (bech32 format) with chain info. - `type` 'cosmos', required - `chain` 'cosmos_agoric-3' | 'cosmos_akashnet-2' | 'cosmos_archway-1' | 'cosmos_axelar-dojo-1' | 'cosmos_bbn-1' | 'cosmos_celestia' | 'cosmos_cosmoshub-4' | 'cosmos_dydx-mainnet-1' | 'cosmos_dydx-testnet-4' | 'cosmos_dymension_1100-1' | 'cosmos_injective-1' | 'cosmos_neutron-1' | 'cosmos_nillion-1' | 'cosmos_noble-1' | 'cosmos_osmosis-1' | 'cosmos_provider' | 'cosmos_ssc-1' | 'cosmos_pacific-1' | 'cosmos_stride-1' | 'cosmos_thorchain-1' | 'cosmos_mantra-1', required - `address` string, required — The address as bech32. - `hex_repr` string — The hex representation of the address. - `key_type` 'secp256k1' | 'ethsecp256k1' - `enriched_chain` EnrichedCosmosChain, required - `chain_type` 'cosmos', required — The type of the chain. - `unique_id` 'cosmos_agoric-3' | 'cosmos_akashnet-2' | 'cosmos_archway-1' | 'cosmos_axelar-dojo-1' | 'cosmos_bbn-1' | 'cosmos_celestia' | 'cosmos_cosmoshub-4' | 'cosmos_dydx-mainnet-1' | 'cosmos_dydx-testnet-4' | 'cosmos_dymension_1100-1' | 'cosmos_injective-1' | 'cosmos_neutron-1' | 'cosmos_nillion-1' | 'cosmos_noble-1' | 'cosmos_osmosis-1' | 'cosmos_provider' | 'cosmos_ssc-1' | 'cosmos_pacific-1' | 'cosmos_stride-1' | 'cosmos_thorchain-1' | 'cosmos_mantra-1', required - `name` string, required — The full blockchain name. - `native_currency_symbol` string, required — The native currency symbol. - `native_currency_name` string, required — The native currency name. - `blockchain_explorer` BlockchainExplorer — A blockchain explorer entry point. - `transaction_url` string, uri, required - `address_url` string, uri, required - `root_url` string, uri, required - `transaction_format_url` string, uri - `address_format_url` string, uri - `asset_format_url` string, uri - `logo_url` string, uri, required — The logo URL of the chain. - `is_testnet` boolean, required — Whether the chain is on a testnet. - `is_enabled` boolean, required — Whether the chain is enabled. - `base_denom` string, required — The base denom of the chain. - `bech32_prefix` 'agoric' | 'akash' | 'archway' | 'axelar' | 'bbn' | 'celestia' | 'cosmos' | 'dydx' | 'dym' | 'inj' | 'neutron' | 'nillion' | 'noble' | 'osmo' | 'saga' | 'sei' | 'stride' | 'thor' | 'mantra', required - EvmVault — Represents an EVM vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'evm', required — EVM vault type. - `address` string, required — The address of the vault on EVM chain types. - `smart_contract_states` object — A dictionary of chain IDs to smart contract states. - SolanaVault — Represents a Solana vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'solana', required — Solana vault type. - `address` string, required — The address of the vault in the Solana blockchain. - StacksVault — Represents a Stacks vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'stacks', required — Stacks vault type. - `address` string, required — The address of the vault on Stacks chain types. - StarknetVault — Represents a Starknet vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'starknet', required — Starknet vault type. - `address` string, required — The address of the vault on Starknet chain types. - `activation_state` 'inactive' | 'activating' | 'active', required - `activating_transaction_id` string, uuid — The transaction id of the activating transaction. - StellarVault - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - `fiat_currency` FiatCurrency, required - `currency_symbol` 'usd', required — FiatCurrencySymbol - `decimals` integer, required — The number of decimals in the fiat currency. - `balances` Balances, required — The cryptocurrency balances of the asset. - `total_mined` string, required — The value of all mined assets. - `total_pending_incoming` string, required — The value of all pending incoming assets. - `available_mined` string, required — The value of all available mined assets. Equals to total mined balance minus frozen mined. - `available_pending_incoming` string, required — The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming. - `frozen_mined` string, required — The value of all mined frozen assets. - `frozen_pending_incoming` string, required — The value of all pending incoming frozen assets. - `trustline_limit` string — The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines. - `is_auto_approved` boolean — (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval. - `balance` string - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `public_key_compressed` string, required — The public key of the vault in its compressed form:
  • For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf).
  • For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
- `derivation_info` VaultDerivationInfo, required - `derivation_path` string, required — The BIP 44 derivation path of the vault. - `master_public_key` MasterPublicKey, required - `id` string, uuid, required — The ID of the key. - `xpub` string, required — The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format - `key_holder` EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - `origin_type` 'native' | 'imported', required - `state` 'active' | 'archived', required - `type` 'stellar', required — Stellar vault type. - `address` string, required — The address of the vault on Stellar chain types. - SuiVault — Represents an SUI vault in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `metadata` object — Metadata in a form: . - `name` string, required — The name of the vault. - `created_by` union, required — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `vault_group` VaultGroupRef — Represents a reference to a vault group in the Fordefi platform - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `vault_groups` VaultGroupRef[], required — The vault groups this vault belongs to. - `id` string, uuid, required — The unique identifier of the vault group in the Fordefi platform. - `name` string, required — The name of the vault group. - `vaults_count` BoundCount, required — BoundCount represents a bound count of items. - `count` integer, required — The number of items in the bound count. - `has_more` boolean, required — Whether there are more items in the bound count. - `can_current_user_create_or_edit_vaults` boolean, required — Can the current user create or edit vaults in the group's based on the group permissions - `skip_indexing_reason` 'spam' - `is_external_signer` boolean — Whether the vault uses an externally imported key (external signer). - `native_assets` OwnedAsset[] — List of native asset information for requested chains. Chain info is in asset_identifier. - `priced_asset` PricedAsset, required - `type` 'asset_price', required - `asset_info` AssetInfo, required - `id` string, uuid, required — The asset ID. - `asset_identifier` union, required - AptosAssetIdentifier - … - ArchAssetIdentifier - … - CantonAssetIdentifier - … - CosmosAssetIdentifier - … - EvmAssetIdentifier - … - ExchangeAssetIdentifier - … - SolanaAssetIdentifier - … - StacksAssetIdentifier - … - StellarAssetIdentifier - … - StarknetAssetIdentifier - … - SuiAssetIdentifier - … - TonAssetIdentifier - … - TronAssetIdentifier - … - UtxoAssetIdentifier - … - `name` string, required — The name of the asset. - `symbol` string, required — The symbol (ticker) of the asset. - `decimals` integer, required - `verified` boolean, required — `True` if this asset is verified by Fordefi, `False` otherwise. - `metadata_uri` string — The URI of the asset metadata. - `is_spam` boolean, required — `True` if this asset is spam, `False` otherwise. - `logo_url` string, uri — The URL of the asset logo. - `explorer_url` string, uri — The URL of a blockchain explorer that provides real-time information about the asset. - `issuer_name` string — Best-effort display name of the issuer - `price` Price — Price represents a price in a given FiatCurrency. - `price` string, required — The price in the given fiat currency. - `price_float` string, required — The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token). - `is_negative` boolean — Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value. - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Bad Request - `401` — Unauthorized User - `403` — Forbidden User - `408` — Request Timeout - `409` — Already Exists - `422` — Validation Error - `429` — Rate Limit Exceeded - `500` — Unexpected Error --- [API](https://skmtc.net/fordefi/apis/fordefi-api.md) · [All operations](https://skmtc.net/fordefi/apis/fordefi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fordefi/fordefi-api/versions/8014fd69ea17/schema)