1. Reference
Bitpanda Enterprise
  • Bitpanda Enterprise
    • Getting Started
      • Overview
      • Authentication
      • Versioning and API Changes
      • Changelog
    • REST API Endpoints
      • Overview
      • Auth Tokens
        • Obtain a Refresh and Access Tokens
        • Revoke a Refresh Token
      • User Administration
        • Individual Users
          • Create new user
          • Get user list v2
          • Search for users
          • Get user details v2
          • Update an existing user
          • Get user details
          • Off-boarding user
          • Inactivate user
          • Get user accepted Terms & Conditions
          • Get user Terms & Conditions v2
          • User verification files
          • Get account levels
          • Get account levels v2
          • Refresh KYC data for an existing user
        • Businesses
          • Get risk questions
          • Get a list of available businesses
          • Create new business
          • Get business details
          • Update an existing business
          • Create Authorized Individual
          • Get a list of Authorized Individuals
          • Get Authorized Individual details
          • Update Authorized Individual
          • Delete Authorized Individual
          • Create Shareholder
          • Get a list of Shareholders
          • Get Shareholder details
          • Update Shareholder
          • Delete Shareholder
          • Create Beneficial Owner
          • Get a list of Beneficial Owners
          • Get Beneficial Owner details
          • Update Beneficial Owner
          • Delete Beneficial Owner
          • Create Managing Director
          • Get a list of Managing Directors
          • Get Managing Director details
          • Update Managing Director
          • Delete Managing Director
          • Create Individual
          • Get a list of Individuals
          • Get Individual details
          • Update Individual
          • Delete Individual
        • User Files
          • Upload a file
          • Get file contents
          • Get file information
          • Upload a financial file
        • Legal & Regulatory
          • Get Terms & Conditions
          • Get Terms & Conditions v2
          • Get AML questions
          • Get appropriateness questions
          • Get client categorization questionnaire
          • Get DAC8 questionnaire
          • Get FATCA questionnaire
          • Get Legal Documents
          • Capture consent for User's final check
          • Retrieve Tax Identification Number Configuration
          • Get UK appropriateness questionnaire
          • Get appropriateness questionnaire for complex products
          • Get UK Risk Disclosure Warning
          • Acknowledge UK Risk Disclosure Warning
          • Get user compliance status
      • Asset Oversight
        • Asset History
          • Get asset history
          • Get asset history V2
        • Available Assets
          • Get a list of available assets
          • Get a list of available assets v2
        • Asset Details
          • Get asset details
          • Get asset details v2
        • Asset Info
          • Get asset information
          • Get asset information V2
        • Cryptocoin Details
          • Get cryptocoin details
          • Get cryptocoin details V2
        • Metal Details
          • Get metal details
          • Get metal details V2
        • Crypto Index Details
          • Get crypto index details
          • Get crypto index details V2
        • Stock Details
          • Get stock details
          • Get stock details V2
        • Equity Stock Details
          • Get equity stock details
          • Get equity stock details V2
        • ETF Details
          • Get ETF details
          • Get ETF details V2
        • Equity ETF Details
          • Get equity ETF details
          • Get equity ETF details V2
          • Get equity complex ETF details
          • Get equity complex ETF details V2
        • ETC Details
          • Get ETC details
          • Get ETC details V2
          • Get equity complex ETC details
          • Get equity complex ETC details V2
        • Equity ETC Details
          • Get Equity ETC details
          • Get Equity ETC details V2
        • Token Details
          • Get token details
          • Get token details V2
        • Asset ESG Data
          • Get asset ESG data
          • Get asset ESG data V2
        • List all available fiats per partner
        • Get the exchange rate for two assets
        • Get the swap exchange rate between two assets
        • Get assets under management
        • Get assets under management grouped by type
        • Get assets under management grouped by user
        • Get crypto index allocations
        • Get asset tags mapping
        • Get prices
        • Get prices V2
      • Trading Capabilities
        • Trades
          • Create a trade offer
          • [Deprecated] Accept a trade offer
          • Accept a trade offer V2
          • Accept a trade offer V3
          • Get a trade offer status
          • Create a trade offer V2
          • Sell asset with auto-withdraw
        • Swaps
          • Create a swap offer
          • Accept a swap offer
          • Accept a swap offer V2
          • Create a swap offer V2
        • Automated Orders
          • List automated orders
          • Get automated order price estimation
          • Create an automated order
          • Get an automated order details
          • Cancel an automated order
      • Portfolio Management
        • Returns the list of owned assets
        • Returns the list of owned asset groups
        • Portfolio performance based on timeframe
        • Returns the enhanced portfolio detail of an asset
        • Returns the list of owned assets
        • Returns the list of owned asset groups
        • Portfolio performance based on timeframe
        • Returns the enhanced portfolio detail of an asset
        • Returns the list of owned fiat wallets
      • Transactions Timeline
        • All
          • Transaction timeline per user
        • Trades
          • List all trades per user
          • Get trade details
          • Get trades history for user using asset and fiat uuid
          • Search for trades
          • Lightweight Search for trades V2
        • Swaps
          • Search for swaps
          • Search for swaps V2
          • Swap details by swap offer ID
          • Swap details by swap offer ID V2
        • Crypto Transfers
          • List all crypto transfers per user
          • Search for crypto transfers
        • Non-User Initiated Transactions
          • Non-user initiated transaction details
          • List all non-user initiated transactions per partner or per user
          • List all non-user initiated transactions per partner or per user V2
        • Corporate Actions
          • List all corporate actions per partner or per user
          • Corporate action details
          • Corporate action details V2
        • Crypto Actions
          • Crypto action details V2
          • Crypto action details
        • Staking Actions
          • List all staking actions per user
          • List all staking actions per user V2
        • Fiat Transfers
          • Search for fiat transfers
      • Reports
        • Get all available report types per user
        • Get all generated reports per user
        • Download a specific report
        • Create Account Statement Report
        • Get ex-ante report for an offer
        • Get kid information for an offer
        • List partner reports
        • Download a partner report file
      • Tax Insights
        • Get user’s tax eligibility status
        • Update user’s tax eligibility status
        • Get trade tax details
      • Notification Events
        • List all notification events per partner
        • Get JSON Web Key Set
      • Smart Investment Features
        • Crypto Transfers
          • List external addresses
          • Create deposit address
          • Update external address
          • Create withdrawal address
          • Create withdrawal address V2
          • List of VASPs
          • Validate crypto address
          • Update tax declaration status for a crypto deposit transaction
          • Create a crypto withdrawal offer
          • Confirm a withdrawal offer
          • Get public address verification details
          • Submit address verification result
        • Crypto Staking
          • Get staking overview
          • Get bonded overview
          • Stake a crypto asset
          • Stake a crypto asset V2
          • Unstake a crypto asset
          • Unstake a crypto asset V2
          • Get a staking action status
        • Savings Plans
          • Create a savings plan
          • Search for savings plans
          • Search for savings plans V2
          • Get savings plan next recurrence date.
          • Cancel a savings plan
          • Cancel a savings plan V2
          • Confirm a savings plan transaction
          • Confirm a savings plan transaction V2
          • Create a savings plan V2
        • Fiat Transfers
          • Initiate a fiat deposit
          • Create a payout account
          • Get payout accounts
          • Verify a payout account
          • Update a verification
          • Initiate a fiat withdrawal
          • List all fiat transfers per user
          • Get fiat transfer fees
          • Get fiat balances
          • Get deposit bank details
          • Initiate a bank fiat deposit
      • Settlements
        • List all available fiats per partner
        • Create a settlement deposit
        • Update the fiat stock
        • List all settlement transactions per partner
    • Webhooks
      • Overview
      • Setting up Webhooks
      • Handling Webhooks Events
        • User Updates Notifications
          • User Updates Notifications
        • Corporate Actions Notifications
          • Corporate Actions Notifications
          • Corporate Actions Notifications V2
        • Crypto Transfers Notifications
          • Deposit or withdrawal notification
        • Settlement Notifications
          • Send Money
          • Send Money V2
          • Send Money Success
          • Send Money Success V2
          • Top-Up Request
          • Top-Up Request V2
          • Top-Up Success
          • Top-Up Success V2
        • Non-user Initiated Transactions Notifications
          • Non-user Initiated Transactions
          • Non-user Initiated Transactions V2
          • Non-user Initiated Transactions V3
        • Savings Plans Notifications
          • Savings Plan Upcoming Trade
          • Savings Plan Upcoming Trade v2
          • Savings Plan Successful Trade
          • Savings Plan Failed Trade
          • Savings Plan Auto Cancel
          • Savings Transaction Updates
        • Crypto Actions Notifications
          • Crypto Actions Notifications
        • Report Notifications
          • Reports Notifications
        • Automated Orders Notifiations
          • Automated Orders Notifications
        • Proxy Voting
          • Proxy Voting Notifications
        • Fiat Transfers
          • Fiat transfer update notification
        • KYC
          • KYC Refresh Notification
        • Offer Status
          • Offer Status Notification
        • Financial Documents
          • User Financial Documents Notification
    • Websocket
      • Overview
      • Setting a Websocket
      • Websocket Server Documentation
    • Glosary
      • Key Terms and Definitions
    • Trades
      • List auto-conversions
  • Custody
    • Overview
      • Introduction
      • How TrustVault Works
      • Supported Assets
      • Environments
    • Getting Started
      • Getting Started
      • API Onboarding
      • Security
    • Tutorials
      • Create a Bitcoin Transaction
      • Create Ethereum Transaction GraphQL API
      • InfraOps
      • Organisation Management
      • TrustVault Node.js SDK
      • Change Wallet Policy API
      • Create an Ethereum Transaction
      • Create Transaction (Unsupported EVM chain)
      • Calculating Transaction Fee
      • Get User Portfolio
    • APIs
      • Trust API
      • Travel Rule API
      • Deprecations
    • Core Concepts
      • Webhooks
      • Address Book V2
      • Policies and Signing
      • Travel Rule API
      • Wallets and Sub-Wallets
    • Reference
      • Changelog
      • Understanding Bitcoin
      • Supported Ethereum Decoded Data
      • TrustVault Node.js SDK
      • Glossary
      • TrustVault Public Keys
  • Crypto Pay by Bitpanda
    • Overview
    • REST API Endpoints
      • Authentication
        • Obtain a Refresh and Access Tokens
        • Revoke a Refresh Token
      • Transactions
        • Get transaction details
        • Create a new transaction
        • Get transactions details
      • Get list of fiat currencies
  1. Reference

Glossary

TERMEXPLANATION
ASN.1Abstract Syntax Notation One (ASN.1) is a notation used for describing data structures that can be serialized and deserialized in a cross-platform way
BIP32The Bitcoin Improvement Proposal (BIP) that defines The Hierarchical Deterministic (HD) key creation and transfer protocol, it allows the automatic generation of a hierarchical tree-like structure of private/public addresses (or keys)
Blockchain WalletWallet relating to a blockchain (i.e. Bitcoin, Ethereum)
ClauseA clause in a policy schedule defines a set of keys and the minimum number of those keys required to satisfy this clause
Custody SignatureAn ECDSA signature representing the points r and s, which is calculated as the signature of the CustodyPrivate Key over the expression secp256k1(SHA_256(auditPrefix || SHA_256(auditMessage)))
DelegatesThe set of key(s) that are allowed to sign transactions for a particular wallet, as defined in the policy's delegate schedules. Delegates cannot approve policy changes
DERDistinguished Encoding Rules (DER) is an ASN.1 subset of Basic Encoding Rules. It is used to produce unique octet string encoding to represent digital signatures computed on an ASN.1 value
DigestThe output from a hash function. Currently expected to be either 20 or 32 bytes (40 or 64 hex characters)
Digest SignatureAn ECDSA signature representing the points r and s, which is calculated over a hash value resulting from a number of possible hash algorithms (including but not limited to SHA-1, SHA-256, RIPEMD-160, SHA-256 applied twice, SHA-256 over RIPEMD-160 and Ethereum's variation on SHA3-256 known as keccak)
ECDSAElliptic Curve Digital Signature Algorithm (ECDSA) offers a variant of the Digital Signature Algorithm (DSA) which uses elliptic curve cryptography to achieve similar levels of security using a smaller key size
HD walletAn HD Wallet, or Hierarchical Deterministic wallet, are wallets that uses the Hierarchical Deterministic (HD) key creation and transfer protocol as outlined in BIP32
HD wallet (derivation) pathThe specific derivation path within an HD wallet that determines the associated public key. Follows a standard as defined in BIP-44
HSMA physical computing device that safeguards and manages digital keys for strong authentication and provides crypto processing. It manages, processes, and stores cryptographic keys securely inside a hardened, tamper-resistant device
Instruction KeyEvery wallet created has a wallet policy which has private/public key(s) assigned to it. These keys are in the secure enclave of the iPhone device you on-boarded with. However some API users may want to NOT use the phone and change the external instruction key of the wallet policy to keys they control programmatically. Keys must be on the secp256r1 curve (see Public Key for the format)
Master Public KeyThe TrustVault provenance public key, it is used to verify the TrustVault Provenance signature
Policy TemplateThe set of rules specifying who can sign with a particular wallet, used in trust-sign generate and trust-sign recover requests
PolicyThis is the resulting policy object that is derived from a policyTemplate object on a request to generate
Policy SignatureAn ECDSA signature representing the points r and s, which is calculated as the signature of the HSM Private Key over the DER encoding of a Policy object
Private KeyThe secret half of an ECDSA key pair, used to produce signatures. It must never be shared; the corresponding Public Key can be derived from it
Provenance SignatureAn ECDSA signature to acts as a proof that the message came from Bitpanda Custody and that the client is indeed the intended recipient of that message
Public KeyAn ECDSA public key in uncompressed hex format (first byte is always 04), exactly 130 hex characters (i.e. 65 bytes) which corresponds to a private key. A public key can be calculated from a private key, but not vice versa
Public Key Signature PairA pair consisting of an ECDSA public key and a signature to acts as proof that message came from a particular private key holder
Quorum CountquorumCount: the number of signatures, s, required by a clause where 1 <= s <= keys.length
prime256v1Another name for the secp256r1 curve (see secp256r1)
RecoverersThe set of key(s), also known as wallet admins, that are allowed to approve policy changes (e.g. key rotation or recovery) for a particular wallet, as defined in the policy's recoverer schedules. Recoverers cannot authorise transactions
SubWalletA subWallet holds the assets. An HD wallet can hold multiple subWallets each with their unique HD wallet path. All subWallets inherit the policy of their parent wallet.
ScheduleA schedule in a policy defines a set of clauses that all must be satisfied
TCSSTransaction Co-Signing Service. Enforces wallet-level rules such as Address Book destination allowlisting before a transaction is submitted; see Policies and Signing
secp256k1The particular elliptic curve that Bitcoin and Ethereum uses
secp256r1The NIST P-256 elliptic curve (also known as prime256v1). It is used within an iOS device's secure enclave and is the curve required for all Instruction Keys
UUIDuniversally unique identifier (UUID) is a 128-bit number used to uniquely identify data
WalletA BIP32 HD key container that holds the policy governing who can sign. A wallet holds assets via its sub-wallets; see Wallets and Sub-Wallets
unverifiedDigestDataThis is an object of data used during API signing. For transactions it consists of transactionDigest, signData and shaSignData (policy change requests have only signData and shaSignData). The transactionDigest is the transaction digest created using the canonical hashing form as described by the relevant chain. e.g. for Ethereum this is keccak(rlp(transaction)). The signData is the transactionDigest with the wallet accountPath appended in DER format. This is TrustVault's native encoding of transaction data to ensure that only the specific wallet path (which relates directly to the sub-wallet) can use the signed data. The shaSignData is SHA-256(signData), the data that must be signed by the private key of the delegate. This is usually the TrustVault iOS App but can also be via API if you have an external signing key attached to your wallet policy.
Zero DelegateTo change the delegate schedules to zero keys via a ZERO policy change request. No keys are allowed to sign a particular wallet (i.e. locks a particular wallet account)
Modified at 2026-10-29 12:46:11
Previous
TrustVault Node.js SDK
Next
TrustVault Public Keys
Built with