Search…
Sign ups
A Sign up represents an active sign up. A Client can only have one active sign up at a time.

Available requests

Create/Read/Update
  • POST /v1/client/sign_ups
  • GET/v1/client/sign_ups/:id
  • PATCH/v1/client/sign_ups/:id
Verification
  • POST/v1/client/sign_ups/:id/prepare_verification
  • POST/v1/client/sign_ups/:id/attempt_verification

The Sign up object

{
"object": "sign_up_attempt",
"status": "missing_requirements",
"required_fields": [
"email_address",
"password",
"first_name",
"last_name"
],
"optional_fields": [],
"missing_fields": [
"email_address",
"password",
"first_name",
"last_name"
],
"unverified_fields": [
"email_address"
],
"supported_external_accounts": [
"oauth_google"
],
"username": null,
"email_address": null,
"phone_number": null,
"web3_wallet": null,
"external_account": null,
"password_enabled": false,
"first_name": null,
"last_name": null,
"created_session_id": null,
"created_user_id": null,
"abandon_at": 1622256299572,
"verifications": {
"email_address": null,
"phone_number": null,
"web3_wallet": null,
"external_account": null
}
}

Create/Update

post
https://clerk.example.com
/v1/client/sign_ups
Create a Sign up
get
https://clerk.example.com
/v1/client/sign_ups/:id
Get a Sign up
patch
https://clerk.example.com
/v1/client/sign_ups/:id
Update

Verification

post
https://clerk.example.com
/v1/client/sign_ups/:id/prepare_verification
Prepare a verification
post
https://clerk.example.com
/v1/client/sign_ups/:id/attempt_verification
Attempt a verification
Last modified 6mo ago
Copy link
On this page
Available requests
The Sign up object
Create/Update
post
Create a Sign up
get
Get a Sign up
patch
Update
Verification
post
Prepare a verification
post
Attempt a verification