Clerk docs

Sign Ups

Used to sign up a new user in the current client.

Create Sign-up

Creates or replaces the sign-up on the current Client object.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
Request Body schema: application/x-www-form-urlencoded
transfer
boolean or null
password
string or null
first_name
string or null
last_name
string or null
username
string or null
email_address
string or null
phone_number
string or null
email_address_or_phone_number
string or null
unsafe_metadata
string or null
strategy
string or null

Strategy used to sign up. Can be one of phone_code, email_code, ticket, web3_[provider]_signature reset_password_code, reset_password_phone_code, email_link, oauth_[provider], oauth_token_[provider], saml, password, passkey, google_one_tap

action_complete_redirect_url
string or null
redirect_url
string or null
ticket
string or null
web3_wallet
string or null
captcha_token
string or null
captcha_error
string or null
code
string or null

The authorization or grant code for an OAuth exchange. Only used with oauth_token_[provider] strategies.

token
string or null

The ID token from an OpenID Connect flow. Only used with oauth_token_[provider] and google_one_tap strategies.

legal_accepted
boolean or null

Has the value true if the user has accepted the legal requirements.

oidc_login_hint
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC login_hint parameter of the generated redirect url.

oidc_prompt
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC prompt parameter of the generated redirect url. When using shared credentials this value might be adjusted for security reasons.

Responses
200

Returns the sign up object, as well as the updated session object.

307

Redirect, no body.

400

Request was not successful

403

Request was not successful

404

Request was not successful

409

Request was not successful

422

Request was not successful

post/v1/client/sign_ups
Request samples
application/x-www-form-urlencoded
transfer=true&password=string&first_name=string&last_name=string&username=string&email_address=string&phone_number=string&email_address_or_phone_number=string&unsafe_metadata=string&strategy=string&action_complete_redirect_url=string&redirect_url=string&ticket=string&web3_wallet=string&captcha_token=string&captcha_error=string&code=string&token=string&legal_accepted=true&oidc_login_hint=string&oidc_prompt=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get Sign-up

Returns the sign-up by ID. Must be associated with the current Client object.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
id
required
string

The sign up unique identifier.

Responses
200

Returns the sign up object, as well as the updated session object.

400

Request was not successful

401

Request was not successful

404

Request was not successful

get/v1/client/sign_ups/{id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Update Sign-up

Updates the sign-up object specified by id, with the supplied parameters.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
id
required
string

The sign up unique identifier.

Request Body schema: application/x-www-form-urlencoded
password
string or null
first_name
string or null
last_name
string or null
username
string or null
email_address
string or null
phone_number
string or null
email_address_or_phone_number
string or null
unsafe_metadata
string or null
strategy
string or null

Strategy used to sign up. Can be one of phone_code, email_code, ticket, web3_[provider]_signature reset_password_code, reset_password_phone_code, email_link, oauth_[provider], oauth_token_[provider], saml, password, passkey, google_one_tap

redirect_url
string or null
action_complete_redirect_url
string or null
ticket
string or null
web3_wallet
string or null
code
string or null

The authorization or grant code for an OAuth exchange. Only used with oauth_token_[provider] strategies.

token
string or null

The ID token from an OpenID Connect flow. Only used with oauth_token_[provider] and google_one_tap strategies.

legal_accepted
boolean or null

Has the value true if the user has accepted the legal requirements.

Responses
200

Returns the sign up object, as well as the updated session object.

307

Redirect, no body.

400

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

patch/v1/client/sign_ups/{id}
Request samples
application/x-www-form-urlencoded
password=string&first_name=string&last_name=string&username=string&email_address=string&phone_number=string&email_address_or_phone_number=string&unsafe_metadata=string&strategy=string&redirect_url=string&action_complete_redirect_url=string&ticket=string&web3_wallet=string&code=string&token=string&legal_accepted=true
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Prepare Sign-up Identification Verification

Prepares verification for the sign-up specified by {id}.

Depending on the given strategy, the API will prepare the verification for the current sign-up. In particular,

  • for email_code, the API will send a verification email to the email address currently load up in the sign-up
  • for phone_code, the API will send a verification SMS to the phone number currently load up in the sign-up
SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
id
required
string

The sign up unique identifier.

Request Body schema: application/x-www-form-urlencoded
strategy
string

The verification strategy

  • email_code
  • email_link
  • phone_code
  • web3_metamask_signature
  • web3_coinbase_wallet_signature
  • web3_okx_wallet_signature
  • saml
  • oauth
redirect_url
string or null
action_complete_redirect_url
string or null
oidc_login_hint
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC login_hint parameter of the generated redirect url.

oidc_prompt
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC prompt parameter of the generated redirect url. When using shared credentials this value might be adjusted for security reasons.

Responses
200

Returns the sign up object, as well as the updated session object.

400

Request was not successful

401

Request was not successful

422

Request was not successful

429

Request was not successful

post/v1/client/sign_ups/{id}/prepare_verification
Request samples
application/x-www-form-urlencoded
strategy=string&redirect_url=string&action_complete_redirect_url=string&oidc_login_hint=string&oidc_prompt=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Attempt Sign-up Identification Verification

Attempts to verify the identification that corresponds to the given strategy using the given verification code.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
id
required
string

The sign up unique identifier.

Request Body schema: application/x-www-form-urlencoded
strategy
string

The verification strategy

Enum: "email_code" "email_link" "phone_code" "web3_metamask_signature" "web3_coinbase_wallet_signature" "web3_okx_wallet_signature" "google_one_tap"
code
string or null

The verification code

signature
string or null

The verification web3 signature

token
string or null

The ID token from an OpenID Connect flow. Only used with oauth_token_[provider] and google_one_tap strategies.

Responses
200

Returns the sign up object, as well as the updated session object.

307

Redirect, no body.

400

Request was not successful

403

Request was not successful

409

Request was not successful

422

Request was not successful

429

Request was not successful

post/v1/client/sign_ups/{id}/attempt_verification
Request samples
application/x-www-form-urlencoded
strategy=email_code&code=string&signature=string&token=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}
➔ Next to User