Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet share

Create a wallet share

Share wallet with an existing BitGo user

post/api/v2/{coin}/wallet/{walletId}/share

Path parameters

coinstring required

A cryptocurrency or token ticker symbol.

Example:btc
walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

The wallet ID.

Request body

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

User readable message to display to the share recipient

reshareboolean

Flag for reinviting a user to the wallet. This is required if the invitee has already been invited to the wallet, but has changed their password and needs a new invite

disableEmailboolean

Flag for disabling invite notification email

userstring required
skipKeychainboolean

If true, allows creating wallet shares without a sharing a key (keychain) when the wallet is shared with spend permission.

Example request

{
  "permission": "spend,view",
  "user": "59cd72485007a239fb00282ed480da1f",
  "keychain": {
    "path": "m/1234/1/1"
  }
}

Response

OK

idstring
coinstring

A cryptocurrency or token ticker symbol.

walletstring
walletLabelstring
fromUserstring
toUserstring
permissions'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

Message for the user receiving the share

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

Example response

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