User Registration

curl -X POST "http://localhost:8080/signup" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "securepassword123",
    "data": {
      "first_name": "John",
      "last_name": "Doe"
    }
  }'

const response = await fetch('http://localhost:8080/signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'securepassword123',
    data: {
      first_name: 'John',
      last_name: 'Doe'
    }
  }),
});

const user = await response.json();

import requests

data = {
    "email": "user@example.com",
    "password": "securepassword123",
    "data": {
        "first_name": "John",
        "last_name": "Doe"
    }
}

response = requests.post('http://localhost:8080/signup', json=data)
user = response.json()

package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func main() {
    data := map[string]interface{}{
        "email":    "user@example.com",
        "password": "securepassword123",
        "data": map[string]string{
            "first_name": "John",
            "last_name":  "Doe",
        },
    }
    
    jsonData, _ := json.Marshal(data)
    
    resp, err := http.Post(
        "http://localhost:8080/signup",
        "application/json",
        bytes.NewBuffer(jsonData),
    )
    // Handle response...
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "aud": "authenticated",
  "role": "authenticated",
  "email": "user@example.com",
  "phone": null,
  "email_confirmed_at": null,
  "phone_confirmed_at": null,
  "last_sign_in_at": null,
  "app_metadata": {
    "provider": "email",
    "providers": ["email"]
  },
  "user_metadata": {
    "first_name": "John",
    "last_name": "Doe"
  },
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z"
}

POST

signup

curl -X POST "http://localhost:8080/signup" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "securepassword123",
    "data": {
      "first_name": "John",
      "last_name": "Doe"
    }
  }'

const response = await fetch('http://localhost:8080/signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'securepassword123',
    data: {
      first_name: 'John',
      last_name: 'Doe'
    }
  }),
});

const user = await response.json();

import requests

data = {
    "email": "user@example.com",
    "password": "securepassword123",
    "data": {
        "first_name": "John",
        "last_name": "Doe"
    }
}

response = requests.post('http://localhost:8080/signup', json=data)
user = response.json()

package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func main() {
    data := map[string]interface{}{
        "email":    "user@example.com",
        "password": "securepassword123",
        "data": map[string]string{
            "first_name": "John",
            "last_name":  "Doe",
        },
    }
    
    jsonData, _ := json.Marshal(data)
    
    resp, err := http.Post(
        "http://localhost:8080/signup",
        "application/json",
        bytes.NewBuffer(jsonData),
    )
    // Handle response...
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "aud": "authenticated",
  "role": "authenticated",
  "email": "user@example.com",
  "phone": null,
  "email_confirmed_at": null,
  "phone_confirmed_at": null,
  "last_sign_in_at": null,
  "app_metadata": {
    "provider": "email",
    "providers": ["email"]
  },
  "user_metadata": {
    "first_name": "John",
    "last_name": "Doe"
  },
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z"
}

Register a new user account with email or phone number and password. This endpoint creates a new user in the system and optionally sends a confirmation email/SMS.

curl -X POST "http://localhost:8080/signup" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "securepassword123",
    "data": {
      "first_name": "John",
      "last_name": "Doe"
    }
  }'

const response = await fetch('http://localhost:8080/signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'securepassword123',
    data: {
      first_name: 'John',
      last_name: 'Doe'
    }
  }),
});

const user = await response.json();

import requests

data = {
    "email": "user@example.com",
    "password": "securepassword123",
    "data": {
        "first_name": "John",
        "last_name": "Doe"
    }
}

response = requests.post('http://localhost:8080/signup', json=data)
user = response.json()

package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func main() {
    data := map[string]interface{}{
        "email":    "user@example.com",
        "password": "securepassword123",
        "data": map[string]string{
            "first_name": "John",
            "last_name":  "Doe",
        },
    }
    
    jsonData, _ := json.Marshal(data)
    
    resp, err := http.Post(
        "http://localhost:8080/signup",
        "application/json",
        bytes.NewBuffer(jsonData),
    )
    // Handle response...
}

Request Body

string

required

User’s email address. Must be a valid email format.

string

User’s phone number in international format (e.g., +1234567890). Either email or phone is required.

string

required

User’s password. Must meet minimum security requirements.

object

Additional user metadata to store with the user profile.

string

Captcha token for verification if captcha is enabled.

Response

string

Unique user identifier (UUID format)

string

Audience claim, typically “authenticated”

string

User role, typically “authenticated”

string

User’s email address

string

User’s phone number

string

Timestamp when email was confirmed (null if not confirmed)

string

Timestamp when phone was confirmed (null if not confirmed)

Timestamp of last sign in (null for new users)

object

Application metadata managed by the system

object

User metadata provided during registration

string

User creation timestamp

string

User last update timestamp

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "aud": "authenticated",
  "role": "authenticated",
  "email": "user@example.com",
  "phone": null,
  "email_confirmed_at": null,
  "phone_confirmed_at": null,
  "last_sign_in_at": null,
  "app_metadata": {
    "provider": "email",
    "providers": ["email"]
  },
  "user_metadata": {
    "first_name": "John",
    "last_name": "Doe"
  },
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z"
}

Error Responses

{
  "code": 400,
  "msg": "Invalid request data",
  "details": "Email is required"
}

{
  "code": 422,
  "msg": "User already registered",
  "details": "A user with this email already exists"
}

{
  "code": 429,
  "msg": "Too many requests",
  "details": "Rate limit exceeded. Try again later."
}

Password Requirements

Passwords must meet the following requirements:

Minimum 8 characters
At least one uppercase letter
At least one lowercase letter
At least one number
At least one special character

Email Confirmation

After successful registration:

If email confirmation is enabled, a confirmation email will be sent
The user’s email_confirmed_at field will be null until confirmed
Users may need to confirm their email before accessing certain features

Phone Registration

To register with a phone number instead of email:

{
  "phone": "+1234567890",
  "password": "securepassword123"
}

Rate Limiting

This endpoint is rate limited to prevent abuse:

Limit: 5 requests per minute per IP address
Headers: Rate limit information is included in response headers

Security Considerations

Passwords are securely hashed using bcrypt
Email addresses are validated and normalized
Phone numbers are validated for proper format
Captcha verification may be required based on configuration

Next Steps

After successful registration, users typically need to:

Confirm their email/phone - Use the verify endpoint
Sign in - Use the login endpoint
Complete profile - Use the update profile endpoint

API Documentation

System

Public

Authentication

User Management

Admin

OAuth

Debug

Request Body

Response

Error Responses

Password Requirements

Email Confirmation

Phone Registration

Rate Limiting

Security Considerations

Next Steps

​Request Body

​Response

​Error Responses

​Password Requirements

​Email Confirmation

​Phone Registration

​Rate Limiting

​Security Considerations

​Next Steps

Request Body

Response

Error Responses

Password Requirements

Email Confirmation

Phone Registration

Rate Limiting

Security Considerations

Next Steps