Overview

A Cloud ID is a globally unique identifier minted once per Device and persisted across factory resets and wipes — similar in role to a serial number.

Because it's stable, the Cloud ID can be printed on the Device's box, shown on the Device's console, or rendered as a QR code so the End Customer can claim the Device with a single scan.

📘

The Cloud ID is required when the Device Model uses the Cloud ID Authentication Method. It's optional for other authentication methods.

Generating a Cloud ID

The manufacturer generates a Cloud ID by concatenating two parts:

1. The Partner's short code — available in the Partner Portal at partners.xyte.io/settings/provision.
2. A 16–36 character string of ASCII letters and digits, unique to the Device.

📘

Use a NanoID library to generate the second part. See NanoID generators for implementations in your language.

Using Cloud IDs

When defining a new Device Model in the Partner Portal, select Cloud ID as the Authentication Method.

When the Device calls the Register Device API, include the Cloud ID in the request body as the cloud_id field.

Sample payload

{
    "hardware_key": "0ed83509-4cfc-4439-ac1c-91f4c77bc6a3",
    "cloud_id": "QRzR3322fas2231qqweqw",
    "firmware_version": "1.0.1",
    "name":"test",
    "sn": "21311.2231.3A"
}

📘

With the Cloud ID Authentication Method, the mac field is optional — but still recommended for diagnostics.