register

Developing

Develop Env

http://localhost:3000/api

POST

/auth/register

public

Maintainer:Not configured

Creates a new user account. The user must verify their email before full access is granted (if verification is enabled).

Rate limit: 10 requests / minute / IP (adjustable)

Idempotency: Optional Idempotency-Key recommended to avoid duplicate accounts.

Only allowed if org allows local auth (default: disabled for enterprise tenants).

For MVP, this endpoint is optional—you may skip and rely solely on OAuth.

Headers

Key	Value	Required
`Content-Type`	`application/json`	✅
`Accept`	`application/json`	✅
`Idempotency-Key`	`<uuid>`	❌
`X-Request-ID`	`<uuid>`	❌

Validation Rules

Password: ≥12 chars, includes uppercase, lowercase, number, symbol

Email must be valid email format, case-insensitive uniqueness, and unique per org

FullName: non-empty.

Notes for clients

Provide Idempotency-Key to avoid duplicate accounts on retry.

After registration, prompt user to check email and call /verify-email.

Show clear password rules (min length, special char, etc.) to reduce validation errors.

Request

Body Params application/json

Examples

Responses

🟢201Created

application/json

User successfully registered

Body

🟠400Bad Request

🔴500Server Error

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://localhost:3000/api/auth/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@email.com",
    "name": "Olga Bergnaum",
    "password": "nN_QXHztsdip",
    "orgId": "3462fe40-286f-45df-96fd-855e6fb9810f"
}'

Response Example

201 - Example 1

{
    "status": "ok",
    "message": "Registered Successfully!",
    "data": {
        "user": {
            "id": "ad038a53-c9bc-4b57-9b1c-563da12f5bb4",
            "email": "Kitty53@yahoo.com",
            "name": "Dr. Roland Bernier",
            "avatarUrl": "https://picsum.photos/seed/ewu4S7Ml9k/58/78?grayscale&blur=9",
            "orgId": "464ba5de-7011-42f0-9eab-280be05d0df5",
            "isVerified": true,
            "status": "banned",
            "createdAt": "2025-10-10T01:19:55.904Z",
            "updatedAt": "2025-10-10T01:19:55.904Z"
        }
    }
}

Modified at 2025-10-10 18:38:32

Auth