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 is a free, flexible, and secure platform for user and organization management. It gives you a complete API for registering users, handling authentication, creating companies, managing roles, and controlling membership — without relying on proprietary systems.

Quick Start

Get Userverse running and make your first API call in minutes.

Configuration

Learn how to configure Userverse using a JSON config file.

API Reference

Full endpoint documentation with request and response schemas.

Authentication

Understand Basic Auth, JWT tokens, and how to secure your requests.

​
What you can build

Userverse handles the core identity infrastructure so you can focus on your product.

User management

Register users, update profiles, and look up accounts.

Company management

Create organizations, manage membership, and structure teams.

Roles & permissions

Define custom roles within companies and assign them to members.

Email verification

Verify user accounts via email and resend verification links.

​
Getting started

1

Run the API

Start the Userverse server locally using uvicorn or the built-in CLI.
uvicorn app.main:create_app --factory --reload --host 0.0.0.0 --port 8501
2

Create a user

Register a new user account with Basic Auth credentials.
curl -X POST http://localhost:8501/user/create \
  -u "user@example.com:YourPassword123" \
  -H "Content-Type: application/json" \
  -d '{"first_name": "Jane", "last_name": "Doe"}'
3

Log in and get a token

Log in to receive JWT access and refresh tokens.
curl -X PATCH http://localhost:8501/user/login \
  -u "user@example.com:YourPassword123"
4

Use the token

Include the JWT token in subsequent requests via the Authorization header.
curl http://localhost:8501/user/get \
  -H "Authorization: Bearer <your_access_token>"
Userverse is open source under the MIT license. Contributions are welcome on GitHub.

Build docs developers (and LLMs) love

Get started for freeTalk to us