Retrieve user profile data such as email or social login metadata
Crossmint Auth provides a way to retrieve and update user profile data, such as email, social login metadata, and more.
Fields in the User Object
The user object contains the following information:
userId
: User’s unique identifier.email
: User’s email address.phoneNumber
: User’s phone number.google
: User’s Google account data.farcaster
: User’s Farcaster account data.Google Account data contains:
name
: User’s Google display name.picture
: User’s Google profile picture URL.Farcaster Account data contains:
fid
: User’s Farcaster ID.username
: User’s Farcaster username.bio
: User’s Farcaster bio.displayName
: User’s Farcaster display name.pfpUrl
: User’s Farcaster profile image URL.custody
: User’s FID custody address.verifications
: List of the user’s verified addresses.This API requires the users.read
scope.
For server-side operations, use the @crossmint/server-sdk
that provides a getUser
function to fetch user information.
Use the useAuth
react hook from @crossmint/client-sdk-react-ui
to access the user object.
If you would like to use a different framework, contact support
Retrieve user profile data such as email or social login metadata
Crossmint Auth provides a way to retrieve and update user profile data, such as email, social login metadata, and more.
Fields in the User Object
The user object contains the following information:
userId
: User’s unique identifier.email
: User’s email address.phoneNumber
: User’s phone number.google
: User’s Google account data.farcaster
: User’s Farcaster account data.Google Account data contains:
name
: User’s Google display name.picture
: User’s Google profile picture URL.Farcaster Account data contains:
fid
: User’s Farcaster ID.username
: User’s Farcaster username.bio
: User’s Farcaster bio.displayName
: User’s Farcaster display name.pfpUrl
: User’s Farcaster profile image URL.custody
: User’s FID custody address.verifications
: List of the user’s verified addresses.This API requires the users.read
scope.
For server-side operations, use the @crossmint/server-sdk
that provides a getUser
function to fetch user information.
Use the useAuth
react hook from @crossmint/client-sdk-react-ui
to access the user object.
If you would like to use a different framework, contact support