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.

This guide walks you through the full user lifecycle in Userverse: from creating an account to updating profile data and viewing company memberships.
1

Register a new account

Send a POST request to /user/create using HTTP Basic Auth. Provide the user’s email as the username and their chosen password as the password. Include optional profile fields in the request body.
​
first_name
string
User’s first name.
​
last_name
string
User’s last name.
​
phone_number
string
Phone number in numeric format, e.g. 1236547899.
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",
    "phone_number": "1236547899"
  }'
A successful response returns 201 Created with the new user record.
​
message
string
Confirmation message.
​
data
object
After registration, Userverse automatically sends a verification email to the address provided. The account must be verified before accessing protected endpoints. See the email verification guide.
2

Verify your email

Click the link in the verification email, or follow the steps in the email verification guide to activate your account before proceeding.
3

Log in

Send a PATCH request to /user/login using HTTP Basic Auth (email as username, password as password). On success, the API returns a JWT access token and refresh token.
curl --request PATCH \
  --url http://localhost:8000/user/login \
  --user "jane@example.com:mysecretpassword"
A successful response returns 202 Accepted.
​
data
object
Store the access_token — you will pass it as a Bearer token in all subsequent requests.
4

Retrieve your profile

Send a GET request to /user/get with the JWT token in the Authorization header.
curl --request GET \
  --url http://localhost:8000/user/get \
  --header "Authorization: Bearer <your_access_token>"
A successful response returns 200 OK with the current user record (same shape as the registration response).
5

Update your profile

Send a PATCH request to /user/update with the fields you want to change. All fields are optional.
​
first_name
string
Updated first name.
​
last_name
string
Updated last name.
​
phone_number
string
Updated phone number.
​
password
string
New password. For a dedicated password reset flow, see the password reset guide.
curl --request PATCH \
  --url http://localhost:8000/user/update \
  --header "Authorization: Bearer <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "first_name": "Jane",
    "last_name": "Doe"
  }'
A successful response returns 201 Created with the updated user record.
6

List your companies

Send a GET request to /user/companies to retrieve a paginated list of all companies you belong to.
curl --request GET \
  --url http://localhost:8000/user/companies \
  --header "Authorization: Bearer <your_access_token>"
You can filter results with optional query parameters:
ParameterTypeDescription
namestringFilter by company name.
industrystringFilter by industry.
emailstringFilter by company email.
role_namestringFilter by your role in the company.
A successful response returns 200 OK with a paginated list of company records.

Email verification

Activate a new account by verifying the user’s email address.

Password reset

Reset a forgotten password using a one-time PIN sent to email.

Company management

Create companies and manage their members.

Roles and permissions

Define and manage roles within a company.

Build docs developers (and LLMs) love

Get started for freeTalk to us