Ctrl+K

Advanced Wallets - Consolidate and Recover Assets

post/api/v1/{coin}/advancedwallet/recoveryconsolidations

Recover assets from an advanced wallet with a balance in multiple receive addresses. Build, sign, and send a consolidation and recovery, all in one call. Sign using your user and backup keys. Works for both multisignature and MPC recoveries.

Retrieves the private keys from KMS using the provided public keys or common keychain, then signs and returns the broadcastable transaction hex.

Note: This endpoint only works when AWM and MBE are running in recovery mode.

To recover assets from an advanced wallet with a balance only in the base address, use Advanced Wallets - Recover Assets.

Use this endpoint only with advanced wallets. For other wallet types, use the Wallet Recovery Wizard.

Path Parameters

  • coinstringRequired

Request Body

userPub string
The user's public key for standard multisig wallets. Required for onchain multisig recovery consolidations.
Example: xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y
backupPub string
The backup public key for standard multisig wallets. Required for onchain multisig recovery consolidations.
Example: xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y
bitgoPub string
The BitGo public key for standard multisig wallets. Required for onchain UTXO multisig recovery consolidations.
Example: xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y
multisigType string required
The type of wallet to recover - onchain: Traditional multisig wallets. - tss: Threshold Signature Scheme wallets.
Allowed values: onchain tss
Example: onchain
commonKeychain string
The common keychain for TSS wallets. Required when multisigType is 'tss'.
Example: 0280ec751d3b165a48811b2cc90f90dcf323f33e8bcaadc0341e1e010adcdcf7005afde80dd286d65b6be947af0424dd1e9f7611f3d20e02a4fc84ad8c8b74c1a5
tokenContractAddress string
The token contract address for token recovery (e.g., ERC20 tokens on Ethereum or SPL tokens on Solana). Required when recovering specific tokens instead of the native coin.
Example: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" // USDC on Solana
startingScanIndex number
The starting index to scan for addresses to consolidate. Useful for limiting the scan range for better performance.
Example: 0
endingScanIndex number
The ending index to scan for addresses to consolidate. Useful for limiting the scan range for better performance.
Default: 20
Example: 100
apiKey string
API key for blockchain explorer services. Required for some coins to build recovery transactions.
Example: v2x8d5e46cf15a7b9b7xc60685d4f56xd8bd5f5cdcef3c1e9d4399c955d587179b
durableNonces object
Durable nonces configuration for Solana transactions. Provides transaction durability for Solana recovery operations. Refer to https://github.com/BitGo/wallet-recovery-wizard/blob/master/DURABLE_NONCE.md on durable nonce creation.
publicKeys array[string] required
Array of public keys associated with the durable nonce.
Example: ["BurablNonc1234567890123456789012345678901","BurablNonc1234567890123456789012345678902"]
secretKey string required
The secret key of the durable nonce account.
Example: 3XNrU5JSPs2VnZCLnWK8GDzB6Pqoy3tYNMJJVesKBXnGqRxwdXDg2QKgv7E9a6QbAiKnLHSxysKWgXDKNdfXZCQM

200 Response

400 Response

error string required
The error name
details string required
Error details

404 Response

error string required
The error name
details string required
Error details

409 Response

error string required
The error name
details string required
Error details

422 Response

error string required
The error name
details string required
Error details

500 Response

error string required
The error name
details string required
Error details

501 Response

error string required
The error name
details string required
Error details