Ctrl+K

Get v1 wallet

get/api/v1/wallet/{walletId}

Get one v1 wallet by its "walletId". One "walletId" can map to multiple receive addresses.

Path Parameters

  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

id string
id of the wallet (also the first receiving address)
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
label string
the wallet label, as shown in the UI
Example: My Wallet
isActive boolean
Wallet is not deleted
Example: true
type string
Wallet type
Example: safehd
freeze object
Wallet is frozen
time string <dateTime>
expires string <dateTime>
adminCount integer
Number of admins on the wallet
Example: 1
disableTransactionNotifications boolean
Flag for disabling wallet transaction notifications
Example: false
private object
contains summarised version of keychains
keychains array[object]
canSendInstant boolean
boolean indicating if wallet is eligible to send instant transactions backed by BitGo’s guarantee against double spends
Example: true
permissions string
user's permissions on this wallet
Example: admin,spend,view
admin object
policy information on the wallet's administrators
policy object
users array[object]
tags array[string]
Example: 59cd72485007a239fb00282ed480da1f
approvalsRequired integer
Minimum: >= 1
Example: 1
spendingAccount boolean
Example: true
pendingApprovals array[object]
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
bitcoinAddress string
Example: 1G47mSr3oANXMafVrR8UC4pzV7FEAzo3r9
enterprise string
The Id of the associated enterprise
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletId string
The base address of the associated wallet
Example: 1G47mSr3oANXMafVrR8UC4pzV7FEAzo3r9
creator string
The Id of the User that created the Pending Approval
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
createDate string <date-time>
info object
state string
Allowed values: pending approved rejected
walletUserIds array[string]
an array of all the Users on the Wallet who need to see this Pending Approval
Example: 59cd72485007a239fb00282ed480da1f
approvalsRequired number
Minimum: >= 1
resolvers array[object]
balance integer
the balance, including transactions with 0 confirmations
Example: 39564772124
spendableConfirmedBalance integer
Example: 39564772124
confirmedBalance integer
the confirmed balance
Example: 39564772124
spendableBalance integer
Example: 39564772124
sent integer
Example: 0
received integer
Example: 39564772124
unconfirmedSends integer
Example: 0
unconfirmedReceives integer
Example: 0

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code

404 Response

error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code