Vault Objects

VaultAccountsPagedResponse

ParameterTypeDescription
accountsArray of VaultAccountList of vault account objects
pagingobjectContains two fields: before (string) and after (string)
previousUrlstringURL string of the request for the previous page
nextUrlstringURL string of the request for the next page

CreateVaultAssetResponse

ParameterTypeDescription
idstringThe ID of the vault account
addressstringAddress of the asset in a vault account; for BTC and LTC, the address is in Segwit (Bech32) format, and the cash address format for BCH
legacyAddressstringLegacy address format for BTC, LTC, and BCH
tagstringUsed as destination tag for XRP; memo for ATOM, EOS, HBAR, LUNA, LUNC, XDB, XEM; memo_text for XLM; notes for ALGO.
eosAccountNamestringReturned for EOS; the account name

VaultAsset

ParameterTypeDescription
idstringThe ID of the asset
totalstringTotal wallet balance
balancestringDeprecated - replaced by "total"
availablestringFunds that are available for transfer, equal to the blockchain balance minus any locked amount
pendingstringThe cumulative balance of all pending transactions to be cleared
stakedstringStaked funds; returned only for DOT
frozenstringFrozen by your workspace's AML policies
lockedAmountstringFunds in outgoing transactions not yet published to the network
totalStakedCPUstring[optional] Deprecated
totalStakedNetworkstring[optional] Deprecated
selfStakedCPUstring[optional] Deprecated
selfStakedNetworkstring[optional] Deprecated
pendingRefundCPUstring[optional] Deprecated
pendingRefundNetworkstring[optional] Deprecated
blockHeightstringThe height (number) of the block of the balance
blockHashstringThe hash of the block of the balance

VaultAccountAssetAddress

ParameterTypeDescription
assetIdstringThe ID of the asset
addressstringAddress of the asset in a vault account; for BTC and LTC, the address is in Segwit (Bech32) format, and the cash address format for BCH
legacyAddressstringLegacy address format for BTC, LTC, and BCH
descriptionstringDescription of the address
tagstringUsed as destination tag for XRP; memo for EOS, HBAR, XDB memo_text for XLM; notes for ALGO; Bank Transfer Description for fiat providers
typestringAddress type
customerRefIdstring[optional] The ID for AML providers to associate the owner of funds with transactions
bip44AddressIndexnumber[optional] The address_index, addressFormat, and enterpriseAddress in the derivation path of this address based on BIP44

VaultAccountBalanceUpdate

ParameterTypeDescription
vaultAccountIdnumberThe ID of the vault account
assetIdstringThe ID of the asset
totalstringTotal wallet balance
pendingstringThe cumulative balance of all pending transactions to be cleared
frozenstringFrozen by your workspace's AML policies
lockedAmountstringFunds in outgoing transactions not yet published to the network
blockHeightstringThe height (number) of the block of the balance
blockHashstringThe hash of the block of the balance

CreateAddressResponse

ParameterTypeDescription
addressstringAddress of the asset in a vault account; for BTC and LTC, the address is in Segwit (Bech32) format, and the cash address format for BCH
legacyAddressstringLegacy address format for BTC, LTC, and BCH
tagstringUsed as destination tag for XRP; memo for EOS, HBAR, XDB memo_text for XLM; notes for ALGO.
bip44AddressIndexnumberThe address_index in the derivation path of this address based on BIP44

VaultAccount

ParameterTypeDescription
idstringThe ID of the vault account
namestringName of the vault account
hiddenOnUIbooleanSpecifies whether this vault account is visible in the Console UI
customerRefIdstring[optional] The ID for AML providers to associate the owner of funds with transactions
autoFuelbooleanSpecifies whether this vault account's Ethereum address is auto-fueled by the Gas Station
assetsArray of VaultAssetList of assets under this vault account

📘

Note

When the VAULT_ACCOUNT_ADDED webhook is used, the VaultAccount object does not contain the customerRefId and autoFuel parameters.


UnspentInputsData

ParameterTypeDescription
inputInputAn object containing the txHash and index of this input
addressstringThe destination address of this input
amountstringThe amount of this input
confirmationsnumberNumber of confirmations for the transaction of this input
statusstringThe status is based on the status of the transaction

PublicKey

ParameterTypeDescription
publicKeystringThe requested public key
algorithmstringOne of the SigningAlgorithms
derivationPathArray of numbersUsed for BIP32 derivation to retrieve the public key

SigningAlgorithm

ParameterTypeDescription
algorithmstring[ MPC_ECDSA_SECP256K1, MPC_EDDSA_ED25519, MPC_ECDSA_SECP256R1 ]