Fetch an eSIM Profile

GET /v1/ESimProfiles/{Sid}

eSIM Profiles that can be loaded onto consumer eUICC SIMs

Fetch an eSIM Profile.

Path parameters

  • Sid string Required

    The SID of the eSIM Profile resource to fetch.

Responses

  • OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account to which the eSIM Profile resource belongs

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • eid string | null

      Identifier of the eUICC that can claim the eSIM Profile

    • error_code string | null

      Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state

    • error_message string | null

      Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state

    • iccid string | null

      The ICCID associated with the Sim resource

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HP[0-9a-fA-F]{32}$.

    • sim_sid string | null

      The SID of the Sim resource that this eSIM Profile controls

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HS[0-9a-fA-F]{32}$.

    • smdp_plus_address string(uri) | null

      Address of the SM-DP+ server from which the Profile will be downloaded

    • status string | null

      The status of the eSIM Profile

      Values are new, reserving, available, downloaded, installed, or failed.

    • url string(uri) | null

      The absolute URL of the eSIM Profile resource

GET /v1/ESimProfiles/{Sid}
curl \
 -X GET https://supersim.twilio.com/v1/ESimProfiles/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "eid": "string",
  "error_code": "string",
  "error_message": "string",
  "iccid": "string",
  "sid": "string",
  "sim_sid": "string",
  "smdp_plus_address": "https://example.com",
  "status": "new",
  "url": "https://example.com"
}
Response examples (200)
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "eid": "string",
  "error_code": "string",
  "error_message": "string",
  "iccid": "string",
  "sid": "string",
  "sim_sid": "string",
  "smdp_plus_address": "https://example.com",
  "status": "new",
  "url": "https://example.com"
}