Retrieve a list of mismatched hardware :

POST /devices/actions/list/imeiiccidmismatch

Returns a list of all 4G devices with an ICCID (SIM) that was not activated with the expected IMEI (hardware) during a specified time frame.

Contents

Uses and Requirements

The current SIM-Device pairing is compared with expected values from the Verizon device database. If the current IMEI (device ID) does not match the value in the database, the device is included in the response.

The report can span up to three months of time, and it is possible for a SIM to be installed in several devices during that time. Each unexpected pairing is reported separately in the response.

You can tell the device manufacturer about any mismatches and ask them to upload corrected information to the Verizon database.

Request

HTTP Request

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

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.

 

Parameter Name Data Type Description
Parameter NameAuthorization
required
Data Typestring DescriptionHTTP Authorization bearer token.
Parameter NameVZ-M2M-Token
required
Data Typestring DescriptionA valid session token returned by POST /session/login.
Parameter NameContent-Type
required
Data Typestring DescriptionMust be application/json.

Request Body

The request body identifies the devices that you want to work with. You can either specify individual devices in the devices parameter, or you can use the filter parameters to work with devices that match the filter parameter values.

Parameter Name Data Type Description
Parameter NameaccountName
optional
*Recommended
Data Typestring DescriptionThe account that you want to search for mismatched devices. If you don’t specify an accountName, the search includes all devices to which you have access.
This parameter is required if you are passing groupName.
An account name is usually numeric, and must include any leading zeros.

*By coding for the account number today, you prevent future code from breaking if you ever add a new sub-account.

Parameter Namedevices
optional
Data Typearray of device kinds and IDs DescriptionA list of specific devices that you want to check, specified by ICCID or MDN. If you do not specify devices, all devices in accountName or groupName are checked.
Parameter Name
kind,
id

required for devices
Data Typestring DescriptionThe type and value of the device identifier. Valid types of identifiers are ICCID and MDN.
Parameter Namefilter
required
Data Typelist of filter parameters DescriptionParameter names and values that you want to use to select the devices to work with.
Parameter Name
earliestrequired
Data Typestring DescriptionOnly include devices that were activated after this date and time. This value cannot be earlier than November 1, 2017.
Parameter Name
latestrequired
Data Typestring DescriptionOnly include devices that were activated before this date and time. Must be within three months of earliest date.
Parameter NamegroupName
optional
Data Typestring DescriptionThe name of a device group, to only include devices in that group.

Example Request Body

Request an IMEI check on two devices during a three month period:

{
  "accountName":"0342077109-00001",
  "devices":[
  {"deviceIds": [
    {
      "kind":"ICCID",
      "id":"8914800000080078"
    },
    {
      "kind":"MDN",
      "id":"5096300587"
    }
  ]
 }
  ],
  "filter":{
    "earliest":"2020-05-01T15:00:00-08:00Z",
    "latest":"2020-07-30T15:00:00-08:00Z"
  }
}

Success Responses

Status 200

Parameter Name Data Type Description
Parameter Namedevices Data Typearray DescriptionThe list of devices with IMEIs that do not match their ICCID when compared with the Verizon device database.
Parameter Name
accountName
Data Typestring DescriptionThe account that the device is associated with.
Parameter Name
mdn
Data Typestring DescriptionThe assigned phone number of the device.
Parameter Name
activationDate
Data Typestring DescriptionThe date and time when the SIM was last activated.
Parameter Name
iccid
Data Typestring DescriptionThe ID of the SIM.
Parameter Name
preImei
Data Typestring DescriptionThe IMEI of the device prior to the SIM OTA activation on simOtaDate.
Parameter Name
postImei
Data Typestring DescriptionThe IMEI of the device after the SIM OTA activation on simOtaDate.
Parameter Name
simOtaDate
Data Typestring DescriptionThe date and time of the SIM OTA activation.

Example Success Response

Response containing a single device that has completed OTA. None of the other devices in the request had mismatched IMEIs. NOTE: If the device has not completed OTA, an empty response is returned.

{
  "devices":[
    {
      "accountName":"0212398765-00001",
      "mdn":"5096300587",
      "activationDate":"2011-01-21T10:55:27-08:00",
      "iccid":"89148000000800784259",
      "preImei":"990003420535573",
      "postImei":"987603420573553",
      "simOtaDate":"2017-12-01T16:00:00-08:00"
    }
  ]
}

Failure Responses

Status 400

All error messages are returned in this format:

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

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!