Registering Soracom Air SIMs

When you purchase an Air 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 SIM module, and to associate basic fees and data usage fees from the SIM module to your account.

Unlike activating a SIM card with a mobile network operator, Soracom's registration process does not incur any fees.


Pre-registered Air SIMs

For orders of SIMs purchased through the User Console, each SIM is automatically pre-registered to your account. Once you receive your SIMs, simply open the Orders screen in the User Console, and click the Register button that corresponds to your SIM card order.

https://console.soracom.io

Register order

Once you have registered your order, all SIMs in that order will appear in your account.


Manually Registering an Air SIM

For orders of SIMs purchased through Amazon or a reseller, each SIM must be individually registered to your Soracom account.

Registering a Soracom Air IoT SIM

When registering a Soracom Air IoT SIM (Global coverage, regardless of plan), you will be required to enter the ICCID of the SIM card, as well as the module's PUK (Personal Unlock Key). Both the ICCID and PUK 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 Global coverage type.

  2. Click the Register SIM button.

    https://console.soracom.io

    Register SIM

  3. Enter the ICCID and PUK of the SIM, then click Register. You can also give the SIM a name, and assign it to an existing group.

    Register Global SIM

Registering a Soracom Air IoT SIM for Japan

When registering a Soracom Air IoT SIM (Japan-only 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. Enter the IMSI and Passcode of the SIM, then click Register. You can also give the SIM a name, and assign it to an existing group.

    Register Japan SIM

When you purchase a Japan Air SIM, a registration deadline is printed on the reverse of the SIM card package. You must register the SIM card to your account before the indicated deadline. If the deadline has already passed, you will be unable to register the SIM card to your account. If you purchased and received a Japan Air SIM with a registration deadline that has already passed, please contact Soracom support in order to receive a replacement SIM card.


Transferring SIM Registration

When an Air SIM is registered to a Soracom account, its subscription status will automatically be set to Ready. This status indicates that the registration process completed successfully, and the Air SIM is ready to make network connections. An Air SIM will remain in the Ready state as long as a device has not initiated a network connection request.

Prior to any network connection, an Air SIM may be transferred to another Soracom account.

However, as soon as a device initiates a network connection request, the status will automatically change to Active. From that point, transferring the Air SIM to another Soracom account is no longer possible.

Before initiating a transfer request, you will need:

Initiate a Transfer Request

  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 transfer.

  3. Click the Actions menu, then select Transfer to another operator.

    https://console.soracom.io

    Transfer SIM

  4. Follow the steps to enter the new Operator ID and complete the initiate transfer request.

    Transfer SIM

An email will be sent to the new operator to notify them of the transfer request.

Accept a Transfer Request

To accept a SIM transfer, the operator receiving the transfer must:

  1. Login to the User Console.

  2. Open the transfer request notification email, and click the transfer confirmation link.

Programmatic Usage

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

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 registerSubscriber API to register 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 '{
>        "registrationSecret": "12345678"
>      }' \
>  https://g.api.soracom.io/v1/subscribers/<IMSI>/register

To transfer a subscriber, use the following APIs to initiate or cancel a transfer request:

And the following API to accept a transfer request:

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 register an Air SIM:

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

To transfer a subscriber, use the following commands to initiate or cancel a transfer request:

  • soracom subscribers issue-transfer-token
  • soracom subscribers verify-transfer-token

And the following command to accept a transfer request:

  • soracom subscribers delete-transfer-token