Skip to main content
POST
/
api
/
v1
/
auth
/
register
Register
curl --request POST \
  --url https://api.example.com/api/v1/auth/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "<string>",
  "account_name": "<string>",
  "account_slug": "<string>"
}
'
{
  "message": "<string>",
  "user": {
    "id": "<string>",
    "email": "<string>",
    "role": "<string>",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "account": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Body

application/json

Request body for account registration.

email
string<email>
required

User's email address

password
string
required

User's password

Minimum string length: 1
account_name
string
required

Display name for the account

Required string length: 1 - 255
account_slug
string | null

URL-friendly account identifier (auto-generated if not provided)

Required string length: 3 - 32

Response

Successful Response

Response for successful registration (verification required).

message
string
required

Success message instructing to verify email

user
UserResponse · object
required

User information

account
AccountResponse · object
required

Account information