Verify an email code
POST
/api/v1/auth/verify
const url = 'https://example.com/api/v1/auth/verify';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"code":"example","device_name":"example","email_address":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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" }'Authorizations
Section titled “Authorizations”- None
Request Bodyrequired
Section titled “Request Bodyrequired”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"}Responses
Section titled “Responses”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
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"}