Sim

A SIM is a unique card that identifies itself to a specific mobile network and provides voice, text, and data connectivity to a user’s device. There are two types of available SIMs: eSIM and pSIM. eSIMs can be activated and installed instantly on any eSIM compatible device, pSIMs (physical SIMs) must be provided to the user or installed into the device beforehand.

  • Name
    object
    Type
    string
    Description

    Type of object is always sim.

    Allowed values: sim 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the SIM.

    Example: "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
  • Name
    metadata
    Type
    Metadata
    Description

    A set of key-value pairs, to store metadata related to the resource.

  • Name
    createdAt
    Type
    string
    Description

    Time when the SIM was created.

    Example: "2021-01-21T19:38:34Z"
  • Name
    iccid
    Type
    string
    Description

    The ICCID (integrated circuit card identifier) associated with the SIM.

    Example: "89883070000007537119"
  • Name
    provider
    Type
    string
    Description

    The ID of the network provider of the SIM.

    Example: "p9"
  • Name
    status
    Type
    string
    Description

    The status of the SIM. Can be active or inactive.

    Allowed values: inactive active retired 
  • Name
    type
    Type
    string
    Description

    The type of the SIM. Can be eSIM or pSIM.

    Allowed values: eSIM pSIM 

Example

{
  "object": "sim",
  "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
  "metadata": {},
  "createdAt": "2021-01-21T19:38:34.0Z",
  "iccid": "89883070000007537119",
  "provider": "p9",
  "status": "inactive",
  "type": "eSIM"
}