Wallet share

Update a wallet share

post/api/v2/{coin}/walletshare/{shareId}

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/v2/{coin}/walletshare/{shareId}
  • Auth
    none declared

Path parameters

coinstring required

A cryptocurrency or token ticker symbol.

Example:btc
shareIdstring required
Example:59cd72485007a239fb00282ed480da1f

Request body

state'pendingapproval' | 'active' | 'accepted' | 'canceled' | 'rejected' required
encryptedPrvstring

Private key encrypted by the accepting user, used when accepting a wallet share to add to the user's keychains for using the wallet. Required when accepting a share that includes a keychain or when userMultiKeyRotationRequired is true.

pubstring

Public key of the accepting user. Required for multi-user-key wallet shares (when userMultiKeyRotationRequired is true). Optional for non-multi-user-key wallets. If provided for non-multi-user-key wallets, it will be validated against the wallet's user key public key.

keyIdstring

Key ID for key rotation verification (deprecated).

signaturestring

Signature for key rotation verification (deprecated).

payloadstring

Payload for key rotation verification (deprecated).

Example request

{
  "state": "active"
}

Response

OK

state'pendingapproval' | 'active' | 'accepted' | 'canceled' | 'rejected'
changedboolean

Example response

{
  "state": "active"
}

Changes

No operation changes recorded.