Ctrl+K

Get wallet passphrase recovery information

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

Retrieve encrypted user key information which can be used with a wallet keycard to recover or reset the wallet passphrase.

Path Parameters

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

200 Response

recoveryInfo object
path string
Derivation path for the wallet's user key
passcodeEncryptionCode string
Encryption key which was used to encrypt the wallet passphrase at the time of wallet creation. This can be used to decrypt Box D on the wallet keycard.
encryptedPrv string
The wallet's user private key, encrypted with the user's wallet passphrase. In the event of a loss of the user's wallet passphrase, this private key can be decrypted by using the passcodeEncryptionCode to decrypt Box D from the wallet keycard, then using that decrypted wallet passphrase to decrypt the encryptedPrv. This works even if the wallet passphrase has been changed since the creation of the wallet keycard.
encryptedXprv string
V1 wallet's user private key, encrypted with the user's wallet passphrase. In the event of a loss of the user's wallet passphrase, this private key can be decrypted by using the passcodeEncryptionCode to decrypt Box D from the wallet keycard, then using that decrypted wallet passphrase to decrypt the encryptedPrv. This works even if the wallet passphrase has been changed since the creation of the wallet keycard.

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