v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB
Client

Verify email with code

Verify email address with a 6-digit code.

Successfully verified users will receive a session token.

Browser email clicks should use GET /api/auth/email/verify-link. POST /api/auth/email/verify is the JSON API for 6-digit code submission.

post/api/auth/email/verify

Query parameters

client_type'web' | 'mobile' | 'desktop' | 'server'

Client type determines how refresh tokens are returned:

  • web: Refresh token stored in httpOnly cookie, csrfToken returned in response
  • mobile/desktop/server: refreshToken returned directly in response body

Request body

emailstring email required

User email address

otpstring required

6-digit verification code

Example request

{
  "email": "user@example.com",
  "otp": "123456"
}

Response

Email verified successfully, session created

accessTokenstring

JWT authentication token

csrfTokenstring nullable

CSRF token for use with refresh endpoint (web clients only)

refreshTokenstring nullable

Refresh token for mobile/desktop/server clients (null for web clients)