Skip to main content
GET
/
inventory
/
sims
/
{iccid}
Get SIM details
curl --request GET \
  --url https://apiv2.example.com/inventory/sims/{iccid} \
  --header 'X-Api-Key: <api-key>'
{
  "iccid": "8946200508271016579",
  "type": "PHYSICAL",
  "status": "AVAILABLE",
  "imsi": "310150000000001",
  "lpa": "1$rsp.example.com$ABCD1234",
  "esimProfile": {
    "status": "AVAILABLE",
    "eid": "89049032004008882600009B40002780",
    "lastOperationAt": "2024-06-15T14:30:00Z"
  },
  "createdAt": "2024-01-10T08:00:00Z",
  "updatedAt": "2024-06-15T14:30:00Z"
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
iccid
string
required

The ICCID of the SIM card to retrieve.

Response

SIM details retrieved successfully.

A SIM card from inventory. For eSIM cards, the response may include live installation status from the network operator when the SIM is linked to a subscription.

​
iccid
string
required

The ICCID (Integrated Circuit Card Identifier) of the SIM card.

Example:

"8946200508271016579"

​
type
enum<string>
required

The technology type of the SIM card.

Available options:
PHYSICAL,
ESIM
​
status
enum<string>
required

Current status of the SIM card in inventory.

Available options:
AVAILABLE,
IN_USE,
RESERVED,
CONSUMED,
BRAND_RESERVED
​
imsi
string

The IMSI (International Mobile Subscriber Identity) of the SIM.

Example:

"310150000000001"

​
lpa
string

Local Profile Assistant address for eSIM activation.

Example:

"1$rsp.example.com$ABCD1234"

​
esimProfile
object

Live eSIM profile status from the network operator. Shows whether the eSIM has been downloaded, installed, or enabled on a device.

​
createdAt
string<date-time>

When the SIM was added to inventory.

Example:

"2024-01-10T08:00:00Z"

​
updatedAt
string<date-time>

When the SIM was last updated in inventory.

Example:

"2024-06-15T14:30:00Z"