Skip to content

Verify an email code

POST
/api/v1/auth/verify
curl --request POST \
--url https://example.com/api/v1/auth/verify \
--header 'Content-Type: application/json' \
--data '{ "code": "example", "device_name": "example", "email_address": "example" }'
  • None
Media typeapplication/json
object
code
required
string
device_name
string | null
email_address
required
string

Example generated

{
"code": "example",
"device_name": "example",
"email_address": "example"
}

Authenticated

Media typeapplication/json
object
token
required
string
user
required
object
created_at
required
string format: date-time
email_address
required
string
email_verified
required
boolean
id
required
string format: uuid
name
string | null
onboarding_completed
required
boolean
onboarding_goal
string | null
plan
required
string
Allowed values: free pro
spaces_remaining
integer | null format: int64
unconfirmed_email
string | null
wins_remaining
integer | null format: int64

Example

{
"user": {
"plan": "free"
}
}

Invalid or expired code

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Rate limited

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}