Assign SIM-Secure for IoT Licenses  

POST /devices/licenses/actions/assign

Assigns SIM-Secure for IoT licenses to SIMs.

Contents

• Assign SIM-Secure for IoT Licenses
  POST /devices/license/actions/assign
  • Uses and Requirements
  • Request Components
    • HTTP Request
    • Resource Path and Query Parameters
    • Header Parameters
    • Request Body
      • Example Request Body
  • Success Responses
    • Example Success Response
    • Example Success Callback Response
  • Failure Responses
  • Error Codes and Messages

Uses and Requirements

You can assign SIM-Secure for IoT licenses to SIMs. Flexible licenses are purchased either a-la-carte or part of a bundle and are designated as: SIMSec-IoT and TS-BUNDLE-KTO-SIMSEC-MRC, respectively. Lifetime licenses are assigned to a SIM for the life of the SIM, and cannot be removed. Lifetime licenses are designated as SIMSec-IoT-Lt. TSS-IOT-INTLG-TIERED-SIMSEC is the SKU for the SIM-Secure flexible license included in the intelligence bundle.

To have a SIM-Secure for IoT license, assigned devices must be:

• In an active state.
• Onboarded into ThingSpace/ThingSpace Connectivity Management.
• Visible within the ThingSpace Manage web portal.
• Part of the account making the assignment request.
• 4G devices. Only 4G devices are eligible for SIM-Secure for IoT license assignment.

Note: The user should register for the CarrierService Callback in order to receive callbacks for confirmation or failure of a license assignment. For more information about callbacks, please see About Callback Services and how to Register a Callback Listener.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/devices/license/actions/assign

Resource Path and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Request Body

The request body identifies the account name, SKU number, and a list of devices to which you want to assign a SIM-Secure for IoT license.

NOTE: You can only assign one license type, or SKU number, per request. To assign different license types, you must use a separate request for each type.

Example Request Body

{
  "accountName": "0000123456-00001",
  "skuNumber": "SIMSec-IoT-Lt",
   "devices": [
    {
      "deviceIds": [
        {
          "id": "15-digit IMEI",
          "kind": "imei"
        },
        {
          "id": "20-digit ICCID",
          "kind": "iccid"
        }
      ]
    },
    {
      "deviceIds": [
        {
          "id": "15-digit IMEI",
          "kind": "imei"
        },
        {
          "id": "20-digit ICCID",
          "kind": "iccid"
        }
      ]
    }
  ]
}

Success Responses

Status 200

Example Success Response

{"requestId": "c3f3d17c-79ff-4b35-82df-94446785b6e0"}

Example Success Callback Response

You receive a callback when you initiate SIM-Secure for IoT license assignment to SIMs and receive an asynchronous response.

{
   "requestId":"c3f3d17c-79ff-4b35-82df-94446785b6e0",
   "deviceIds":[
      {
         "id":"20-digit ICCID",
         "kind":"ICCID"
      },
      {
         "id":"10-digit MDN",
         "kind":"MDN"
      },
      {
         "id":"15-digit IMEI",
         "kind":"IMEI"
      }
   ],
   "deviceResponse":{
      "deviceSkuSubscriptionResponse":{
         "accountName":"0000123456-00001",
         "skuNumber":"TSS-IOT-INTLG-TIERED-SIMSEC",
         "action":"Assign"
      }
   },
   "comment":"",
   "status":"Success",
   "callbackCount":1,
   "maxCallbackThreshold":4
}

Failure Responses

Error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error Codes and Messages