Upload Device Identifiers to Verizon:

POST /devices/actions/upload

Uploads new device identifiers from OEMs to Verizon. The devices can then be added to accounts and activated for service.
The information is returned in a callback response, so you must register a URL endpoint to receive DeviceService callback messages using POST /callbacks.

NOTE: To use this API method, your company must be registered on the Open Development portal with the ability to upload devices to Verizon. Additionally, users can submit up to 10,000 device IDs per request.

Contents

• Upload Device Identifiers to Verizon:
  POST /devices/actions/upload
  • Uses and Requirements
  • Request Components
    • HTTP Request
    • Query Parameters
    • Header Parameters
    • Request Body
      • Example Request Body
  • Success Response
    • Example Success Response
  • Callback Response
    • Example Callback Response
    • Error and Status Messages

Uses and Requirements

As an alternative to uploading a CSV file, device manufacturers can use this endpoint to upload the identifiers and SKUs of newly manufactured devices to Verizon. The request returns a synchronous response that indicates that the data has been received, and returns any errors in the request format. When the request has been fully processed, Verizon sends a report to the email address provided in the request body. Users can submit up to 10,000 device IDs per request.

All devices in an upload must be of the same type and have the same SKU.

Please wait at least 5 minutes after receiving an Upload response to submit an Activation request.

NOTE: SKUs are case-sensitive and must be upper case.

Request Components

HTTP Request

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

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 devices to upload.

Example Request Body

Upload devices by IMEI

{
  "accountName":"1223334444-00001",
  "emailAddress":"bob@mycompany.com",
  "deviceSku":"VZW123456",
  "uploadType":"IMEI",
  "devices":[
    {
      "deviceIds":[  
        {
          "kind":"IMEI",
          "id":"15-digit IMEI"
        }
      ]
    },
    {
      "deviceIds":[  
        {
          "kind":"IMEI",
          "id":"15-digit IMEI"
        }
      ]
    },
    {
      "deviceIds":[  
        {
          "kind":"IMEI",
          "id":"15-digit IMEI"
        }
      ]
    }
  ]
}

Upload devices by IMEI ICCID Pair

{
  "accountName":"1223334444-00001",
  "emailAddress":"bob@mycompany.com",
  "deviceSku":"VZW123456",
  "uploadType":"IMEI ICCID Pair",
  "devices":[
    {
      "deviceIds":[  
        {
          "kind":"IMEI",
          "id":"15-digit IMEI"
        },
        {  
          "kind":"ICCID",
          "id":"20-digit ICCID"
        }
      ]
    },
    {
      "deviceIds":[  
        {
          "kind":"IMEI",
          "id":"15-digit IMEI"
        },
        {  
          "kind":"ICCID",
          "id":"20-digit ICCID"
        }
      ]
    },
    {
      "deviceIds":[  
        {
          "kind":"IMEI",
          "id":"15-digit IMEI"
        },
        {  
          "kind":"ICCID",
          "id":"20-digit ICCID"
        }
      ]
    }
  ]
}

Success Response

Status 200

Example Success Response

{"requestId": "595f5c44-c31c-4552-8670-020a1545a84d"}

Callback Response

The callback contains an array of devices objects, one for each device in the request and a lineStatus that describes whether the upload was successful or the error indicating why the device upload failed.

Example Callback Response

{
   "username":"",
   "password":"",
   "requestId":"595f5c44-c31c-4552-8670-020a1545a84d",
   "deviceResponse":{
      "deviceUploadResponse":{
         "devices":[
            {
               "deviceIds":[
                  {
                     "id":"20-digit ICCID",
                     "kind":"ICCID"
                  },
                  {
                     "id":"15-digit IMEI",
                     "kind":"IMEI"
                  }
               ],
               "lineStatus":"Device upload successful."
            },
            {
               "deviceIds":[
                  {
                     "id":"20-digit ICCID",
                     "kind":"ICCID"
                  },
                  {
                     "id":"15-digit IMEI",
                     "kind":"IMEI"
                  }
               ],
               "lineStatus":"Device upload successful"
            },
            {
               "deviceIds":[
                  {
                     "id":"20-digit ICCID",
                     "kind":"ICCID"
                  },
                  {
                     "id":"15-digit IMEI",
                     "kind":"IMEI"
                  }
               ],
               "lineStatus":"SIM Id is invalid"
            }
         ],
         "accountName":"1223334444-00001",
         "deviceSku":"VZW123456",
         "totalLineCount":"3",
         "failedLineCount":"1",
         "successLineCount":"2"
      }
   },
   "status":"null",
   "callbackCount":1,
   "maxCallbackThreshold":4
}

Error and Status Messages