Skip to main content
POST
/
api
/
v1
/
auth
/
register
curl -X POST https://api.example.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "birthDate": "1990-05-15",
    "username": "johndoe",
    "password": "securePassword123",
    "email": "[email protected]"
  }'
{
  "username": "johndoe",
  "email": "[email protected]",
  "message": "User registered successfully",
  "status": true
}
This endpoint allows new users to register by providing their personal information including name, birth date, username, password, and email address.

Request Body

name
string
required
The full name of the user. Cannot be blank.
birthDate
string
required
The date of birth of the user in ISO 8601 format (YYYY-MM-DD). Must be a past or present date.Example: "1990-05-15"
username
string
required
The username for the new account. Cannot be blank. Must be unique in the system.
password
string
required
The password for the new account. Cannot be blank.
email
string
required
The email address of the user. Must be a valid email format and cannot be blank.Example: "[email protected]"

Response

username
string
The username of the newly registered user.
email
string
The email address of the newly registered user.
message
string
A confirmation message about the registration status.
status
boolean
A boolean indicating the success of the registration operation.
curl -X POST https://api.example.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "birthDate": "1990-05-15",
    "username": "johndoe",
    "password": "securePassword123",
    "email": "[email protected]"
  }'
{
  "username": "johndoe",
  "email": "[email protected]",
  "message": "User registered successfully",
  "status": true
}

Build docs developers (and LLMs) love