Register

Defines the structure of the request body for the account/register endpoint.

Schema

{
  "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"
}

Properties

user_first_name

The user’s first name

Data Type: String
Required: Yes
Table: User

user_middle_name

The user’s middle name

Data Type: String
Required: No
Table: User

user_last_name

The user’s last name

Data Type: String
Required: Yes
Table: User

user_username

The user’s username

Data Type: String
Required: Yes
Table: User

user_email

The user’s email

Data Type: String
Required: Yes
Table: User

user_password

The user’s password

Data Type: String
Required: No
Table: User

Caution

This property is required if the user_login_option_type is set to Capturit.

user_password_confirmation

Confirms the user’s password by ensuring it matches the user_password field

Data Type: String
Required: No

Caution

This property is required if the user_login_option_type is set to Capturit.

user_login_option_type

The type of authentication provider the user will use

Data Type: Integer
Required: Yes
Values:

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

user_login_option_unique_identifier

The unique identifier of the authentication provider, usually the ID of the user (e.g., FacebookID)

Data Type: String
Required: No

Caution

This property is required if the user_login_option_type is not Capturit.

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

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
Values:

• android
• ios