Look up end users by identity
Looks up end users. Exactly one lookup type must be provided per request:
-
email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods.
-
oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the
subclaim from the provider’s ID token). Both params must be provided together. -
phoneNumber: looks up a user by their SMS-verified phone number.
-
siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361).
Returns all matching end users. If no end users match, an empty array is returned.
This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.
Authorizations
A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.
Query Parameters
The OAuth provider to search by. Must be provided together with oauthSubject. The type of OAuth2 provider.
google, apple, x, telegram, github "google"
The OAuth subject (the sub claim from the provider's ID token). Must be provided together with oauthProvider.
The ERC-55 checksummed Ethereum address to search for. Looks up a user by the address they authenticated with via Sign In With Ethereum (EIP-4361). A blockchain address. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana).
1 - 128"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
Response
Successfully looked up end users.
The list of end users matching the lookup.