Sign Up

Create a new user account with a username and password.

Endpoint: POST /sign_up

Headers:

x-api-key (required) - Your application’s API key
x-api-secret (required) - Your application’s API secret

Request Body:


{
  "username": "john_doe",
  "password": "secure_password123",
  "hardware_id": "device-hardware-id"  // Optional: required when device authentication is enabled
}

Response:


{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "username": "john_doe",
  "membership": {
    "is_active": false
  }
}

Errors:

403 - Banned (IP address or hardware ID is banned)
422 - Validation error (username taken, missing required fields)

Notes:

New users start without an active membership
Users need to activate a license to get access
If device authentication is enabled, hardware_id is required and the device is registered during sign-up
User’s IP address is automatically tracked
Signup is blocked if the IP address or hardware ID is banned

Create a new user account using a license code. The license is automatically activated.

Endpoint: POST /sign_up_with_license_code

Headers:

x-api-key (required) - Your application’s API key
x-api-secret (required) - Your application’s API secret

Request Body:


{
  "code": "ABC123XYZ789",
  "hardware_id": "device-hardware-id"  // Optional: required when device authentication is enabled
}

Response:


{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "username": "generated_username",
  "membership": {
    "is_active": true
  }
}

Errors:

403 - Banned (IP address, hardware ID, or license is banned)
422 - Validation error (Invalid or already used license code, missing required fields)

Notes:

Username is automatically generated
License is immediately activated and membership becomes active
Ideal for simple license-only authentication without passwords
If device authentication is enabled, hardware_id is required and the device is registered during sign-up
User’s IP address is automatically tracked
Signup is blocked if the IP address, hardware ID, or license is banned

Sign Up with Username/Password

Sign Up with License Code