Skip to main content
POST
/
api
/
auth
/
register
Register User
curl --request POST \
  --url https://api.example.com/api/auth/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "password": "<string>",
  "full_name": "<string>"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "full_name": "<string>",
  "is_active": true,
  "is_verified": true,
  "created_at": {}
}

Overview

Register a new user account in the Meta-Data Tag Generator system. This endpoint creates a new user with email and password credentials.

Endpoint

POST /api/auth/register

Request Body

email
string
required
User’s email address. Must be a valid email format.
password
string
required
User’s password. Must be at least 8 characters long.
full_name
string
User’s full name (optional).

Response

id
UUID
Unique identifier for the user.
email
string
User’s email address.
full_name
string
User’s full name (if provided).
is_active
boolean
Whether the user account is active. Defaults to true.
is_verified
boolean
Whether the user’s email has been verified. Defaults to false.
created_at
datetime
Timestamp when the user account was created.

Example Request

curl -X POST https://api.example.com/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "securePassword123",
    "full_name": "John Doe"
  }'

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "full_name": "John Doe",
  "is_active": true,
  "is_verified": false,
  "created_at": "2026-03-03T10:30:00Z"
}

Error Responses

400 Bad Request

Returned when the email is already registered or validation fails.
{
  "detail": "Email already registered"
}

500 Internal Server Error

Returned when the registration fails due to a server error.
{
  "detail": "Failed to register user"
}

Notes

  • Passwords are hashed using bcrypt before storage
  • Email addresses must be unique
  • New accounts are created with is_active=true but is_verified=false
  • No authentication tokens are returned; users must call the /login endpoint after registration

Build docs developers (and LLMs) love