Create a wallet share

post

https://app.bitgo-test.com/api/v2/{coin}/wallet/{walletId}/share

Share wallet with an existing BitGo user

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

coin

string

required

A cryptocurrency or token ticker symbol.

walletId

string

required

The wallet ID.

Body Params

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.

Allowed:

message

string

User readable message to display to the share recipient

reshare

boolean

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

disableEmail

boolean

Flag for disabling invite notification email

user

string

required

keychain

object

Key passed to the receiving user, included if the wallet was shared with spend permission

skipKeychain

boolean

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

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request