Sign in

Add Recovery Method

Changed on

Add a recovery method to a wallet.

post/2025-06-09/wallets/{walletLocator}/recovery-methods

Request

  • Base URL: https://staging.crossmint.com/api
  • URL: https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}/recovery-methods
  • Auth: none declared. Required headers: X-API-KEY

Path parameters

walletLocatorstring required

A wallet locator can be of the format:

  • <walletAddress>
  • email:<email>:<chainType>[:<walletType>][:alias:<alias>] (walletType defaults to 'smart')
  • userId:<userId>:<chainType>[:<walletType>][:alias:<alias>] (white label user example)
  • phoneNumber:<phoneNumber>:<chainType>[:<walletType>][:alias:<alias>]
  • twitter:<handle>:<chainType>[:<walletType>][:alias:<alias>]
  • x:<handle>:<chainType>[:<walletType>][:alias:<alias>]
  • me:<chainType>[:<walletType>][:alias:<alias>] (Use when calling from the client side with a client API key)
  • chainType[:<walletType>]:alias:<alias>

Headers

X-API-KEYstring required

API key required for authentication

Request body

OR
OR

Example request

{
  "approver": "passkey:cWtP7gmZbd98HbKUuGXx5Q",
  "recoveryMethods": "passkey:cWtP7gmZbd98HbKUuGXx5Q"
}

Response

The recovery method transaction has been created.

Example response

{
  "tx": {
    "params": {
      "signer": "passkey:cWtP7gmZbd98HbKUuGXx5Q",
      "transaction": {
        "type": "migrate-wallet"
      }
    }
  }
}

Changes