Vault Objects

VaultAccountsPagedResponse

ParameterTypeDescription
accountsArray of VaultAccountList of vault account objects
pagingobjectThis object contains 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/LTC the address is in Segwit (Bech32) format, cash address format for BCH
legacyAddressstringLegacy address format for BTC/LTC/BCH
tagstringUsed as destination tag for XRP; memo for EOS/XLM
eosAccountNamestringReturned for EOS, the account name

VaultAsset

ParameterTypeDescription
idstringThe ID of the asset
totalstringThe total wallet balance.
balancestringDeprecated - replaced by "total"
availablestringFunds available for transfer. Equals the blockchain balance minus any locked amount
pendingstringThe cumulative balance of all transactions pending to be cleared
stakedstringStaked funds, returned only for DOT
frozenstringFrozen by the AML policy in your workspace
lockedAmountstringFunds in outgoing transactions that are 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/LTC the address is in Segwit (Bech32) format, for BCH cash format
legacyAddressstringFor BTC/LTC/BCH the legacy format address
descriptionstringDescription of the address
tagstringUsed as destination tag for XRP; memo for EOS/XLM; 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

CreateAddressResponse

ParameterTypeDescription
addressstringAddress of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, cash address format for BCH
legacyAddressstringLegacy address format for BTC/LTC/BCH
tagstringUsed as destination tag for XRP; memo for EOS/XLM
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 web console or not
customerRefIdstring[optional] The ID for AML providers to associate the owner of funds with transactions
autoFuelbooleanSpecifies whether this account's Ethereum address is auto-fueled by the Gas Station or not
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 ]