1. APIs
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 accepted Terms & Conditions v2
          • User verification files
          • Get account levels
        • 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
        • 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 client categorization questionnaire
          • Get UK Risk Disclosure Warning
          • Acknowledge UK Risk Disclosure Warning
          • Get user compliance status
      • Asset Oversight
        • 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 History
          • Get asset history
          • Get asset history
        • Asset Info
          • Get asset information
          • Get asset information
        • Cryptocoin Details
          • Get cryptocoin details
          • Get cryptocoin details
        • Metal Details
          • Get metal details
          • Get metal details
        • Crypto Index Details
          • Get crypto index details
          • Get crypto index details
        • Stock Details
          • Get stock details
          • Get stock details
        • Equity Stock Details
          • Get equity stock details
          • Get equity stock details V2
        • ETF Details
          • Get ETF details
          • Get ETF details
        • Equity ETF Details
          • Get equity ETF details
          • Get equity ETF details V2
        • ETC Details
          • Get ETC details
          • Get ETC details
        • Equity ETC Details
          • Get Equity ETC details
          • Get Equity ETC details V2
        • Token Details
          • Get token details
          • Get token details
        • 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 crypto index allocations
        • Get asset tags mapping
        • Get prices
        • Get prices V2
      • Trading Capabilities
        • Trades
          • Create a trade offer
          • Create a trade offer V2
          • [Deprecated] Accept a trade offer
          • Accept a trade offer V2
          • Accept a trade offer V3
          • Get a trade offer status
        • Swaps
          • Create a swap offer
          • Create a swap offer V2
          • Accept a swap offer
          • Accept 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
      • 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
          • Swap details by swap offer ID
          • Search for swaps V2
          • 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
        • Crypto Actions
          • Crypto action details V2
          • Crypto action details
        • Staking Actions
          • List all staking actions per user
          • List all staking actions per user V2
      • Reports
        • Get all available report types per user
        • Get all generated reports per user
        • Create Account Statement Report
        • Download a specific report
      • 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
      • 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
        • Crypto Staking
          • Get staking overview
          • Get bonded overview
          • Stake a crypto asset
          • Unstake a crypto asset
          • Stake a crypto asset V2
          • Unstake a crypto asset V2
          • Get a staking action status
        • Savings Plans
          • Create a savings plan
          • Search for savings plans
          • 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
          • Search for savings plans V2
          • Get savings plan next recurrence date.
      • 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
        • Crypto Transfers Notifications
          • Deposit or withdrawal notification
        • Settlement Notifications
          • Top-Up Request
          • Top-Up Request V2
          • Top-Up Success
          • Top-Up Success V2
          • Send Money
          • Send Money V2
          • Send Money Success
          • Send Money 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
        • Crypto Actions Notifications
          • Crypto Actions Notifications
        • Reports Notifications
          • Reports Notifications
        • Automated Orders Notifications
          • Automated Orders Notifications
    • WebSocket
      • Overview
      • Setting a Websocket
      • Websocket Server Documentation
    • Glosary
      • Key Terms and Definitions
    • Schemas
      • 400
      • 401
      • CreateWithdrawalAddressRequestV2
      • 404
      • 422
      • AddressV2Response
      • UpdateExternalAddressRequest
      • TransactionTimelineItem
      • 403
      • UserJourney
      • trades-search-lightweight
      • 413
      • TradeDetails
      • CreateOfferRequest
      • 500
      • CreateOfferUUIDRequest
      • AccessToken
      • ListOrderResponse
      • getTransactionResponse
      • CreateOrderRequest
      • getFiatsResponse
      • CreateOrderResponse
      • 428
      • GetOrderResponse
      • OAuthTokenRequest
      • 405
      • 406
      • OAuthRevokeRequest
      • 409
      • 410
      • TermListResponse
      • 503
      • UserFlow
      • TradingAssetGroup
      • Term
      • TradingAssetAction
      • PaginationMeta
      • PaginationLinks
      • TermV2Link
      • ComplexProductsAnswer
      • TermsV2Response
      • TermV2Text
      • ComplexProductsQuestion
      • AmlAnswerNested
      • AmlQuestionNested
      • AmlAnswer
      • AmlQuestion
      • AmlquestionListResponse
      • QuestionnaireAnswer
      • QuestionnaireQuestion
      • ClientCategorizationNestedAnswer
      • QuestionnairequestionListResponse
      • ClientCategorizationNestedQuestion
      • QuestionnairequestionUKListResponse
      • ClientCategorizationAnswer
      • ClientCategorizationQuestion
      • UKRiskDisclosureContentLink
      • Dac8Answer
      • UKRiskDisclosureContent
      • ComplexproductsquestionListResponse
      • Dac8Question
      • UKRiskDisclosureActions
      • FatcaAnswer
      • UKRiskDisclosure
      • FatcaQuestion
      • AccountLevel
      • GetUserList
      • ClientcategorizationquestionListResponse
      • SimpleCursorPaginationMeta
      • AmlQuestionAnswerRequest
      • AppropriatenessQuestionAnswerRequest
      • Dac8questionListResponse
      • ClientCategorizationQuestionAnswerRequest
      • FatcaQuestionAnswerRequest
      • Dac8QuestionAnswerRequest
      • FatcaquestionListResponse
      • UserVerificationV2Request
      • UserTax
      • AccountlevelListResponse
      • UserMultipleTax
      • UserExtCompliance
      • CreateUserV2RequestBody
      • UserSearch
      • GetUserV2
      • UkRiskDisclosureGetResponse
      • UpdateUserV2RequestBody
      • GetUser
      • UserOffBoardingRequestBody
      • GetuserlistListResponse
      • UserAcceptedTerm
      • UserAcceptedTermV2Link
      • UserAcceptedTermV2Text
      • ComplianceDetails
      • UserVerificationFilesV2RequestBody
      • UserComplianceV2
      • LegalDocument
      • UserComplianceV2Response
      • TaxRules
      • Asset
      • AssetHistory
      • AssetInfo
      • CryptoIndexAllocation
      • CoinDetails
      • CreateUserV2Response
      • MetalDetails
      • CryptoIndexDetails
      • UsersearchListResponse
      • YearlyNetIncome
      • StockDetails
      • Getuserv2Response
      • EquityStockDetails
      • ETFDetails
      • UpdateUserV2Response
      • EquityETFDetails
      • ETCDetails
      • GetuserResponse
      • EquityETCDetails
      • TokenDetails
      • OffBoardingResponse
      • ESGData
      • InactivateUserResponse
      • ExchangeRate
      • SwapExchangeRate
      • UseracceptedtermListResponse
      • Asset-V2
      • GetAssetsUnderManagement
      • GetAssetsUnderManagementTypeGroup
      • UserAcceptedTermsV2Response
      • FiatV2
      • TagGroup
      • TagsMapping
      • AppropriatenessComplexProducts
      • Trade
      • TradeV2
      • TradeSearchV2
      • LegaldocumentListResponse
      • NextPrevCursorPagination
      • CorporateActions
      • CorporateActionDetailsAsset
      • AssetListResponse
      • CorporateActionDetailsFiat
      • AssetResponse
      • CorporateActionDetails
      • NonUserInitiatedTransactionsDetailsAsset
      • AssethistoryListResponse
      • NonUserInitiatedTransactionDetailsFiat
      • NonUserInitiatedTransactionsDetails
      • AssetinfoListResponse
      • CryptoActionDetailsAsset
      • CryptoActionDetailsFiat
      • CryptoindexallocationListResponse
      • CryptoActionDetails
      • CryptoActionDetailsAssetV2
      • CoindetailsResponse
      • CryptoActionTransaction
      • CryptoActionDetailsV2
      • MetaldetailsResponse
      • Warnings
      • Offer
      • CryptoindexdetailsResponse
      • OfferUUID
      • Offer-Accept
      • Offer-Accept-Uuid
      • StockdetailsResponse
      • Overview
      • GroupOverview
      • EquitystockdetailsResponse
      • Performance
      • AssetDetailsEnhancedWithStaking
      • EtfdetailsResponse
      • OverviewV2
      • AssetDetailsEnhancedWithStakingV2
      • EquityetfdetailsResponse
      • Fiat
      • CreateDomainDepositRequestBody
      • EtcdetailsResponse
      • UpdateFiatStockRequestBody
      • TransactionSearch
      • EquityetcdetailsResponse
      • CreateAccountStatement
      • AccountStatementReportResponse
      • TokendetailsResponse
      • ReportDetails
      • UploadFileRequestBody
      • EsgdataResponse
      • FileInformation
      • OverviewResponse
      • BondedOverviewResponse
      • StakeRequest
      • AssetV2ListResponse
      • StakeResponse
      • AssetV2Response
      • PendingStakeActionResponse
      • UnstakeRequest
      • GetAssetsUnderManagementResponse
      • UnstakeResponse
      • SearchResponse
      • GetAssetsUnderManagementTypeGroupResponse
      • SearchV2Response
      • PaginationMetaV2
      • Fiatv2ListResponse
      • StakeV2Request
      • StakeV2Response
      • UnstakeV2Request
      • TagsmappingListResponse
      • UnstakeV2Response
      • GetStatusResponse
      • TradeListResponse
      • EventV2
      • NonUserInitiatedTransactions
      • Tradev2ListResponse
      • NonUserInitiatedTransactionsV2
      • GetPricesResponse
      • TransactiontimelineitemListResponse
      • GetPricesResponse-v2
      • GetTaxStatusResponse
      • Tradesearchv2ListResponse
      • OrderPriceEstimationResponse
      • UpdateTaxStatusRequest
      • UpdateTaxStatusResponse
      • TradesSearchLightweightListResponse
      • GetTaxDetailsResponse
      • AddressResponse
      • TradedetailsResponse
      • CreateAddressRequest
      • DepositAddressResponse
      • CorporateactionsListResponse
      • CreateWithdrawalAddressRequest
      • VaspResponse
      • ValidateCryptoAddressRequest
      • ValidateCryptoAddressResponse
      • TransactionResponse
      • TaxDeclarationUpdateRequest
      • WithdrawalOfferRequest
      • WithdrawalOfferResponse
      • WithdrawalResponse
      • SearchSavingsPlanResponse
      • CreateSavingsPlanRequest
      • CreateSavingsPlanResponse
      • ModifySavingsPlanRequest
      • ModifySavingsPlanResponse
      • CancelSavingsPlanV2Response
      • OfferResponse
      • ConfirmSavingsPlanTransactionResponse
      • ConfirmSavingsPlanTransactionV2Response
      • SearchSavingsPlanV2Response
      • OfferuuidResponse
      • CreateSavingsPlanV2Request
      • CreateSavingsPlanV2Response
      • AcceptOfferResponse
      • GetSavingsPlanNextRecurrenceResponse
      • AcceptOfferIdempotentResponse
      • CreateSwapOfferRequest
      • CreateSwapOfferResponse
      • AcceptOfferUuidResponse
      • SwapTradesSearch
      • OfferV2StatusResponse
      • GetSwap
      • CreateSwapOfferRequestV2
      • OverviewListResponse
      • CreateSwapOfferResponseV2
      • SwapTradesSearchV2
      • GroupoverviewListResponse
      • GetSwapV2
      • AcceptSwapOfferResponse
      • PerformanceResponse
      • AcceptSwapOfferResponseV2
      • ResponseMeta
      • RiskAnswer
      • Overviewv2ListResponse
      • RiskQuestion
      • GeneralAddress
      • EntityTaxClassification
      • FiatListResponse
      • Business
      • RiskQuestionAnswerRequest
      • CreateDepositResponse
      • CreateBusinessRequestBody
      • BusinessDetails
      • UpdateFiatStockResponse
      • UpdateBusinessRequestBody
      • AuthorizedIndividual
      • TransactionsearchListResponse
      • CreateAuthorizedIndividualRequestBody
      • UserReportTypesResponse
      • UpdateAuthorizedIndividualRequestBody
      • UserGeneratedReportsResponse
      • Shareholder
      • CreateShareholderRequestBody
      • UpdateShareholderRequestBody
      • CreateReportResponse
      • BeneficialOwnerType
      • BeneficialOwnerControllingPersonType
      • BeneficialOwner
      • CreateBeneficialOwnerRequestBody
      • FileinformationListResponse
      • UpdateBeneficialOwnerRequestBody
      • ManagingDirector
      • CreateManagingDirectorRequestBody
      • UpdateManagingDirectorRequestBody
      • Individual
      • StakeSuccessResponse
      • CreateIndividualRequestBody
      • UpdateIndividualRequestBody
      • PendingStakeActionSuccessResponse
      • UnstakeSuccessResponse
      • SearchSuccessResponse
      • SearchV2SuccessResponse
      • StakeV2SuccessResponse
      • UnstakeV2SuccessResponse
      • GetstatusSuccessResponse
      • Eventv2ListResponse
      • NonuserinitiatedtransactionsListResponse
      • Nonuserinitiatedtransactionsv2ListResponse
      • GetPricesSuccessResponse
      • GetPricesV2SuccessResponse
      • GetTaxStatusSuccessResponse
      • UpdateTaxStatusSuccessResponse
      • GetTaxDetailsSuccessResponse
      • AddressV2ListSuccessResponse
      • DepositAddressSuccessResponse
      • AddressSuccessResponse
      • AddressV2SuccessResponse
      • ValidateCryptoAddressSuccessResponse
      • TransactionListSuccessResponse
      • TransactionSuccessResponse
      • WithdrawalOfferSuccessResponse
      • WithdrawalSuccessResponse
      • SearchSavingsPlanSuccessResponse
      • CreateSavingsPlanSuccessResponse
      • ModifySavingsPlanSuccessResponse
      • CancelSavingsPlanV2SuccessResponse
      • ConfirmSavingsPlanTransactionSuccessResponse
      • ConfirmSavingsPlanTransactionV2SuccessResponse
      • SearchSavingsPlanV2SuccessResponse
      • CreateSavingsPlanV2SuccessResponse
      • GetSavingsPlanNextRecurrenceSuccessResponse
      • CreateSwapOfferSuccessResponse
      • SwaptradessearchListResponse
      • GetswapResponse
      • Createswapofferresponsev2Response
      • Swaptradessearchv2ListResponse
      • Getswapv2Response
      • AcceptSwapOfferSuccessResponse
      • Acceptswapofferresponsev2Response
      • ListOrdersSuccessResponse
      • CreateOrderSuccessResponse
      • GetOrderSuccessResponse
      • RiskquestionListResponse
      • BusinessListResponse
      • CreateBusinessResponse
      • BusinessdetailsResponse
      • UpdateBusinessResponse
      • AuthorizedindividualListResponse
      • CreateAuthorizedIndividualResponse
      • AuthorizedindividualResponse
      • UpdateAuthorizedIndividualResponse
      • ShareholderListResponse
      • CreateShareholderResponse
      • ShareholderResponse
      • UpdateShareholderResponse
      • BeneficialownerListResponse
      • CreateBeneficialOwnerResponse
      • BeneficialownerResponse
      • UpdateBeneficialOwnerResponse
      • ManagingdirectorListResponse
      • CreateManagingDirectorResponse
      • ManagingdirectorResponse
      • UpdateManagingDirectorResponse
      • IndividualListResponse
      • CreateIndividualResponse
      • IndividualResponse
      • UpdateIndividualResponse
      • CorporateActionsNotificationRequest
      • CorporateActionsNotificationV2Request
      • UserUpdateRequest
      • CryptoTransferNotificationRequest
      • TopUpRequest
      • TopUpV2Request
      • TopUpSuccessRequest
      • TopUpSuccessV2Request
      • SendMoneyRequest
      • SendMoneyV2Request
      • SendMoneySuccessRequest
      • SendMoneySuccessV2Request
      • NonUserInitiatedTransactionsRequest
      • NonUserInitiatedTransactionsV2Request
      • NonUserInitiatedTransactionsV3Request
      • SavingsPlanNoticeRequest
      • SavingsPlanNoticeV2Request
      • SavingsPlanTradeSuccessNoticeRequest
      • SavingsPlanTradeErrorNoticeRequest
      • CryptoActionsNotificationRequest
      • AutomatedOrdersNotificationRequest
      • ReportsNotificationRequest
      • SavingsPlanAutoCancelNotificationRequest
  • Custody
    • Introduction
    • Security
    • Getting Started
    • Webhooks
    • Supported Assets
    • Glossary
    • Changelog
    • Tutorials
      • API Onboarding
      • TrustVault Node.js SDK
      • Change Wallet Policy API
      • Create a Bitcoin Transaction
      • Create an Ethereum Transaction
      • Create Transaction (Unsupported EVM chain)
      • Create Ethereum Transaction GraphQL API
      • Calculating Transaction Fee
      • Decoding an Ethereum Transaction Webhook Payload
      • Get User Portfolio
      • Environments
      • InfraOps
      • Organisation Management
      • Address Book V2
    • APIs
      • Travel Rule API
      • Deprecations
      • Trust API
        • Authentication
          • TrustVault Public Keys
        • Query
          • User
            • User SubWallets - Details
            • User SubWallets - Portfolio
            • User SubWallets - Balances
            • Get Transactions
            • Get Transactions for a BTC Receive Address
            • Get All BTC Receive Addresses (With Transactions)
            • Get User Portfolio
            • csvPortfolio
          • Get Request Item
        • Mutations
          • Create Transactions
            • Create BTC Transaction
            • Create ETH
            • Create Transaction (EVM compatible chain)
            • Create Exchange Transfer
          • Create Change Policy Request
          • Create Bitcoin Receive Address
          • Add Signature
          • Cancel request
          • Create Sub Wallet
          • Create Eth Personal Sign
          • Create Eth Signed Typed Data
          • Create Radix Transaction
          • Create Xdc.Network Transaction
    • Under the Hood
      • Understanding Bitcoin
      • Supported Ethereum Decoded Data
  • Crypto Pay by Bitpanda
    • Overview
    • Webhooks
      • Settlement Update Notifications
      • Transaction Update Notifications
    • 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
    • Schemas
      • 400
      • 401
      • 403
      • 404
      • 413
      • 422
      • 500
      • AccessToken
      • getTransactionResponse
      • getFiatsResponse
  1. APIs

API

You can run queries in our Sandbox environment using our Postman collection.

Schema Types#

Table of Contents
Query
Mutation
Objects
AccessListItem
Address
AddressBook
AddressBookApproval
AddressBookChangeRequestsItem
AddressBookChangeRequestsResponse
AddressBookConnection
AddressBookConnectionV2
AddressBookEntriesConnection
AddressBookEntry
AddressBookV2
AddressConnection
AddressPublicKeyProvenance
AllowedDestinationsResponse
Amount
Asset
AssetBalance
AsyncReportRequestResponse
Auth
Authentication
AuthenticationResponse
BabylonTransactionData
Balance
BalanceConnection
BitcoinAddress
BitcoinAddressResults
BitcoinInput
BitcoinOutput
BitcoinPublicKeyProvenance
BitcoinSign
BitcoinTransaction
BlockchainSubWallet
BlockchainTransaction
CardanoPublicKeyProvenance
ChainInfo
ChainInfoDescription
ChainRawEthereumTransaction
ChangePolicyRequest
ChangePolicyRequestResponse
Cluster
ContractInfo
ContractManagementConnection
ContractManagementItem
CounterpartyInfo
CounterpartyInfoV2
CreateBitcoinDraftTransaction
CreateBitcoinTransactionIdResponse
CreateCardanoTransactionResponse
CreateDogeTransactionResponse
CreateEthPersonalSignResponse
CreateEthSignTypedDataResponse
CreateEthereumDraftTransaction
CreateEthereumTransactionResponse
CreateEvmTransactionLiteResponse
CreateEvmTransactionResponse
CreateExchangeTransferResponse
CreateOrgApiKeyResponse
CreateRadixTransactionResponse
CreateRippleTransactionResponse
CreateSolanaTransactionResponse
CreateSubWalletResponse
CreateSubstrateTransactionResponse
CreateXdcNetworkTransactionResponse
DeleteAddressBookEntriesResponse
DeleteAddressBookEntryResponse
DeleteAddressBookResponse
DigestData
DownloadPendingToSign
EIP1559Transaction
EIP2930Transaction
ERC20TokenInfo
EthDecodedArrayParameter
EthDecodedMethodData
EthDecodedStringParameter
EthPersonalSignData
EthSignTypedData
EthereumSign
EthereumTransaction
EvmAsset
EvmLegacyTransaction
EvmSign
ExchangeSubWallet
ExchangeTransaction
FeePrice
GenericAsset
GenericTransaction
GenericTransactionConnection
GetTransactionCountResponse
HdWalletPath
InfraOpsClustersConnection
ListApiKeysResponse
MessageAddress
OfflineCluster
OnlineCluster
OrgApiKeyDetails
Organisation
OrganisationManagement
OrganisationUser
OrganisationUsersConnection
PinChallenge
Policy
PolicyTemplate
Portfolio
PortfolioConnection
PortfolioCsv
PublicKeyUser
RequestIdResponse
RequestItem
RequestTransactionsCsv
Schedule
SignData
SignDataEncoding
Signatures
SignedTransaction
SolanaAddress
SolanaStakeAddress
SubWalletConnection
SubWalletId
SubWalletSummary
SuccessResponse
TransactionConnection
TransactionCsv
TransactionDigestData
TransactionId
TransactionResponse
Transfer
TransfersConnection
TravelRuleInfo
UpdateOrgApiKeyResponse
UpdateTransferResponse
User
UserSecureTokens
Vasp
VaspConnection
VaspInfo
VaspInfoV2
WalletInfo
WalletSeed
WalletsInfoConnection
Inputs
AccessListItemInput
AddSignatureInput
AddressBookChangeRequestsInput
AddressBookEntriesInput
AddressBookEntriesInputV2
AddressBookEntryInput
AddressBookInput
AuthenticationInput
BabylonTransactionInput
CardanoPaymentTransactionInput
CardanoStakeTransactionInput
ClusterInput
CounterpartyInfoInput
CreateAddressBookEntriesInput
CreateAddressBookEntryInput
CreateAddressBookInput
CreateBabylonTransactionInput
CreateBitcoinAddressInput
CreateBitcoinTransactionInput
CreateBitcoinTransactionParams
CreateCardanoPaymentTransactionInput
CreateCardanoStakeTransactionInput
CreateCardanoUnstakeTransactionInput
CreateCardanoWithdrawalTransactionInput
CreateChangePolicyRequestInput
CreateCounterpartyInfoInput
CreateDogePaymentTransactionInput
CreateEIP1559TransactionInput
CreateEIP2930TransactionInput
CreateEthPersonalSignInput
CreateEthSignTypedDataInput
CreateEthereumTransactionInput
CreateEvmTransactionLiteInput
CreateExchangeTransferInput
CreateOrgApiKeyInput
CreateRadixTransactionInput
CreateRippleTransactionInput
CreateSolanaActivateStakeTransactionInput
CreateSolanaDeactivateStakeTransactionInput
CreateSolanaInitialiseStakeTransactionInput
CreateSolanaPaymentTransactionInput
CreateSolanaSplitStakeTransactionInput
CreateSolanaTokenPaymentTransactionInput
CreateSolanaWithdrawStakeTransactionInput
CreateSubWalletInput
CreateSubstrateAddStakeTransactionInput
CreateSubstrateDelegateStakeTransactionInput
CreateSubstratePaymentTransactionInput
CreateSubstrateRestakeTransactionInput
CreateSubstrateStakeTransactionInput
CreateSubstrateUnstakeTransactionInput
CreateSubstrateWithdrawStakeTransactionInput
CreateVaspInfoV2Input
DeleteAddressBookEntriesInput
DeleteAddressBookInput
DogePaymentTransactionInput
EditAddressBookInput
EthereumTransactionInput
EvmEIP1559Transaction
EvmEIP2930Transaction
EvmRawTransactionInput
ExchangeTransferInput
ExchangeWalletId
GetAuthenticationTokensInput
GetTransactionCountInput
HdWalletPathInput
InviteUserInput
ListApiKeysInput
MessageAddressInput
OrgUserInput
PinChallengeAttempt
PublicKeySignaturePair
RadixTransactionInput
RequestAuditLogInput
RequestCsvTransactionsInput
RequestSignatureInput
RippleTransactionInput
ScheduleInput
SignRequest
SolanaActivateStakeTransactionInput
SolanaDeactivateStakeTransactionInput
SolanaInitialiseStakeTransactionInput
SolanaPaymentTransactionInput
SolanaSplitStakeTransactionInput
SolanaTokenPaymentTransactionInput
SolanaWithdrawStakeTransactionInput
SubWalletIdInput
SubstrateAddStakeTransactionInput
SubstrateDelegateStakeTransactionInput
SubstratePaymentTransactionInput
SubstrateRestakeTransactionInput
SubstrateStakeTransactionInput
SubstrateUnstakeTransactionInput
SubstrateWithdrawStakeTransactionInput
TransactionAmount
TransactionInput
TransferInput
TravelRuleInfoInput
UpdateOrgApiKeyInput
UpdateUserInput
VaspInfoInput
Enums
AddressBookEntryType
ApprovalProcess
AssetSymbol
AssetType
BitcoinAddressType
BitcoinAddressUsage
CardanoAddressType
Chain
ChainAddressUsage
ChangeRequestsStateEnum
ClusterType
ExchangeSubWalletStatus
ExchangeType
ExchangeWalletStatus
Role
SolanaAddressUsage
SolanaStakeStatus
SubWalletType
TimePeriod
TransactionDirection
TransactionResponseStatus
TransactionSpeed
TransactionStatus
VaspType
WalletFilter
WalletType
Scalars
Boolean
ID
Int
String
Interfaces
BaseAsset
ChainRawTransaction
Connection
CreateBitcoinTransactionResponseInterface
CreateEthereumTransactionResponseInterface
CreateTransactionResponse
EthDecodedParameter
GenericAddress
InfraOpsCluster
PublicKeyProvenance
SubWallet
Transaction
Unions
EvmSignTransaction
TransactionData

Query#

FieldArgumentTypeDescription
authAuth!
authenticationAuthenticationInput
getAuthenticationTokensAuthenticationResponse!Submit the partial pin and if successful return the authentication tokens
getAuthenticationTokensInputGetAuthenticationTokensInput!
getPartialPinChallengePinChallengeGet the partial pin challenge for the a user
emailString!
refreshAuthenticationTokensAuthentication!Refresh the authentication tokens
authenticationAuthenticationInput!
userUser!Use this to get information about a user (AuthenticationInput or API key must be provided)
authenticationAuthenticationInput
addressBooksAddressBookConnectionV2
authenticationAuthenticationInput
addressBookAddressBookV2
addressBookInputAddressBookInput!
addressBookApprovals[AddressBookApproval!]
authenticationAuthenticationInput
getRequestRequestItem!Retrieves the request item associated with the given requestId (AuthenticationInput or API key must be provided)
authenticationAuthenticationInput
requestIdString!
vaspsVaspConnection!Retrieves a list of all active vasps
nextTokenString
clusterInfraOpsCluster
clusterInputClusterInput!
clustersInfraOpsClustersConnection
authenticationAuthenticationInput
listApiKeysListApiKeysResponse
listApiKeysInputListApiKeysInput
organisationManagementOrganisationManagement

Mutation#

FieldArgumentTypeDescription
createAddressBookAddressBookV2!
createAddressBookInputCreateAddressBookInput!
editAddressBookAddressBookV2!
editAddressBookInputEditAddressBookInput!
createAddressBookEntries[AddressBookEntry!]
createAddressBookEntriesInputCreateAddressBookEntriesInput!
deleteAddressBookDeleteAddressBookResponse!
deleteAddressBookInputDeleteAddressBookInput!
deleteAddressBookEntriesDeleteAddressBookEntriesResponse!
deleteAddressBookEntriesInputDeleteAddressBookEntriesInput!
requestSignature ⚠️TransactionId!deprecated because you should use the createEthereumTransaction mutation instead. Not supported after 31st March 2020
⚠️ DEPRECATED
renamed to createEthereumTransactionRaw
requestSignatureInputRequestSignatureInput!
createSubWalletCreateSubWalletResponse!create a subWallet for a given wallet
createSubWalletInputCreateSubWalletInput!
createExchangeTransferCreateExchangeTransferResponse!create an transfer between exchange accounts and send the transaction to the TrustVault authorised signer(s) inbox for signing. Use the requestId to query the status of the transaction later.
createExchangeTransferInputCreateExchangeTransferInput!
createBitcoinAddressBitcoinAddressResults!
createBitcoinAddressInputCreateBitcoinAddressInput!
createChangePolicyRequestChangePolicyRequestResponse!create a change policy request of a wallet(s) (available via API key authentication only)
createChangePolicyRequestInputCreateChangePolicyRequestInput
addSignatureRequestIdResponse!add public key & signature pairs for the given requestId (available via API key authentication only)
addSignatureInputAddSignatureInput
cancelRequestRequestIdResponse!cancel the request item associated with the given requestId, optionally pass a reason for cancelling
requestIdString!
reasonString
createEthPersonalSignCreateEthPersonalSignResponse!Create a request to sign a given message using the private key of the given ethereum address
createEthPersonalSignInputCreateEthPersonalSignInput!
createEthSignTypedDataCreateEthSignTypedDataResponse!Create a request to sign with eth_signTypedData a message using the private key of the given ethereum address
createEthSignTypedDataInputCreateEthSignTypedDataInput!
createEthereumTransactionCreateEthereumTransactionResponseInterface!create an Ethereum Transaction specifying only the minimal attributes of the transaction and send the transaction to the TrustVault authorised signer(s) inbox for signing. Use the requestId to query the status of the transaction later.
createTransactionInputCreateEthereumTransactionInput!
createBitcoinTransactionCreateBitcoinTransactionResponseInterfacecreate a Bitcoin Transaction specifying only the minimal attributes of the transaction and send the transaction to the TrustVault authorised signer(s) inbox for signing. Use the requestId to query the status of the transaction later.
NOTE: returns null if an error occurred
createBitcoinTransactionInputCreateBitcoinTransactionInput!
createRadixTransactionCreateRadixTransactionResponse!Create a radix transaction request to sign using the private key of the given subWalletId
createRadixTransactionInputCreateRadixTransactionInput!
createBabylonTransactionCreateRadixTransactionResponse!Create a Babylon transaction request to sign
createBabylonTransactionInputCreateBabylonTransactionInput!
createSolanaInitialiseStakeTransactionCreateSolanaTransactionResponse!Create a new Solana Transfer
transactionInputCreateSolanaInitialiseStakeTransactionInput!
createSolanaActivateStakeTransactionCreateSolanaTransactionResponse!
transactionInputCreateSolanaActivateStakeTransactionInput!
createSolanaDeactivateStakeTransactionCreateSolanaTransactionResponse!
transactionInputCreateSolanaDeactivateStakeTransactionInput!
createSolanaWithdrawStakeTransactionCreateSolanaTransactionResponse!
transactionInputCreateSolanaWithdrawStakeTransactionInput!
createSolanaSplitStakeTransactionCreateSolanaTransactionResponse
transactionInputCreateSolanaSplitStakeTransactionInput!
createRippleTransactionCreateRippleTransactionResponse!Create a Ripple transaction request to sign
createRippleTransactionInputCreateRippleTransactionInput!
createSolanaPaymentTransactionCreateSolanaTransactionResponse!Create a new Solana Transfer
transactionInputCreateSolanaPaymentTransactionInput!
createSolanaTokenPaymentTransactionCreateSolanaTransactionResponse!
transactionInputCreateSolanaTokenPaymentTransactionInput!
createCardanoPaymentTransactionCreateCardanoTransactionResponse!Create a new Cardano Transfer
There are 4 types of Cardano transactions: PAYMENT, STAKE, UNSTAKE, and WITHDRAWAL
transactionInputCreateCardanoPaymentTransactionInput!
createCardanoStakeTransactionCreateCardanoTransactionResponse!Create a new Cardano Stake Transaction
transactionInputCreateCardanoStakeTransactionInput!
createCardanoUnstakeTransactionCreateCardanoTransactionResponse!Create a new Cardano Unstake Transaction
transactionInputCreateCardanoUnstakeTransactionInput!
createCardanoWithdrawalTransactionCreateCardanoTransactionResponse!Create a new Cardano Withdrawal Transaction
transactionInputCreateCardanoWithdrawalTransactionInput!
createSubstratePaymentTransactionCreateSubstrateTransactionResponse!
transactionInputCreateSubstratePaymentTransactionInput!
createSubstrateStakeTransactionCreateSubstrateTransactionResponse!
transactionInputCreateSubstrateStakeTransactionInput!
createSubstrateAddStakeTransactionCreateSubstrateTransactionResponse!
transactionInputCreateSubstrateAddStakeTransactionInput!
createSubstrateDelegateStakeTransactionCreateSubstrateTransactionResponse!
transactionInputCreateSubstrateDelegateStakeTransactionInput!
createAddressBookEntry ⚠️SuccessResponse!Add new entry to address book
⚠️ DEPRECATED
Deprecated. Use Mutation.createAddressBookEntries instead.
addressBookEntryInputAddressBookEntriesInput!
requestCsvTransactionsRequestTransactionsCsvUsers transactions in csv string, csv will be sent to a registered email, optionally can pass asset and walletId
requestCsvTransactionsInputRequestCsvTransactionsInput!
requestAuditLogAsyncReportRequestResponse!Organisation audit log as csv string, csv will be sent to the registered email
requestAuditLogInputRequestAuditLogInput!
createEvmTransactionLiteCreateEvmTransactionLiteResponse!Lightweight version of createEthereumTransaction which takes a raw transaction and its set of pre-signed signRequests. Returned is the signed rawTransactionBytes.
createTransactionInputCreateEvmTransactionLiteInput!
createSubstrateUnstakeTransactionCreateSubstrateTransactionResponse!
transactionInputCreateSubstrateUnstakeTransactionInput!
createSubstrateRestakeTransactionCreateSubstrateTransactionResponse!
transactionInputCreateSubstrateRestakeTransactionInput!
createSubstrateWithdrawStakeTransactionCreateSubstrateTransactionResponse!
transactionInputCreateSubstrateWithdrawStakeTransactionInput!
createDogePaymentTransactionCreateDogeTransactionResponse!
transactionInputCreateDogePaymentTransactionInput!
createEIP1559TransactionCreateEvmTransactionResponse!EIP1559 transactions
createEIP1559TransactionInputCreateEIP1559TransactionInput!
createEIP2930TransactionCreateEvmTransactionResponse!EIP2930 Transactions
createEIP2930TransactionInputCreateEIP2930TransactionInput!
updateTravelRuleInfoUpdateTransferResponse!Travel rule
authenticationAuthenticationInput
transfers[TransferInput!]!
createOrgApiKeyCreateOrgApiKeyResponse
createOrgApiKeyInputCreateOrgApiKeyInput!
updateOrgApiKeyUpdateOrgApiKeyResponse
updateOrgApiKeyInputUpdateOrgApiKeyInput!
inviteUserSuccessResponse!
inviteUserInputInviteUserInput!
updateUserOrganisationUser!
updateUserInputUpdateUserInput!

Objects#

AccessListItem#

FieldArgumentTypeDescription
addressString!
storageKeys[String!]!

Address#

FieldArgumentTypeDescription
idString!Unique identifier for the address

AddressBook#

FieldArgumentTypeDescription
assetBaseAssetasset if the address book references a known asset
addressString!Chain address
chainChainChain the address belongs to
nameString!Name of the address
labelStringLabel (optional)
memoStringMemo (optional), only supported for some chains
type[AddressBookEntryType!]!
counterpartyCounterpartyInfoInformation of the counterparty that should be used for travel rule if a transaction contains the address of interest (NOTE: only applicable if type contains TRAVEL_RULE)

AddressBookApproval#

FieldArgumentTypeDescription
idID!
addressBookIdID!
statusString!
requesterString
requestedAtString

AddressBookChangeRequestsItem#

FieldArgumentTypeDescription
requestIdString!
addressBookIdString!
stateChangeRequestsStateEnum!
approvalTypeString!
approvalEmails[String!]
approvalEmailQuorumInt
approvedEmails[String!]!
createdAtString!
updatedAtString!

AddressBookChangeRequestsResponse#

FieldArgumentTypeDescription
items[AddressBookChangeRequestsItem!]!
nextTokenString

AddressBookConnection#

FieldArgumentTypeDescription
items[AddressBook!]Array with all the Address Book items
nextTokenStringnextToken for pagination. Not used for now.
whitelistEnabledBooleanWhitelist flag

AddressBookConnectionV2#

FieldArgumentTypeDescription
items[AddressBookV2!]!

AddressBookEntriesConnection#

FieldArgumentTypeDescription
items[AddressBookEntry!]!
nextTokenString

AddressBookEntry#

FieldArgumentTypeDescription
idID
assetBaseAsset
addressString!
chainChain!
nameString!
labelString
memoString
type[AddressBookEntryType!]!
counterpartyCounterpartyInfoV2Information of the counterparty that should be used for travel rule is required if TRAVEL_RULE type is defined (NOTE: only applicable if type contains TRAVEL_RULE)

AddressBookV2#

FieldArgumentTypeDescription
idID!
nameString!
approvalProcessApprovalProcess!
appliesTo[String!]!
approvalEmails[String!]
approvalEmailQuorumInt
approvalWalletIdID
createdAtString
updatedAtString
entriesAddressBookEntriesConnection
addressBookEntriesInputAddressBookEntriesInputV2
entryAddressBookEntry
idID!
addressBookChangeRequestsAddressBookChangeRequestsResponse
addressBookChangeRequestsInputAddressBookChangeRequestsInput

AddressConnection#

FieldArgumentTypeDescription
items[GenericAddress!]The current page of Address objects. This can be an empty array if there are no items on this page - (null for exchange wallets)
nextTokenStringThe token to use to get the next page of Address objects. If items is an empty array then this value should be null

AddressPublicKeyProvenance#

FieldArgumentTypeDescription
unverifiedAddressStringDo not use for transactions, instead derive the address from the public key after verifying it with the trustVaultProvenanceSignature (null for exchange subWallets)
publicKeyString!The sub-wallet's public key
path[String!]!The HD wallet path of the sub-wallet
trustVaultProvenanceSignatureString!The trustvault signature over SHA-256(DER(publicKey + path + walletId))
addressTypeBitcoinAddressTypeBitcoin address type (only available on Bitcoin subWallets)

AllowedDestinationsResponse#

FieldArgumentTypeDescription
assetAssetSymbol!
subWalletIds[String!]!

Amount#

FieldArgumentTypeDescription
valueStringBig decimal in string format
currencyString!could be the asset symbol or fiat currency
timestampStringTimestamp represents how stale the data is
NOTE:
timestamp is either the timestamp when the amount of the asset is queried
or if converted from another currency the timestamp of the convertion rate used
inAmount!convert the value to another currency
NOTE: currently only supports asset -> fiat / assets -> assets
currencyString!

Asset#

FieldArgumentTypeDescription
symbolString!The ticker symbol used to uniquely identify this asset within our systems. This will often match the publicly used ticker symbol, but may diverge where there are multiple matching assets.
nameString!The name of the asset
iconUrlString!The location of a standardised icon for this asset
typeAssetType!The asset type
chainString!The chain the asset belongs to (ETHEREUM / BITCOIN)
dateAddedString!The ISO date that this asset was added to the catalog
decimalPlaceInt!The maximum number of decimal place for the asset
displaySymbolString!Public ticker symbol
contractAddressStringThe contract address of the asset (i.e. ERC20 tokens)

AssetBalance#

FieldArgumentTypeDescription
assetBaseAsset
amountAmount

AsyncReportRequestResponse#

FieldArgumentTypeDescription
emailStringThe email who will receive the auditLog
requestIdString!A unique identifier for this request

Auth#

FieldArgumentTypeDescription
chainInfos[ChainInfo!]!returns a list of all supported chains and information about them (only Ethereum supported for now)
chainInfoChainInfo!returns the information about the chain requested, for EVM pass chain: ETHEREUM chainId: '0x12' if supported
chainChain!
chainIdString

Authentication#

FieldArgumentTypeDescription
encStringEncrypted blob 3 tokens
ivString
tagString

AuthenticationResponse#

FieldArgumentTypeDescription
authenticationAuthentication
pinChallengePinChallenge

BabylonTransactionData#

FieldArgumentTypeDescription
publishResponseCodeInt

Balance#

FieldArgumentTypeDescription
assetAssetAsset object
amountAmountAmount of the asset - optional conversion in the currency given
availableAmountThe available to spend net of any fees (Support on certain exchanges only)

BalanceConnection#

FieldArgumentTypeDescription
items[Balance!]The current page of Asset objects. This can be an empty array if there are no items on this page - (null for exchange wallets)
nextTokenStringThe token to use to get the next page of Wallet objects. If items is an empty array then this value should be null

BitcoinAddress#

FieldArgumentTypeDescription
idString!Unique identifier for the address.
addressTypeBitcoinAddressType!The type (e.g. COMPATIBILITY) of the address generated as displayed in the 'id' field
addressUsageTypeBitcoinAddressUsage!The address usage type (e.g. CHANGE or RECEIVE)
transactionsTransactionConnection!Transactions were received into the given bitcoin address.
limitInt
nextTokenString

BitcoinAddressResults#

AddressCreationResults
This is a type so we can add more properties later, e.g. total number of addresses
FieldArgumentTypeDescription
addressGenericAddress!

BitcoinInput#

see: https://en.bitcoin.it/wiki/Transaction#Input
FieldArgumentTypeDescription
addressString!The address of the UTXO
txIdString!The hash of the transaction that generated the UTXO
outputIndexInt!The specific output in the referenced transaction id above
scriptString!public key + signature over the hash of the transaction
sequenceString!Indicates if the transaction is final. Max value indicates finality (0xFFFFFFFF)
valueInt!The amount of satoshi in the UTXO
publicKeyProvenanceDataBitcoinPublicKeyProvenance!The provenance signature data for the address of the utxo
unverifiedDigestDataTransactionDigestData!IMPORTANT: This should only be used to verify that the digest you created from the transaction input is correct. NEVER sign this digest without verifying!

BitcoinOutput#

FieldArgumentTypeDescription
recipientAddressString!The address of the transaction recipient
amountToSendInt!The amount of satoshi to be sent
publicKeyProvenanceDataBitcoinPublicKeyProvenanceThe provenance signature data for the change address. (Only the change output will have it)

BitcoinPublicKeyProvenance#

FieldArgumentTypeDescription
publicKeyString!The sub-wallet's public key
path[String!]!The HD wallet path of the sub-wallet
trustVaultProvenanceSignatureString!The trustvault signature over SHA-256(DER(publicKey + path + walletId))
unverifiedAddressString!Do not use for transactions, instead derive the address from the public key after verifying it with the trustVaultProvenanceSignature
addressTypeBitcoinAddressType!Bitcoin address type

BitcoinSign#

FieldArgumentTypeDescription
transactionBitcoinTransaction!The raw bitcoin transaction
changeAddressProvenanceBitcoinPublicKeyProvenanceThe provenance signature data for the change address

BitcoinTransaction#

see: https://wiki.bitcoinsv.io/index.php/Bitcoin_Transactions
FieldArgumentTypeDescription
versionInt!
inputs[BitcoinInput!]!The UTXOs to be spent
outputs[BitcoinOutput!]!The recipient(s) of the transaction - including the change address
lockTimeInt!Block height or timestamp when transaction is final
sighashInt!The signature type for the transaction

BlockchainSubWallet#

FieldArgumentTypeDescription
walletInfoWalletInfoWallet Information for this SubWallet
addressStringConvenience property showing the current address. For enhanced security, generate on the address on the client from the subWallet public key after verifying the signature
subWalletIdString!
nameString!name of the subWallet
createdAtString!Creation time stamp (ISO 8601 UTC time)
updatedAtString!Modified time stamp (ISO 8601 UTC time)
walletTypeWalletType!Wallet Type
publicKeyString!The public key of the subWallet - used to generate the address on the client side
chainChain!The chain of the subWallet
trustVaultPublicKeySignatureString!The TrustVault signature over the public key
addressesAddressConnection!Bitcoin Addresses associated with this subWallet, addressType defaults to 'RECEIVE'
limitInt
nextTokenString
addressUsageTypeChainAddressUsage
transactionsTransactionConnection!Transaction connection
limitInt
nextTokenString
assetSymbols[String]
addressString
balanceAssetBalanceassetId: NATIVE, or contract address
chainId: For EVM only, specify hex
assetIdString
chainIdString
balances ⚠️BalanceConnection!List of token assets with balances associated with the subWallet (ETH + ERC20 if Ethereum else BTC on Bitcoin)
NOTE: pagination is not implemented yet - limit and nextToken are currently ignored
⚠️ DEPRECATED
use balance field
limitInt
nextTokenString
totalAmount!The total value of all the tokens associated with the subWallet

BlockchainTransaction#

This represents an asset transfer within a transaction (there could be multiple transfers in a transaction)
FieldArgumentTypeDescription
fromGenericAddress!The exchange the transaction is sent from
toGenericAddress!The exchange the transaction is sent to
amountAmount!The amount of the transferred asset
statusTransactionStatus!Status of the transaction
createdAtStringTimestamp the transaction was created at (ISO 8601 UTC date time):
updatedAtStringTimestamp the transaction was last updated (ISO 8601 UTC date time):
feeAmount!The transaction cost paid to the network for processing the transaction
transactionHashString!the unique identifier of the transaction
transactionDirectionTransactionDirectionthe direction the transaction was sent
chainTransactionChainRawTransactionChain specific raw transaction

CardanoPublicKeyProvenance#

FieldArgumentTypeDescription
publicKeyString!The sub-wallet's public key
hdWalletPath[String!]!The HD wallet path of the sub-wallet
signatureString!The trustvault signature over SHA-256(DER(publicKey + path + walletId))
addressTypeCardanoAddressType!Cardano address type

ChainInfo#

FieldArgumentTypeDescription
nameChain!the name of the chain (ETHEREUM, BITCOIN, etc..)
symbolString!the native token symbol belonging to the chain (ETH, BTC, BNB, etc...)
feePriceFeePricethe fee price at a specific speed (FAST, MEDIUM, SLOW are supported on all chains)
speedString
feePrices[FeePrice]all the possible feePrices for a given chain (a minimum of 3 items)

ChainInfoDescription#

FieldArgumentTypeDescription
chainIdString
protocolString

ChainRawEthereumTransaction#

FieldArgumentTypeDescription
amountString!The amount in wei that was transferred in the transaction (hex string)
fromString!The address for which the transaction is destined
toStringThe address for which the transaction is destined
blockHeightInt!The height of the block where this transaction is in
rString!The r value of the ECDSA signature
sString!The s value of the ECDSA signature
transactionIndexStringThe index position of the transaction in the block. (hex string - null when its pending)
vString!The recovery id
gasLimitString!The gas limit of the transaction (hex string)
gasPriceString!The gas price per unit of gas of the transaction in wei (hex string)
nonceString!The number of transactions made by the sender prior to this one (hex string)
decodedInputEthDecodedMethodDataThe decoded input data sent along with the transaction
decodedEvents[EthDecodedMethodData!]!The decoded event logs of the transaction (could be empty if there are no events, unsupported events is not included)

ChangePolicyRequest#

FieldArgumentTypeDescription
requestIdString!Unique identifier for the change policy request
policyTemplatePolicyTemplate!The policy change that describe the new delegate/recoverer schedules
recovererTrustVaultSignatureString!The TrustVault signature over the recoverer schedule. Use this to verify the recoverer schedule did indeed came from TrustVault
walletIdString!Unique identifier for the wallet to which the change policy is going to be applied to
unverifiedDigestDataSignData!IMPORTANT: This digest data should only be used to verify that the digest you created from the policyTemplate is correct. NEVER sign this digest without verifying!

ChangePolicyRequestResponse#

FieldArgumentTypeDescription
requests[ChangePolicyRequest!]!The list of change policy requests created

Cluster#

FieldArgumentTypeDescription
typeClusterType
nameString

ContractInfo#

TokenInfo
FieldArgumentTypeDescription
contractAddressString
contractDisplayNameString
chainInfoChainInfoDescription
typeString
erc20TokenInfoERC20TokenInfo

ContractManagementConnection#

FieldArgumentTypeDescription
items[ContractManagementItem]!An array of all tokens
nextTokenStringPagination token

ContractManagementItem#

FieldArgumentTypeDescription
contractInfoContractInfo!token information
subWalletsSubWalletConnection!The addresses that manage the contract

CounterpartyInfo#

FieldArgumentTypeDescription
nameString!
vaspVaspInfo!

CounterpartyInfoV2#

FieldArgumentTypeDescription
nameString!
vaspVaspInfoV2!

CreateBitcoinDraftTransaction#

FieldArgumentTypeDescription
signDataBitcoinSignThe transaction data to be signed
chainRateStringBitcoin rate in desired currency
feeIntThe transaction fee in satoshi
maxAllowedToSendStringThe max allowed to send in satoshi
feeForMaxStringThe fee for the max send amount in satoshi
balanceStringThe current balance of the wallet in satoshi

CreateBitcoinTransactionIdResponse#

FieldArgumentTypeDescription
requestIdStringUnique identifier for the transaction request
signDataBitcoinSignThe transaction data to be signed
chainRateStringBitcoin rate in desired currency
feeIntThe transaction fee in satoshi
maxAllowedToSendStringThe max allowed to send in satoshi
feeForMaxStringThe fee for the max send amount in satoshi
balanceStringThe current balance of the wallet in satoshi

CreateCardanoTransactionResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the transaction
Optional in case sendToDevicesForSigning is false

CreateDogeTransactionResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the transaction
Optional in case sendToDevicesForSigning is false

CreateEthPersonalSignResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the ethereum personal sign request (null if sendToDevicesForSigning is false)
signDataEthPersonalSignDataThe details of message data to be signed

CreateEthSignTypedDataResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the ethereum personal sign request (null if sendToDevicesForSigning is false)
signDataEthSignTypedDataThe details of message data to be signed

CreateEthereumDraftTransaction#

FieldArgumentTypeDescription
signDataEthereumSign!Data needed to sign a transaction
chainRateString!Ethereum rate in desired currency
assetRateString!Token rate in desired currency

CreateEthereumTransactionResponse#

FieldArgumentTypeDescription
requestIdString!The unique identifier for the ethereum transaction request
signDataEthereumSign!Data needed to sign a transaction
chainRateString!Ethereum rate in desired currency
assetRateString!Token rate in desired currency

CreateEvmTransactionLiteResponse#

FieldArgumentTypeDescription
signDataEthereumSign!Data needed to sign a transaction
rawTransactionBytesString!Raw transaction bytes of signed transaction

CreateEvmTransactionResponse#

FieldArgumentTypeDescription
requestIdString!The unique identifier for the ethereum transaction request
signDataEvmSign!Data needed to sign a transaction
chainRateString!Ethereum rate in desired currency
assetRateString!Token rate in desired currency

CreateExchangeTransferResponse#

FieldArgumentTypeDescription
transactionIdString!NOTE: deprecated by trustVaultTransactionId
trustVaultTransactionIdString!The Trustvault transaction id

CreateOrgApiKeyResponse#

FieldArgumentTypeDescription
orgApiKeyDetailsOrgApiKeyDetails!
orgApiKeyString!

CreateRadixTransactionResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the radix transaction sign request

CreateRippleTransactionResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the transaction
signDataTransactionDigestData!IMPORTANT: This should only be used to verify that the digest you created from the transaction input is correct. NEVER sign this digest without verifying!

CreateSolanaTransactionResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the transaction
Optional in case sendToDevicesForSigning is false

CreateSubWalletResponse#

FieldArgumentTypeDescription
subWalletIdString!Unique id for the subWallet
receiveAddressDetailsAddressPublicKeyProvenance!The receive address details of the newly created subWallet

CreateSubstrateTransactionResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the transaction
Optional in case sendToDevicesForSigning is false

CreateXdcNetworkTransactionResponse#

FieldArgumentTypeDescription
requestIdString!The unique identifier for the ethereum transaction request
signDataEthereumSign!Data needed to sign a transaction
chainRateString!Ethereum rate in desired currency
assetRateString!Token rate in desired currency

DeleteAddressBookEntriesResponse#

FieldArgumentTypeDescription
items[DeleteAddressBookEntryResponse!]!

DeleteAddressBookEntryResponse#

FieldArgumentTypeDescription
addressBookEntryIdString!
requestIdString

DeleteAddressBookResponse#

FieldArgumentTypeDescription
addressBookIdID!

DigestData#

FieldArgumentTypeDescription
digestString!The digest of the message input
signDataString!The DER encoded transaction digest and the wallet path
shaSignDataString!The SHA3-256 digest of the signData

DownloadPendingToSign#

FieldArgumentTypeDescription
sizeInt!
sizeInBytesInt!
urlString!

EIP1559Transaction#

FieldArgumentTypeDescription
fromString!Hex - From address
toStringHex - To address
valueStringHex - The value of ETH to send with this transaction
chainIdString!Hex - The chainId e.g. 1 for mainnet or 560048 for Hoodi
nonceString!Hex - The number of transactions a user has already sent (plus 1 for this transaction)
gasLimitString!Hex - Limit of gas used for the transaction execution (wei)
dataStringHex - compiled contract code for the transaction
maxFeePerGasString!Hex - Maximum fee per gas (wei)
maxPriorityFeePerGasString!Hex - Maximum priority fee per gas (wei)
accessList[AccessListItem!]Access list
rStringThe r value of the signature (optional as it will not exist if tx is not signed)
sStringThe s value of the signature (optional as it will not exist if tx is not signed)
vStringThe recovery Id of the Ethereum chain (optional as it will not exist if tx is not signed)

EIP2930Transaction#

FieldArgumentTypeDescription
fromString!Hex - From address
toString!Hex - To address
valueString!Hex - The value of ETH to send with this transaction
chainIdString!Hex - The chainId e.g. 1 for mainnet or 560048 for Hoodi
nonceString!Hex - A counter for the number of transactions sent by the account
gasLimitString!Hex - Limit of gas used for the transaction execution (wei)
dataString!Hex - compiled contract code for the transaction
accessList[AccessListItem!]!Access list
gasPriceString!Hex - Gas price per unit consumed (wei)
rStringThe r value of the signature (optional as it will not exist if tx is not signed)
sStringThe s value of the signature (optional as it will not exist if tx is not signed)
vStringThe recovery Id of the Ethereum chain (optional as it will not exist if tx is not signed)

ERC20TokenInfo#

FieldArgumentTypeDescription
nameString
symbolString
decimalsString
totalSupplyString

EthDecodedArrayParameter#

FieldArgumentTypeDescription
nameStringThe parameter name of the decoded input array, only available on the top level params in EthDecodedMethodData
typeString!The solidity type of the input parameter (bytes, uint, address etc..)
items[EthDecodedParameter!]!The value of the input parameter

EthDecodedMethodData#

FieldArgumentTypeDescription
idString!The keccak hash of method signature in hex string
4 bytes for decodedInput ("0x" + 8 hex strings)
32 bytes for decodedEvents ("0x" + 64 hex strings)
signatureString!The signature of the method the transaction invoked (i.e. transfer(address to, uint256 amount))
params[EthDecodedParameter!]!The decoded parameters of the method

EthDecodedStringParameter#

FieldArgumentTypeDescription
nameStringThe parameter name of the decoded input, only available on the top level params in EthDecodedMethodData
typeString!The solidity type of the input parameter (bytes, uint, address etc..)
valueString!The value of the input parameter

EthPersonalSignData#

FieldArgumentTypeDescription
messageAddressMessageAddress!The message and address from which the message is signed from
hdWalletPathHdWalletPath!The HD wallet path within the BIP32 Wallet
unverifiedDigestDataDigestData!The digest of the message

EthSignTypedData#

FieldArgumentTypeDescription
messageAddressMessageAddress!The message and address from which the message is signed from
hdWalletPathHdWalletPath!The HD wallet path within the BIP32 Wallet
unverifiedDigestDataDigestData!The digest of the message

EthereumSign#

FieldArgumentTypeDescription
transactionEthereumTransaction!An Ethereum Transaction
hdWalletPathHdWalletPath!The HD wallet path within the BIP32 Wallet
unverifiedDigestDataTransactionDigestData!IMPORTANT: This should only be used to verify that the digest you created from the transaction is correct. NEVER sign this digest without verifying!

EthereumTransaction#

FieldArgumentTypeDescription
toString!The address to send this transaction is directed to
valueString!The value of ETH to send with this transaction
chainIdInt!The chainId e.g. 1 for mainnet or 560048 for Hoodi
nonceInt!The number of transactions a user has already sent (plus 1 for this transaction)
gasLimitString!Int (as String) of the gas provided for the transaction execution.
gasPriceStringInt (as String) of the gasPrice used for each paid gas
fromAddressString!The address the transaction is sent from
rStringThe r value of the signature (optional as it will not exist if tx is not signed)
sStringThe s value of the signature (optional as it will not exist if tx is not signed)
vStringThe recovery Id of the Ethereum chain (optional as it will not exist if tx is not signed)
dataStringThe compiled code of a contract OR the hash of the invoked method signature and encoded parameters.

EvmAsset#

FieldArgumentTypeDescription
nameString!
chainIdString!0x prefixed hex
contractAddressString
decimalsIntOnly present for certain known EVM chains
assetSymbolString!
iconUrlString

EvmLegacyTransaction#

FieldArgumentTypeDescription
fromString!Hex - From address
toStringHex - To address
valueStringHex - The value of ETH to send with this transaction
chainIdString!Hex - The chainId e.g. 1 for mainnet or 560048 for Hoodi
nonceString!Hex - The number of transactions a user has already sent (plus 1 for this transaction)
gasLimitString!Hex - Limit of gas used for the transaction execution (wei)
gasPriceStringHex - Gas price used for the transaction execution (wei)
dataStringHex - compiled contract code for the transaction
accessList[AccessListItem!]Access list
rStringThe r value of the signature (optional as it will not exist if tx is not signed)
sStringThe s value of the signature (optional as it will not exist if tx is not signed)
vStringThe recovery Id of the Ethereum chain (optional as it will not exist if tx is not signed)

EvmSign#

FieldArgumentTypeDescription
transactionEvmSignTransaction!An Ethereum Transaction
hdWalletPathHdWalletPath!The HD wallet path within the BIP32 Wallet
unverifiedDigestDataTransactionDigestData!IMPORTANT: This should only be used to verify that the digest you created from the transaction is correct. NEVER sign this digest without verifying!

ExchangeSubWallet#

FieldArgumentTypeDescription
walletInfoWalletInfowallet info
addressStringsubWallet address
subWalletIdString!Unique id for the subWallet. String format of the subWalletId (id/type/index)
nameString!The name of the subWallet
createdAtString!Creation time stamp (ISO 8601 UTC date time):
updatedAtString!Modified time stamp (ISO 8601 UTC date time):
walletTypeWalletType!Wallet Type
transactionsTransactionConnection!Transaction connection
limitInt
nextTokenString
assetSymbols[String]
addressString
exchangeNameStringName of the exchange if its an exchange subWallet
statusExchangeSubWalletStatusstatus of the exchange subWallet
balanceAssetBalanceassetId: NATIVE, or contract address
chainId: For EVM only, specify hex
assetIdString
chainIdString
balances ⚠️BalanceConnection!List of token assets with balances associated with the subWallet (ETH + ERC20 if Ethereum else BTC on Bitcoin)
NOTE: pagination is not implemented yet - limit and nextToken are currently ignored
⚠️ DEPRECATED
use balance field
limitInt
nextTokenString
allowedDestinations[AllowedDestinationsResponse!]!All the wallets that this wallet can send to for each supported asset.
assetAssetSymbol

ExchangeTransaction#

FieldArgumentTypeDescription
fromGenericAddress!The exchange the transaction is sent from
toGenericAddress!The exchange the transaction is sent to
amountAmount!The amount of the transferred asset
statusTransactionStatus!Status of the transaction
createdAtStringTimestamp the transaction was created at (ISO 8601 UTC date time)
updatedAtStringTimestamp the transaction was last updated (ISO 8601 UTC date time)

FeePrice#

FieldArgumentTypeDescription
tipStringthe optional tip or priority fee that can be added in most networks. Same unit as price
speedString!the name of the fee price, typical values are slow, medium and fast.
priceString!price in the unit specified
unitString!unit of the prices given. e.g. wei or satoshi per byte or other chain specific units
waitTimeInSecondsStringestimated wait time (in seconds) for the transaction to be included in a block at this price

GenericAsset#

FieldArgumentTypeDescription
nameString!
assetSymbolString!
decimalsInt
iconUrlString

GenericTransaction#

FieldArgumentTypeDescription
fromGenericAddress!The exchange the transaction is sent from
from.id can be set to empty string if not present
for outbound bitcoin transaction, from.id is the subwallet ID
toGenericAddress!The exchange the transaction is sent to
amountAmount!The amount of the transferred asset
statusTransactionStatus!Status of the transaction
cancelReasonStringReason the Transaction was cancelled
errorCodeStringError code if an error occurred
errorMessageStringError message describing more of the error, the contents may change
createdAtStringTimestamp the transaction was created at (ISO 8601 UTC date time):
updatedAtStringTimestamp the transaction was last updated (ISO 8601 UTC date time):
chainDescriptionString!Free text field describing the chain
transfersTransfersConnection!may be empty until transfers are known
idString!Unique identifier for the transaction
trustVaultInitiatedBoolean!Indicates if the transactions was created and signed from our systems
transactionHashStringunique identifier for the transaction

GenericTransactionConnection#

FieldArgumentTypeDescription
items[GenericTransaction]Array of transactions on this page
nextTokenStringToken used for querying on the next page

GetTransactionCountResponse#

FieldArgumentTypeDescription
countStringNumber of transactions for provided address on provided chainId

HdWalletPath#

The HDWalletPath within the BIP32 Wallet
FieldArgumentTypeDescription
hdWalletPurposeString!Purpose is a constant set to 44' (or 0x8000002C) following the BIP43 recommendation. It indicates that the subtree of this node is used according to this specification
hdWalletCoinTypeString!Coin type is a constant, set for each cryptocoin
hdWalletAccountString!This level splits the key space into independent user identities, so the wallet never mixes the coins across different accounts.
hdWalletUsageString!Constant 0 is used for external chain(e.g. for receiving payments) and constant 1 for internal chain (also known as change addresses)
hdWalletAddressIndexString!Addresses are numbered from index 0 in sequentially increasing manner. This number is used as child index in BIP32 derivation.

InfraOpsClustersConnection#

FieldArgumentTypeDescription
items[InfraOpsCluster!]!

ListApiKeysResponse#

FieldArgumentTypeDescription
orgApiKeysList[OrgApiKeyDetails!]!

MessageAddress#

FieldArgumentTypeDescription
messageString!The message string to be signed
addressString!The address of the public key pair from which the message will be signed from

OfflineCluster#

FieldArgumentTypeDescription
idID!
pendingChangesToSignDownloadPendingToSign
uploadSignedRequestsUrlString

OnlineCluster#

FieldArgumentTypeDescription
idID!

OrgApiKeyDetails#

FieldArgumentTypeDescription
nameString!
roles[Role!]!
apiKeyExpiryDateString!
apiKeyIdString!
enabledBoolean!

Organisation#

FieldArgumentTypeDescription
trustIdString!The trustId
nameString!The Organisation Name
defaultIntermediaryBoolean!Indicates whether the Organisation often acts as an intermediary for transfers on behalf of their customers
canActAsIntermediaryBoolean!Indicates whether the Organisation can act as an intermediary or can only make direct transfers

OrganisationManagement#

FieldArgumentTypeDescription
idID!
listUsersOrganisationUsersConnection
userOrganisationUser
orgUserInputOrgUserInput!

OrganisationUser#

FieldArgumentTypeDescription
emailString!
userTrustIdString!
firstNameString
lastNameString
phoneNumberString
roles[Role!]!
createdAtString

OrganisationUsersConnection#

FieldArgumentTypeDescription
items[OrganisationUser!]!
totalInt!

PinChallenge#

Pin challenge to successfully authenticate
FieldArgumentTypeDescription
firstPinDigitPositionString!
secondPinDigitPositionString!
sessionTokenString!

Policy#

FieldArgumentTypeDescription
walletIdString!The walletId associated with this policy
recovererSchedules[[Schedule]]!Schedule describing the recoverers policy
delegateSchedules[[Schedule]]!Schedule describing the delegates policy
creationTimestampInt!Creation time stamp (unix timestamp)
creationDeadlineInt!Deadline for the creation to policy (unix timestamp) - security feature
masterPublicKeyString!Public key of the HSM
versionInt!The version of the policy

PolicyTemplate#

FieldArgumentTypeDescription
expiryTimestampInt!The epoch timestamp the policy change request is valid until
delegateSchedules[[Schedule!]!]!The schedule that describes which public keys and how many of it is needed to access wallet funds
recovererSchedules[[Schedule!]!]!The schedule that describes which public keys and how many of it is needed to change the wallet policy

Portfolio#

FieldArgumentTypeDescription
totalAmount!The total value of all the assets under the portfolio
balancesBalanceConnection!The asset balance summaries of each of the coins (ETH/BTC)
The balance summaries of each of the asset (i.e. ETH, BTC..)
timestampStringThe timestamp of the portfolio values (ISO 8601 UTC time)

PortfolioConnection#

FieldArgumentTypeDescription
items[Portfolio!]!The current page of Portfolio objects. There will be a portfolio item for each time Period specified in the query
nextTokenStringThe token to use to get the next page of Portfolio objects. If items is an empty array then this value should be null

PortfolioCsv#

FieldArgumentTypeDescription
csvString!CSV portfolio in string format. columns (trustId, subWalletId, asset, value, timestamp)

PublicKeyUser#

A type referring to a User that has signed with this publicKey in the past
FieldArgumentTypeDescription
emailStringemail if user, empty if API Key
descriptionString!Description of the principal
publicKeyString!Device Public Key

RequestIdResponse#

FieldArgumentTypeDescription
requestIdString!Unique identifier for the change policy request

RequestItem#

FieldArgumentTypeDescription
requestIdString!The unique identifier for the request
statusString!The status of the request
typeString!The type of the request - RECOVERY CREATION ETH_TRANSACTION EXTERNAL_ETH_TRANSACTION BTC_TRANSACTION EXCHANGE_TRANSFER, ETH_PERSONAL_SIGN ETH_TYPED_DATA_SIGN
transactionHashStringUnique identifier of the transaction in the blockchain. (only available on BTC_TRANSACTION request type)
signaturesSignaturesThe signatures for the request
rawTransactionBytesStringRaw transaction bytes of the transaction
errorCodeStringError code if an error occurred
errorMessageStringError message describing more of the message, the messages may change
transactionDataTransactionData

RequestTransactionsCsv#

FieldArgumentTypeDescription
emailString!

Schedule#

FieldArgumentTypeDescription
quorumCountInt!Defines the minimum number of public keys needed to sign to satisfy the schedule
keys[String!]!The list of public keys that can sign for the wallet

SignData#

FieldArgumentTypeDescription
signDataString!The DER encoded transaction digest and the wallet path
shaSignDataString!The SHA3-256 digest of the signData

SignDataEncoding#

FieldArgumentTypeDescription
hdWalletPathHdWalletPath!
algorithmString!
unverifiedDigestDataTransactionDigestData!
provenanceKeyInfoCardanoPublicKeyProvenance!

Signatures#

FieldArgumentTypeDescription
derStringDER formatted signature
rawString!r + s signature
rawVrsStringv + r + s signature

SignedTransaction#

FieldArgumentTypeDescription
transactionEthereumTransaction!
transactionDigestString!

SolanaAddress#

FieldArgumentTypeDescription
idString!Unique identifier for the address.
addressUsageTypeSolanaAddressUsage!The address usage type (e.g. RECEIVE or STAKE)

SolanaStakeAddress#

FieldArgumentTypeDescription
idString!Unique identifier for the address.
addressUsageTypeSolanaAddressUsage!The address usage type (e.g. RECEIVE or STAKE)
statusSolanaStakeStatus!The status of the staked address
inactiveBalanceString!The inactive balance
activeBalanceString!The active balance
publicKeyString!The publicKey associated with this stake address

SubWalletConnection#

FieldArgumentTypeDescription
items[SubWallet]The current page of SubWallet objects. This can be an empty array if there are no items on this page
nextTokenStringThe token to use to get the next page of SubWallet objects. If items is an empty array then this value should be null

SubWalletId#

FieldArgumentTypeDescription
idString!The HD wallet id
typeSubWalletType!The subwallet type
indexInt!The HD wallet index of the subwallet

SubWalletSummary#

FieldArgumentTypeDescription
subWalletTypeString!Type of subWallet
deletedIntNumber of deleted subWallets
countIntNumber of SubWallets

SuccessResponse#

FieldArgumentTypeDescription
successBoolean!

TransactionConnection#

Transaction History
Connection object to navigate through the transactions
FieldArgumentTypeDescription
items[Transaction]Array of transactions on this page
nextTokenStringToken used for querying on the next page

TransactionCsv#

FieldArgumentTypeDescription
csvString!CSV in string format.
nextFromDateStringThe date timestamp (ISO 8601 UTC time) to be inputted in the subsequent call to get the truncated transactions.
rowsTruncatedIntAmount of rows was truncated.

TransactionDigestData#

FieldArgumentTypeDescription
transactionDigestString!The transaction digest of the input
signDataString!The DER encoded transaction digest and the wallet path
shaSignDataString!The SHA3-256 digest of the signData

TransactionId#

deprecated because you should use the createEthereumTransactionRaw mutation instead. Not supported after 31st March 2020.
FieldArgumentTypeDescription
transactionIdString

TransactionResponse#

FieldArgumentTypeDescription
statusTransactionResponseStatus
signedTransactionSignedTransaction

Transfer#

FieldArgumentTypeDescription
idString!
fromGenericAddress!from.id can be empty string if not present
from.id is subWalletId for outbound Bitcoin
toGenericAddress!
directionString!RECEIVED | SENT | SELF
assetBaseAsset!
amountAmount!
originatorTravelRuleInfo
beneficiaryTravelRuleInfo
submittedBoolean!Whether the transfer has beeen previously submitted

TransfersConnection#

FieldArgumentTypeDescription
items[Transfer]!space here for additional props, e.g. total etc in future
nextTokenString

TravelRuleInfo#

FieldArgumentTypeDescription
nameString
accountIdString
customerIdString
isCallerBoolean
vaspVaspInfo

UpdateOrgApiKeyResponse#

FieldArgumentTypeDescription
apiKeyIdString!

UpdateTransferResponse#

FieldArgumentTypeDescription
successBoolean!Whether the update was successful

User#

FieldArgumentTypeDescription
securityTokensUserSecureTokensUser's secure tokens
firstNameStringUser's first name
lastNameStringUser's last name
emailStringUser's email
organisationOrganisation!Organisation details
roles[Role]!The roles assigned to the user
portfolioPortfolioConnection!Get the portfolio summary for the user - startDate / endDate is ISO 8601 UTC timestamp
startDateString
endDateString
timePeriodTimePeriod
csvPortfolioPortfolioCsv!Get the portfolio summary broken down by assets for each subWallet a user has in csv string format - startDate / endDate is ISO 8601 UTC timestamp, currency defaults to GBP
NOTE: currently only supports ONE_MONTH_DAILY timePeriod and could fail to get the most recent time point if the endDate timestamp is within the last 30 minutes of the current hour
endDateString!
timePeriodTimePeriod!
currencyString
contractManagementContractManagementConnectionfast query for a single subWallet
ONLY the subWallet details (name, address etc...) and Transactions is supported.
subWalletSubWallet
subWalletIdString!
subWalletsSubWalletConnection!
subWalletIdStringoptional parameter to get the subWallet for the given subWalletId
currencyStringdefaults to GBP
limitIntpagination limit
nextTokenStringpagination next token
searchNameStringoptional parameter to get the wallets matching the given searchName
walletsInfoWalletsInfoConnection!Get Wallets along with associated subwallet summaries
NOTE: pagination is not implemented yet - limit and nextToken are currently ignored
includeDeletedBooleanoptional parameter to include deleted Wallets
includePolicyBooleanoptional parameter to include each Wallet's policy
limitIntpagination limit
nextTokenStringpagination next token
addressBook ⚠️AddressBookConnection
⚠️ DEPRECATED
Deprecated. Use Query.addressBooks instead. Organizations can have multiple address books. this field returns only the entries of all address books and will be removed in a future release.
transactionsGenericTransactionConnection!
limitIntOptional parameter to set number of results per page, max 50
nextTokenStringpagination next token
startDateStringTransactions after this date in ISO format e.g. '2022-11-29T16:52:03.892Z'
endDateStringTransactions before this date in ISO format e.g. '2022-11-29T16:52:03.892Z' defaults to now
transactionGenericTransaction
idString!

UserSecureTokens#

FieldArgumentTypeDescription
hmaciOSStringThe hmac for secure intercom from iOS
hmacWebStringThe hmac for secure intercom from web

Vasp#

FieldArgumentTypeDescription
idString!
nameString!

VaspConnection#

FieldArgumentTypeDescription
items[Vasp]!
nextTokenString

VaspInfo#

FieldArgumentTypeDescription
idString
nameString
typeVaspType

VaspInfoV2#

FieldArgumentTypeDescription
idID
nameStringname of the vasp if no id is provided
typeVaspType!

WalletInfo#

WalletsInfo return Wallet type
FieldArgumentTypeDescription
walletIdString!Unique identifier for the wallet
walletNameStringName of wallet
policyPolicyWallet's signing policy
policyProvenanceSignatureStringWallet's provenance signature
subWalletsSummary[SubWalletSummary]Summary of SubWallets in Wallet
deletedBooleanIs this wallet deleted
clusterCluster!Cluster information for this wallet
uniquePolicyPublicKeys[PublicKeyUser]List of all publicKeys used in the Policy
seedWalletSeed

WalletSeed#

FieldArgumentTypeDescription
encPrivateSeedString

WalletsInfoConnection#

FieldArgumentTypeDescription
items[WalletInfo]The current page of Wallet objects. This can be an empty array if there are no items on this page
nextTokenStringThe token to use to get the next page of Wallet objects. If items is an empty array then this value should be null
defaultWalletIdStringUnique identifier for default wallet

Inputs#

AccessListItemInput#

FieldTypeDescription
addressString!
storageKeys[String!]!

AddSignatureInput#

FieldTypeDescription
signRequests[SignRequest!]!The signature to be added for the requestId
requestIdString!Unique identifier for the request to which the signatures will be added

AddressBookChangeRequestsInput#

FieldTypeDescription
authenticationAuthenticationInput
limitInt
nextTokenString
stateChangeRequestsStateEnum

AddressBookEntriesInput#

FieldTypeDescription
authenticationAuthenticationInput
entries[AddressBookEntryInput!]!

AddressBookEntriesInputV2#

FieldTypeDescription
limitInt
nextTokenString

AddressBookEntryInput#

FieldTypeDescription
addressString!
nameString!
chainChain!
labelString
memoString
type[AddressBookEntryType!]If not set it will be defaulted to ['RECIPIENT']
counterpartyCounterpartyInfoInput

AddressBookInput#

FieldTypeDescription
authenticationAuthenticationInput
addressBookIdID!

AuthenticationInput#

FieldTypeDescription
encString!
ivString!
tagString!

BabylonTransactionInput#

FieldTypeDescription
base64CompiledManifestString!Base64 encoded manifest file
startEpochInclusiveInt!The start epoch
endEpochExclusiveInt!The end epoch
nonceInt!The transaction nonce
tipPercentageIntTip

CardanoPaymentTransactionInput#

FieldTypeDescription
amountString!0x prefixed hexadecimal value of the transaction in Lovelace
toString!Cardano address to send payment to (e.g addr1xyz456)

CardanoStakeTransactionInput#

FieldTypeDescription
poolIdString!Pool Identifier e.g pool1abc123

ClusterInput#

FieldTypeDescription
authenticationAuthenticationInput
clusterIdString!

CounterpartyInfoInput#

FieldTypeDescription
nameString
vaspVaspInfoInput

CreateAddressBookEntriesInput#

FieldTypeDescription
authenticationAuthenticationInput
addressBookIdID!Can be "default" for the default per organisation global address book.
items[CreateAddressBookEntryInput!]!

CreateAddressBookEntryInput#

FieldTypeDescription
addressString!
nameString!
chainChain!
labelString
memoString
type[AddressBookEntryType!]
counterpartyCreateCounterpartyInfoInput

CreateAddressBookInput#

FieldTypeDescription
authenticationAuthenticationInput
approvalProcessApprovalProcess!
nameString!
appliesTo[String!]!If value = '*', it applies to all wallets
approvalEmails[String!]Required if approvalProcess includes EMAIL.
Define a list which will have emails sent to them in order to approve an address book change
approvalEmailQuorumIntRequired if approvalProcess includes EMAIL.
Define how many emails must approve a change before the change is executed.
Must be at least 1 and cannot be greater than the number of approvalEmails provided
approvalWalletIdIDIf approvalProcess=WALLET,
We define the ID of the wallet allowed to approve changes.

CreateBabylonTransactionInput#

FieldTypeDescription
sourceStringA text field identifying where the request to sign came from - your application name should go here
sendToNetworkWhenSignedBooleanRequest that when the transaction is signed by the authorised signer(s), TrustVault will send it directly to the network
sendToDevicesForSigningBooleanIf the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
babylonTransactionInputBabylonTransactionInput!The Babylon transaction details to be signed

CreateBitcoinAddressInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
addressTypeBitcoinAddressTypeOnly COMPATABILITY IS SUPPORTED
addressUsageTypeBitcoinAddressUsage
subWalletIdStringString!The unique identifier for the subWallet you wish to send this transaction from

CreateBitcoinTransactionInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user. Optional for API key authentication
bitcoinTransactionParamsCreateBitcoinTransactionParams!The create bitcoin transaction parameters
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToNetworkWhenSignedBooleanRequest that when the transaction is signed by the authorised signer(s), TrustVault will send it directly to the network
currencyStringThe currency to return the assets in. See docs for supported currencies. defaults to GBP
sendToDevicesForSigningBooleanIf the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.

CreateBitcoinTransactionParams#

FieldTypeDescription
subWalletIdString!The unique identifier for the subWallet you wish to send this transaction from
toString!The address this transaction is directed to
amountTransactionAmount!The value of BTC to send with this transation in satoshis
speedTransactionSpeedThe speed at which you want the network to accept the transaction. This a
dynamic value for the gasPrice and helps determine the fee. The fee is charged
by the network in satoshi. This value is included in the total amount of the transaction.
Defaults to MEDIUM
satoshiPerByteStringThe amount of satoshi you are willing to pay per byte of the transaction

CreateCardanoPaymentTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
cardanoTransactionInputCardanoPaymentTransactionInput!The cardano transaction to be signed

CreateCardanoStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
cardanoTransactionInputCardanoStakeTransactionInput!The cardano transaction to be signed

CreateCardanoUnstakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from

CreateCardanoWithdrawalTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from

CreateChangePolicyRequestInput#

FieldTypeDescription
delegateSchedules[[ScheduleInput!]!]!The schedule that describes which public keys and how many of it is needed to access wallet funds. (Only supports 1 of 1 schedule currently)
walletIdStringUnique identifier for the wallet which the new delegate schedule is going to apply to
If not specified the new delegate schedule will going to be applied to ALL the wallets associated with the user

CreateCounterpartyInfoInput#

FieldTypeDescription
nameString!
vaspCreateVaspInfoV2Input!

CreateDogePaymentTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
dogeTransactionInputDogePaymentTransactionInput!The required fields to create the transaction

CreateEIP1559TransactionInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
transactionEvmEIP1559TransactionThe EthereumTransaction to be signed
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToNetworkWhenSignedBooleanRequest that when the transaction is signed by the authorised signer(s), TrustVault will send it directly to the network
currencyStringThe currency to return the assets in. See docs for supported currencies. defaults to GBP
rpcUrlStringA non-authenticated Rpc Url of a node to submit transactions to

CreateEIP2930TransactionInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
transactionEvmEIP2930Transaction!The EthereumTransaction to be signed
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToNetworkWhenSignedBooleanRequest that when the transaction is signed by the authorised signer(s), TrustVault will send it directly to the network
currencyStringThe currency to return the assets in. See docs for supported currencies. defaults to GBP
rpcUrlStringA non-authenticated Rpc Url of a node to submit transactions to

CreateEthPersonalSignInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
messageAddressMessageAddressInput!The signPersonalMessage to be signed
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBooleanIf the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
signatureEncryptionPublicKeyStringA public key of the caller used to encrypt the signature. Must be on the secp256k1 curve

CreateEthSignTypedDataInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
messageAddressMessageAddressInput!The EthSignTypeData to be signed
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBooleanIf the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
signatureEncryptionPublicKeyStringA public key of the caller used to encrypt the signature. Must be on the secp256k1 curve

CreateEthereumTransactionInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
ethereumTransactionEthereumTransactionInput!The EthereumTransaction to be signed
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToNetworkWhenSignedBooleanRequest that when the transaction is signed by the authorised signer(s), TrustVault will send it directly to the network
currencyStringThe currency to return the assets in. See docs for supported currencies. defaults to GBP
sendToDevicesForSigningBooleanIf the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
rpcUrlStringA non-authenticated Rpc Url of a node to submit transactions to

CreateEvmTransactionLiteInput#

FieldTypeDescription
ethereumTransactionEvmRawTransactionInput!The EthereumTransaction to be signed
sourceString!A text field identifying where the request to sign came from - your application name should go here
signRequests[SignRequest!]!The signatures which satisfy the wallet's policy
expectedDigestString!The digest the user signed (this should include the wallet path)
hdWalletPathHdWalletPathInput!The HD wallet path within the BIP32 Wallet

CreateExchangeTransferInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
exchangeTransferExchangeTransferInput!The ExchangeTransfer to be signed
sourceString!A text field identifying where the request to sign came from - your application name should go here

CreateOrgApiKeyInput#

FieldTypeDescription
authenticationAuthenticationInput
nameString!
roles[Role!]!
apiKeyExpiryDateString!

CreateRadixTransactionInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
radixTransactionInputRadixTransactionInput!The Radix transaction details to be signed

CreateRippleTransactionInput#

FieldTypeDescription
sourceStringA text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBooleanIf the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
rippleTransactionInputRippleTransactionInput!The XRP transaction to be signed

CreateSolanaActivateStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
solanaTransactionInputSolanaActivateStakeTransactionInput!The required fields to create the transaction

CreateSolanaDeactivateStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
solanaTransactionInputSolanaDeactivateStakeTransactionInput!The required fields to create the transaction

CreateSolanaInitialiseStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
solanaTransactionInputSolanaInitialiseStakeTransactionInput!The required fields to create the transaction

CreateSolanaPaymentTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
solanaTransactionInputSolanaPaymentTransactionInput!The required fields to create the transaction

CreateSolanaSplitStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
solanaTransactionInputSolanaSplitStakeTransactionInput!The required fields to create the transaction

CreateSolanaTokenPaymentTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
solanaTransactionInputSolanaTokenPaymentTransactionInput!The required fields to create the transaction

CreateSolanaWithdrawStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
solanaTransactionInputSolanaWithdrawStakeTransactionInput!The required fields to create the transaction

CreateSubWalletInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user
walletIdString!Unique id for the HD wallet
typeSubWalletType!Name of the asset (i.e BTC / ETH)
nameString!Name of the subWallet (i.e BTC / ETH)

CreateSubstrateAddStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
substrateTransactionInputSubstrateAddStakeTransactionInput!The required fields to create the transaction

CreateSubstrateDelegateStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
substrateTransactionInputSubstrateDelegateStakeTransactionInput!The required fields to create the transaction

CreateSubstratePaymentTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
substrateTransactionInputSubstratePaymentTransactionInput!The required fields to create the transaction

CreateSubstrateRestakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
substrateTransactionInputSubstrateRestakeTransactionInput!The required fields to create the transaction

CreateSubstrateStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
substrateTransactionInputSubstrateStakeTransactionInput!The required fields to create the transaction

CreateSubstrateUnstakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
substrateTransactionInputSubstrateUnstakeTransactionInput!The required fields to create the transaction

CreateSubstrateWithdrawStakeTransactionInput#

FieldTypeDescription
sourceString!A text field identifying where the request to sign came from - your application name should go here
sendToDevicesForSigningBoolean!If the transaction should be submitted for devices for signing. Set to false to allow reviewing transaction data. Set to true when you want to send a transaction to devices to sign. Defaults to true.
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
subWalletIdString!The unique identifier for subWallet you wish to sign this transaction from
substrateTransactionInputSubstrateWithdrawStakeTransactionInput!The required fields to create the transaction

CreateVaspInfoV2Input#

FieldTypeDescription
idID
nameStringname of the vasp if no id is provided
typeVaspType!

DeleteAddressBookEntriesInput#

FieldTypeDescription
authenticationAuthenticationInput
addressBookIdID!
addressBookEntryIds[ID!]!

DeleteAddressBookInput#

FieldTypeDescription
authenticationAuthenticationInput
addressBookIdID!

DogePaymentTransactionInput#

FieldTypeDescription
amountString!The 0x prefixed hexadecimal amount in satoshi you would like to send to the 'to' address
toString!Doge address to send payment to.
satoshiPerByteStringOptional, provide a specific satoshiPerByte to use for the transaction fee, 0x prefixed hexadecimal.
Prioritised over speed if provided
speedTransactionSpeedThe speed at which you want the network to accept the transaction. This a
dynamic value for the gasPrice and helps determine the fee. The fee is charged
by the network in satoshi. This value is included in the total amount of the transaction.
Must provide eitherspeed or satoshiPerByte

EditAddressBookInput#

FieldTypeDescription
authenticationAuthenticationInput
addressBookIdID!
appliesTo[String!]The array passed will overwrite the current value stored.
nameString

EthereumTransactionInput#

FieldTypeDescription
toString!The address this transaction is directed to OR the ERC20 token recipient
assetSymbolStringThis TrustVault supported asset you are trying to send. For Ether set this to 'ETH' for ERC20 token, set this to the TrustVault token symbol. (See docs for supported tokens)
valueString!For ETH, the value of ETH to send with this transaction in WEI, for ERC20, the value in base unit. e.g. for a token with 6 decimal places, to send 1 token specify 1000000
speedTransactionSpeedThe speed at which you want the network to accept the transaction. This a
dynamic value for the gasPrice and helps determine the fee. The fee is charged
by the network in ETH. This value is included in the total amount of the
transaction. Defaults to MEDIUM (either speed or gasLimit + gasPrice must be given)
gasLimitStringInt (as String) of the gas provided for the transaction execution (either speed or gasLimit + gasPrice must be given)
gasPriceStringInt (as String) of the gasPrice used for each paid gas (either speed or gasLimit + gasPrice must be given)
fromAddressString!The address the transaction is sent from (This must be owned by the user whose authentication tokens you are using)
nonceIntThe number of transactions made by the sender prior to this one (will be calculated automatically if not given)
chainIdIntThe chainId e.g. 1 for mainnet or 560048 for Hoodi (will be calculated automatically if not given)
dataStringThe compiled code of a contract OR the hash of the invoked method signature and encoded parameters (will be calculated automatically if not given)

EvmEIP1559Transaction#

FieldTypeDescription
fromString!Hex - From address
toStringHex - To address
valueString!Hex - The value of ETH to send with this transaction
chainIdString!Hex - The chainId e.g. 1 for mainnet or 560048 for Hoodi
nonceString!Hex - The number of transactions a user has already sent (plus 1 for this transaction)
gasLimitString!Hex - Limit of gas used for the transaction execution (wei)
dataStringHex - compiled contract code for the transaction, valid values undefined, 0x, 0xdeadbeef etc
maxFeePerGasString!Hex - Maximum fee per gas (wei)
maxPriorityFeePerGasString!Hex - Maximum priority fee per gas (wei)
accessList[AccessListItemInput!]Access list

EvmEIP2930Transaction#

FieldTypeDescription
fromString!Hex - From address
toStringHex - To address
valueString!Hex - The value of ETH to send with this transaction
chainIdString!Hex - The chainId e.g. 1 for mainnet or 560048 for Hoodi
nonceString!Hex - A counter for the number of transactions sent by the account
gasLimitString!Hex - Limit of gas used for the transaction execution (wei)
dataStringHex - compiled contract code for the transaction, valid values undefined, 0x, 0xdeadbeef etc
accessList[AccessListItemInput!]!Access list
gasPriceString!Hex - Gas price per unit consumed (wei)

EvmRawTransactionInput#

FieldTypeDescription
typeIntThe Ethereum transaction envelope type, defaults to 0 (legacy) if not provided
toString!The address this transaction is directed to OR the ERC20 token recipient
valueString!The value of ETH to send with this transactiona
gasLimitStringInt (as String) of the gas provided for the transaction execution.
gasPriceStringInt (as String) - wei
maxPriorityFeePerGasStringInt (as String) - wei
maxFeePerGasStringInt (as String) - wei
fromAddressString!The address the transaction is sent from (This must be owned by the user whose authentication tokens you are using)
nonceIntThe number of transactions made by the sender prior to this one
chainIdIntThe chainId e.g. 1 for mainnet or 560048 for Hoodi
dataStringThe compiled c code of a contract OR the hash of the invoked method signature and encoded parameters

ExchangeTransferInput#

The ExchangeTransferInput to be sent
FieldTypeDescription
fromSubWalletIdString
toSubWalletIdString
valueString!The amount of the asset to be transferred, a decimal integer string in the base unit of the asset e.g. Satoshis for BTC or Wei for ETH
assetSymbolAssetSymbol!The asset to be transferred

ExchangeWalletId#

FieldTypeDescription
idString!The id of the wallet
typeExchangeType!The type of the exchange wallet, i.e. which exchange is it on
indexInt!The 0-based index of the key within the same wallet. This allows us to have multiple exchange accounts
of the same type within a single wallet. This isn't expected right now, but good to be future proof

GetAuthenticationTokensInput#

FieldTypeDescription
emailString!
pinChallengePinChallengeAttempt!

GetTransactionCountInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
chainIdInt!The chainId of the desired transaction count e.g. 1 for mainnet or 560048 for Hoodi
addressString!Address from which to count the number of transaction
walletIdString!Internal Only. Temporarily used to determine whether queuing is turned on for that account/wallet

HdWalletPathInput#

The HDWalletPath within the BIP32 Wallet
FieldTypeDescription
hdWalletPurposeString!Purpose is a constant set to 44' (or 0x8000002C) following the BIP43 recommendation. It indicates that the subtree of this node is used according to this specification
hdWalletCoinTypeString!Coin type is a constant, set for each cryptocoin
hdWalletAccountString!This level splits the key space into independent user identities, so the wallet never mixes the coins across different accounts.
hdWalletUsageString!Constant 0 is used for external chain(e.g. for receiving payments) and constant 1 for internal chain (also known as change addresses)
hdWalletAddressIndexString!Addresses are numbered from index 0 in sequentially increasing manner. This number is used as child index in BIP32 derivation.

InviteUserInput#

FieldTypeDescription
emailString!
firstNameString!
lastNameString!
phoneNumberString!
applicantIdString!
termsAndConditionsString
privacyPolicyString
internalMarketingString
externalMarketingString
permissions[Int!]
roles[Role!]!

ListApiKeysInput#

FieldTypeDescription
authenticationAuthenticationInput

MessageAddressInput#

FieldTypeDescription
messageString!The message string to be signed
addressString!The address of the public key pair from which the message will be signed from
versionStringVersion of the eth_signedtyped_data. defaults to 'V3'. format is currently 'V3' or 'V4'

OrgUserInput#

FieldTypeDescription
authenticationAuthenticationInput
userTrustIdID!

PinChallengeAttempt#

The pin digits the user has to input
FieldTypeDescription
firstPinDigitString!
secondPinDigitString!
sessionTokenString!

PublicKeySignaturePair#

FieldTypeDescription
publicKeyString!The public key of the private key that was used to sign the digest
signatureString!The signature generated when the digest was signed by the private key

RadixTransactionInput#

FieldTypeDescription
amountString!Decimal whole number string
hashString!Transaction hash to sign
typeString!Transaction type (TRANSFER, STAKE, UNSTAKE)
fromString!From address
toString!To address
messageString!Message to display during signing

RequestAuditLogInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
toDateStringThe end date from date in ISO format e.g. '2022-11-29T16:52:03.892Z'. Will default to now
fromDateStringThe initial from date in ISO format e.g. '2022-11-29T16:52:03.892Z'. Will default to one month ago

RequestCsvTransactionsInput#

FieldTypeDescription
authenticationAuthenticationInputThe authentication tokens for the user (optional for API key users)
assetSymbols[String]
toDateString
fromDateString!
countInt
subWalletIdString

RequestSignatureInput#

FieldTypeDescription
authenticationAuthenticationInput!
transactionTransactionInput!
transactionDigestString!
sourceString

RippleTransactionInput#

FieldTypeDescription
amountString!Hexadecimal Value for the number of XRP to send (in drops)
destinationString!XRP Address to send Payment to
destinationTagStringHexadecimal Encoding of the Destination tag

ScheduleInput#

FieldTypeDescription
quorumCountInt!Defines the minimum number of public keys needed to sign to satisfy the schedule
keys[String!]!The list of public keys that can sign for the wallet

SignRequest#

FieldTypeDescription
publicKeySignaturePairs[PublicKeySignaturePair]!The public key and signature pair over the digest

SolanaActivateStakeTransactionInput#

FieldTypeDescription
stakeAddressString!The stakeAddress which inactive funds waiting to be delegated to a voteAddress
voteAddressString!The voteAddress that the stakeAddress will be delegated to

SolanaDeactivateStakeTransactionInput#

FieldTypeDescription
stakeAddressString!The stakeAddress which you would like to deactivate and will not longer be delegated to a voteAddress

SolanaInitialiseStakeTransactionInput#

FieldTypeDescription
newStakeAddressString!The uninitialised address that will become a stake address
amountString!The 0x prefixed hexadecimal amount in lamports which you would like to assign to the newStakeAddress e.g 0xabc123
voteAddressStringOptional - if provided, the newStakeAddress will immediately be delegated to the provided voteAddress

SolanaPaymentTransactionInput#

FieldTypeDescription
amountString!The 0x prefixed hexadecimal amount in lamports you would like to send to the 'to' address
toString!Solana address to send payment to (e.g JBca1tbqWRZs....)

SolanaSplitStakeTransactionInput#

FieldTypeDescription
stakeAddressString!The stakeAddress which is actively staking that will have its funds split to the newStakeAddress
newStakeAddressString!The uninitialised stakeAddress to split funds to
amountString!The 0x prefixed hexadecimal amount in lamports to split to the newStakeAddress

SolanaTokenPaymentTransactionInput#

FieldTypeDescription
mintAddressString!Mint address to identify the token (e.g QzVChBbCYQpJ....)
toString!Solana address to send payment to (e.g JBca1tbqWRZs....)
amountString!The 0x prefixed hexadecimal amount in lamports you would like to send to the 'to' address
decimalsInt!The number of decimals for the token

SolanaWithdrawStakeTransactionInput#

FieldTypeDescription
stakeAddressString!The stakeAddress which has inactive balance and is currently not delegated to a voteAddress
amountString!The 0x prefixed hexadecimal amount in lamports you would like to withdraw from the stateAddress
withdrawAddressString!The address which will receive the inactiveBalance from the stakeAddress

SubWalletIdInput#

FieldTypeDescription
idString!The HD wallet id
typeSubWalletType!The subwallet type
indexInt!The HD wallet index of the subwallet

SubstrateAddStakeTransactionInput#

FieldTypeDescription
amountString!The 0x prefixed hexadecimal amount in plancks you would like to send to the 'to' address
chainStringOptional, chain you would like to operate on. defaults to 'polkadot'
nonceStringOptional, override the nonce used in the transaction, otherwise we will calculate it for you.
immortalBooleanOptional, set to true if you would like the transaction to be immortal, otherwise it needs to be signed and submitted with ~7 hours
tipStringOptional, provide a tip to increase transaction priority, 0x prefixed hexadecimal in plancks

SubstrateDelegateStakeTransactionInput#

FieldTypeDescription
validators[String!]!The validators you would like to nominate. Between 1 and 16 must be provided
chainStringOptional, chain you would like to operate on. defaults to 'polkadot'
nonceStringOptional, override the nonce used in the transaction, otherwise we will calculate it for you.
immortalBooleanOptional, set to true if you would like the transaction to be immortal, otherwise it needs to be signed and submitted with ~7 hours
tipStringOptional, provide a tip to increase transaction priority, 0x prefixed hexadecimal in plancks

SubstratePaymentTransactionInput#

FieldTypeDescription
amountString!The 0x prefixed hexadecimal amount in plancks you would like to send to the 'to' address
toString!Substrate address to send payment to.
chainStringOptional, chain you would like to operate on. defaults to 'polkadot'
nonceStringOptional, override the nonce used in the transaction, otherwise we will calculate it for you.
immortalBooleanOptional, set to true if you would like the transaction to be immortal, otherwise it needs to be signed and submitted with ~7 hours
tipStringOptional, provide a tip to increase transaction priority, 0x prefixed hexadecimal in plancks

SubstrateRestakeTransactionInput#

FieldTypeDescription
amountString!The 0x prefixed hexadecimal amount in plancks you would like to send to the 'to' address
chainStringOptional, chain you would like to operate on. defaults to 'polkadot'
nonceStringOptional, override the nonce used in the transaction, otherwise we will calculate it for you.
immortalBooleanOptional, set to true if you would like the transaction to be immortal, otherwise it needs to be signed and submitted with ~7 hours
tipStringOptional, provide a tip to increase transaction priority, 0x prefixed hexadecimal in plancks

SubstrateStakeTransactionInput#

FieldTypeDescription
amountString!The 0x prefixed hexadecimal amount in plancks you would like to send to the 'to' address
validators[String!]!The validators you would like to nominate. Between 1 and 16 must be provided
chainStringOptional, chain you would like to operate on. defaults to 'polkadot'
nonceStringOptional, override the nonce used in the transaction, otherwise we will calculate it for you.
immortalBooleanOptional, set to true if you would like the transaction to be immortal, otherwise it needs to be signed and submitted with ~7 hours
tipStringOptional, provide a tip to increase transaction priority, 0x prefixed hexadecimal in plancks

SubstrateUnstakeTransactionInput#

FieldTypeDescription
amountString!The 0x prefixed hexadecimal amount in plancks you would like to send to the 'to' address
chainStringOptional, chain you would like to operate on. defaults to 'polkadot'
nonceStringOptional, override the nonce used in the transaction, otherwise we will calculate it for you.
immortalBooleanOptional, set to true if you would like the transaction to be immortal, otherwise it needs to be signed and submitted with ~7 hours
tipStringOptional, provide a tip to increase transaction priority, 0x prefixed hexadecimal in plancks

SubstrateWithdrawStakeTransactionInput#

FieldTypeDescription
chainStringOptional, chain you would like to operate on. defaults to 'polkadot'
nonceStringOptional, override the nonce used in the transaction, otherwise we will calculate it for you.
immortalBooleanOptional, set to true if you would like the transaction to be immortal, otherwise it needs to be signed and submitted with ~7 hours
tipStringOptional, provide a tip to increase transaction priority, 0x prefixed hexadecimal in plancks

TransactionAmount#

FieldTypeDescription
valueString!
currencyString!

TransactionInput#

deprecated because you should use the createEthereumTransactionRaw mutation instead. Not supported after 31st March 2020.
FieldTypeDescription
toString!
valueString!
chainIdInt!
nonceInt!
gasLimitString!
gasPriceString!
fromAddressString!
dataString
vInt!

TransferInput#

FieldTypeDescription
idString!The transfer ID
${transactionId}-${index} e.g. 1245-0
beneficiaryTravelRuleInfoInput!The beneficiary information
originatorTravelRuleInfoInput!The originator information
submitBooleanWhether to submit the transfer for compliance review or not

TravelRuleInfoInput#

FieldTypeDescription
nameStringThe name of the originator
accountIdStringThe account ID of the originator
customerIdStringThe customer ID of the originator
If value >= 1000 EUR, an additional identifier for customer is required
isCallerBoolean!True means the Organisation is the originator/beneficiary (depending on transfer direction of SENT/RECEIVED respectively)
False means that the originator/beneficiary is the User's Organisation is acting as an intermediary OR its an unrelated 3rd party. (depending on the transfer direction)
vaspVaspInfoInputThe VASP (virtual asset service provider) information

UpdateOrgApiKeyInput#

FieldTypeDescription
authenticationAuthenticationInput
apiKeyIdString!
enabledBoolean!

UpdateUserInput#

FieldTypeDescription
userTrustIdID!
enabledBoolean!
roles[Role!]!

VaspInfoInput#

FieldTypeDescription
idString
nameStringname of the vasp if no id is provided
typeVaspType

Enums#

AddressBookEntryType#

ValueDescription
RECIPIENT
TRAVEL_RULE

ApprovalProcess#

ValueDescription
NONE
EMAIL
WALLET

AssetSymbol#

ValueDescription
ETH
BTC

AssetType#

NATIVE - assets that are native the chain (i.e. Etheruem, Bitcoin), ERC20 - Ethereum ERC20 Tokens
ValueDescription
NATIVE
ERC20
BEP2

BitcoinAddressType#

ValueDescription
LEGACY
COMPATIBILITY
NATIVE

BitcoinAddressUsage#

ValueDescription
CHANGE
RECEIVE

CardanoAddressType#

ValueDescription
STAKE
CHANGE

Chain#

The blockchain on which an asset is traded.
ChainInstance (not protocol).
EVM: Generic identifier for Ethereum and all EVM-compatible chains.
EVM_{chainId}: Specific EVM chain (e.g., EVM_56 for BSC, EVM_137 for Polygon).
Used by address book v2 module.
Non-EVM chains use plain names (BITCOIN, SOLANA, etc.)
Legacy values (BINANCE_SMART_CHAIN, ETHEREUM, XDCNETWORK) are supported for backward compatibility.
ValueDescription
EVM
EVM_50
EVM_51
EVM_56
EVM_97
ETHEREUM
BINANCE_SMART_CHAIN
XDCNETWORK
BITCOIN
CARDANO
DOGE
RADIX
RIPPLE
SOLANA
SUBSTRATE
VECHAIN

ChainAddressUsage#

All possible Address Usages across all chains, does not necessarily apply to each chain
ValueDescription
RECEIVE
STAKE
CHANGE

ChangeRequestsStateEnum#

ValueDescription
PENDING
COMPLETED
CANCELLED

ClusterType#

ValueDescription
ONLINE
ULTRA_COLD

ExchangeSubWalletStatus#

ValueDescription
UNINITIALISED
RECEIVE
ALL
TOTP_ONLY

ExchangeType#

ValueDescription
KRAKEN
COINBASE_PRIME
LUNO
BITMEX
VALR
TAGOMI
KRAKEN_FUTURES

ExchangeWalletStatus#

The status of a wallet
UNINITIALISED - A wallet that has not been initialised.Cannot send, receive or see their balances.
RECEIVE - A wallet that has not been initialised but can only receieve.
ALL - A wallet that has been initialised with api keys that can receive , send and see their balances.
TOTP_ONLY A wallet that has been initialised with only TOTP. It can receive transactions.
ValueDescription
UNINITIALISED
RECEIVE
ALL
TOTP_ONLY

Role#

ValueDescription
CNL_TXN
CRE_ADR
CRE_SBW
CRE_TXN
DEL_ADR
DEL_SBW
ADMIN
SIGNER
CLUSTER_MANAGER
CLUSTER_OPS

SolanaAddressUsage#

ValueDescription
RECEIVE
STAKE

SolanaStakeStatus#

ValueDescription
ACTIVE
ACTIVATING
INACTIVE
DEACTIVATING
UNINITIALISED
UNKNOWN

SubWalletType#

ValueDescription
KRAKEN
COINBASE_PRIME
LUNO
BITMEX
ETH
BTC
VALR
TAGOMI
KRAKEN_FUTURES
RADIX
XDCNETWORK
BINANCE_SMART_CHAIN

TimePeriod#

ONE_MONTH_DAILY - daily for the last 31 days
ValueDescription
HOURLY
DAILY
WEEKLY
MONTHLY
ONE_MONTH_DAILY
ONE_WEEK_DAILY
ONE_DAY

TransactionDirection#

The direction the transaction was sent
the transaction was sent to the same address that it came from (sent to yourself)
the client sent a transaction to someone
the client received a transaction from someone
ValueDescription
SELF
SENT
RECEIVED

TransactionResponseStatus#

ValueDescription
PENDING
QUEUED
SIGNED
SUBMITTED
USER_CANCELLED
ERROR
BLOCKED
CONFIRMED

TransactionSpeed#

ValueDescription
SLOW
MEDIUM
FAST

TransactionStatus#

The status that a blockchain transaction or exchange transfer can take.
NOTE: This list is subject to additions, do not assume this is a finalized list
DRAFT - The transaction has not been signed by any users of the account and is not ready to be submitted to the blockchain yet
SIGNED - The transaction has been signed by all necessary users and re-signed by TrustVault / not yet been processed by the Exchange Service
PREPROCESSING - A transfer that has been currently being preprocessed but yet not completed. (ie moved from KRAKEN_FUTURES to KRAKEN_SPOT but not yet confirmed that it has been deposited.).
PREPROCESSED - A transfer has been preprocessed ie; moved from KRAKEN-FUTURES to KRAKEN-SPOT, but not been submitted to the sending exchange/network.
SUBMITTED - The transfer has been submitted to the sending exchange / submitted to the network for processing
ON_CHAIN - The transaction has been sent to the network and included in at least 1 block. Currently waiting for further confirmations to be CONFIRMED (i.e. not yet guaranteed that the block is in the longest chain of that network)
RECEIVED - The receiving exchange has identified the on-chain transaction but has not yet credited it to the client's account.
CREDITED The funds are cleared in the client's account.
CONFIRMED - The transaction has been included in enough blocks to deem it irreversible /
USER_CANCELLED - The transaction was cancelled by a user
POSTPROCESSING - A transfer that has been credited but has not finished being preprocessed (eg moved from Kraken-Spot to Kraken-Futures).
COMPLETED - All the postprocessing activities have successfully finished. ie; moved from KRAKEN-SPOT to KRAKEN-FUTURES.
ERROR - The transaction is in an error state
NOT_AVAILABLE - The transaction status cannot be obtained at this point. Try again later
BLOCKED - The transaction cannot be sent as it is BLOCKED by client defined rules
AWAITING_USER_TRAVEL_RULE - The transaction requires more information to be provided, this can be done on the Bitpanda Custody website
AWAITING_COMPLIANCE - The transaction is being reviewed by our compliance team
AWAITING_SIGNATURES - The transaction is waiting all necessary users to sign the transaction
REJECTED - The transaction has been rejected by the compliance team and cannot be sent
CLEARED - A transaction that did NOT originate from TrustVault was cleared by compliance meaning they can spend any resulting funds received.
ValueDescription
DRAFT
SIGNED
PREPROCESSING
PREPROCESSED
SUBMITTED
ON_CHAIN
RECEIVED
CREDITED
CONFIRMED
USER_CANCELLED
SYSTEM_CANCELLED
POSTPROCESSING
COMPLETED
ERROR
BLOCKED
NOT_AVAILABLE
AWAITING_USER_TRAVEL_RULE
AWAITING_COMPLIANCE
AWAITING_SIGNATURES
REJECTED
CLEARED

VaspType#

ValueDescription
LISTED
UNLISTED
UNKNOWN
UNHOSTED

WalletFilter#

BLOCKCHAIN (i.e. Ethereum, Bitcoin), EXCHANGE (i.e. Coinbase, Kraken)
ValueDescription
BLOCKCHAIN
EXCHANGE
ALL

WalletType#

ValueDescription
EXCHANGE
BLOCKCHAIN
UNIVERSAL

Scalars#

Boolean#

The Boolean scalar type represents true or false.

ID#

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int#

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

String#

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Interfaces#

BaseAsset#

FieldArgumentTypeDescription
nameString!
assetSymbolString!
decimalsInt
iconUrlString
Possible Types: GenericAsset, EvmAsset

ChainRawTransaction#

FieldArgumentTypeDescription
amountString!The amount in wei that was transferred in the transaction - hex string
blockHeightInt!The height of the block where this transaction is in
Possible Types: ChainRawEthereumTransaction

Connection#

FieldArgumentTypeDescription
nextTokenString
Possible Types: AddressBookEntriesConnection, BalanceConnection, SubWalletConnection, WalletsInfoConnection, AddressBookConnection, GenericTransactionConnection, VaspConnection, TransfersConnection, AddressConnection

CreateBitcoinTransactionResponseInterface#

FieldArgumentTypeDescription
signDataBitcoinSignThe transaction data to be signed
chainRateStringBitcoin rate in desired currency
feeIntThe transaction fee in satoshi
maxAllowedToSendStringThe max allowed to send in satoshi
feeForMaxStringThe fee for the max send amount in satoshi
balanceStringThe current balance of the wallet in satoshi
Possible Types: CreateBitcoinDraftTransaction, CreateBitcoinTransactionIdResponse

CreateEthereumTransactionResponseInterface#

FieldArgumentTypeDescription
signDataEthereumSign!Data needed to sign a transaction
chainRateString!Ethereum rate in desired currency
assetRateString!Token rate in desired currency
Possible Types: CreateEthereumDraftTransaction, CreateXdcNetworkTransactionResponse, CreateEthereumTransactionResponse

CreateTransactionResponse#

FieldArgumentTypeDescription
requestIdStringThe unique identifier for the transaction
Optional in case sendToDevicesForSigning is false
Possible Types: CreateSolanaTransactionResponse, CreateCardanoTransactionResponse, CreateSubstrateTransactionResponse, CreateDogeTransactionResponse

EthDecodedParameter#

FieldArgumentTypeDescription
nameStringThe parameter name of the decoded input array, only available on the top level params in EthDecodedMethodData
typeString!The solidity type of the input parameter (bytes, uint, address etc..)
Possible Types: EthDecodedArrayParameter, EthDecodedStringParameter

GenericAddress#

FieldArgumentTypeDescription
idString!
Possible Types: Address, SolanaAddress, SolanaStakeAddress, BitcoinAddress

InfraOpsCluster#

FieldArgumentTypeDescription
idID!
Possible Types: OfflineCluster, OnlineCluster

PublicKeyProvenance#

FieldArgumentTypeDescription
publicKeyString!The sub-wallet's public key
path[String!]!The HD wallet path of the sub-wallet
trustVaultProvenanceSignatureString!The trustvault signature over SHA-256(DER(publicKey + path + walletId))

SubWallet#

FieldArgumentTypeDescription
walletInfoWalletInfoWallet Information for this SubWallet
addressStringsubWallet address
subWalletIdString!Unique id for the subWallet. String format of the subWalletId (id/type/index)
nameString!name of the subWallet
createdAtString!Creation time stamp (ISO 8601 UTC time)
updatedAtString!Modified time stamp (ISO 8601 UTC time)
walletTypeWalletType!SubWallet Type
transactionsTransactionConnection!Transaction connection
limitInt
nextTokenString
assetSymbols[String]
addressString
balanceAssetBalanceassetId: NATIVE, or contract address
chainId: For EVM only, specify hex
assetIdString
chainIdString
balances ⚠️BalanceConnection!List of token assets with balances associated with the subWallet (ETH + ERC20 if Ethereum else BTC on Bitcoin)
NOTE: pagination is not implemented yet - limit and nextToken are currently ignored
⚠️ DEPRECATED
use balance field
limitInt
nextTokenString
Possible Types: BlockchainSubWallet, ExchangeSubWallet

Transaction#

Transaction object
FieldArgumentTypeDescription
fromGenericAddress!The exchange the transaction is sent from
toGenericAddress!The exchange the transaction is sent to
amountAmount!The amount of the transferred asset
statusTransactionStatus!Status of the transaction
createdAtStringTimestamp the transaction was created at (ISO 8601 UTC date time):
updatedAtStringTimestamp the transaction was last updated (ISO 8601 UTC date time):
Possible Types: GenericTransaction, BlockchainTransaction, ExchangeTransaction

Unions#

EvmSignTransaction#

TypeDescription
EIP2930Transaction
EIP1559Transaction

TransactionData#

TypeDescription
BabylonTransactionData
EvmLegacyTransaction
EIP1559Transaction
Previous
Deprecations
Next
TrustVault Public Keys
Built with