> ## Documentation Index
> Fetch the complete documentation index at: https://docs.privy.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Passkey
> Authenticate users with passkeys using WebAuthn for biometric and device-based login
export const ExpoUserObject = ({description}) => {
return
{description}
The Privy DID which you may use to identify your user on your backend
UNIX timestamp of when the user was created
An array of the user's linked accounts
'apple_oauth'
Email address associated with the user's Apple account
ID of user from Apple's user API
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'custom_auth'
ID of user from custom auth provider
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'discord_oauth'
ID of user from Discord user API response
Email of user from Discord user API response
Username of user from Discord user API response, including the 4-digit
discriminator prefixed by '#'
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'email'
Email address of user account
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'farcaster'
FID of the user from Farcaster user API response
Wallet address of the user from Farcaster user API response (Farcaster wallet
address, not Privy embedded wallet address)
Username of user from Farcaster user API response (does not include the '@')
Display name of user from Farcaster user API response
Bio of user from Farcaster user API response
Profile picture URL of the user from Farcaster user API response
Profile URL of the user from Farcaster user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'github_oauth'
ID of user from GitHub user API response
Email of user from GitHub user API response
Name of user from GitHub user API response
Username of user from GitHub user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'google_oauth'
'sub' pulled from Google-provided JWT with "openid" scope
'email' from Google-provided JWT with "email" scope
'name' from Google-provided JWT with "profile" scope
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'instagram_oauth'
ID of user from Instagram user API response
The name displayed on a user's profile from Instagram's `/me` API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'linkedin_oauth'
ID of user from LinkedIn user API response
Email of user from LinkedIn user API response
Name of user from LinkedIn user API response (does not include the '@')
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'phone'
Phone number of user account (non-international numbers default to US)
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'spotify_oauth'
ID of user from Spotify user API response
Email of user from Spotify user API
The name displayed on a user's profile from Spotify display_name API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'telegram'
ID of a user's telegram account
The first name displayed on a user's telegram account
The last name displayed on a user's telegram account
The username displayed on a user's telegram account
The url of a user's telegram account profile picture
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'twitter_oauth'
ID of user from Twitter user API response
Name of user from Twitter user API response
Username of user from Twitter user API response (does not include the '@')
Profile picture URL of the user from Twitter user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
'wallet'
Type of chain for the wallet: 'ethereum' or 'solana'
Checksummed wallet address
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
;
};
Privy offers the ability to sign up and log users in using a passkey. This lets users access their account simply and securely.
Enable passkey authentication in the [Privy
Dashboard](https://dashboard.privy.io/apps?page=login-methods) before implementing this feature.
## Login with Passkey
To authenticate your users with Privy's out of the box UIs, check out UI components [here](/authentication/user-authentication/ui-component).
Use `loginWithPasskey` from the `useLoginWithPasskey` hook to trigger the passkey login flow.
```jsx theme={"system"}
loginWithPasskey: ({ passkey?: string }) => void
```
Optionally prompt the user to sign in with a specific passkey credential.
### Usage
```jsx theme={"system"}
import { useLoginWithPasskey } from '@privy-io/react-auth';
export default function LoginWithPasskey() {
const { loginWithPasskey } = useLoginWithPasskey();
return (
);
}
```
## Sign up with Passkey
Use `signupWithPasskey` from the `useSignupWithPasskey` hook to trigger the passkey signup flow.
```jsx theme={"system"}
signupWithPasskey: () => void
```
### Usage
```jsx theme={"system"}
import { useSignupWithPasskey } from '@privy-io/react-auth';
export default function SignupWithPasskey() {
const { signupWithPasskey } = useSignupWithPasskey();
return (
);
}
```
## Tracking Flow State
Track the state of the passkey flow via the `state` variable returned by both the
`useLoginWithPasskey` and `useSignupWithPasskey` hooks.
```tsx theme={"system"}
state:
| {status: 'initial'}
| {status: 'error'; error: Error | null}
| {status: 'generating-challenge'}
| {status: 'awaiting-passkey'}
| {status: 'submitting-response'}
| {status: 'done'};
```
The current state of the passkey flow.
The error that occurred during the passkey flow.
## Callbacks
You can optionally pass callbacks into the `useLoginWithPasskey` and `useSignupWithPasskey` hooks to run custom logic after a successful login or signup, or to handle errors that occur during the flow.
### `onComplete`
```tsx theme={"system"}
onComplete: ({user, isNewUser, wasAlreadyAuthenticated, loginMethod, linkedAccount}) => void
```
#### Parameters
The [user object](/user-management/users/the-user-object) returned after successful login or signup."
Whether the user is a new user or an existing user.
Whether the user was already authenticated before the passkey flow.
The login method used to authenticate the user.
The linked account if the user was already authenticated.
### `onError`
```tsx theme={"system"}
onError: (error: Error) => void
```
#### Parameters
The error that occurred during the passkey flow.
## Resources
Get started with React and Privy.
Get started with Next.js and Privy.
Get started with a whitelabel Privy integration.
Follow the [passkeys setup guide](/basics/react-native/advanced/setup-passkeys) to enable passkey authentication in your React Native app.
To authenticate your users with Privy's out of the box UIs, check out UI components [here](/authentication/user-authentication/ui-component#react-native).
## Login with Passkey
Use `loginWithPasskey` from the `useLoginWithPasskey` hook to authenticate users using a passkey. Before using this method, ensure you have setup passkeys as described in this [guide](/basics/react-native/advanced/setup-passkeys).
```tsx theme={"system"}
loginWithPasskey: ({ relyingParty: string }) => Promise
```
### Parameters
The URL origin where your Apple App Site Association or Digital Asset Links are available (e.g. `https://example.com`).
### Response
### Usage
```tsx theme={"system"}
import {useLoginWithPasskey} from '@privy-io/expo/passkey';
export function LoginButton() {
const {loginWithPasskey} = useLoginWithPasskey();
return (
);
}
```
## Sign up with Passkey
Use `signupWithPasskey` from the `useSignupWithPasskey` hook to sign up users using a passkey.
```tsx theme={"system"}
signupWithPasskey: ({ relyingParty: string }) => Promise
```
### Parameters
The URL origin where your Apple App Site Association or Digital Asset Links are available (e.g. `https://example.com`).
### Response
### Usage
```tsx theme={"system"}
import {useSignupWithPasskey} from '@privy-io/expo/passkey';
export function SignupButton() {
const {signupWithPasskey} = useSignupWithPasskey();
return (
);
}
```
## Tracking Flow State
Track the state of the passkey flow via the `state` variable returned by both the
`useLoginWithPasskey` and `useSignupWithPasskey` hooks.
```tsx theme={"system"}
state:
| {status: 'initial'}
| {status: 'error'; error: Error | null}
| {status: 'generating-challenege'}
| {status: 'awaiting-passkey'}
| {status: 'submitting-response'}
| {status: 'done'};
```
{/* spellchecker:disable-line */}
The current state of the passkey flow.
The error that occurred during the passkey flow.
## Callbacks
You can optionally pass callbacks into the `useLoginWithPasskey` and `useSignupWithPasskey` hooks to run custom logic after a successful login or signup, or to handle errors that occur during the flow.
### `onSuccess`
```tsx theme={"system"}
onSuccess: (user: PrivyUser, isNewUser: boolean) => Promise
```
#### Parameters
Whether the user is a new user or an existing user.
#### Usage
```tsx theme={"system"}
import {useLoginWithPasskey} from '@privy-io/expo/passkey';
export function LoginScreen() {
const {loginWithPasskey} = useLoginWithPasskey({
onSuccess(user, isNewUser) {
// show a toast, send analytics event, etc...
},
});
// ...
}
```
### `onError`
```tsx theme={"system"}
onError: (error: Error) => Promise
```
#### Parameters
The error that occurred during the passkey flow.
#### Usage
```tsx theme={"system"}
import {useLoginWithPasskey} from '@privy-io/expo/passkey';
export function LoginScreen() {
const {loginWithPasskey} = useLoginWithPasskey({
onError(error) {
// show a toast, update form errors, etc...
},
});
// ...
}
```
## Resources
Get started with Expo and Privy.
Get started with Expo bare and Privy.
Ensure an [apple-app-site-association (AASA) file is present on your domain](https://developer.apple.com/documentation/Xcode/supporting-associated-domains) in the .well-known directory, and that it contains an entry for your app’s App ID for the webcredentials service.
## Login with Passkey
Use `login` from the `privy.passkey` interface to authenticate an existing user who has already registered a passkey. This method allows returning users to log in using their previously created passkey credentials. Before using this method, ensure you have setup passkeys as described in the passkey setup guide.
```swift theme={"system"}
func login(relyingParty: String) async throws -> PrivyUser
```
### Parameters
The URL origin where your Digital Asset Links are available (e.g., `https://example.com`).
### Returns
The authenticated Privy user
### Usage
```swift theme={"system"}
do {
let user = try await privy.passkey.login(relyingParty: relyingParty)
// Successfully authenticated an existing user with a passkey
} catch {
print("Login failed: \(error.localizedDescription)")
}
```
## Sign up with Passkey
Use `signup` from the `privy.passkey` interface to create a new user account and register a passkey for them. This method creates a new user in your Privy app, whereas `login` authenticates an existing user who has already registered a passkey.
```kotlin theme={"system"}
func signup(relyingParty: String, displayName: String?) async throws -> PrivyUser
```
### Parameters
The URL origin where your Digital Asset Links are available (e.g., `https://example.com`).
An optional display name to associate with the passkey. This name will be shown to the user when selecting which passkey to use for authentication.
### Returns
The authenticated Privy user
### Usage
```swift theme={"system"}
do {
let displayName = "Optional Display Name"
let user = try await privy.passkey.signup(
relyingParty: relyingParty,
displayName: displayName
)
// Successfully created a new user with authenticated by a passkey
} catch {
print("Signup failed: \(error.localizedDescription)")
}
```
Follow the [passkeys setup guide](/basics/android/advanced/setup-passkeys) to enable passkey authentication in your Android app.
## Login with Passkey
Use `login` from the `privy.passkey` interface to authenticate an existing user who has already registered a passkey. This method allows returning users to log in using their previously created passkey credentials. Before using this method, ensure you have setup passkeys as described in the passkey setup guide.
```kotlin theme={"system"}
suspend fun login(relyingParty: String): Result
```
### Parameters
The URL origin where your Digital Asset Links are available (e.g., `https://example.com`).
### Response
Returns a `Result` containing the user object after successful login.
The unique identifier for this user
A list of linked accounts for this user. A linked account can be any of the methods a user
authenticated with, or a user's embedded wallet
ID of user from custom auth provider
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
The unique identifier for this embedded wallet
The wallet address
The chain ID for this wallet
The recovery method configured for this wallet
The HD wallet index (0 is the primary wallet)
The unique identifier for this embedded wallet
The wallet address
The chain ID for this wallet
The recovery method configured for this wallet
The HD wallet index (0 is the primary wallet)
The wallet address
The type of blockchain: ethereum or solana
The chain ID for this wallet
The wallet client type
The connector type used
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
Phone number of user account
Email address of user account
ID of user from Google user API response
Email of user from Google user API response
Name of user from Google user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
ID of user from Twitter user API response
Username of user from Twitter user API response (does not include the '@')
Name of user from Twitter user API response
Email of user from Twitter user API response
Profile picture URL of the user from Twitter user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
ID of user from Discord user API response
Username of user from Discord user API response
Email of user from Discord user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
The credential ID for this passkey
Name of the authenticator device
Browser used to create the passkey
Operating system used to create the passkey
Device used to create the passkey
The public key for this passkey
Whether this passkey is enrolled in multi-factor authentication
UNIX timestamp for when the account was verified
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
The identity token for this user, if configured in the Privy dashboard. This token is an optional
JWT provided by Privy when identity token generation is enabled in the dashboard settings. It
returns null if the user is unauthenticated or if the feature is not configured
A list of the user's embedded Ethereum wallets. These wallets expose a "provider" instance which
can be used to take wallet actions
A list of the user's embedded Solana wallets. These wallets expose a "provider" instance which can
be used to take wallet actions
### Usage
```kotlin theme={"system"}
val result = privy.passkey.login(relyingParty = "https://")
result.fold(
onSuccess = { user ->
// Handle successful login
},
onFailure = { error ->
// Handle login error
}
)
```
## Sign up with Passkey
Use `signup` from the `privy.passkey` interface to create a new user account and register a passkey for them. This method creates a new user in your Privy app, whereas `login` authenticates an existing user who has already registered a passkey.
```kotlin theme={"system"}
suspend fun signup(relyingParty: String, displayName: String? = null): Result
```
### Parameters
The URL origin where your Digital Asset Links are available (e.g., `https://example.com`).
An optional display name to associate with the passkey. This name will be shown to the user when selecting which passkey to use for authentication.
### Response
Returns a `Result` containing the user object after successful signup.
The unique identifier for this user
A list of linked accounts for this user. A linked account can be any of the methods a user
authenticated with, or a user's embedded wallet
ID of user from custom auth provider
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
The unique identifier for this embedded wallet
The wallet address
The chain ID for this wallet
The recovery method configured for this wallet
The HD wallet index (0 is the primary wallet)
The unique identifier for this embedded wallet
The wallet address
The chain ID for this wallet
The recovery method configured for this wallet
The HD wallet index (0 is the primary wallet)
The wallet address
The type of blockchain: ethereum or solana
The chain ID for this wallet
The wallet client type
The connector type used
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
Phone number of user account
Email address of user account
ID of user from Google user API response
Email of user from Google user API response
Name of user from Google user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
ID of user from Twitter user API response
Username of user from Twitter user API response (does not include the '@')
Name of user from Twitter user API response
Email of user from Twitter user API response
Profile picture URL of the user from Twitter user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
ID of user from Discord user API response
Username of user from Discord user API response
Email of user from Discord user API response
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
The credential ID for this passkey
Name of the authenticator device
Browser used to create the passkey
Operating system used to create the passkey
Device used to create the passkey
The public key for this passkey
Whether this passkey is enrolled in multi-factor authentication
UNIX timestamp for when the account was verified
UNIX timestamp for when the account was first verified and linked to the user
UNIX timestamp for when the account was last verified
The identity token for this user, if configured in the Privy dashboard. This token is an optional
JWT provided by Privy when identity token generation is enabled in the dashboard settings. It
returns null if the user is unauthenticated or if the feature is not configured
A list of the user's embedded Ethereum wallets. These wallets expose a "provider" instance which
can be used to take wallet actions
A list of the user's embedded Solana wallets. These wallets expose a "provider" instance which can
be used to take wallet actions
### Usage
```kotlin theme={"system"}
val result = privy.passkey.signup(relyingParty = "https://")
result.fold(
onSuccess = { user ->
// Handle successful signup
},
onFailure = { error ->
// Handle signup error
}
)
```
To enable passkeys for your Flutter app, you need to set them up for both iOS and Android. Follow the [Android passkeys setup guide](/basics/android/advanced/setup-passkeys), and ensure an apple-app-site-association (AASA) file is present on your domain in the .well-known directory that contains an entry for your app's App ID for the webcredentials service.
## Login with Passkey
Use `login` from the `privy.passkey` interface to authenticate an existing user who has already registered a passkey. This method allows returning users to log in using their previously created passkey credentials. Before using this method, ensure you have setup passkeys as described in the passkey setup guide.
```dart theme={"system"}
Future> login({
required String relyingParty,
})
```
### Parameters
The URL origin where your Digital Asset Links are available (e.g., `https://example.com`).
### Response
Returns a `Result` containing the user object after successful login.
### Usage
```dart theme={"system"}
final result = await privy.passkey.login(
relyingParty: "https://",
);
result.fold(
onSuccess: (user) {
// Handle successful login
},
onFailure: (error) {
// Handle login error
},
);
```
## Sign up with Passkey
Use `signup` from the `privy.passkey` interface to create a new user account and register a passkey for them. This method creates a new user in your Privy app, whereas `login` authenticates an existing user who has already registered a passkey.
```dart theme={"system"}
Future> signup({
required String relyingParty,
String? displayName,
})
```
### Parameters
The URL origin where your Digital Asset Links are available (e.g., `https://example.com`).
An optional display name to associate with the passkey. This name will be shown to the user when selecting which passkey to use for authentication.
### Response
Returns a `Result` containing the user object after successful signup.
### Usage
```dart theme={"system"}
final result = await privy.passkey.signup(
relyingParty: "https://",
displayName: "My Passkey", // optional
);
result.fold(
onSuccess: (user) {
// Handle successful signup
},
onFailure: (error) {
// Handle signup error
},
);
```