v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

SIM Cards

Register SIM cards

Register the SIM cards associated with the provided registration codes to the current user's account.<br/><br/> If <code>sim_card_group_id</code> is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.<br/><br/>

post/actions/register/sim_cards

Request body

registration_codesstring[] required

sim_card_group_idstring uuid

The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.

status'enabled' | 'disabled' | 'standby'

Status on which the SIM card will be set after being successful registered.

tagsstring[]

Searchable tags associated with the SIM card

Example request

{
  "registration_codes": [
    "0000000001",
    "0000000002",
    "0000000003"
  ],
  "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "status": "standby",
  "tags": [
    "personal",
    "customers",
    "active-customers"
  ]
}

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"
      },
      "data_limit": {
        "amount": "2048.0",
        "unit": "MB"
      },
      "esim_installation_status": "released",
      "iccid": "89310410106543789301",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "imsi": "081932214823362973",
      "msisdn": "+13109976224",
      "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"
    }
  ]
}