Skip to content

Register

Description

Module to offer a unified endpoint to handle all required device registration steps

API

Endpoints
POST
Register device

Register device

Endpoint to handle all device-register related things in a single endpoint.

POST
/api/v1/register

Access

This endpoint requires create permission for the resource register.

Request Body

NameDescription
imei
string
The IMEI number of the device
Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
iccid
string
The ICCID for the device
Pattern: ^[0-9a-fA-F]
publicKey
string
The public key for the device
Pattern: ^[0-9a-fA-F]

Response

NameDescription
claimCode
string
Claim code as seen on the device
Pattern: ^(?:[1-9A-HJ-NP-Za-km-z]{4}-[1-9A-HJ-NP-Za-km-z]{4}-[1-9A-HJ-NP-Za-km-z]{2,4}|[1-9A-HJ-NP-Za-km-z]{10,12})$