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

1
{
2
"object": "sign_up_attempt",
3
"status": "missing_requirements",
4
"required_fields": [
5
"email_address",
6
"password",
7
"first_name",
8
"last_name"
9
],
10
"optional_fields": [],
11
"missing_fields": [
12
"email_address",
13
"password",
14
"first_name",
15
"last_name"
16
],
17
"unverified_fields": [
18
"email_address"
19
],
20
"supported_external_accounts": [
21
"oauth_google"
22
],
23
"username": null,
24
"email_address": null,
25
"phone_number": null,
26
"web3_wallet": null,
27
"external_account": null,
28
"password_enabled": false,
29
"first_name": null,
30
"last_name": null,
31
"created_session_id": null,
32
"created_user_id": null,
33
"abandon_at": 1622256299572,
34
"verifications": {
35
"email_address": null,
36
"phone_number": null,
37
"web3_wallet": null,
38
"external_account": null
39
}
40
}
Copied!

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 1mo ago