CheckDeviceAvailability

Checks whether specified devices are registered by the manufacturer with the Verizon network and are available to be activated. The information is returned in a callback response, so you must register a URL endpoint to receive DeviceService callback messages using the Register Callback API in the Callback Registration Service.

Uses and Requirements

You can use this request to find out about the existence and status of these types of devices:

2G/3G device - send the device ESN or MEID to find out if the device exists in the Verizon database, what the product type is, the device SKU, and whether it is associated with an active line of service.
4G device with removable SIM - send the device IMEI to find out if the device exists in the Verizon database, what the product type is, and the device SKU.
4G removable SIM - send the SIM ICCID to find out if the SIM exists in the Verizon database and whether it is associated with an active line of service.
4G device with embedded SIM - send either the IMEI or the ICCID or both to verify their existence in the Verizon database, whether they are paired together, and the line activation status, as well as product type and SKUs.

Request Parameters

Parameter	Type	Description
DeviceList required	DeviceIdentifierCollection	A list of up to 2,000 DeviceIdentifierCollections containing the devices and SIMS that you want to search for in the Verizon database. Each DeviceIdentifierCollection will have a corresponding `CheckDeviceAvailability` element in the callback response. To search for a 4G device and SIM pairing, include both the IMEI and ICCID in the same DeviceIdentifierCollection. For each device in DeviceList, use this structure of nested parameters: <DeviceIdentifierCollection> <DeviceIndentifiers> <DeviceIdentifier> <Kind>identifier_type</Kind> <Identifier>identifier_value</Identifier> </DeviceIdentifier> </DeviceIndentifiers> </DeviceIdentifierCollection>
Kind required for DeviceList	string	The type of the device identifier. Valid types of identifiers are: ESN (decimal) ICCID (up to 20 digits) IMEI (up to 16 digits) MEID (hexadecimal)
Identifier required for DeviceList	string	The value of the device identifier.
AccountName required	string	The name of the account that you want the callback response sent to. Account names are usually numeric and must include any leading zeros.

Response Parameters

Parameter	Type	Description
RequestId	string	A unique string that associates the request with the results that are sent via a callback service. The callback message will contain the information for all devices in the request.

Callback Response Parameters

Parameter	Type	Description
CallbackRequest	CallbackRequest	Wrapper element for all callback elements.
Username	string	The username defined when a URL was registered for the callback service, or an empty element if no username was defined.
Password	string	The password defined when a registered for the callback service, or an empty element if no password was defined.
RequestId	string	A unique string that matches the RequestId returned in the synchronous response to the original API request. A separate callback message is sent for each device that matched the request criteria, indicating whether the operation succeeded for that device. All of the callback messages will have the same RequestId.
Data	CallbackData	The data elements for this callback.
CarrierService	CarrierServiceCallbackRequest	Null for this callback service.
ExternalProvisioningChange	ExternalProvisioningChange	Null for this callback service.
PromoChange	PromoChange	Null for this callback service.
SMSDelivery	SMSDelivery	Null for this callback service.
PRLInformation	PRLInformation	Null for this callback service.
DeviceService	DeviceServiceCallbackRequest	The data returned from a DeviceService API request.
CheckDeviceAvailability	CheckDeviceAvailabilityResponse	The availability information for one requested DeviceIdentifierCollection.
DeviceInfo	Devices object	Devices associated with a single requested device. If the request was for either an ICCID or IMEI of a 4G device with embedded SIM, both the ICCID and IMEI will be included in the response.
Device	DeviceInfo object	Availability information about a single device. This element will be repeated if the specified ID is part of a Device-SIM pairing.
Kind	string	The type of the device identifier. Valid types of identifiers are: ESN (decimal) ICCID (up to 20 digits) IMEI (up to 16 digits) MEID (hexadecimal)
Identifier	string	The value of the device identifier.
DeviceSku	string	The SKU of the device. May not be present for ICCIDs.
ProductType	string	The general type of the device. May not be present for ICCIDs.
DeviceFound	Boolean	True if the device has been registered with Verizon by the manufacturer.
DeviceSimPair	Boolean	True for IMEIs or ICCIDs from 4G devices with embedded SIMs; false in all other devices.
AssociatedWithMtn	Boolean	True for ICCIDs if the device is associated with a line of service. False for all other device identifiers.
AccountName	string	The name of the account that requested the callback.
GoToState	GoToState	Null for this callback service.
Fault	SoapFault	Information about any errors that may have occurred.
faultcode	QName
faultstring	string
faultfactor	anyURI
detail
Comment	string	Null for this callback service.
Summary	SummaryReport	Null for this callback service.
Status	string	Null for this callback service.
CallbackCount	integer	The number of times this callback message has been sent.
MaxCallbackThreshold	integer	The maximum number of times this callback message will be sent if it is not correctly acknowledged.

Example SOAP Request

A request for information about a 3G device, two SIMs, and a SIM-ICCID pair.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:v2="http://nphase.com/unifiedwebservice/v2"
 xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.DeviceService"
 xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
  lt;soapenv:Header>
    <token xmlns="http://nphase.com/unifiedwebservice/v2">4e0c28cd-dd4a-40b9-adae-bbea774b4aab</token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:CheckDeviceAvailability>
      <v2:Input>
        <nph:DeviceList>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>meid</nph1:Kind>
                <nph1:Identifier>A100008385E561</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind>
                <nph1:Identifier>89148000000842590078</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind>
                <nph1:Identifier>84258000000891490087</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>imei</nph1:Kind>
                <nph1:Identifier>990005350342573</nph1:Identifier>
              </nph1:DeviceIdentifier>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind>
                <nph1:Identifier>82458000000984190032</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
        </nph:DeviceList>
        <nph:AccountName>0251687987-0001</nph:AccountName>
      </v2:Input>
    </v2:CheckDeviceAvailability>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <CheckDeviceAvailabilityResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.DeviceService">
        <a:RequestId>6d5ccc6a-d3bc-4a9c-8466-c7f67c15e1f4</a:RequestId>
      </Output>
    </CheckDeviceAvailabilityResponse>
  </s:Body>
</s:Envelope>

Example SOAP Callback Response

This example response has comments inserted to highlight responses for these different scenarios:

The 3G device is found in the Verizon database and has a line of service.
One SIM is found in the Verizon database and is associated with a device.
One SIM is not found in the Verizon database.
The SIM-device pair is found in the Verizon database.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <CallbackRequest xmlns="http://nphase.com/unifiedwebservice/v2">
      <Username/>
      <Password/>
      <RequestId>6d5ccc6a-d3bc-4a9c-8466-c7f67c15e1f4</RequestId>
      <Data>
        <Data>
          <CarrierService xsi:nil="true"/>
          <ExternalProvisioningChange xsi:nil="true"/>
          <PromoChange xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceService>
            <CheckDeviceAvailability>
        <!-- 3G device found -->
              <DeviceInfo>
                <Device>
                  <Kind>MEID</Kind>
                  <Identifier>A100008385E561</Identifier>
                  <DeviceSku>SMB311ZKA</DeviceSku>
                  <ProductType>BasicPhone</ProductType>
                  <DeviceFound>true</DeviceFound>
                </Device>
                <DeviceSimPair>false</DeviceSimPair>
                <AssociatedWithMtn>true</AssociatedWithMtn>
              </DeviceInfo>
        <!-- ICCID found; paired IMEI is also included -->
              <DeviceInfo>
                <Device>
                  <Kind>imei</Kind>
                  <Identifier>990005325735034</Identifier>
                  <DeviceSku>VZW090000450004</DeviceSku>
                  <ProductType>Modem</ProductType>
                  <DeviceFound>true</DeviceFound>
                </Device>
                <Device>
                  <Kind>iccid</Kind>
                  <Identifier>89148000000842590078</Identifier>
                  <DeviceFound>true</DeviceFound>
                </Device>
                <DeviceSimPair>true</DeviceSimPair>
                <AssociatedWithMtn>true</AssociatedWithMtn>
              </DeviceInfo>
        <!-- ICCID not found -->
              <DeviceInfo>
                <Device>
                  <Kind>iccid</Kind>
                  <Identifier>84258000000891490087</Identifier>
                  <DeviceFound>false</DeviceFound>
                </Device>
                <DeviceSimPair>false</DeviceSimPair>
                <AssociatedWithMtn>false</AssociatedWithMtn>
              </DeviceInfo>
        <!-- IMEI and ICCID pairing  found -->
              <DeviceInfo>
                <Device>
                  <Kind>imei</Kind>
                  <Identifier>990005350342573</Identifier>
                  <DeviceSku>VZW090000450004</DeviceSku>
                  <ProductType>Modem</ProductType>
                  <DeviceFound>true</DeviceFound>
                </Device>
                <Device>
                  <Kind>iccid</Kind>
                  <Identifier>82458000000984190032</Identifier>
                  <DeviceFound>true</DeviceFound>
                </Device>
                <DeviceSimPair>true</DeviceSimPair>
                <AssociatedWithMtn>true</AssociatedWithMtn>
              </DeviceInfo>
              <AccountName>0251687987-0001</AccountName>
            </CheckDeviceAvailability>
          </DeviceService>
          <GoToState xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment xsi:nil="true"/>
          <Summary xsi:nil="true"/>
          <Status xsi:nil="true" />
          <CallbackCount>1</CallbackCount>
          <MaxCallbackThreshold>4</MaxCallbackThreshold/>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>