Skip to main content
POST
/
api
/
auth
/
users
Register new user
curl --request POST \
  --url https://api.example.com/api/auth/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "securepassword123",
  "name": "John Doe"
}
'
{
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "profile": {
      "name": "<string>",
      "avatar_url": "<string>"
    },
    "metadata": {},
    "emailVerified": true,
    "providers": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "accessToken": "<string>",
  "csrfToken": "<string>",
  "refreshToken": "<string>",
  "requireEmailVerification": true,
  "redirectTo": "<string>"
}

Query Parameters

​
client_type
enum<string>
default:web

Client type determines how refresh tokens are returned:

  • web: Refresh token stored in httpOnly cookie, csrfToken returned in response
  • mobile/desktop: refreshToken returned directly in response body
Available options:
web,
mobile,
desktop

Body

application/json
​
email
string<email>
required
Example:

"user@example.com"

​
password
string
required

Password meeting configured requirements (check /api/auth/email/config for current requirements)

Example:

"securepassword123"

​
name
string
Example:

"John Doe"

Response

User created successfully

​
user
object
​
accessToken
string | null

JWT authentication token (null if email verification required)

​
csrfToken
string | null

CSRF token for use with refresh endpoint (web clients only, null if email verification required)

​
refreshToken
string | null

Refresh token for mobile/desktop clients (null for web clients or if email verification required)

​
requireEmailVerification
boolean

Whether email verification is required before login

​
redirectTo
string<uri>

Optional URL to redirect user after registration (only present if email verification not required)