Querying a single user

WARNING

Privy has deprecated getUser where Privy DID is passed as the parameter. It is highly recommended that you use getUser with the identity token instead. Privy rate limits REST API endpoints that you may call from your server. If you suspect your team will require an increased rate limit, please reach out to support!

Use the PrivyClient's getUser method to get a single user by their Privy DID. As a parameter, pass the user's DID as a string:

const user = await privy.getUser('did:privy:XXXXXX');

If a matching user is found, the method will return the corresponding User object. If no matching user is found, the method will throw an error.

Using the REST API

Make a GET request to:

https://auth.privy.io/api/v1/users/<did>

Replace <did> with your desired Privy DID. It should have the format did:privy:XXXXXX.

Below is a sample cURL command for this request:

curl --request GET https://auth.privy.io/api/v1/users/<user-did> \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>"

TIP

Looking for the types of LinkedAccounts?

See a list of the different account types and the data they include

Note:

• Each account should be a JSON object including all the necessary fields for that account type.
  • Valid account types are apple_oauth, 'custom_auth', 'discord_oauth', 'farcaster', 'github_oauth', 'google_oauth', 'instagram_oauth', 'linkedin_oauth', 'spotify_oauth', 'telegram', 'tiktok_oauth', 'twitter_oauth', 'email', 'phone' and 'wallet'.
• If importing a user with a custom_auth account, the custom_auth account must be the only element of the linked_accounts array. It is not permitted to import a user with a custom_auth account and other linked_accounts.
• You must exclude the verifiedAt field.
• The SDK and REST API have different naming conventions. The SDK uses camelCase and the API uses snake_case.

  CustomJwtAccount

Field	Type	Description
type	'custom_auth'	N/A
API: custom_user_id SDK: customUserId	string	ID of user from custom auth provider.

  DiscordAccount

Field	Type	Description
type	'discord_oauth'	N/A
subject	string	ID of user from Discord user API response.
email	string	Email of user from Discord user API response.
username	string	Username of user from Discord user API response.

(See Discord docs)

  EmailAccount

Field	Type	Description
type	'email'	N/A
address	string	Email address of user account.

  FarcasterAccount

Field	Type	Description
type	'farcaster'	N/A
fid	number	FID of the user from Farcaster user API response.
API: owner_address SDK: ownerAddress	string	Wallet address of the user from Farcaster user API response. Note that this is the Farcaster wallet address, and not the Privy embedded wallet address.
username	string	(Optional) Username of user from Farcaster user API response. Do not include the '@'.
API: display_name SDK: displayName	string	(Optional) Display name of user from Farcaster user API response.
bio	string	(Optional) Bio of user from Farcaster user API response.
API: profile_picture_url SDK: profilePictureUrl	string	(Optional) Profile picture URL of the user from Farcaster user API response. Must be a valid image URL.
API: homepage_url SDK: homepageUrl	string	(Optional) Profile URL of the user from Farcaster user API response.

(See Farcaster docs. Note that the Privy import interface differs slightly from the Farcaster public interface in order to maintain consistency with other Privy LinkedAccount types.)

  GithubAccount

Field	Type	Description
type	'github_oauth'	N/A
subject	string	ID of user from GitHub user API response.
email	string	Email of user from GitHub user API response
name	string	Name of user from GitHub user API response
username	string	Username of user from GitHub user API response

(See GitHub docs)

  GoogleAccount

Field	Type	Description
type	'google_oauth'	N/A
subject	string	sub pulled from Google-provided JWT with "openid" scope.
email	string	email from Google-provided JWT with "email" scope.
name	string	name from Google-provided JWT with "profile" scope.

  InstagramAccount

Field	Type	Description
type	'instagram_oauth'	N/A
subject	string	ID of user from Instagram user API response.
username	string	The name displayed on a user's profile from Instagram's /me API response.

(See Instagram docs)

  LinkedinAccount

Field	Type	Description
type	'linkedin_oauth'	N/A
subject	string	ID of user from LinkedIn user API response.
email	string	Email of user from LinkedIn user API response
name	string	Name of user from LinkedIn user API response. Do not include the '@'.

(See Linkedin docs)

  PhoneAccount

Field	Type	Description
type	'phone'	N/A
number	string	Phone number of user account (non-international numbers default to US).

While number is accepted as input, phoneNumber is returned in the response.

  SmartWalletAccount

Field	Type	Description
type	'smart_wallet'	N/A
address	string	Checksummed smart wallet address.
smart_wallet_type	SmartWalletType	One of 'kernel', 'safe', 'biconomy' or 'light_account'

  SpotifyAccount

Field	Type	Description
type	'spotify_oauth'	N/A
subject	string	ID of user from Spotify user API response.
email	string	Email of user from Spotify user API.
name	string	The name displayed on a user's profile from Spotify display_name API response.

(See Spotify docs)

  TelegramAccount

Field	Type	Description
type	'telegram'	N/A
telegram_user_id	string	ID of a user's telegram account.
first_name	string	The first name displayed on a user's telegram account.
last_name	string	(Optional) The last name displayed on a user's telegram account.
username	string	(Optional) The username displayed on a user's telegram account.
photo_url	string	(Optional) The url of a user's telegram account profile picture.

(See Telegram docs)

  TwitterAccount

Field	Type	Description
type	'twitter_oauth'	N/A
subject	string	ID of user from Twitter user API response.
name	string	Name of user from Twitter user API response
username	string	Username of user from Twitter user API response. Do not include the '@'.
API: profile_picture_url SDK: profilePictureUrl	string	(Optional) Profile picture URL of the user from Twitter user API response. Must be a valid image URL.

(See Twitter docs)

  WalletAccount

Field	Type	Description
type	'wallet'	N/A
API: chain_type SDK: chainType	'ethereum'	Type of chain for the wallet. EVM chains ('ethereum') and Solana ('solana') are currently supported.
address	string	Checksummed wallet address.

---

A successful response will include the user object associated with the DID, like below:

{
  "id":"did:privy:cfbsvtqo2c22202mo08847jdux2z",
  "created_at":1667165891,
  "linked_accounts":[
    {
      "type": "wallet",
      "address": "0xABCDEFGHIJKL01234567895C5cAe8B9472c14328",
      "chain_type": "ethereum",
      "chain_id": "eip155:137",
      "wallet_client": "unknown",
      "wallet_client_type": "metamask",
      "connector_type": "injected",
      "verified_at": 1688556783
    }
    {
      "type":"email",
      "address":"user@gmail.com",
      "verified_at":1667350653
    }
  ]
}

If there is no user associated with the provided DID, the API will return an error.