emnify

emnify Subpackage Euicc API

The subpackage_euicc API from emnify — 5 operation(s) for subpackage_euicc.

GitHub OpenAPI

Operations 5

GET /api/v1/euicc List eUICCs #
GET /api/v1/euicc/profile/status List eUICC Profile status #
GET /api/v1/euicc/status List eUICC status #
POST /api/v1/euicc/unlinked_validation Unlinked eUICC validation #
GET /api/v1/euicc/{euicc_id} Get eUICC #

Documentation

📖
Documentation
https://docs.emnify.com/developers
📖
Documentation
https://docs.emnify.com/developers/api-guidelines/conventions
📖
Documentation
https://docs.emnify.com/llms-full.txt

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/openapi/emnify-subpackage-euicc-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-schema/emnify-sim-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-schema/emnify-endpoint-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-schema/emnify-event-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-structure/emnify-sim-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-structure/emnify-endpoint-structure.json

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/rules/emnify-rules.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-ld/emnify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-authenticate-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-list-endpoints-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-send-sms-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-list-events-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/vocabulary/emnify-vocabulary.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/emnify-subpackage-euicc-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

emnify-subpackage-euicc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: emnify REST Subpackage Euicc API
  version: 1.0.0
  description: The emnify REST API gives programmatic access to the emnify IoT SuperNetwork — global cellular connectivity for IoT devices.
  contact:
    name: emnify Developer Support
    url: https://docs.emnify.com/developers
  license:
    name: Proprietary
    url: https://www.emnify.com/legal
servers:
- url: https://cdn.emnify.net
  description: emnify REST API base host
security:
- BearerAuth: []
tags:
- name: subpackage_euicc
  x-display-name: Euicc
paths:
  /api/v1/euicc:
    get:
      operationId: list-euiccs
      summary: List eUICCs
      description: 'List all eUICCs for your organization.

        Use filter parameters to search for specific eUICCs and sort to order the response list.'
      tags:
      - subpackage_euicc
      parameters:
      - name: page
        in: query
        description: Page number (1-based).
        required: false
        schema:
          type: integer
          default: 1
      - name: per_page
        in: query
        description: Items per page.
        required: false
        schema:
          type: integer
          default: 100
      - name: q
        in: query
        description: 'Filter parameter in `<field>:<criteria>` format.

          Expects a comma-separated list from the allowed fields:


          - `id`

          - `eid`

          - `supported_profile_type`

          - `status`

          - `eim`

          '
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: 'Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):


          - `id`

          - `eid`

          - `modified`

          - `supported_profile_type`

          - `status`

          - `eim`

          '
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of eUICCs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Euicc'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/euicc/profile/status:
    get:
      operationId: list-euicc-profile-status
      summary: List eUICC Profile status
      description: List possible eUICC Profile statuses.
      tags:
      - subpackage_euicc
      parameters:
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of eUICC Profile statuses
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Status'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/euicc/status:
    get:
      operationId: list-euicc-status
      summary: List eUICC status
      description: List possible eUICC statuses (reserved for future use).
      tags:
      - subpackage_euicc
      parameters:
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of eUICC statuses
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Status'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/euicc/unlinked_validation:
    post:
      operationId: post-euicc-unlinked-validation
      summary: Unlinked eUICC validation
      description: Validate whether the specified eUICCs do not have any existing profiles linked.
      tags:
      - subpackage_euicc
      parameters:
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Validation response containing EIDs that already have linked profiles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EuiccUnlinkedValidationResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EuiccUnlinkedValidationRequest'
  /api/v1/euicc/{euicc_id}:
    get:
      operationId: get-euicc
      summary: Get eUICC
      description: List details on one specific eUICC within your organization.
      tags:
      - subpackage_euicc
      parameters:
      - name: euicc_id
        in: path
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: eUICC detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Euicc'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    EuiccUnlinkedValidationResponseItems:
      type: object
      properties:
        eid:
          $ref: '#/components/schemas/Eid'
      required:
      - eid
      title: EuiccUnlinkedValidationResponseItems
    Endpoint:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      title: Endpoint
    Euicc:
      type: object
      properties:
        id:
          type: integer
        eid:
          $ref: '#/components/schemas/Eid'
        created:
          type: string
          format: date-time
        issuer_org:
          $ref: '#/components/schemas/Organisation'
        customer_org:
          $ref: '#/components/schemas/Organisation'
        supported_profile_type:
          $ref: '#/components/schemas/EuiccSupportedProfileType'
        status:
          $ref: '#/components/schemas/Status'
        last_audited:
          type:
          - string
          - 'null'
          format: date-time
        last_polled:
          type:
          - string
          - 'null'
          format: date-time
        last_synced:
          type:
          - string
          - 'null'
          format: date-time
        eim:
          $ref: '#/components/schemas/EuiccEim'
        profile:
          type: array
          items:
            $ref: '#/components/schemas/Profile'
      required:
      - id
      - eid
      - created
      - profile
      title: Euicc
    EuiccUnlinkedValidationRequestTargetItems:
      type: object
      properties:
        eid:
          $ref: '#/components/schemas/Eid'
      required:
      - eid
      title: EuiccUnlinkedValidationRequestTargetItems
    Eid:
      type: string
      title: Eid
    EuiccUnlinkedValidationRequest:
      type: object
      properties:
        target:
          type: array
          items:
            $ref: '#/components/schemas/EuiccUnlinkedValidationRequestTargetItems'
      required:
      - target
      title: EuiccUnlinkedValidationRequest
    Error:
      type: object
      properties:
        status_code:
          type: integer
        message:
          type: string
      required:
      - status_code
      - message
      title: Error
    EuiccSupportedProfileType:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
      title: EuiccSupportedProfileType
    EuiccEim:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
      title: EuiccEim
    Status:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
      required:
      - id
      - description
      title: Status
    ProfileStatus:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
      title: ProfileStatus
    Profile:
      type: object
      properties:
        iccid_with_luhn:
          $ref: '#/components/schemas/IccidWithLuhnRef'
        status:
          $ref: '#/components/schemas/ProfileStatus'
        customer_org:
          oneOf:
          - $ref: '#/components/schemas/Organisation'
          - type: 'null'
        name:
          type:
          - string
          - 'null'
        operator:
          oneOf:
          - $ref: '#/components/schemas/IdName'
          - type: 'null'
        preloaded:
          type:
          - boolean
          - 'null'
        fallback_allowed:
          type:
          - boolean
          - 'null'
        fallback_attribute:
          type:
          - boolean
          - 'null'
        profile_type:
          oneOf:
          - $ref: '#/components/schemas/ProfileProfileType'
          - type: 'null'
        endpoint:
          oneOf:
          - $ref: '#/components/schemas/Endpoint'
          - type: 'null'
      required:
      - iccid_with_luhn
      title: Profile
    IccidWithLuhnRef:
      type: string
      description: Full ICCID including the Luhn check digit
      title: IccidWithLuhnRef
    EuiccUnlinkedValidationResponse:
      type: array
      items:
        $ref: '#/components/schemas/EuiccUnlinkedValidationResponseItems'
      title: EuiccUnlinkedValidationResponse
    Organisation:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      title: Organisation
    ProfileProfileType:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
      title: ProfileProfileType
    IdName:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      title: IdName
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Retrieve a JWT via POST /api/v1/authenticate using an application_token or user credentials, then send it as `Authorization: Bearer <token>`.'