POSTeSIM Management
Create eSIM
Use this endpoint to provision a new eSIM. The request requires the productId of the desired eSIM plan, the ISO3 country code, and a unique idempotencyKey in the request body. A new idempotency key must be generated and passed for every Create eSIM request. The same idempotency key should not be reused for a new eSIM provisioning request. A successful response returns the eSIM's ICCID, activation code, and associated data plan details.
Endpoint
POSThttps://api.sotel.com/api/esim/create
Authentication
Requires an Authentication Token obtained from the /authenticate endpoint. Include it in the X-Token header.
X-Token:{{token}}Request Body
| Name | Type | Required | Description |
|---|---|---|---|
productId | string | Required | The ID of the eSIM data plan to be provisioned. Obtain this from the Get Data Plans endpoint. |
iso3 | string | Required | The ISO3 country code for the selected destination (e.g. "GRC", "USA", "NGA"). |
idempotencyKey | string | Optional | A unique key generated by the user/client for each Create eSIM request. A new key must be provided for every request. |
Request Example
{
"productId": "21170365",
"iso3": "GRC",
"idempotencyKey": "order-12345"
}Response
eSIM created and provisioned successfully.
Response
{
"status": "Success",
"code": 200,
"data": {
"sim": {
"id": 48,
"iccid": "8910300000033610520",
"productId": "21170170",
"imsi": "260012165106754",
"state": "INACTIVE",
"lastOperationDate": "2025-10-31 09:18:17",
"activationCode": "TN20250310111816F04A4DFD",
"smdp": "consumer.e-sim.global",
"purchaseDate": "2026-10-07T13:37:44.092+01:00",
"plan": {
"productId": "21170170",
"name": "Netherlands 1GB 5 days",
"dataPlanType": "DESTINATION",
"dataAllowance": 1,
"timeAllowance": 5,
"price": 2,
"country": "Netherlands",
"iso3": "NLD",
"region": "Europe",
"expiryDate": "2026-10-12T13:37:43.896+01:00"
}
},
"dataPlan": {
"productId": "21170170",
"name": "Netherlands 1GB 5 days",
"dataUsageAllowance": 1,
"timeAllowance": 5,
"country": "Netherlands",
"iso3": "NLD",
"region": "Europe",
"price": 2
},
"amountNaira": 3225,
"currency": "NGN"
},
"message": "Successful",
"timestamp": "2026-10-07 13:37:44"
}Code Examples
curl -X POST 'https://api.sotel.com/api/esim/create' \
-H 'X-Token:{{token}}' \
-H 'Content-Type: application/json' \
-d '{
"productId": "21170365",
"iso3": "GRC",
"idempotencyKey": "order-12345"
}'Try It
Try It
Fill in the parameters to generate a cURL command
Request Body
Generated cURL
curl --location 'https://api.sotel.com/api/esim/create' \
--header 'X-Token: {token}' \
--header 'Content-Type: application/json' \
--data '{
"productId": "{productId}",
"iso3": "{iso3}"
}'