Create a wallet share

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

Share wallet with an existing BitGo user

Path Parameters

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

Request Body

permissions string
Comma-separated list of permissions (view, spend, admin) which are granted by this share. Required if "reshare" is false.
Example: spend,view
message string
User readable message to display to the share recipient
reshare boolean
Flag for reinviting a user to the wallet <br/> This is required if the invitee has already been invited to the wallet, but has changed their password and needs a new invite
disableEmail boolean
Flag for disabling invite notification email
user string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
keychain object
Key passed to the receiving user, included if the wallet was shared with spend permission
pub string
One of wallet pub (onchain), commonPub (BLS) or commonKeychain (TSS)
encryptedPrv string
Private key of the user sharing the wallet encrypted under their wallet passphrase
fromPubKey string
Derived public key of the user sharing the wallet
toPubKey string
Derived public key of the user receiving the share
path string
BIP32 HD path of the derived public keys (fromPubKey and toPubKey)
Example: m/1234/1/1
skipKeychain boolean
If true, allows creating wallet shares without a sharing a key (keychain) when the wallet is shared with spend permission.

200 Response

id string
Wallet share id
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coin string
Coin of the wallet
Example: btc
wallet string
Wallet id
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletLabel string
Example: My Wallet
fromUser string
Id of the user sharing the wallet
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
toUser string
Id of the user receiving the share
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
permissions string
Comma-separated list of permissions which are granted by this share
Allowed values: admin view spend
Example: spend,view
message string
Message for the user receiving the share
state string
State of the share
Allowed values: pendingapproval active accepted canceled rejected
Example: active
enterprise string
If the wallet belongs to an enterprise, the id of that enterprise
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pendingApprovalId string
If the share generated a pending approval, the id of that pending approval
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
keychain object
Key passed to the receiving user, included if the wallet was shared with spend permission
pub string
One of wallet pub (onchain), commonPub (BLS) or commonKeychain (TSS)
encryptedPrv string
Private key of the user sharing the wallet encrypted under their wallet passphrase
fromPubKey string
Derived public key of the user sharing the wallet
toPubKey string
Derived public key of the user receiving the share
path string
BIP32 HD path of the derived public keys (fromPubKey and toPubKey)
Example: m/1234/1/1

400 Response

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