Soracom Air for Cellular

IMEI Lock

The IMEI Lock option provides a straightforward method for securing your Air SIM, ensuring that in the case that your Air SIM is stolen, it cannot be used inside another device resulting in unwanted data usage charges.

IMEI Lock works by verifying the IMEI of the device as reported by the carrier. Although rare, some carriers may not report the IMEI. As Soracom will be unable to verify the IMEI of the device, any data session will be rejected, even if the device is correct. Please confirm that the IMEI Lock option works as intended in your country of use.

Enabling IMEI Lock

  1. Login to the User Console. From the Menu, open the SIM Management screen.

  2. From the list of subscribers, click the for the SIM you want to modify.

  3. Click the Actions menu, then select Enable IMEI lock.

    https://console.soracom.io

    Enable IMEI lock

  4. In the dialog, enter the IMEI of the device the SIM should be locked to, then click Lock.

    Set IMEI lock

You can set IMEI Lock for multiple SIMs that have been installed in a device and are online. Simply click the for each SIM, then repeat the steps above. Each SIM will be locked to the IMEI of the device it is currently in.

Removing IMEI Lock

  1. Login to the User Console. From the Menu, open the SIM Management screen.

  2. From the list of subscribers, click the for the SIM you want to modify.

  3. Click the Actions menu, then select Unset IMEI lock.

    https://console.soracom.io

    Unset IMEI lock

  4. In the dialog, click Remove Lock to confirm that you want to remove the IMEI Lock.

    Remove IMEI lock

You can remove IMEI Lock for multiple SIMs. Simply click the for each SIM, then repeat the steps above. IMEI Lock will be removed for each selected SIM, regardless of its Session status.

Programmatic Usage

You can also use the Soracom API, Soracom CLI, and Metadata Service to enable or disable IMEI lock.

Soracom API

To access the Soracom API, first use the auth API to obtain an API Key and Token. Refer to the API Reference Guide for instructions on how to use the API Key and Token in API requests.

Then, use the setImeiLock API to enable IMEI lock on an Air SIM:

curl -X POST \
>  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
>  -H 'X-Soracom-Token: <MY-TOKEN>' \
>  -H 'Content-Type: application/json' \
>  -d '{
>        "imei": "860000012345678"
>      }' \
>  https://g.api.soracom.io/v1/subscribers/<IMSI>/set_imei_lock

If the subscriber is online, you can omit the payload in order to lock the subscriber to the current IMEI.

To remove IMEI lock from an Air SIM, use the unsetImeiLock API:

curl -X POST \
>  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
>  -H 'X-Soracom-Token: <MY-TOKEN>' \
>  https://g.api.soracom.io/v1/subscribers/<IMSI>/unset_imei_lock

Soracom CLI

To use the Soracom CLI, you must first configure it to authenticate with your account information, authorization key, or SAM user credentials.

Then, run the following command to enable IMEI lock on an Air SIM:

soracom subscribers set-imei-lock --imsi <IMSI> --imei "860000012345678" --coverage-type g

If the subscriber is online, you can omit the --imei flag in order to lock the subscriber to the current IMEI.

To remove IMEI lock from an Air SIM, use following command:

soracom subscribers unset-imei-lock --imsi <IMSI> --coverage-type g

Metadata Service

The Metadata Service allows an Air SIM device to access and configure its own settings without the need for authentication. For more information, refer to the Metadata Service documentation.

Because the Metadata Service allows an Air SIM to access its own subscriber settings, this can be used as part of an initialization script so that a device sets its own IMEI lock when it connects to a network for the first time.

To enable IMEI lock on an Air SIM, the Metadata Service Readonly option must be disabled. Then, from the Air SIM device, use the setImeiLock API:

curl -X POST \
>  -H 'Content-Type: application/json' \
>  -d '{
>        "imei": "860000012345678"
>      }' \
>  http://metadata.soracom.io/v1/subscriber/set_imei_lock

Since the subscriber will be online, you can also omit the payload in order to lock the subscriber to its current IMEI.

To remove IMEI lock from the Air SIM, use the unsetImeiLock API:

curl -X POST http://metadata.soracom.io/v1/subscriber/unset_imei_lock