List Wallet Signers

This page has been updated for Wallets SDK V1. If you are using the previous version, see the previous version docs or the V1 migration guide.

Overview

The List Wallet Signers API allows you to retrieve all operational signers registered on a wallet. Each signer includes its type, locator, and current status. The recovery signer is accessed separately via wallet.recovery. This is useful for displaying signer management UIs, checking which signers are active, or verifying that a new signer was registered successfully.

Prerequisites

You have a wallet created
API Key: You have an API key with the scope: wallets.read. In staging, all scopes are included

Listing Signers

React
Node.js
REST

import { useWallet } from "@crossmint/client-sdk-react-ui";

const { wallet } = useWallet();

const signers = await wallet.signers();

for (const signer of signers) {
    console.log(signer.type, signer.locator, signer.status);
}

With a Wallet Address

import {
    createCrossmint,
    CrossmintWallets,
} from "@crossmint/wallets-sdk";

const crossmint = createCrossmint({
    apiKey: "<your-server-api-key>",
});
const wallets = CrossmintWallets.from(crossmint);

const wallet = await wallets.getWallet(
    "<wallet-address>",
    { chain: "base-sepolia" }
);

const signers = await wallet.signers();

for (const signer of signers) {
    console.log(signer.type, signer.locator, signer.status);
}

With a User Locator

const wallet = await wallets.getWallet(
    "email:user@example.com",
    { chain: "base-sepolia" }
);

const signers = await wallet.signers();
console.log(signers);

Fetch the wallet details — signers are included in the response under the config field.

curl --request GET \
    --url 'https://staging.crossmint.com/api/2025-06-09/wallets/<walletAddress>' \
    --header 'X-API-KEY: <your-server-api-key>'

You can also retrieve a specific signer by its locator:

curl --request GET \
    --url 'https://staging.crossmint.com/api/2025-06-09/wallets/<walletAddress>/signers/<signerLocator>' \
    --header 'X-API-KEY: <your-server-api-key>'

See the Get Signer API reference for full parameter details and to test requests in the playground.

Checking If a Signer Is Registered

Use signerIsRegistered() to check whether a specific signer is already registered on the wallet, without retrieving the full list:

const isRegistered = await wallet.signerIsRegistered("device:abc123");
console.log("Registered:", isRegistered); // true or false

Accessing the Recovery Signer

The recovery signer is separate from the operational signers returned by wallet.signers(). Access it directly:

const recovery = wallet.recovery;
console.log("Recovery type:", recovery.type);

Signer Response Shape

Each operational signer returned by wallet.signers() includes:

Field	Type	Description
`type`	`string`	The signer type — `"device"`, `"passkey"`, `"external-wallet"`, or `"server"`
`locator`	`string`	Unique identifier for the signer (e.g., `"device:abc123"`, `"passkey:xyz789"`)
`status`	`SignerStatus`	Current status — `"success"`, `"pending"`, `"awaiting-approval"`, or `"failed"`

Important Notes

EVM Chain Filtering

For EVM wallets, wallet.signers() only returns signers that have an approval (pending or completed) for the wallet’s specific chain. Signers registered on other chains are not included.

SDK vs REST API Field Names

The SDK uses recovery and signers terminology. When using the REST API directly, the corresponding fields are adminSigner (recovery) and delegatedSigners (operational signers).

Read-Only Wallet from getWallet (Server-Side)

When you retrieve a wallet server-side with getWallet, the wallet is in a read-only state — wallet.signer will be undefined. You must call useSigner() before performing any signing operations. However, wallet.signers() works without an active signer since it is a read operation.

Signer Status Values

success — Signer is fully registered and active
pending — Registration is in progress
awaiting-approval — Signer needs approval from the recovery signer
failed — Registration failed

Next Steps

Add Signers

Configure Recovery

Set up recovery signers for your wallets

Transfer Tokens

Send tokens from your wallet

Introduction

Quickstarts ⚡️

Concepts

Guides

API Reference

Overview

Prerequisites

Listing Signers

With a Wallet Address

With a User Locator

Checking If a Signer Is Registered

Accessing the Recovery Signer

Signer Response Shape

Important Notes

Next Steps

Add Signers

Configure Recovery

Transfer Tokens

Introduction

Quickstarts ⚡️

Concepts

Guides

API Reference

​Overview

​Prerequisites

​Listing Signers

​With a Wallet Address

​With a User Locator

​Checking If a Signer Is Registered

​Accessing the Recovery Signer

​Signer Response Shape

​Important Notes

​Next Steps

Add Signers

Configure Recovery

Transfer Tokens

Overview

Prerequisites

Listing Signers

With a Wallet Address

With a User Locator

Checking If a Signer Is Registered

Accessing the Recovery Signer

Signer Response Shape

Important Notes

Next Steps