Order an eSIM Profile.

POST /v1/ESimProfiles
Account sid auth token

eSIM Profiles that can be loaded onto consumer eUICC SIMs

Order an eSIM Profile.

application/x-www-form-urlencoded

Body

  • CallbackUrl string

    The URL we should call using the callback_method when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from reserving to available.

  • CallbackMethod string(http-method)

    The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST.

    Values are GET or POST.

  • GenerateMatchingId boolean

    When set to true, a value for Eid does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the matching_id property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the profile.

  • Eid string

    Identifier of the eUICC that will claim the eSIM Profile.

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

      The unique string that we created to identify the eSIM Profile resource.

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

    • 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}$.

    • iccid string | null

      The ICCID associated with the Sim resource.

    • 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}$.

    • status string

      The status of the eSIM Profile. Can be: new, reserving, available, downloaded, installed or failed. See the eSIM Profile Status Values for a description of each.

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

    • eid string | null

      Identifier of the eUICC that can claim the eSIM Profile.

    • smdp_plus_address string(uri) | null

      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 string | null

      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 string | null

      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 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.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • url string(uri) | null

      The absolute URL of the eSIM Profile resource.
POST /v1/ESimProfiles 
curl \
 --request POST 'https://supersim.twilio.com/v1/ESimProfiles' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Eid=89049032005008882600033489aaaaaa'
Request examples 
{"Eid"=>"89049032005008882600033489aaaaaa"}
{"GenerateMatchingId"=>true}
{"Eid"=>"89049032005008882600033489aaaaaa", "CallbackUrl"=>"http://callback.twilio.com", "CallbackMethod"=>"POST"}
Response examples (201) 
{
  "eid": "89049032005008882600033489aaaaaa",
  "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "iccid": null,
  "status": "new",
  "sim_sid": null,
  "error_code": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "matching_id": null,
  "date_created": "2020-09-01T20:00:00Z",
  "date_updated": "2020-09-01T20:00:00Z",
  "error_message": null,
  "activation_code": null,
  "smdp_plus_address": null
}
{
  "eid": null,
  "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "iccid": null,
  "status": "new",
  "sim_sid": null,
  "error_code": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "matching_id": null,
  "date_created": "2020-09-01T20:00:00Z",
  "date_updated": "2020-09-01T20:00:00Z",
  "error_message": null,
  "activation_code": null,
  "smdp_plus_address": null
}
{
  "eid": "89049032005008882600033489aaaaaa",
  "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "iccid": null,
  "status": "reserving",
  "sim_sid": null,
  "error_code": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "matching_id": null,
  "date_created": "2020-09-01T20:00:00Z",
  "date_updated": "2020-09-01T20:00:00Z",
  "error_message": null,
  "activation_code": null,
  "smdp_plus_address": null
}