Skip to main content

Sign Up

Endpoint

[POST] /auth/sign-up

Description

This endpoint allows a new user to sign up/register by providing the necessary details.

Request

Headers

KeyValueDescription
Content-Typeapplication/jsonSpecifies the request content type

Body Parameters

ParameterTypeDescription
namestringName of user
lastnamestringLast name of user
emailstringThe email of the user
passwordstringThe password of the user

Example Request

{
"name": "John",
"lastname": "Doe",
"email": "newuser@example.com",
"password": "password123"
}

Response

Success (201 Created)

{
"message": "User created successfully",
"data": {
"user": {
//..
},
"accesstoken": "ey...."
}
}

Error (400 Bad Request)

{
"message": "Invalid input data",
"errors": [
//...
]
}

Example Usage

curl -X POST https://yourapi.com/auth/sign-up \
-H "Content-Type: application/json" \
-d '{
"email": "newuser@example.com",
"password": "password123"
}'