Skip to main content

Module email_verification

auth_framework::api

Module email_verification 

Source
Expand description

Email Verification API Endpoints

Handles email address verification through token-based confirmation.

§Storage keys

  • email_verify:{token} — user_id bytes, TTL 24 hours (verification link)
  • User JSON email_verified field — true once verified

§Flow

  1. User registers → email_verified set to false in user record
  2. POST /auth/verify-email/send → generates verification token, returns it (and sends email if SMTP is configured)
  3. POST /auth/verify-email → verifies token, sets email_verified: true
  4. POST /auth/resend-verification → regenerates token for the user

Structs§

ResendVerificationRequest
Request body for POST /auth/resend-verification.
VerificationSentResponse
Response returned when a verification token is generated.
VerifyEmailRequest
Request body for POST /auth/verify-email.

Functions§

resend_verification
POST /auth/resend-verification
send_verification
POST /auth/verify-email/send
verify_email
POST /auth/verify-email