Register a new user

Developing

POST

/auth/register

Creates a new user account in the system using the provided registration details such as name, email address, and password. After successful registration, the system generates a verification code and sends it to the user’s email address to confirm ownership. The account typically remains in a pending or unverified state until the email verification process is completed.

Request

Body Params application/jsonRequired

Examples

Responses

🟢201Success

application/json

Bodyapplication/json

🟠400Validation Error

🟠409Email Already Exists

🟠429Rate Limit Exceeded

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:3000/api/v1/auth/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Willard Lueilwitz",
    "email": "taryn82@hotmail.com",
    "password": "DLCO2lz$Pj@RSpg"
}'

Response Example

201 - Example

{
    "status": "success",
    "message": "User created successfully.",
    "data": {
        "user": {
            "id": "b899f5c7bf633758f754b00b5c5e017ee1c8d313",
            "name": "Marty Mitchell",
            "email": "davonte56@hotmail.com",
            "account_status": "suspend",
            "email_verified": true,
            "email_verified_at": "2026-05-18T08:06:42.478Z",
            "created_at": "2026-05-18T08:06:42.481Z",
            "updated_at": "2026-05-18T08:06:42.481Z"
        }
    }
}

Modified at 2026-03-07 02:24:42

Registration & Onboarding

Verify email address