---
title: "Register SIM cards"
method: POST
path: "/actions/register/sim_cards"
tags: ["SIM Cards"]
---

# Register SIM cards

`POST /actions/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/>

## Request body

- SIMCardRegistration
  - `registration_codes` string[], required
  - `sim_card_group_id` string, 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.
  - `tags` string[] — Searchable tags associated with the SIM card

## Response `202`

Successful response

- object
  - `data` SimpleSIMCard[] — Successfully registered SIM cards.
    - `actions_in_progress` boolean — Indicate whether the SIM card has any pending (in-progress) actions.
    - `authorized_imeis` string[], nullable — List of IMEIs authorized to use a given SIM card.
    - `created_at` string — ISO 8601 formatted date-time indicating when the resource was created.
    - `current_billing_period_consumed_data` object — The SIM card consumption so far in the current billing cycle.
      - `amount` string
      - `unit` string
    - `data_limit` object — The SIM card individual data limit configuration.
      - `amount` string
      - `unit` 'MB' | 'GB'
    - `eid` string, nullable — The Embedded Identity Document (eID) for eSIM cards.
    - `esim_installation_status` 'released' | 'disabled', nullable — The installation status of the eSIM. Only applicable for eSIM cards.
    - `iccid` string — 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.
    - `id` string, uuid — Identifies the resource.
    - `imsi` string — SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI). <br/> Mobile 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).
    - `msisdn` string — Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally. <br/> MSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.
    - `record_type` string
    - `resources_with_in_progress_actions` object[] — List of resources with actions in progress.
    - `sim_card_group_id` string, uuid — The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.
    - `status` SIMCardStatus
      - `reason` string — It describes why the SIM card is in the current status.
      - `value` 'registering' | 'enabling' | 'enabled' | 'disabling' | 'disabled' | 'data_limit_exceeded' | 'setting_standby' | 'standby' — The current status of the SIM card. It will be one of the following: <br/> <ul> <li><code>registering</code> - the card is being registered</li> <li><code>enabling</code> - the card is being enabled</li> <li><code>enabled</code> - the card is enabled and ready for use</li> <li><code>disabling</code> - the card is being disabled</li> <li><code>disabled</code> - the card has been disabled and cannot be used</li> <li><code>data_limit_exceeded</code> - the card has exceeded its data consumption limit</li> <li><code>setting_standby</code> - the process to set the card in stand by is in progress</li> <li><code>standby</code> - the card is in stand by</li> </ul> Transitioning between the enabled and disabled states may take a period of time.
    - `tags` string[] — Searchable tags associated with the SIM card
    - `type` 'physical' | 'esim' — The type of SIM card
    - `updated_at` string — ISO 8601 formatted date-time indicating when the resource was updated.
    - `version` string — The version of the SIM card.
    - `voice_enabled` boolean — Indicates whether voice services are enabled for the SIM card.
  - `errors` WirelessError[]
    - `code` string, required
    - `detail` string
    - `meta` object
    - `source` object
      - `parameter` string — Indicates which query parameter caused the error.
      - `pointer` string — JSON pointer (RFC6901) to the offending entity.
    - `title` string, required

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/revisions/3fdc16374d70/schema)