Create a device

Create a device

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class provides the Device Create Request Dto.

typestring · enumRequired

Device type enum. See more: https://help.jframework.io/services/identity/device/device-type

Possible values:

codestring · min: 1Required

The code of the device.

isMobileAppbooleanOptional

Flag indicating if the device is a mobile app. By default, it is false.

isDefaultboolean · nullableOptional

Flag indicating if the device is the default device.

testModeboolean · nullableOptional

The test mode of the device.

namestring · min: 1Required

The name of the device.

phoneNumberstring · nullableOptional

The phone number of the device.

osDevicestring · min: 1Required

The operating system of the device.

appVersionNumberstring · min: 1Required

The version of the operating system of the device.

iccidstring · nullableOptional

The iccid of the device.

imsistring · nullableOptional

The imsi of the device.

imeistring · nullableOptional

The imei of the device.

simCardInfostring · nullableOptional

The sim card info of the device.

avatarURLstring · nullableOptional

The avatar URL of the device.

tagsstring · nullableOptional

The tags of the device.

statusstring · enumOptional

Represents the status of a device within the system.

Possible values:

Responses

201

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/devices

HTTPcURLJavaScriptPython

POST /api/v1/devices HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 372

{
  "type": "Mobile",
  "code": "DEV-001",
  "isMobileApp": true,
  "isDefault": true,
  "testMode": false,
  "name": "Steve's Android Phone",
  "phoneNumber": "[phone]",
  "osDevice": "Android",
  "appVersionNumber": "3.1.0",
  "iccid": "89148000001234567890",
  "imsi": "310150123456789",
  "imei": "358240051111110",
  "simCardInfo": "CarrierX - Plan A",
  "avatarURL": null,
  "tags": "production, android",
  "status": "Active"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "countryCode": null,
    "type": "Web",
    "code": "XYZ123",
    "isMobileApp": true,
    "tags": "android, smartphone",
    "status": "Active",
    "isDefault": true,
    "testMode": false,
    "name": "John's Phone",
    "phoneNumber": "[phone]",
    "osDevice": "Android",
    "appVersionNumber": "1.0.5",
    "iccid": "89148000000000000001",
    "imsi": "310260000000000",
    "imei": "356938035643809",
    "simCardInfo": "Verizon SIM",
    "avatarURL": null,
    "modifiedDate": "2026-01-26T01:03:23.748567Z"
  },
  "errors": []
}