Add Wallet Users

Share a wallet with users in your enterprise and assign permissions. See the Guide.

Wallet admins can send wallet-user invitations to people in their enterprise who have a BitGo account. When you share a wallet, you can assign one or more permissions: Admin, Freeze, Spend, Trade, or View.

You must provide the wallet ID, the invitee's user ID, and the desired permissions as a comma-separated list. If granting spend permissions, include the keychain object so the wallet spender can sign with their passphrase.

Prerequisites: You must have completed Get Started and Create Wallets.

API Reference

// 1. Create Wallet Share
export COIN="<ASSET_ID>"
export WALLET_ID="<YOUR_WALLET_ID>"
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
export MESSAGE="<MESSAGE_TO_THE_INVITEE>"
export USER="<INVITEE_USER_ID>"

curl -X POST \
  https://app.bitgo-test.com/api/v2/$COIN/wallet/$WALLET_ID/share \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "permissions": "spend,view",
    "message": "'"$MESSAGE"'",
    "user": "'"$USER"'",
    "keychain": {
      "pub": "string",
      "encryptedPrv": "string",
      "fromPubKey": "string",
      "toPubKey": "string",
      "path": "m/1234/1/1"
  }
}'

// 1. Create Wallet Share
import { BitGoAPI } from '@bitgo/sdk-api';
import { Btc, Tbtc4 } from '@bitgo/sdk-coin-btc';

const bitgo = new BitGoAPI({
  accessToken: '<access_token>',
  env: 'test',
});

const coin = 'tbtc4';
bitgo.register(coin, Tbtc4.createInstance);

// Set the id of the wallet to share.
const walletId = null;

// Set BitGo account email of wallet share recipient.
const recipient = null;

// Set share permissions as a comma-separated list (e.g. 'view,spend').
// Valid permissions to choose from are: view, spend, manage, admin.
const perms = 'view';

// Provide the passphrase for the wallet being shared
const passphrase = null;

async function main() {
  const wallet = await bitgo.coin(coin).wallets().get({ id: walletId });

  const shareResult = await wallet.shareWallet({
    email: recipient,
    walletPassphrase: passphrase,
    permissions: perms,
  });

  console.log('Wallet was shared successfully');
  console.dir(shareResult);
}

main().catch(error => console.log(error))

Response

// 1. Create Wallet Share Response
{
  "id": "string",
  "coin": "string",
  "wallet": "string",
  "walletLabel": "My Wallet",
  "fromUser": "string",
  "toUser": "string",
  "permissions": "spend,view",
  "message": "string",
  "state": "active",
  "enterprise": "string",
  "pendingApprovalId": "string",
  "keychain": {
    "pub": "string",
    "encryptedPrv": "string",
    "fromPubKey": "string",
    "toPubKey": "string",
    "path": "m/1234/1/1"
  }
}