eSIM vs physical SIM
MIOeSIM supports both eSIM and physical SIM cards. Both types are ordered through the same endpoint (POST /api_esim/addEsimOrder), but they differ in how they are activated and managed.
| eSIM | Physical SIM | |
|---|---|---|
| Form factor | Digital profile stored on a device’s eUICC chip. No physical card is shipped. | A traditional plastic SIM card shipped to a distribution partner. |
| Activation | Customer scans a QR code or enters an LPA string (LPA:1$<sm_dp_address>$<activationCode>) in device settings. | Customer inserts the physical card into their device. |
| Distribution | Activation codes and QR codes are delivered via the API response immediately after ordering. | Cards are distributed through a DP (distribution partner). |
| Order parameter | No dpId required. | Include dpId in the order request to identify the distribution partner. |
| SKU retrieval | Use GET /api_esim/getSkus or GET /api_esim/getSkuByGroup. | Use GET /api_esim/getDpSupportSkuInfo?dpId=<id> to get SKUs for your DP. |
dpId parameter in the request body. Omitting it will cause the order to fail. Contact MIOeSIM to obtain your dpId if you have not already received one.
ICCID operations
Once you have an ICCID from an order response, you can perform the following operations:- Look up renewal options — retrieve which SKUs and packages are available for an existing card, so you can present renewal choices to your customer before their plan expires.
- Check current usage — query how much data has been consumed, when the plan started and ends, and the current activation status of the card.
- Get historical packages — retrieve a list of all plans that have been active on this ICCID over time.
- Query card status — check whether the card is currently active, disabled, or deleted.
- Batch query — retrieve status and usage information for up to 100 ICCIDs in a single request, useful for bulk monitoring.
ICCID endpoints
| Endpoint | Description |
|---|---|
GET /api_esim/getIccidSupportSku | Returns the SKUs available for renewal on this ICCID. |
GET /api_esim/getIccidSupportPackageInfo | Returns the packages available for renewal on this ICCID. |
GET /api_esim/getESIMDetail | Returns full usage data and current status for a single ICCID. Requires IP whitelist. |
GET /api_esim/queryIccidInformation | Batch query for up to 100 ICCIDs. |
GET /api_esim/getHistoryDetail | Returns historical plan records for this ICCID. |
Card status values
ThedpStatus field on a card record indicates the current state of the SIM card.
| Value | Description |
|---|---|
ACTIVE | The card is active and the plan is running. Data usage is being tracked. |
Enable | The card profile is enabled on the device but the plan may not have started yet. |
Disable | The card profile has been disabled. The card is not in active use. |
Delete | The card profile has been deleted from the device. The card can no longer be activated. |
dpStatus to surface card health to your customers and to determine whether a renewal or support action is relevant.
Checking usage
CallGET /api_esim/getESIMDetail with an ICCID to retrieve the full current state of a card, including:
- Data consumed (
usedMB) - Plan start and end dates
- Current activation status
- Remaining data
Batch querying cards
CallGET /api_esim/queryIccidInformation to retrieve status information for multiple ICCIDs in a single request. Pass a comma-separated list of ICCIDs in the request. The endpoint accepts up to 100 ICCIDs per call.