# Registration

# Register User

POST
/register

# Parameters

Parameter Type Required Description
username String Yes Unique user's username.
email String Yes Unique user's email.
password String Yes Users password.
password_confirmation String Yes Password confirmation.
g-recaptcha-response String Only if Google re-captcha is enabled Google re-captcha response.
tos Boolean Only if ToS is enabled Indicates if Terms of Service are accepted.

# Example Request

curl --location --request POST 'https://yourwebsite.com/api/register' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
  "username": "johndoe",
  "email": "[email protected]",
  "password": "123123",
  "password_confirmation": "123123",
  "g-recaptcha-response": "asdfjn123jnjqpoasdnv934q243r",
  "tos": true
}'

# Example Response

Status: 201 Created

{
    "requires_email_confirmation": true
}

The requires_email_confirmation flag indicates if email confirmation is required. If it is set to true that means that user has received a verification email.