Ctrl+K

Create a Wallet Recovery Unsigned Transaction with HSMv3 for V1 Wallets

post/api/v1/{coin}/admin/wallet/{walletId}/recovery

Creates a Wallet Recovery Transaction that returns an unsigned transaction for sweeping all the wallet funds to the recovery address.

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
    Min length: >= 1 characters
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Request Body

userEmail string required
Email of the user who wants to recover their wallet.
Min length: >= 1 characters
destAddress string required
Blockchain address where the funds want to be recovered to.
Min length: >= 1 characters
allowExternal boolean
Set to true if recovering to a non-bitgo address.
utxoFeePerKb number
Fee estimate for UTXO recoveries.
isWrsRecovery boolean
Set to true if this is a WRS recovery to return encryptedPrv.

200 Response

One of
encodedTransaction string required
The unsigned transaction that was built in hex or base64 format.
recoveryId string required
ID of the recovery record tracked by BitGo.

400 Response

One of
name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id