Super SIM

KORE's Super SIM API empowers you to manage and deploy massive fleets of IoT devices around the world.

Using this REST API, you can activate and deactivate Super SIMs, control the capabilities of individual Super SIMs or groups of Super SIMs, send machine-to-machine (M2M) messages, and query usage.

The Super SIM API Base URL

All URLs in the reference documentation use the following base URL:

https://supersim.api.korewireless.com/v1

The API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. All responses are provided in JSON format.

You don't need to use the .json file extension in API request URIs.

API Resources

The Super SIM API comprises the following resources:

Resource	Description
Sim	Access individual SIMs
Sim BillingPeriod subresource	Access Super SIM billing data
UsageRecord	Access Super SIM usage data
eSimProfile	Access Super SIM functionality via eUICCs
Fleet	Organize and configure groups of Sim resources
Network	Access cellular networks to which Super SIMs can connect
NetworkAccessProfile	Control which mobile networks Super SIMs can connect to
NetworkAccessProfile Network subresource	Manage NAP-listed cellular networks
SMSCommand	Exchange machine-to-machine (M2M) messages via SMS
IPCommand	Transfer IP/UDP messages between your cloud and your devices

API Resource Properties

When you create or update resources, you indicate the data that is being added or changed by specifying the appropriate resource property. All resource properties are case-sensitive and written in UpperCamelCase. For example, if you want to change a new Sim's status from new to active and receive an asynchronous notification of the change, you call:

curl https://supersim.api.korewireless.com/v1/Sims/{Sim SID} \
  -d 'Status=active' \
  -d 'CallbackUrl={Your notification URI}'

This contrasts with responses from the API, in which properties are referenced using lower_snake_case. For example, getting that same Sim's details will return:

{
  "sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "unique_name": "My SIM",
  "status": "new",
  "fleet_sid": null,
  "iccid": "89883070000123456789",
  "date_created": "2021-04-01T20:00:00Z",
  "date_updated": "2021-04-01T20:00:00Z",
  "url": "https://supersim.api.korewireless.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

The API documentation presents the appropriate parameter formatting for the language or tool that you select in the code column.

API Authorization

Review our API authorization guide for more details on how to access KORE's APIs and make API calls to the Super SIM product.

API Errors

Review our API errors guide for more details on how API errors are returned and details on what kinds of error codes you may encounter.

Asynchronous resources

If you are migrating from Twilio to KORE, refer to our Migration to KORE Callbacks guide to smoothly transition from receiving callbacks from Twilio's infrastructure to receiving them from KORE's with minimal disruption to your current operations.

Certain operations in the Super SIM API — such as changing a Sim's status — are handled asynchronously. These operations will return an intermediate HTTP response — 202 Accepted — while the requested action completes in the background.

Requests that will be processed asynchronously allow you to specify a callback URL for KORE to notify when the requested action has completed. A callback is sent to your server as either an HTTP POST or GET, according to your preference. Form parameters or query string parameters sent with the callback request describe the asynchronous outcome. Callback request formats are documented with each of the relevant API resources.

If your initial request completes synchronously, a 200 OK, 201 Created, or 204 No Content response will be returned and you should not expect an asynchronous callback, even if you specified a callback URL.

Help integrating the Super SIM API

KORE's Super SIM API is a flexible building block which can take you from activating your first Super SIM to managing a fleet of millions of Super SIMs.

While we hope this page gives a good overview of what you can do with the API, we're only scratching the surface of what the Super SIM API can do.

If you need any help integrating the Super SIM API or want to talk about best practices, please get in touch by reaching out to KORE support.