Login

Defines the structure of the request body for the account/authenticate endpoint

Schema

{
  "user_login_option_type": 0,
  "user_login_id": "string",
  "user_password": "string",
  "device_id": "string",
  "user_timezone": "string",
  "user_device_platform": "string"
}

Properties

user_login_option_type

The type of authentication provider the user will use

Data Type: Integer
Required: Yes
Table: User Login Options
Values:

• 1 - Capturit
• 2 - Google
• 3 - Facebook

user_login_id

The unique identifier of the account

Data Type: String
Required: Yes
Table: User Login Options

Note

For Capturit, it can be either the username or the email. For third-party authenticated providers, it should be their unique identifier (e.g., Facebook ID).

user_password

The user’s password

Data Type: String
Required: No
Table: User

Note

For third-party authenticated providers, it should be the authentication token.

device_id

This is the ID generated by Firebase Cloud Messaging (FCM) for identifying devices or users in push notifications.

Data Type: String
Required: Yes
Table: User Device ID

user_timezone

The user’s timezone

Data Type: String
Format: ISO - UTC
Required: Yes
Table: User

user_device_platform

This is the identification of the device for which the device_id is generated.

Data Type: String
Required: Yes
Table: User Device ID
Values:

• android
• ios