Soracom Air for Cellular

Transferring Soracom IoT SIMs

Once an IoT SIM has been registered to a Soracom account, all aspects of the SIM, such as configuration and billing, will be associated with that Soracom account. In some cases, you may want to manage a SIM using a different Soracom account, such as maintaining a separate account for a project or department, or giving control of a SIM to an end-user. Although an IoT SIM cannot be registered to more than one Soracom account at a time, its registration can be transferred from one Soracom account to another. Depending on the subscriber status of your SIM, see the table below for the appropriate next steps.

Transferring Ready Status SIMs

You can transfer Ready status IoT SIMs to another Soracom account directly from the User Console or programmatically using the Soracom API. The basic transfer process is illustrated below.

Conditions and Limitations

When transferring Ready status SIMs, the following conditions and limitations apply:

• Some SIM cards cannot be transferred due to specific terms and conditions, resulting in an error when a transfer is attempted.
• The following SIM settings are not transferred from the source Soracom account:
  • Tags (including the name of the IoT SIM)
  • Expiration
  • Termination Protection
  • Group Settings
  • Event Handler

Initiating a SIM Transfer

To transfer a Ready status SIM, you will need the following:

• Your Soracom account (the source Soracom account)
• One or more SIMs to transfer, each of which is in the Ready status
• The primary Email Address and Operator ID of the Soracom account you want to transfer the SIMs to (the destination Soracom account)

To begin transferring Ready SIMs:

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.

4. Enter the destination operator Email and ID, then click Transfer.

   • Destination Operator Email - The primary email address of the destination Soracom account.
   • Destination Operator ID (OP + 10 digits) - The operator ID of the destination Soracom account.

Once you initiate the SIM transfer, the status of each SIM will change to Transferring, and an email will be sent to the destination Soracom account, allowing them to accept and complete the transfer

To complete the transfer, the owner of the destination Soracom account will need to accept the transfer using the steps in the next section.

Accepting a SIM Transfer

To accept a SIM transfer request:

1. Login to the User Console.

2. If necessary, change the Coverage Type (Global Coverage or Japan Coverage) to match that of the SIMs being transferred. Refer to Coverage Types for more information.

3. Using the same browser, open the SIM transfer request email that was sent to the primary email address of the destination Soracom account and click the URL included in the email.

   Clicking the link in the SIM transfer request email will immediately accept the transfer request upon opening the page. If you are not signed in, you may be prompted to do so first, upon which the transfer request will be completed.

   If you are not expecting a SIM transfer or do not wish to accept a transfer request, you may safely ignore the SIM transfer request email.

Once you have accepted the SIM transfer request, the SIMs will appear in your account, and you can begin using the SIMs by installing them in your devices and setting up the Soracom APN information as needed.

If the transferred SIMs require a specific configuration to function with existing devices, reach out to the owner of the source Soracom account to determine the appropriate configuration.

Canceling a SIM Transfer

If you need to cancel the transfer of a SIM:

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 cancel.
3. Click the Actions menu, then select Cancel Transfer.

Transferring SIMs in Other Statuses

To transfer SIMs that are in the Active, Inactive, Standby, or Suspended status, submit a SIM transfer request to Soracom by following the instructions below. Soracom will handle the process of transferring SIMs on your behalf.

Conditions and Limitations

When transferring Active, Inactive, Standby, or Suspended status SIMs, the following conditions and limitations apply:

• Some SIMs cannot be transferred due to specific terms and conditions. Once you submit a SIM transfer request, you will be notified if any SIMs cannot be transferred.
• SIM transfer requests must always be initiated by the source Soracom account where the SIMs are currently registered.
• The destination Soracom account must have accepted the appropriate regional terms and conditions for Soracom Air usage for the SIMs being transferred (Global or Japan). For example, if plan01s SIM cards are being transferred, the destination account must have accepted the Global terms and conditions for Air usage. You will be prompted to accept the terms and conditions for the relevant region the first time you switch your User Console to that region.
• Both the source and destination Soracom accounts must not have any outstanding charges.
• During the transfer, the following SIM settings will be preserved: Tags, Expiration settings, Subscription Containers, and IMEI Lock settings.
• During the transfer, the following SIM settings will not be preserved: Speed Class settings, Event Handler settings, Group settings, and stored data or files in Soracom Harvest.
• Existing active data sessions for SIMs will be deleted automatically during the transfer operation and cannot be transferred.
• If a Group exists on the destination Soracom account, you may specify its Group ID in your SIM transfer request, and each SIM's Group setting will be set accordingly during the transfer. If no Group is specified, the transferred SIMs will not be assigned to a Group.

Initiating a SIM Transfer Request

To submit a SIM transfer request, you will need to provide the following:

• The SIM ID(s) of the SIMs to transfer
• The Email Address and Operator ID of the operator account you want to transfer the SIMs to (the destination Soracom account)
• (Optional) The Group ID to be assigned to each SIM after transfer

1. Log in to the Soracom Support site using the source Soracom account.

2. Access the following link to open the SIM transfer request form, then fill in the required fields and submit the request:

   Application for transferring other status SIMs

Once you have submitted your request, Soracom will review it and confirm that both the source and destination Soracom accounts meet the required SIM transfer conditions. Soracom will notify you if there are any issues.

Then, Soracom will send a confirmation email to the primary email address of the destination Soracom account.

Accepting a SIM Transfer Request

To accept a SIM transfer request, the destination operator account must reply to the confirmation email within 5 business days of sending the email.

Once Soracom receives confirmation, the SIM transfer request will proceed.

Transfer Timing And Confirmation

The timing of the SIM transfer depends on the date that the destination Soracom account replies to the confirmation email:

• If the reply is received by the 25th, the SIM transfer will be processed on the 1st of the following month.
• If the reply is received after the 25th, the SIM transfer will be processed on the 1st of the month after next

Transfer Timing Examples

Programmatic Usage

You can also use the Soracom API and Soracom CLI to transfer Ready status SIMs.

curl -X POST \
|  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
|  -H 'X-Soracom-Token: <MY-TOKEN>' \
|  -H 'Content-Type: application/json' \
|  -d '{
|        "transferDestinationOperatorEmail": "<DESTINATION-OPERATOR-EMAIL>",
|        "transferDestinationOperatorId": "<DESTINATION-OPERATOR-ID>",
|        "transferImsi": [
|          "<IMSI-TO-TRANSFER-1>",
|          "<IMSI-TO-TRANSFER-2>",
|          "<IMSI-TO-TRANSFER-3>"
|        ]
|      }' \
|  https://g.api.soracom.io/v1/subscribers/transfer_token/issue

curl -X POST \
|  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
|  -H 'X-Soracom-Token: <MY-TOKEN>' \
|  -H 'Content-Type: application/json' \
|  -d '{
|        "transferDestinationOperatorEmail": "<DESTINATION-OPERATOR-EMAIL>",
|        "transferDestinationOperatorId": "<DESTINATION-OPERATOR-ID>",
|        "transferImsi": [
|          "<IMSI-TO-TRANSFER-1>",
|          "<IMSI-TO-TRANSFER-2>",
|          "<IMSI-TO-TRANSFER-3>"
|        ]
|      }' \
|  https://jp.api.soracom.io/v1/subscribers/transfer_token/issue

{
  "token": "abcdef00-1111-2222-3333-444444444444-abcdef00-5555-6666-7777-888888888888"
}

curl -X DELETE \
|  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
|  -H 'X-Soracom-Token: <MY-TOKEN>' \
|  https://g.api.soracom.io/v1/subscribers/transfer_token/<TRANSFER-TOKEN>

curl -X DELETE \
|  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
|  -H 'X-Soracom-Token: <MY-TOKEN>' \
|  https://jp.api.soracom.io/v1/subscribers/transfer_token/<TRANSFER-TOKEN>

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

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

soracom subscribers issue-transfer-token \
|  --profile "<SOURCE-OPERATOR-PROFILE-NAME>" \
|  --transfer-destination-operator-email "<DESTINATION-OPERATOR-EMAIL>" \
|  --transfer-destination-operator-id "<DESTINATION-OPERATOR-ID>" \
|  --body '{
|    "transferImsi": [
|      "<IMSI-TO-TRANSFER-1>",
|      "<IMSI-TO-TRANSFER-2>",
|      "<IMSI-TO-TRANSFER-3>"
|    ]
|  }' \
|  --coverage-type g

soracom subscribers issue-transfer-token \
|  --profile "<SOURCE-OPERATOR-PROFILE-NAME>" \
|  --transfer-destination-operator-email "<DESTINATION-OPERATOR-EMAIL>" \
|  --transfer-destination-operator-id "<DESTINATION-OPERATOR-ID>" \
|  --body '{
|    "transferImsi": [
|      "<IMSI-TO-TRANSFER-1>",
|      "<IMSI-TO-TRANSFER-2>",
|      "<IMSI-TO-TRANSFER-3>"
|    ]
|  }' \
|  --coverage-type jp

{
  "token": "abcdef00-1111-2222-3333-444444444444-abcdef00-5555-6666-7777-888888888888"
}

$ soracom subscribers delete-transfer-token --profile "<SOURCE-OPERATOR-PROFILE-NAME>" --token "<TRANSFER-TOKEN>" --coverage-type g

$ soracom subscribers delete-transfer-token --profile "<SOURCE-OPERATOR-PROFILE-NAME>" --token "<TRANSFER-TOKEN>" --coverage-type jp

$ soracom subscribers verify-transfer-token --profile "<DESTINATION-OPERATOR-PROFILE-NAME>" --token "<TRANSFER-TOKEN>" --coverage-type g

$ soracom subscribers verify-transfer-token --profile "<DESTINATION-OPERATOR-PROFILE-NAME>" --token "<TRANSFER-TOKEN>" --coverage-type jp