supersim.v1.esim_profile

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twilio/main/json-schema/twilio-supersim-v1-esim-profile-schema.json",
  "title": "supersim.v1.esim_profile",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/twilio-esimprofiles-api-openapi.yml#/components/schemas/supersim.v1.esim_profile",
  "type": "object",
  "properties": {
    "sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^HP[0-9a-fA-F]{32}$",
      "description": "The unique string that we created to identify the eSIM Profile resource."
    },
    "account_sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^AC[0-9a-fA-F]{32}$",
      "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the eSIM Profile resource belongs."
    },
    "iccid": {
      "type": [
        "string",
        "null"
      ],
      "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource.",
      "x-twilio": {
        "pii": {
          "handling": "standard",
          "deleteSla": 30
        }
      }
    },
    "sim_sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^HS[0-9a-fA-F]{32}$",
      "description": "The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls."
    },
    "status": {
      "type": [
        "string",
        "null"
      ],
      "$ref": "#/$defs/esim_profile_enum_status",
      "description": "The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each."
    },
    "eid": {
      "type": [
        "string",
        "null"
      ],
      "description": "Identifier of the eUICC that can claim the eSIM Profile."
    },
    "smdp_plus_address": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status `available`."
    },
    "matching_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if `generate_matching_id` is set to `true` when creating the eSIM profile reservation."
    },
    "activation_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an eSIM profile."
    },
    "error_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."
    },
    "error_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."
    },
    "date_created": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
    },
    "date_updated": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The absolute URL of the eSIM Profile resource."
    }
  },
  "$defs": {
    "esim_profile_enum_status": {
      "type": "string",
      "enum": [
        "new",
        "reserving",
        "available",
        "downloaded",
        "installed",
        "failed"
      ]
    }
  }
}