Skip to content
Capturit Backend Docs

Register

POST api/account/register

This is used to register a new user.

Example Request

Terminal window
curl -X 'POST' \
  'http://localhost:8080/api/account/register' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_first_name": "John",
  "user_middle_name": null,
  "user_last_name": "Doe",
  "user_username": "johndoe",
  "user_email": "johndoe@gmail.com",
  "user_password": "johndoe",
  "user_password_confirmation": "johndoe",
  "user_login_option_type": 1,
  "device_id": "DeviceID",
  "user_timezone": "Asia/Manila",
  "user_device_platform": "android"
}'

Request Body

Content Type: application/json
Content: Register Account

{
  "user_first_name": "string",
  "user_middle_name": "string",
  "user_last_name": "string",
  "user_username": "string",
  "user_email": "string",
  "user_password": "string",
  "user_password_confirmation": "string",
  "user_login_option_type": 0,
  "user_login_option_unique_identifier": "string",
  "device_id": "string",
  "user_timezone": "string",
  "user_device_platform": "string"
}

Responses

200 - OK

The request was successful

Content Type: application/json
Content: Authenticated Account

{
    "user": {
        "id": 0,
        "user_first_name": "string",
        "user_middle_name": "string",
        "user_last_name": "string",
        "user_username": "string",
        "user_email": "string",
        "user_avatar_url": "string",
        "user_visible": true,
        "user_status": 0,
        "user_timezone": "string",
        "subscription_plan": {
            "subscription_plan_title": "string",
            "subscription_plan_pricing": 0,
            "subscription_plan_expiration": "2024-12-02T11:58:54.523Z"
        },
        "user_login_options": [
            {
            "user_id": 0,
            "user_login_option_type": 0,
            "user_login_option_unique_identifier": "string",
            "user_login_option_name": "string"
            }
        ],
        "user_settings": {
            "user_setting_mute_notification": true
        },
        "created_at": "2024-12-02T11:58:54.523Z",
        "updated_at": "2024-12-02T11:58:54.523Z"
    },
    "token": "string",
    "token_expiration": "2024-12-04T12:46:45.770Z"
}

400 - Bad Request

Validation Error

Content Type: application/json
Content:

{
  "param_name": [
    "string"
  ],
  "param_name_2": [
    "string"
  ]
}

429 - Too Many Requests

The user has exceeded the rate limit of 10 requests per minute.

500 - Internal Server Error

There is an issue with the backend. Sentry will provide a more detailed report on the problem.