Skip to content
Capturit Backend Docs

Login

POST api/account/authenticate

This is used to log in to the user’s account via Capturit or a third-party authenticated provider.

Example Request

Terminal window
curl -X 'POST' \
  'http://localhost:8080/api/account/authenticate' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_login_option_type": 1,
  "user_login_id": "johndoe@gmail.com",
  "user_password": "johndoe",
  "device_id": "DeviceID",
  "user_timezone": "Asia/Manila",
  "user_device_platform": "android"
}'

Request Body

Content Type: application/json
Content: Login Account

{
  "user_login_option_type": 0,
  "user_login_id": "string",
  "user_password": "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",
    "subscription_plan": {
      "subscription_plan_title": "string",
      "subscription_plan_pricing": 0,
      "subscription_plan_expiration": "2024-12-05T06:28:21.265Z"
    },
    "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
    },
    "user_visible": true,
    "user_status": 0,
    "user_timezone": "string",
    "created_at": "2024-12-05T06:28:21.265Z",
    "updated_at": "2024-12-05T06:28:21.265Z"
  },
  "token": "string",
  "token_expiration": "2024-12-05T06:28:21.265Z"
}

400 - Bad Request

Validation Error

Content Type: application/json
Content:

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

401 - Unauthorized

Invalid Credentials

Content Type: application/json
Content:

{
  "error_message": "Incorrect Details.  Please try again."
}

429 - Too Many Requests

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