Soracom Air for Cellular

Registering Soracom IoT SIMs

When you purchase a Soracom IoT SIM, it must be registered to your Soracom account before use. This is similar to activating a SIM card with a traditional mobile network operator. The SIM registration process is required to confirm your receipt of the SIMs and to associate basic fees and data usage fees from the SIMs to your account.

Registering SIMs from an Order

If you purchased Soracom IoT SIMs or other products that include Soracom IoT SIMs from the User Console or Soracom Web Store, the SIMs may have been pre-registered to your account, and you can register them by registering the order. If you do not see a Register Order button next to your order, please register the SIM using its ICCID and PUK (Personal Unlock Key) numbers as detailed in Manually Registering a SIM.

To register SIMs from an order:

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

2. Click the Register SIM button.

   https://console.soracom.io

   

3. Click the From Order tab.

4. From the list of orders, find the order that you want to register, and click Register.

   https://console.soracom.io

   

Customizing Initial Settings

While configuring an IoT SIM's settings from the User Console is simple, doing so for a large number of SIMs can become tedious. When purchasing SIMs directly from Soracom, you can customize the initial settings that will be applied to all of the SIMs in the order upon registration.

The following initial settings can be customized for each subscription in your order:

• Group
• Speed Class
• Tags

Once you register your order, the initial settings you selected will be automatically applied to each SIM in the order.

If you do not specify any initial settings, your SIMs will be registered to your account without any Group setting or Tags, and the Speed Class will be configured according to the subscription's default Speed Class.

To customize the initial settings you want to apply to the SIMs in your order:

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

2. Click the Register SIM button.

   https://console.soracom.io

   

3. Click the From Order tab.

4. From the list of orders, find the order that you want to customize, and click Configure SIM initial settings.

   https://console.soracom.io

   

5. Configure the Group, Speed Class, and Tags that you would like to be applied to each SIM in your order:

   

   • Group (optional) - Each SIM will be added to the selected group upon registration. If empty, or if the group was deleted prior to registration, the SIMs will be registered without being added to any group.

     If you want to add SIMs to a new group, first create a new group by following the Groups: Managing Groups instructions. Then return to this step in order to select your new group.

     Note that the Group initial setting will be configured using the selected group's Group ID. Therefore, SIMs will still be registered to the selected group, even if you rename the group or modify group settings.

   • Speed Class (optional) - Each SIM will be configured with the selected speed class upon registration. If empty, the default Speed Class for the subscription will be applied to the SIMs.

   • Tags (optional) - Tags will be added to each SIM upon registration.

     The Tag Name name is used for giving a SIM a custom name. If specified, each SIM will be named according to the value specified. For example, if you configure Tag Name as name and its corresponding Tag Value as my-sim, each SIM in your order will be renamed to my-sim upon registration.

6. Click Update initial settings.

The initial settings that you specified will be applied to each SIM in the order as soon as you register the order or once the order is automatically registered according to the Automatic Registration Period above.

Manually Registering a SIM

If you purchased or received products that include Soracom IoT SIMs through a non-Soracom shopping site, including eSIMs and other SIM formats included in device bundles, you must register each SIM individually to your Soracom account using its ICCID and PUK numbers.

Registering an IoT SIM

When registering a Soracom IoT SIM (under Global coverage, regardless of the plan), you will need to enter the SIM card's ICCID and PUK numbers. See the table below for details on where to find the ICCID and PUK numbers depending on the Soracom product.

^{*1 - LTE-M Buttons purchased from Soracom directly have the eSIM ICCID and PUK numbers printed in the same location. However, their associated eSIMs are pre-registered to your Soracom account and do not require manual registration.}

Once you have obtained the ICCID and PUK information, you can register the SIM to your account.

1. Login to the User Console. From the Menu, open the SIM Management screen. Ensure that you have selected the Global coverage type.

2. Click the Register SIM button.

   https://console.soracom.io

   

3. From the Direct Input tab, enter the ICCID and PUK numbers of the SIM, then click Register. You can also give the SIM a name and assign it to an existing group.

   https://console.soracom.io

   

Registering an IoT SIM for Japan

When registering a Soracom IoT SIM for Japan (Japan coverage, regardless of plan), you will be required to enter the IMSI of the SIM card, as well as the SIM card's Passcode. Both the IMSI and Passcode are printed on the reverse side of the SIM card.

1. Login to the User Console. From the Menu, open the SIM Management screen. Ensure that you have selected the Japan coverage type.

2. Click the Register SIM button.

3. From the Direct Input tab, enter the IMSI and Passcode for the SIM, then click Register. You can also give the SIM a name and assign it to an existing group.

   https://console.soracom.io/

   

Bulk Registration of IoT eSIMs

If you have purchased IoT embedded SIMs (eSIMs) in a reel from a store other than Soracom's, you can register the IoT eSIMs in bulk by entering the 19-digit First ICCID, 19-digit Last ICCID, and 8-character Authentication Passcode in the Soracom User Console.

1. Login to the User Console. From the Menu, open the SIM Management screen. Ensure that you have selected the correct coverage type for your region.

2. Click the Register SIM button.

3. From the Authentication Passcode tab, enter the 19-digit First SIM ICCID, 19-digit Last SIM ICCID, and 8-character Authentication Passcode, then click Register

Downloading a List of Registered SIMs

You can download a CSV file containing a list of all SIMs registered to your account.

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

2. Click the Download button on the upper right side of the screen.

   https://console.soracom.io

   

   The columns of the downloadable CSV file are explained below:

You can also download a CSV file containing a list of SIMs that belong to a specific order.

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

2. From the list of orders, find the order that contains the SIMs you want to download, and click the List subscribers button.

   https://console.soracom.io

   

3. In the dialog window pop up, click the Download CSV button.

   The columns of the downloadable CSV file are explained below:

Programmatic Usage

You can also use the Soracom API and Soracom CLI to register IoT SIMs to your account.

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

curl -X POST \
|  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
|  -H 'X-Soracom-Token: <MY-TOKEN>' \
|  -H 'Content-Type: application/json' \
|  -d '{
|        "registrationSecret": "12345"
|      }' \
|  https://jp.api.soracom.io/v1/subscribers/<IMSI>/register

soracom subscribers register --imsi <IMSI> --registration-secret "12345678" --coverage-type g

soracom subscribers register --imsi <IMSI> --registration-secret "12345" --coverage-type jp