Skip to main content
GET
/
esim
/
{iccid}
Get eSIM Details
curl --request GET \
  --url https://api.fyatu.com/api/v3/esim/{iccid} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "<string>",
  "data": {
    "esimId": "<string>",
    "iccid": "<string>",
    "customName": "<string>",
    "status": "ready",
    "package": {
      "id": "<string>",
      "name": "<string>",
      "destination": "<string>",
      "destinationType": "<string>",
      "dataGb": 123,
      "dataDisplay": "<string>",
      "validityDays": 123,
      "isUnlimited": true
    },
    "usage": {
      "data": {
        "totalMb": 123,
        "usedMb": 123,
        "remainingMb": 123,
        "percentUsed": 123
      },
      "voice": {
        "totalMinutes": 123,
        "usedMinutes": 123,
        "remainingMinutes": 123
      },
      "sms": {
        "total": 123,
        "used": 123,
        "remaining": 123
      }
    },
    "validity": {
      "activatedAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "daysRemaining": 123
    },
    "activation": {
      "qrCodeUrl": "<string>",
      "manualCode": "<string>",
      "appleInstallUrl": "<string>",
      "lpa": "<string>",
      "matchingId": "<string>",
      "confirmationCode": "<string>"
    },
    "apn": {
      "type": "<string>",
      "value": "<string>",
      "data": "<string>"
    },
    "sharing": {
      "accessCode": "<string>",
      "link": "<string>"
    },
    "operator": {
      "name": "<string>",
      "imageUrl": "<string>"
    },
    "orderId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_abc123def456",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

​
Overview

Retrieve detailed information about a specific eSIM, including package details, usage statistics, validity dates, and activation codes.

​
Path Parameters

ParameterTypeDescription
iccidstringThe eSIM’s ICCID (also accepts esimId for backwards compatibility)
The ICCID (Integrated Circuit Card Identifier) is a unique 19-20 digit number that identifies the eSIM. You can also use the esimId if preferred.

​
Response Sections

​
Package Information

FieldDescription
package.packageIdPackage identifier
package.namePackage name
package.destinationCountry/region name
package.destinationTypelocal/regional/global
package.dataDisplayHuman-readable data amount
package.validityDaysValidity period
package.isUnlimitedWhether data is unlimited

​
Usage Statistics

FieldDescription
usage.data.totalMbTotal data allowance in MB
usage.data.usedMbData consumed in MB
usage.data.remainingMbData remaining in MB
usage.data.percentUsedUsage as percentage
usage.voice.*Voice usage (if premium package)
usage.sms.*SMS usage (if premium package)

​
Validity Information

FieldDescription
validity.activatedAtWhen eSIM was first activated
validity.expiresAtExpiration date/time
validity.daysRemainingDays until expiration

​
Activation Codes

FieldDescription
activation.qrCodeUrlURL to QR code image
activation.manualCodeManual activation code
activation.lpaLPA address for manual entry
activation.matchingIdMatching ID for manual entry
activation.confirmationCodeConfirmation code (if required)
activation.appleInstallUrlDirect iOS installation URL

​
Sharing (for eSIM transfer)

FieldDescription
sharing.accessCodeAccess code for sharing
sharing.linkShareable link URL

​
APN Settings

FieldDescription
apn.typeautomatic or manual
apn.valueAPN value if manual
apn.dataAdditional APN data

​
Example Usage

const iccid = '8910300000000012345';

const response = await fetch(`https://api.fyatu.com/api/v3/esim/${iccid}`, {
  headers: {
    'Authorization': `Bearer ${accessToken}`
  }
});

const { data } = await response.json();

// Display basic info
console.log(`ICCID: ${data.iccid}`);
console.log(`eSIM ID: ${data.esimId}`);
console.log(`Status: ${data.status}`);
console.log(`Package: ${data.package.name} (${data.package.destination})`);

// Show usage
const usage = data.usage.data;
console.log(`Data: ${usage.usedMb}MB / ${usage.totalMb}MB (${usage.percentUsed}% used)`);
console.log(`Remaining: ${usage.remainingMb}MB`);

// Show validity
if (data.validity.daysRemaining !== null) {
  console.log(`Expires in ${data.validity.daysRemaining} days`);
}

// Get activation code for user
if (data.status === 'inactive') {
  console.log(`QR Code: ${data.activation.qrCodeUrl}`);
  console.log(`Manual Code: ${data.activation.manualCode}`);

  // For iOS users
  if (data.activation.appleInstallUrl) {
    console.log(`iOS Install: ${data.activation.appleInstallUrl}`);
  }
}

​
Example Response

{
  "success": true,
  "status": 200,
  "message": "eSIM details retrieved successfully",
  "data": {
    "esimId": "ESIM-20260105-ABC12345",
    "iccid": "8910300000000012345",
    "customName": null,
    "status": "active",
    "package": {
      "packageId": "merhaba-7days-5gb",
      "name": "Merhaba 7 Days 5GB",
      "destination": "Turkey",
      "destinationType": "local",
      "dataDisplay": "5 GB",
      "validityDays": 7,
      "isUnlimited": false
    },
    "usage": {
      "data": {
        "totalMb": 5120,
        "usedMb": 2048,
        "remainingMb": 3072,
        "percentUsed": 40.0
      },
      "voice": {
        "totalMinutes": 0,
        "usedMinutes": 0,
        "remainingMinutes": 0
      },
      "sms": {
        "total": 0,
        "used": 0,
        "remaining": 0
      }
    },
    "validity": {
      "activatedAt": "2026-01-03T14:30:00Z",
      "expiresAt": "2026-01-10T14:30:00Z",
      "daysRemaining": 5
    },
    "activation": {
      "qrCodeUrl": "https://cdn.fyatu.com/qr/abc12345.png",
      "manualCode": "LPA:1$smdp.io$ABC123DEF456",
      "lpa": "smdp.io",
      "matchingId": "ABC123DEF456",
      "confirmationCode": null,
      "appleInstallUrl": "https://esimsetup.apple.com/esim_qrcode_provisioning?..."
    },
    "sharing": {
      "accessCode": "ABC123",
      "link": "https://share.fyatu.com/esim/abc123"
    },
    "apn": {
      "type": "automatic",
      "value": null,
      "data": null
    },
    "operator": {
      "name": "Turkcell",
      "imageUrl": "https://cdn.fyatu.com/operators/turkcell.png"
    },
    "orderId": "airalo-order-67890",
    "createdAt": "2026-01-03T10:00:00Z",
    "updatedAt": "2026-01-05T08:00:00Z"
  }
}
Usage data may be cached. Use the Refresh endpoint to get real-time usage from the provider.

Authorizations

​
Authorization
string
header
required

JWT access token obtained from /auth/token

Path Parameters

​
iccid
string
required

eSIM ICCID (19-20 digits) or esimId (ESIM-XXXXXXXX)

Response

eSIM details retrieved successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
​
data
object
​
meta
object