Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/SoftwareVerse/userverse/llms.txt

Use this file to discover all available pages before exploring further.

Userverse requires users to verify their email address before they can access protected endpoints. This guide explains the verification flow and shows you how to handle common scenarios.

​
How it works

1

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.
curl --request POST \
  --url http://localhost:8000/user/create \
  --user "jane@example.com:mysecretpassword" \
  --header "Content-Type: application/json" \
  --data '{
    "first_name": "Jane",
    "last_name": "Smith"
  }'
Sending verification emails requires a working mail server configuration. See configuration for the required HOST, PORT, USERNAME, and PASSWORD settings.
2

User clicks the verification link

The link in the email points to 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:
curl --request GET \
  --url "http://localhost:8000/user/verify?token=<verification_token>"
A successful response returns 201 Created with a confirmation message. No authentication is required — the token itself proves the user’s identity.
3

Access protected endpoints

Once verified, the user can log in and access all JWT-protected endpoints normally.
curl --request PATCH \
  --url http://localhost:8000/user/login \
  --user "jane@example.com:mysecretpassword"

​
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. 
curl --request POST \
  --url http://localhost:8000/user/resend-verification \
  --header "Authorization: Bearer <your_access_token>"
A successful response returns 200 OK confirming the email was resent.

​
Email configuration

Userverse uses an SMTP mail server to send verification emails. Configure the email block in your JSON config file:
Config keyDescription
email.HOSTSMTP server hostname.
email.PORTSMTP server port (e.g. 587).
email.USERNAMESMTP account username or address.
email.PASSWORDSMTP account password.
Refer to the configuration guide for the full settings reference.
If a user reports that their verification link is not working, use the resend endpoint to issue a fresh token.

User management

Full user lifecycle: register, log in, and update your profile.

Password reset

Reset a forgotten password using a one-time PIN.

Build docs developers (and LLMs) love

Get started for freeTalk to us