How it works
Register a new account
When you call
POST /user/create, Userverse creates the account and immediately sends a verification email to the address provided. The email contains a link with a short-lived token.Sending verification emails requires a working mail server configuration. See configuration for the required
HOST, PORT, USERNAME, and PASSWORD settings.User clicks the verification link
The link in the email points to A successful response returns
GET /user/verify?token=<token>. When the user visits this URL, Userverse validates the token and activates the account.You can also call this endpoint directly:201 Created with a confirmation message. No authentication is required — the token itself proves the user’s identity.Unverified accounts
If an unverified user attempts to access an endpoint that enforces the status check, the API returns an error indicating the account is not active. The user must verify their email before proceeding.Resend the verification email
If the original email was lost or the token expired, the user can request a new one. This endpoint requires the user to be logged in.200 OK confirming the email was resent.
Email configuration
Userverse uses an SMTP mail server to send verification emails. Configure theemail block in your JSON config file:
| Config key | Description |
|---|---|
email.HOST | SMTP server hostname. |
email.PORT | SMTP server port (e.g. 587). |
email.USERNAME | SMTP account username or address. |
email.PASSWORD | SMTP account password. |
Related guides
User management
Full user lifecycle: register, log in, and update your profile.
Password reset
Reset a forgotten password using a one-time PIN.