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

# Get a SIM by ICCID

> Get a single SIM by ICCID, account-scoped — another account's SIM reports the same 404 as a nonexistent one.



## OpenAPI

````yaml /openapi.yaml get /api/v1.1/sims/{iccid}
openapi: 3.1.0
info:
  title: Spenza Partner API
  version: 3.0.0
  summary: >-
    Partner API for SIMs, eSIMs, plans, billing, users, groups and numbers —
    v1.1 surface.
  description: >
    The **Spenza Partner API** lets you manage SIMs, eSIMs, plans,
    subscriptions,

    billing, users, phone numbers, teams and device/SIM/user groups
    programmatically.


    All endpoints follow one consistent standard:


    - **Auth** — exchange your API `key` + `secret` for a bearer token, then
    send
      `Authorization: Bearer <token>` on every request.
    - **Envelopes** — success responses are `{ success, data, meta? }`; errors
    are
      `{ success: false, error: { code, message, details? } }`.
    - **Pagination** — list endpoints accept `page` (1-indexed) and `pageSize`
      (max 100); totals are returned in `meta`.
    - **Idempotency** — many write endpoints honor an optional `Idempotency-Key`
      request header so a retried call replays the original result instead of
      repeating the side effect.
    - **Async operations** — a handful of endpoints (eSIM provisioning, port-in,
      the `/api/v3/...` purchase variants, top-up) return `202` (`201` for
      top-up) with a `transactionId` + `statusEndpoint` instead of the finished
      resource. Poll
      `GET /api/v3/transactions/{transactionId}` (no auth required) until the
      transaction reaches a terminal status.

    One resource — **port-in submission** — is a documented exception: it lives
    at

    `POST /api/v3/port-in`, requires an Admin-tier account role rather than just
    a

    valid bearer token, and is **not** on the standard envelope (see that
    operation's

    description for its exact response shape).
  contact:
    name: Spenza API Support
    email: support@spenza.com
    url: https://spenza.com
  license:
    name: Proprietary
    url: https://spenza.com/terms
  x-logo:
    url: https://spenza.com/logo.png
    altText: Spenza
servers:
  - url: https://api.spenza.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Exchange API credentials for a bearer token.
  - name: SIMs
    description: List, inspect, assign and manage SIMs.
  - name: Subscriptions
    description: Plan subscriptions attached to SIMs.
  - name: Plans & Catalog
    description: Purchasable plans and SIM products.
  - name: eSIM
    description: Provision eSIMs and fetch activation QR / install status.
  - name: Billing
    description: Invoices, credit balance and top-ups.
  - name: Users
    description: End users (employees) on your account that SIMs/devices are assigned to.
  - name: Orders & Transactions
    description: Order history and financial transactions.
  - name: Numbers & Port-in
    description: Check port-in eligibility and port existing numbers into Spenza.
  - name: Messaging
    description: Send outbound SMS from a provisioned number.
  - name: Webhooks
    description: Register endpoints for operator SMS/voice events and inspect deliveries.
  - name: Notifications
    description: In-account notifications and delivery preferences.
  - name: Device Groups
    description: Organize devices into named groups with spend/data limits.
  - name: SIM Groups
    description: Organize SIMs into named groups with spend/data limits.
  - name: User Groups
    description: Organize users (departments) into named groups with spend/data limits.
  - name: Devices
    description: The device catalog (phones/tablets) and their assignment to users.
  - name: Team Members
    description: Admins who manage your Spenza account (distinct from Users/end-users).
  - name: Async Status
    description: Universal status poll for any asynchronous (v3) operation.
paths:
  /api/v1.1/sims/{iccid}:
    get:
      tags:
        - SIMs
      summary: Get a SIM by ICCID
      description: >-
        Get a single SIM by ICCID, account-scoped — another account's SIM
        reports the same 404 as a nonexistent one.
      operationId: getSim
      parameters:
        - $ref: '#/components/parameters/Iccid'
      responses:
        '200':
          description: The SIM.
          content:
            application/json:
              example:
                success: true
                data:
                  iccid: '8901260853182965429'
                  phoneNumber: '+12792044584'
                  status: ACTIVE
                  assignedStatus: ASSIGNED
                  isEsim: false
                  operator: T-Mobile
                  network: T-Mobile
                  operatorStatus: ACTIVATED
                  source: Other
                  activationCode: ''
                  assignedTo:
                    name: Jane Doe
                    email: jane@example.com
                  activePlan:
                    productName: T-Mobile 100
                    status: ACTIVE
                    endDate: '2026-08-21T00:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: No SIM with that ICCID on your account.
          content:
            application/json:
              example:
                success: false
                error:
                  code: SIM_NOT_FOUND
                  message: We couldn't find a SIM with that ICCID on your account.
components:
  parameters:
    Iccid:
      name: iccid
      in: path
      required: true
      description: SIM ICCID.
      schema:
        type: string
        example: '8901260853182965429'
  responses:
    Unauthorized:
      description: Missing, malformed or expired bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Missing or invalid token.
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: SIM_NOT_FOUND
            message:
              type: string
              example: We couldn't find a SIM with that ICCID on your account.
            details:
              description: >-
                Present on some 4xx errors (for example a list of missing
                fields). Always absent on 5xx.
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained from `POST /api/v1.1/auth/token`.

````