Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet share

Get wallet share V1

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

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

Path parameters

coinstring required

A cryptocurrency or token ticker symbol.

Example:btc
shareIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

skipUnlockboolean

True, if skipping unlock. Excludes keychain in response.

Response

OK

idstring required
coinstring required

A cryptocurrency or token ticker symbol.

walletstring required
walletLabelstring required
fromUserstring required
toUserstring required

A cryptocurrency or token ticker symbol.

permission'admin' | 'spend' | 'trade' | 'view'

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.

messagestring required

User readable message to display to the share recipient

state'pendingapproval' | 'active' | 'accepted' | 'canceled' | 'rejected' required
enterprisestring required
pendingApprovalIdstring

Example response

{
  "id": "59cd72485007a239fb00282ed480da1f",
  "coin": "btc",
  "wallet": "59cd72485007a239fb00282ed480da1f",
  "walletLabel": "My Wallet",
  "fromUser": "59cd72485007a239fb00282ed480da1f",
  "toUser": "btc",
  "permission": "spend,view",
  "state": "active",
  "enterprise": "59cd72485007a239fb00282ed480da1f",
  "pendingApprovalId": "59cd72485007a239fb00282ed480da1f",
  "keychain": {
    "path": "m/1234/1/1"
  }
}