Docs

useSignUp()

The useSignUp() hook gives you access to the SignUp object, which allows you to check the current state of a sign-up. This is also useful for creating a custom sign-up flow.

useSignUp() 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
    signUp
    Type
    SignUp
    Description

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

SetActiveParams

  • 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 useSignUp() hook

Check the current state of a sign-up with useSignUp()

Use the useSignUp() hook to access the SignUp object and check the current state of a sign-up.

sign-up-step.tsx
import { useSignUp } from '@clerk/clerk-react'

export default function SignUpStep() {
  const { isLoaded, signUp } = useSignUp()

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

  return <div>The current sign-up attempt status is {signUp.status}.</div>
}

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

ValuesDescription
completeThe user has been created and custom flow can proceed to setActive() to create session.
abandonedThe sign-up attempt will be abandoned if it was started more than 24 hours previously.
missing_requirementsA requirement from the Email, Phone, Username settings is missing. For example, in the Clerk Dashboard, the Password setting is required but a password was not provided in the custom flow.

Create a custom sign-up flow with useSignUp()

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

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on