Docs

useSignIn()

The useSignIn() hook provides access to the SignIn object, which allows you to check the current state of a sign-in. This is also useful for creating a custom sign-in flow.

useSignIn() returns

  • Name
    isLoaded
    Type
    boolean
    Description

    A boolean that is set to false until Clerk loads and initializes.

  • Name
    setActive()
    Type
    (params: SetActiveParams) => Promise<void>
    Description

    A function that sets the active session.

  • Name
    signIn
    Type
    SignIn
    Description

    An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.

  • Name
    session
    Type
    Session | string | null
    Description

    The session resource or session ID (string version) to be set as active. If null, the current session is deleted.

  • Name
    organization
    Type
    Organization | string | null
    Description

    The organization resource or organization ID/slug (string version) to be set as active in the current session. If null, the currently active organization is removed as active.

  • Name
    beforeEmit?
    Type
    (session?: Session | null) => void | Promise<any>
    Description

    Callback run just before the active session and/or organization is set to the passed object. Can be used to hook up for pre-navigation actions.

How to use the useSignIn() hook

Check the current state of a sign-in with useSignIn()

Use the useSignIn() hook to check the current state of a sign-in.

pages/sign-in-step.tsx
import { useSignIn } from '@clerk/clerk-react'

export default function SignInStep() {
  const { isLoaded, signIn } = useSignIn()

  if (!isLoaded) {
    // Add logic to handle loading state
    return null
  }

  return <div>The current sign in attempt status is {signIn.status}.</div>
}

The status property of the SignIn object can be one of the following values:

ValuesDescriptiom
completeThe user has been signed in and custom flow can proceed to setActive() to create session.
needs_first_factorThe First Factor verification is missing. One of email_link, email_code, phone_code, web3_metamask_signature, web3_coinbase_wallet_signature or oauth_provider is required to verify user. See First Factor for details.
needs_second_factorThe Second Factor verification is missing. The Second Factor is an optional step to provide additional verification and includes phone_code and totp. See Second Factor for details.
needs_identifierThe user's identifier (email address, phone number, username, etc.) hasn't been provided.
needs_new_passwordThe user needs to set a new password.

Create a custom sign-in flow with useSignIn()

The useSignIn() hook can also be used to build fully custom sign-in flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the useSignIn() hook to create custom flows, check out the custom flow guides.

Feedback

What did you think of this content?

Last updated on