GetSubscriptionInformation

SIM-Secure binds SIMs to devices, safeguarding data usage and access to corporate networks

As your connected systems grow, so does your exposure to risk of SIM card misuse. SIM-Secure takes on the burden of securing the SIM of each device that connects to your network.

SIM-Secure helps you:

Secure IoT sensors and devices, industrial equipment, and more by pairing each SIM card with a specific device.
Prevent unauthorized devices from connecting to your private network.

Once the SIM-Secure feature is applied to a SIM, it is bound to the device in which it is inserted. If the SIM is removed from the original device and placed into a second device, the SIM-Secure feature will recognize that it is in the wrong device, and will prevent connection to the network.

Uses and Requirements

Devices must meet the following requirements to have a SIM-Secure license and lifetime SKU assigned:

Devices must be in an active state.
Devices must be onboarded onto the ThingSpace platform
Devices must belong to the account making the assignment request.
Devices must be 4G devices. Only 4G devices are eligible for Sim-Secure license assignment.

Request Parameters

The request body identifies the account name, SKU number, and a list of devices that you want to assign a SIMSecure license to. NOTE: The skuNumber for the devices must be "skuNumber": "SIMSec-IoT-Lt".

Parameter	Type	Description
AccountName required	string	The name of the billing account. This parameter is only required if the UWS account used for the current API session has access to multiple accounts. An account name is usually numeric, and must include any leading zeros.
SkuNumber optional	string	The Stock Keeping Unit (SKU). NOTE: For SIM-Secure, SkuNumber must be "SIMSec-IoT-Lt"

Response Parameters

The response includes the request ID and the current status of the request.

Parameter	Type	Description
Subscriptions	SubscriptionInfo
SkuNumber	string	The Stock Keeping Unit (SKU) of the device.
LicenseType	string	The type of license assigned: Lifetime Monthly Recurring Charge
LicensePurchased	string	The number of licenses purchased on the account.
LicenseAssigned	string	The number of licenses assigned on the account.
LicenseAvailable	string	The number of licenses available on the account.

Example SOAP Request

<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.AccountService">
  <soapenv:Header>
    <v2:token">75519e03-36fc-421d-84a7-23fff01c9e96</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:GetSubscriptionInformation>
      <v2:Input>
        <nph:AccountName>0001234654-00001</nph:AccountName>
        <nph:SkuNumber></nph:SkuNumber>
      </v2:Input>
    </v2:GetSubscriptionInformation>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<GetSubscriptionInformationResponse xmlns="http://nphase.com/unifiedwebservice/v2">
  <Output xmlns:a="http://schemas.datacontract.org/2004/07NPhase.UnifiedWebService.APIs.v2.Contract.AccountService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <a:RequestIdStatus>
      <a:RequestId>91bd36d3-a063-4600-928b-bb57eeccb9ad</a:RequestId>
      <a:Status>Success</a:Status>
    </a:RequestIdStatus>  
  </Output>
</GetSubscriptionInformationResponse>