Sign in

Get Wallet By Locator

Changed on

Retrieves a wallet by its locator (address or user identifier and wallet type)

API scope required: wallets.read

get/2025-06-09/wallets/{walletLocator}

Request

  • Base URL: https://staging.crossmint.com/api
  • URL: https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}
  • 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

Response

The record has been successfully retreived.

OR
OR
OR
OR

Example response

{
  "type": "smart",
  "config": {
    "adminSigner": {
      "type": "passkey",
      "id": "cWtP7gmZbd98HbKUuGXx5Q",
      "name": "hgranger",
      "publicKey": {
        "x": "38035223810536273945556366218149112558607829411547667975304293530457502824247",
        "y": "91117823763706733837104303008228095481082989039135234750508288790583476078729"
      },
      "validatorContractVersion": "0.2.0",
      "locator": "passkey:cWtP7gmZbd98HbKUuGXx5Q"
    }
  },
  "address": "0x1234567890123456789012345678901234567890",
  "owner": "email:test@example.com",
  "alias": "my-usdc-wallet"
}

Changes

  • c9d4b4eb588aRevision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 8a293eb59891Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status