Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Devices

Register Device

Register a new tablet/kiosk device.

This endpoint creates a new device record and generates a JWT token for device authentication. The token has limited scope (earn, redeem, balance_check) and expires in 24 hours.

Parameters:

  • request (DeviceRegisterRequest): Device registration details
  • current_user (User): Authenticated user making the request

Returns:

  • DeviceRegisterResponse: Device ID, SID, and authentication token

Raises:

  • 404: If the specified program doesn't exist
post/v2/devices/register

Headers

authorizationstring nullable

Request body

deviceType'tablet_kiosk' | 'tablet' | 'kiosk' required

Device type enumeration for tablet/kiosk devices.

deviceNamestring required

Human-readable name for the device

programIdstring required
hardwareInfoobject nullable

Hardware information (model, OS version, etc.)

locationNamestring nullable

Physical location of device

locationAddressstring nullable

Address of device location

Example request

{
  "programId": "5eb7cf5a86d9755df3a6c593"
}

Response

Successful Response

deviceIdstring required

Device ID

deviceSidstring required

Device SID (human-readable identifier)

deviceTokenstring required

JWT token for device authentication

expiresAtstring date-time required

Token expiration timestamp

status'active' | 'inactive' | 'blocked' | 'pending_activation' required

Device status enumeration.