REST API›Wallet & Transact›Wallet share

GET

Get wallet share

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

Path Params

  • coin string required
    A cryptocurrency or token ticker symbol.
  • shareId string required

    matches ^[0-9a-f]{32}$

Query Params

  • skipUnlock boolean
    True, if skipping unlock. Excludes keychain in response.

Responses

200
OK

Response Body

object

  • id string required

    matches ^[0-9a-f]{32}$

  • coin string required
    A cryptocurrency or token ticker symbol.
  • wallet string required

    matches ^[0-9a-f]{32}$

  • walletLabel string required
  • fromUser string required

    matches ^[0-9a-f]{32}$

  • toUser string required
    A cryptocurrency or token ticker symbol.
  • permission string enum

    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.

    adminspendtradeview
  • message string required
    User readable message to display to the share recipient
  • state string enum required
    pendingapprovalactiveacceptedcanceledrejected
  • enterprise string required

    matches ^[0-9a-f]{32}$

  • pendingApprovalId string
    Only set if this wallet share is currently pending approval
  • keychain object
    Only set if this wallet share has an associated keychain
    keychain object
    • 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)
401
Unauthorized

Response Body

object

  • 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