SIMCard

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-simcard-schema.json",
  "title": "SIMCard",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-sim-cards-api-openapi.yml#/components/schemas/SIMCard",
  "properties": {
    "actions_in_progress": {
      "default": false,
      "description": "Indicate whether the SIM card has any pending (in-progress) actions.",
      "readOnly": true,
      "type": "boolean"
    },
    "authorized_imeis": {
      "description": "List of IMEIs authorized to use a given SIM card.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "created_at": {
      "description": "ISO 8601 formatted date-time indicating when the resource was created.",
      "readOnly": true,
      "type": "string"
    },
    "current_billing_period_consumed_data": {
      "description": "The SIM card consumption so far in the current billing cycle.",
      "properties": {
        "amount": {
          "type": "string"
        },
        "unit": {
          "default": "MB",
          "type": "string"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "current_device_location": {
      "description": "Current physical location data of a given SIM card. Accuracy is given in meters.",
      "properties": {
        "accuracy": {
          "type": "integer"
        },
        "accuracy_unit": {
          "default": "m",
          "type": "string"
        },
        "latitude": {
          "type": "string"
        },
        "longitude": {
          "type": "string"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "current_imei": {
      "description": "IMEI of the device where a given SIM card is currently being used.",
      "readOnly": true,
      "type": "string"
    },
    "current_mcc": {
      "description": "Mobile Country Code of the current network to which the SIM card is connected. It's a three decimal digit that identifies a country.<br/><br/>\nThis code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.",
      "readOnly": true,
      "type": "string"
    },
    "current_mnc": {
      "description": "Mobile Network Code of the current network to which the SIM card is connected. It's a two to three decimal digits that identify a network.<br/><br/>\n This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.",
      "readOnly": true,
      "type": "string"
    },
    "data_limit": {
      "description": "The SIM card individual data limit configuration.",
      "properties": {
        "amount": {
          "type": "string"
        },
        "unit": {
          "enum": [
            "MB",
            "GB"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "eid": {
      "description": "The Embedded Identity Document (eID) for eSIM cards.",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "esim_installation_status": {
      "description": "The installation status of the eSIM. Only applicable for eSIM cards.",
      "enum": [
        "released",
        "disabled"
      ],
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "iccid": {
      "description": "The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.\n",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "Identifies the resource.",
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "imsi": {
      "description": "SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI). <br/>\nMobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber  Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home  Location Register (HLR) or the Visitor Location Register (VLR).\n",
      "readOnly": true,
      "type": "string"
    },
    "ipv4": {
      "description": "The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.\n",
      "readOnly": true,
      "type": "string"
    },
    "ipv6": {
      "description": "The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.\n",
      "readOnly": true,
      "type": "string"
    },
    "live_data_session": {
      "description": "Indicates whether the device is actively connected to a network and able to run data.",
      "enum": [
        "connected",
        "disconnected",
        "unknown"
      ],
      "readOnly": true,
      "type": "string"
    },
    "msisdn": {
      "description": "Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally. <br/>\nMSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.\n",
      "readOnly": true,
      "type": "string"
    },
    "pin_puk_codes": {
      "description": "PIN and PUK codes for the SIM card. Only available when include_pin_puk_codes=true is set in the request.",
      "properties": {
        "pin1": {
          "description": "The primary Personal Identification Number (PIN) for the SIM card. This is a 4-digit code used to protect the SIM card from unauthorized use.",
          "readOnly": true,
          "type": "string"
        },
        "pin2": {
          "description": "The secondary Personal Identification Number (PIN2) for the SIM card. This is a 4-digit code used for additional security features.",
          "readOnly": true,
          "type": "string"
        },
        "puk1": {
          "description": "The primary Personal Unblocking Key (PUK1) for the SIM card. This is an 8-digit code used to unlock the SIM card if PIN1 is entered incorrectly multiple times.",
          "readOnly": true,
          "type": "string"
        },
        "puk2": {
          "description": "The secondary Personal Unblocking Key (PUK2) for the SIM card. This is an 8-digit code used to unlock the SIM card if PIN2 is entered incorrectly multiple times.",
          "readOnly": true,
          "type": "string"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "record_type": {
      "readOnly": true,
      "type": "string"
    },
    "resources_with_in_progress_actions": {
      "description": "List of resources with actions in progress.",
      "items": {
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "sim_card_group_id": {
      "description": "The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.",
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "$ref": "#/$defs/SIMCardStatus"
    },
    "tags": {
      "description": "Searchable tags associated with the SIM card",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "description": "The type of SIM card",
      "enum": [
        "physical",
        "esim"
      ],
      "readOnly": true,
      "type": "string"
    },
    "updated_at": {
      "description": "ISO 8601 formatted date-time indicating when the resource was updated.",
      "readOnly": true,
      "type": "string"
    },
    "version": {
      "description": "The version of the SIM card.",
      "readOnly": true,
      "type": "string"
    },
    "voice_enabled": {
      "default": false,
      "description": "Indicates whether voice services are enabled for the SIM card.",
      "readOnly": true,
      "type": "boolean"
    }
  },
  "type": "object",
  "$defs": {
    "SIMCardStatus": {
      "properties": {
        "reason": {
          "description": "It describes why the SIM card is in the current status.",
          "readOnly": true,
          "type": "string"
        },
        "value": {
          "description": "The current status of the SIM card. It will be one of the following: <br/>\n<ul>\n <li><code>registering</code> - the card is being registered</li>\n <li><code>enabling</code> - the card is being enabled</li>\n <li><code>enabled</code> - the card is enabled and ready for use</li>\n <li><code>disabling</code> - the card is being disabled</li>\n <li><code>disabled</code> - the card has been disabled and cannot be used</li>\n <li><code>data_limit_exceeded</code> - the card has exceeded its data consumption limit</li>\n <li><code>setting_standby</code> - the process to set the card in stand by is in progress</li>\n <li><code>standby</code> - the card is in stand by</li>\n</ul>\nTransitioning between the enabled and disabled states may take a period of time.\n",
          "enum": [
            "registering",
            "enabling",
            "enabled",
            "disabling",
            "disabled",
            "data_limit_exceeded",
            "setting_standby",
            "standby"
          ],
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}