Ctrl+K

Get wallet share

get/api/v2/{coin}/walletshare/{shareId}

Returns a wallet share, requires unlock if the wallet share includes a keychain.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: btc
  • shareIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • skipUnlockboolean
    True, if skipping unlock. Excludes keychain in response.

200 Response

id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coin string required
A cryptocurrency or token ticker symbol.
Example: btc
wallet string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletLabel string required
Example: My Wallet
fromUser string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
toUser string required
A cryptocurrency or token ticker symbol.
Example: btc
permission string
Comma-separated list of privileges for a wallet. Includes: - 'admin' - Can manage wallet policies and users and approve or reject pending approvals. - 'freeze' - Can freeze a wallet, disabling all withdrawals. - 'spend' - Can initiate withdrawals and generate new receive addresses. - 'trade' - Can initiate trades from a Go Account ('trading' wallet type). - 'view' - Can view balances and transactions. Permissions don't overlap. Required parameter if 'reshare' is false.
Allowed values: admin spend trade view
Example: spend,view
message string required
User readable message to display to the share recipient
state string required
The state of wallet share object
Allowed values: pendingapproval active accepted canceled rejected
Example: active
enterprise string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pendingApprovalId string
Only set if this wallet share is currently pending approval
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
keychain object
Only set if this wallet share has an associated keychain
pub string
Sharing user's root public key
encryptedPrv string
Sharing user's private key encrypted under their wallet passphrase
fromPubKey string
Sharing user's derived public key which will be used to calculate the wallet sharing secret.
toPubKey string
Shared-to user's derived public key which will be used to calculate the wallet sharing secret.
path string
BIP32 HD path of the derived public keys (fromPubKey and toPubKey)
Example: m/1234/1/1

401 Response

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