# Order an eSIM Profile.

**POST /v1/ESimProfiles**

Order an eSIM Profile.
eSIM Profiles that can be loaded onto consumer eUICC SIMs

## Servers
- https://supersim.twilio.com: https://supersim.twilio.com ()


## Authentication methods
- Account sid auth token


## Parameters



### Body: application/x-www-form-urlencoded (object)

- **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.
- **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
Created
#### Headers
- **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

#### Body: application/json (object)
- **sid** (string | null)
  The unique string that we created to identify the eSIM Profile resource.
- **account_sid** (string | null)
  The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the eSIM Profile resource belongs.
- **iccid** (string | null)
  The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource.
- **sim_sid** (string | null)
  The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls.
- **status** (string)
  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** (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](https://en.wikipedia.org/wiki/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](https://en.wikipedia.org/wiki/ISO_8601) format.
- **url** (string(uri) | null)
  The absolute URL of the eSIM Profile resource.


[Powered by Bump.sh](https://bump.sh)