> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telnesstech.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get SIM details

> Retrieve details of a SIM card from inventory by its ICCID.

For eSIM cards linked to a subscription, the response includes live installation status
from the network operator, showing whether the profile has been downloaded, installed,
or enabled on a device.




## OpenAPI

````yaml /api-reference/bundled_openapi.json get /inventory/sims/{iccid}
openapi: 3.1.0
info:
  title: Telness Tech Connect
  version: 2.0.0-alpha
  description: >
    Telness Tech Connect API provides all you need to own your user's
    connectivity experience.


    Go back to [Telnesstech.com](https://telnesstech.com)
servers:
  - url: https://apiv2.example.com
    description: Connect API URL for your domain
security:
  - apiKey: []
  - bearerAuth: []
    apiKey: []
tags:
  - name: Auth
    description: Authenticate users and obtain access tokens.
  - name: Users
    description: Manage users.
  - name: Customers
    description: Manage customers.
  - name: Subscriptions
    description: Manage subscriptions and subscription.
  - name: Subscription Addons
    description: Manage subscription addons.
  - name: Subscription Usage
    description: Get subscription usage.
  - name: Subscribers
    description: Manage subscribers.
  - name: Licenses
    description: Manage licenses.
  - name: Product Offerings
    description: Browse product offerings.
  - name: Product Catalogs
    description: Browse product catalogs.
  - name: Product Discounts
    description: Discounts and promotions.
  - name: Orders
    description: Manage orders and line items.
  - name: Payment Intents
    description: >-
      Inspect payment intents, the money collected over card rails for orders
      and renewals.
  - name: Payment Links
    description: Create and manage payment links for orders and invoices.
  - name: Payment Sessions
    description: Create and manage payment sessions for orders.
  - name: Payment Profiles
    description: Manage customer payment profiles and methods.
  - name: Payment Profile Sessions
    description: Create sessions for setting up payment profiles.
  - name: Signing sessions
    description: Handle contract signing sessions for postpaid orders.
  - name: Porting
    description: Manage number porting for subscriptions.
  - name: Taxes
    description: Calculate taxes for products and line items.
  - name: Invoices
    description: Manage invoices and invoice items.
  - name: Tools
    description: >-
      Tools for address validation, number porting, device info, and network
      coverage.
  - name: Inventory
    description: Manage phone number inventory, SIM cards, and reservations.
  - name: Workflows
    description: Dynamic processing of customer journeys and events.
paths:
  /inventory/sims/{iccid}:
    get:
      tags:
        - Inventory
      summary: Get SIM details
      description: >
        Retrieve details of a SIM card from inventory by its ICCID.


        For eSIM cards linked to a subscription, the response includes live
        installation status

        from the network operator, showing whether the profile has been
        downloaded, installed,

        or enabled on a device.
      operationId: getInventorySim
      parameters:
        - name: iccid
          in: path
          required: true
          schema:
            type: string
          description: The ICCID of the SIM card to retrieve.
          example: '8946200508271016579'
      responses:
        '200':
          description: SIM details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventorySim'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    InventorySim:
      type: object
      description: >
        A SIM card from inventory. For eSIM cards, the response may include live
        installation

        status from the network operator when the SIM is linked to a
        subscription.
      required:
        - iccid
        - type
        - status
      additionalProperties: false
      properties:
        iccid:
          type: string
          description: The ICCID (Integrated Circuit Card Identifier) of the SIM card.
          example: '8946200508271016579'
        imsi:
          type: string
          description: The IMSI (International Mobile Subscriber Identity) of the SIM.
          example: '310150000000001'
        type:
          $ref: '#/components/schemas/SimType'
        status:
          $ref: '#/components/schemas/SimStatus'
        lpa:
          type: string
          description: Local Profile Assistant address for eSIM activation.
          example: 1$rsp.example.com$ABCD1234
        esimProfile:
          $ref: '#/components/schemas/EsimProfile'
        createdAt:
          type: string
          format: date-time
          description: When the SIM was added to inventory.
          example: '2024-01-10T08:00:00Z'
        updatedAt:
          type: string
          format: date-time
          description: When the SIM was last updated in inventory.
          example: '2024-06-15T14:30:00Z'
    SimType:
      type: string
      description: The technology type of the SIM card.
      enum:
        - PHYSICAL
        - ESIM
    SimStatus:
      type: string
      description: Current status of the SIM card in inventory.
      enum:
        - AVAILABLE
        - IN_USE
        - RESERVED
        - CONSUMED
        - BRAND_RESERVED
    EsimProfile:
      type: object
      description: >
        Live eSIM profile status from the network operator.

        Shows whether the eSIM has been downloaded, installed, or enabled on a
        device.
      required:
        - status
      additionalProperties: false
      properties:
        status:
          $ref: '#/components/schemas/EsimInstallationStatus'
        eid:
          type: string
          description: >-
            The EID (eSIM Identifier) assigned to the device. Empty until the
            eSIM is activated.
          example: 89049032004008882600009B40002780
        lastOperationAt:
          type: string
          format: date-time
          description: When the last eUICC operation occurred for this profile.
          example: '2024-06-15T14:30:00Z'
    Error:
      type: object
      required:
        - message
        - code
      properties:
        message:
          type: string
          description: A human-readable message providing more details about the error.
        code:
          type: string
          description: A machine-readable code for the error.
        details:
          type: array
          description: Additional details about the error.
          items:
            type: object
            required:
              - message
              - code
            properties:
              message:
                type: string
                description: >-
                  A human-readable message providing more details about the
                  error.
              code:
                type: string
                description: A machine-readable code for the specific detail.
              property:
                type: string
                description: The property or field related to the error.
              suggestion:
                $ref: '#/components/schemas/Any'
                description: >
                  A suggested value for the particular property.


                  For example, this may be set when validating an address with
                  an alias, suggesting the expected value by the operator.
        hint:
          type: string
          description: A hint to help resolve the error.
    EsimInstallationStatus:
      type: string
      description: >
        The installation state of an eSIM profile on the network.

        Reflects the current eUICC profile lifecycle stage as reported by the
        network operator.
      enum:
        - AVAILABLE
        - ALLOCATED
        - LINKED
        - CONFIRMED
        - RELEASED
        - DOWNLOADED
        - INSTALLED
        - ENABLED
        - DISABLED
        - ERROR
        - UNAVAILABLE
        - DELETED
    Any:
      oneOf:
        - type: string
        - type: number
        - type: boolean
        - type: object
          additionalProperties: true
        - type: array
  responses:
    BadRequest:
      description: The request was malformed or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication is required to access this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Access to this resource is forbidden.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: An unexpected error occurred on the server.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >
        An API key that grants access to the Connect API. You can create and
        manage API keys in the portal.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Bearer authentication with JWT tokens is used to authenticate users.


        Do note that a valid API keys is also required to access the Connect API
        to prove that requests are made by a trusted party.


        Requests with a JWT token is scoped to the permissions of the user the
        token belongs to, regardless of the API key used.

````