curl --request POST \
--url https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}/recovery-methods \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"approver": "email:user@example.com",
"chain": "base-sepolia",
"recoveryMethods": {
"email": "recovery@example.com",
"type": "email"
}
}
'{
"recoveryMethods": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"tx": {
"chainType": "aptos",
"createdAt": 123,
"id": "<string>",
"onChain": {
"call": {
"data": "<unknown>",
"to": "<string>"
},
"explorerLink": "<string>",
"txId": "<string>"
},
"params": {
"call": {
"abi": [
"<unknown>"
],
"address": "<string>",
"args": [
"<unknown>"
],
"functionName": "<string>"
},
"chain": "abstract"
},
"status": "awaiting-approval",
"walletType": "mpc",
"approvals": {
"pending": [
{
"quorumApprovals": {
"pending": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>"
}
],
"remaining": 123,
"submitted": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>",
"signature": "<string>",
"submittedAt": 123
}
],
"threshold": 123
},
"signer": {
"locator": "<string>",
"type": "quorum"
}
}
],
"submitted": [
{
"quorumApprovals": {
"pending": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>"
}
],
"remaining": 123,
"submitted": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>",
"signature": "<string>",
"submittedAt": 123
}
],
"threshold": 123
},
"signer": {
"locator": "<string>",
"type": "quorum"
}
}
],
"required": 123
},
"completedAt": 123,
"error": {
"message": "<string>",
"reason": "program_error",
"logs": "<unknown>",
"revertData": {}
},
"fees": {
"mode": "project",
"actual": "<unknown>",
"billed": {
"usd": 123
},
"billing": {
"status": "failed"
},
"estimate": "<unknown>"
},
"sendParams": {
"params": {
"recipient": "<string>",
"recipientAddress": "<string>",
"amount": "<string>"
},
"token": "<string>"
}
}
}REST
Add Recovery Method
Add a recovery method to a wallet.
POST
/
2025-06-09
/
wallets
/
{walletLocator}
/
recovery-methods
curl --request POST \
--url https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}/recovery-methods \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"approver": "email:user@example.com",
"chain": "base-sepolia",
"recoveryMethods": {
"email": "recovery@example.com",
"type": "email"
}
}
'{
"recoveryMethods": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"tx": {
"chainType": "aptos",
"createdAt": 123,
"id": "<string>",
"onChain": {
"call": {
"data": "<unknown>",
"to": "<string>"
},
"explorerLink": "<string>",
"txId": "<string>"
},
"params": {
"call": {
"abi": [
"<unknown>"
],
"address": "<string>",
"args": [
"<unknown>"
],
"functionName": "<string>"
},
"chain": "abstract"
},
"status": "awaiting-approval",
"walletType": "mpc",
"approvals": {
"pending": [
{
"quorumApprovals": {
"pending": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>"
}
],
"remaining": 123,
"submitted": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>",
"signature": "<string>",
"submittedAt": 123
}
],
"threshold": 123
},
"signer": {
"locator": "<string>",
"type": "quorum"
}
}
],
"submitted": [
{
"quorumApprovals": {
"pending": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>"
}
],
"remaining": 123,
"submitted": [
{
"member": {
"address": "<string>",
"locator": "<string>",
"type": "api-key"
},
"message": "<string>",
"signature": "<string>",
"submittedAt": 123
}
],
"threshold": 123
},
"signer": {
"locator": "<string>",
"type": "quorum"
}
}
],
"required": 123
},
"completedAt": 123,
"error": {
"message": "<string>",
"reason": "program_error",
"logs": "<unknown>",
"revertData": {}
},
"fees": {
"mode": "project",
"actual": "<unknown>",
"billed": {
"usd": 123
},
"billing": {
"status": "failed"
},
"estimate": "<unknown>"
},
"sendParams": {
"params": {
"recipient": "<string>",
"recipientAddress": "<string>",
"amount": "<string>"
},
"token": "<string>"
}
}
}Authorizations
API key required for authentication
Path Parameters
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>
Body
application/json
- EVM
- Solana
- Stellar
Parameters for adding EVM recovery methods
The recovery method that authorizes this operation.
Examples:
"passkey:cWtP7gmZbd98HbKUuGXx5Q"
"api-key:123456789"
"external-wallet:0x1234567890123456789012345678901234567890"
"server:0x1234567890123456789012345678901234567890"
"email:test@example.com"
"phone:+1234567890"
"device:BIVmCqMz8QJB+se2kJEpGQ..."
"quorum:123e4567-e89b-12d3-a456-426614174000"
The chain where the recovery method will be registered. Accepts the smart-wallet-enabled EVM chains.
Available options:
apechain, arbitrum, arbitrum-sepolia, arbitrumnova, arc, arc-testnet, avalanche, avalanche-fuji, base, base-sepolia, bsc, celo, celo-sepolia, curtis, ethereum, ethereum-sepolia, flow, flow-testnet, mantle, mantle-sepolia, optimism, optimism-sepolia, polygon, polygon-amoy, robinhood-chain, robinhood-chain-testnet, scroll, scroll-sepolia, shape, story, story-testnet, tempo, tempo-testnet, zora, zora-sepolia recoveryMethods
Quorum Signer · objectstringAPI Key Signer · objectDevice Signer · objectServer Signer · objectEmail Signer · objectExternal Wallet Signer · objectPhone Signer · objectPasskey Signer · object
required
The recovery method to add.
Show child attributes
Show child attributes
Response
201 - application/json
The recovery method transaction has been created.
The recovery method being added, with its resolved locator.
- API Key Signer
- Device Signer
- External Wallet Signer
- Passkey Signer
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
Complete transaction response including status, signing requirements, and wallet type specific data
- EVM MPC Wallet
- EVM Smart Wallet
- Stellar Smart Wallet
- Solana Smart Wallet
- Solana MPC Wallet
Show child attributes
Show child attributes
Was this page helpful?