> ## Documentation Index
> Fetch the complete documentation index at: https://developers.mioesim.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api_esim/getESIMDetail — ICCID usage and card status

> Retrieve usage, network support, plan history, and card status for a specific ICCID. This endpoint requires IP whitelist approval from MIOeSIM before use.

This endpoint returns comprehensive information about a SIM card: current usage in MB, supported networks, card status, active and historical plans, and company branding info. It is intended for building customer-facing eSIM management interfaces.

```
GET http://bpm.mioesim.com/api_esim/getESIMDetail
```

<Warning>
  This endpoint requires your server's IP address to be added to the MIOeSIM whitelist. Contact [help@mioesim.com](mailto:help@mioesim.com) before using it. Unauthorized IPs will receive a `400108` (Access denied) error.
</Warning>

<Note>
  This endpoint uses HTTP (not HTTPS) and does **not** require `token` or `sign`. Authentication is by IP whitelist only.
</Note>

## Request parameters

<ParamField query="iccid" type="string" required>The ICCID of the SIM card.</ParamField>

## Response fields

<ResponseField name="data" type="object">
  <Expandable title="Top-level fields">
    <ResponseField name="esimInfo" type="object">
      Card identity: `iccid`, `number` (phone number), `createDate`, `expireDate`, `supportRenew`, `eid`, `dpStatus` (ACTIVE / Disable / Delete / Enable).
    </ResponseField>

    <ResponseField name="supportNetwork" type="object">
      Map of country name → array of supported networks (countryCode, type: 3G/LTE/5G, operator, name).
    </ResponseField>

    <ResponseField name="esimPackets" type="array">
      Active and recent plan orders. Each entry includes `orderNum`, `skuName`, `type`, `status`, `createTime`, and `packageList` (flows, unit, days, usedMb, beginDate, endDate, status).
    </ResponseField>

    <ResponseField name="company" type="object">
      Branding info: `name`, `logoUrl`, `slogan`.
    </ResponseField>

    <ResponseField name="supportCountryGroup" type="array">
      Countries grouped by continent: `continent`, `countryNames`.
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl "http://bpm.mioesim.com/api_esim/getESIMDetail?iccid=89480100000xxxxxxxx"
  ```

  ```json Success theme={null}
  {
    "code": 1,
    "message": "success",
    "status": "Success",
    "data": {
      "esimInfo": {
        "iccid": "89480100000xxxxxxxx",
        "number": "xxx6335xxxx",
        "expireDate": "2026-03-24",
        "supportRenew": false,
        "dpStatus": "Delete"
      },
      "supportNetwork": {
        "Kazakhstan": [
          { "countryCode": 398, "type": "5G", "operator": "Tele2" },
          { "countryCode": 398, "type": "LTE", "operator": "Beeline" }
        ]
      },
      "esimPackets": [
        {
          "orderNum": "EP20251215000285",
          "skuName": "Kazakhstan",
          "status": 5,
          "packageList": [
            { "flows": 3, "unit": "GB", "days": 7, "usedMb": 3038.57, "status": 2 }
          ]
        }
      ]
    }
  }
  ```

  ```json Error - Access denied theme={null}
  { "code": 400108, "message": "Access denied", "data": null, "status": "Fail" }
  ```
</CodeGroup>