Skip to content
Alchemy Logo

useAddPasskey

function useAddPasskey(mutationArgs?): UseAddPasskeyResult;

Defined in: account-kit/react/src/hooks/useAddPasskey.ts:56

A custom hook to handle the addition of a passkey to an already authenticated account, which includes executing a mutation with optional parameters.

import { useAddPasskey } from "@account-kit/react";
 
const { addPasskey, isAddingPasskey, error } = useAddPasskey({
  // these are optional
  onSuccess: () => {
    // do something on success
  },
  onError: (error) => console.error(error),
});

ParameterTypeDescription

mutationArgs?

Partial<Omit<UseMutationOptions<string[], Error, undefined | void | CredentialCreationOptions, unknown>, "mutationFn" | "mutationKey">>

Optional arguments for the mutation used for adding a passkey. ref

UseAddPasskeyResult

An object containing the addPasskey function, addPasskeyAsync for async execution, a boolean isAddingPasskey to track the mutation status, and any error encountered. ref

Was this page helpful?