Authentication

Get current user profile

get

Get the profile information for the authenticated user

Authorizations

SessionToken

AuthorizationstringRequired

Session token in Bearer format: Bearer

Responses

200

User profile retrieved successfully

application/json

401

Unauthorized - invalid or missing session token

application/json

500

Internal server error

application/json

get

/user

HTTPcURLJavaScriptPython

GET /api/v1/user HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "phoneNumber": "text",
  "username": "text",
  "createdAt": "2025-12-25T16:32:26.275Z"
}

Generate authentication game code

post

Generate a new 6-digit authentication code from headset side

Authorizations

AppAPIKey

x-app-api-keystringRequired

App API key in format:

Body

application/json

playerIdstring | nullableRequired

Player ID to associate with the code. Used to link the player to the code. Optional.

Responses

200

Code generated successfully

application/json

401

Unauthorized - invalid or missing API key

application/json

500

Unable to generate unique code or internal server error

application/json

post

/code

HTTPcURLJavaScriptPython

POST /api/v1/code HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "playerId": "text"
}

{
  "code": "text",
  "playerId": "text",
  "expiryTime": "2025-12-25T16:32:26.275Z"
}

Validate authentication code

post

Validate an authentication code and optionally return a session token

Authorizations

AppAPIKey

x-app-api-keystringRequired

App API key in format:

Body

application/json

codestringRequired

Authentication code

Pattern: ^[0-9]{6}$

Responses

200

Game code validation result

application/json

400

Invalid request data

application/json

401

Unauthorized - invalid or missing App API key

application/json

500

Internal server error

application/json

post

/auth/code

HTTPcURLJavaScriptPython

POST /api/v1/auth/code HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "code": "text"
}

{
  "status": "VALID",
  "sessionToken": "text",
  "expiryTime": "2025-12-25T16:32:26.275Z",
  "error": "text"
}