Sign in
SIM Cards

Get SIM card

Returns the details regarding a specific SIM card.

get/sim_cards/{id}

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the SIM.

Query parameters

include_sim_card_groupboolean
Example:true

It includes the associated SIM card group object in the response when present.

include_pin_puk_codesboolean

When set to true, includes the PIN and PUK codes in the response. These codes are used for SIM card security and unlocking purposes. Available for both physical SIM cards and eSIMs.

Response

Successful response

Example response

{
  "data": {
    "actions_in_progress": true,
    "authorized_imeis": [
      "106516771852751",
      "534051870479563",
      "508821468377961"
    ],
    "created_at": "2018-02-02T22:25:27.521Z",
    "current_billing_period_consumed_data": {
      "amount": "2049.0",
      "unit": "MB"
    },
    "current_device_location": {
      "accuracy": 1250,
      "accuracy_unit": "m",
      "latitude": "41.143",
      "longitude": "-8.605"
    },
    "current_imei": "457032284023794",
    "current_mcc": "410",
    "current_mnc": "260",
    "data_limit": {
      "amount": "2048.1",
      "unit": "MB"
    },
    "esim_installation_status": "released",
    "iccid": "89310410106543789301",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "imsi": "081932214823362973",
    "ipv4": "192.168.0.0",
    "ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652",
    "live_data_session": "connected",
    "msisdn": "+13109976224",
    "pin_puk_codes": {
      "pin1": "1234",
      "pin2": "5678",
      "puk1": "12345678",
      "puk2": "87654321"
    },
    "record_type": "sim_card",
    "resources_with_in_progress_actions": [],
    "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "status": {
      "reason": "The SIM card is active, ready to connect to networks and consume data.",
      "value": "enabled"
    },
    "tags": [
      "personal",
      "customers",
      "active-customers"
    ],
    "type": "physical",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "version": "4.3"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.2

  • 1571b0380bd71See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379941See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog