create

Initiates a new sign-up process and returns a SignUp object based on the provided strategy and optional parameters.

Creates a new sign-up instance using the specified strategy.

This method initiates a new sign-up process by sending the appropriate parameters to Clerk's API. It deactivates any existing sign-up process and stores the sign-up lifecycle state in the status property of the new SignUp object. If required fields are provided, the sign-up process can be completed in one step. If not, Clerk's flexible sign-up process allows multi-step flows.

What you must pass to params depends on which sign-up options you have enabled in your Clerk application instance.

Return

A ClerkResult containing either a SignUp object with the current status and details of the sign-up process, or a ClerkErrorResponse if the operation failed. The SignUp.status property reflects the current state of the sign-up.

Parameters

params

The strategy to use for creating the sign-up. See CreateParams for available options.

See also


Creates a new sign-up process and returns a SignUp object based on the provided strategy and optional parameters.

Creates a new sign-up instance using the specified strategy.

This method initiates a new sign-up process by sending the appropriate parameters to Clerk's API. It deactivates any existing sign-up process and stores the sign-up lifecycle state in the status property.

This is a raw json version of the create method that accepts a map of string parameters instead of typed parameters.

Return

A ClerkResult containing either the created SignUp object or a ClerkErrorResponse.

Parameters

params

The parameters for creating the sign-up as a map of string key-value pairs.