Getting user data

You can get information about the current user from the user object in the usePrivy hook:

const {user} = usePrivy();

For unauthenticated users, the user object will be null. For authenticated users, you can use:

• user.id to get their Privy DID, which you may use to identify your user on your backend
• user.created_at to get a UNIX timestamp of when the user was created.
• user.linked_accounts to get an array of the user's linked accounts

Parsing linked accounts

Each entry in the linked_accounts array has different fields depending on the user data associated with that account type.

See the dropdowns below to see the specific fields associated with each account type.

  AppleAccount

Field	Type	Description
type	'apple_oauth'	N/A
email	string	Email address associated with the user's Apple account.
subject	number	ID of user from Apple's user API.

  CustomJwtAccount

Field	Type	Description
type	'custom_auth'	N/A
custom_user_id	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. Include the 4-digit discriminator prefixed by '#'.

(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.
owner_address	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 '@'.
display_name	string	(Optional) Display name of user from Farcaster user API response.
bio	string	(Optional) Bio of user from Farcaster user API response.
profile_picture_url	string	(Optional) Profile picture URL of the user from Farcaster user API response. Must be a valid image URL.
homepage_url	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).

  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 '@'.
profile_picture_url	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
chain_type	'ethereum' | 'solana'	Type of chain for the wallet. EVM chains ('ethereum') and Solana ('solana') are currently supported.
address	string	Checksummed wallet address.

---

In addition to the fields outlined above, all linked accounts will have the following metadata:

Field	Type	Description
first_verified_at	number	UNIX timestamp for when the account was first verified and linked to the user.
latest_verified_at	number	UNIX timestamp for when the account was first verified and linked to the user.