Register a device
Registers one device with status not_activated. Its
device_identifier is its serial number.
Take model_id and its vendor_id from
GET /integration/v1/device-models. A key limited to one vendor can
register only that vendor's devices. Send an Idempotency-Key so that a retry
returns the first response.
integrationKeyAuthorizationBearer <token>Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>.
Konsol issues it.
Idempotency-Key?stringA unique value per logical request, such as a UUID. Within 24 hours a repeat
with the same key, path and body returns the first response; the same key
with a different path or body is a 409.
1 <= length <= 255application/json- body
device_identifier*stringThe device's serial number. Unique among your devices.
1 <= length <= 128vendor_id*stringThe vendor that supplied the device.
uuidmodel_id*stringThe device's model, from GET /integration/v1/device-models. It must belong
to vendor_id. Konsol uses it to choose which build of each application the
device gets.
uuiddisplay_name?string1 <= length <= 100The registered device
application/json- response
id*stringuuiddevice_identifier*stringdisplay_name?string|nullstatus*stringnot_activated: registered, and no activation code has been entered on it.
activated: in use. suspended: paused in the Konsol portal.
decommissioned: retired permanently.
"not_activated""activated""suspended""decommissioned"activated_at?|When an activation code was first entered on the device.
date-timetrading_ids*array<>The tradings the device is currently assigned to.
created_at*stringdate-timeupdated_at*stringdate-timecurl -X POST 'https://api.konsol.my/integration/v1/devices' \ -H 'Content-Type: application/json' \ -d '{ "device_identifier": "string", "vendor_id": "98232994-9d54-43ee-a280-d7c895362d0c", "model_id": "f8ff2fb8-4acc-4e48-bd83-cbdac23e1224"}'{ "id": "01a15ef6-b957-7b5b-827a-32ddeac48253", "device_identifier": "PAX0012345", "display_name": "Counter 1", "status": "not_activated", "trading_ids": [], "created_at": "2026-10-21T14:56:30.039938Z", "updated_at": "2026-10-21T14:56:30.039938Z"}