Skip to main content

​
Overview

Retrieve complete details of an eSIM including activation codes, QR codes, data usage, and expiry information. This is useful for displaying eSIM status to users or resending installation instructions.

​
Quick Start

async function getEsim(transactionId) {
  const response = await fetch(
    `https://api.vellosim.com/api/esim/${transactionId}`,
    {
      method: 'GET',
      headers: {
        'X-API-Key': `API_KEY}`,
        'Content-Type': 'application/json'
      }
    }
  );
  
  const data = await response.json();
  
  return {
    iccid: data.iccid,
    qrCodeUrl: data.qrCodeUrl,
    activationCode: data.ac,
    shortUrl: data.shortUrl,
    dataRemaining: data.data_usage_remain,
    totalVolume: data.totalVolume,
    validityRemaining: data.validity_usage_remain,
    expiryDate: data.expiredTime,
    packageDetails: data.packageDetails,
    pin: data.pin,
    puk: data.puk,
    apn: data.apn
  };
}

// Usage
const esim = await getEsim('esim_1762811805580_83');
console.log(`ICCID: ${esim.iccid}`);
console.log(`Data Remaining: ${esim.dataRemaining} bytes`);
console.log(`QR Code: ${esim.qrCodeUrl}`);

​
Response Format

{
  "_id": "69125f9f56d7f09edabbaf23",
  "packageCode": "PWZ5FXSJ3",
  "orderNo": "B25111021560007",
  "transactionId": "esim_1762811805580_83",
  "esimTranNo": "25111021560007",
  "iccid": "8997250230000286674",
  "imsi": "260066020045995",
  "msisdn": "",
  "ac": "LPA:1$rsp-eu.simlessly.com$ABAB05BFAFF44413AA72E3305C80887F",
  "qrCodeUrl": "https://p.qrsim.net/674c5892006f4703871581a7bc3b8319.png",
  "shortUrl": "https://p.qrsim.net/674c5892006f4703871581a7bc3b8319",
  "smdpStatus": "RELEASED",
  "eid": "",
  "activeType": "2",
  "expiredTime": "2026-05-09T21:56:47.000Z",
  "totalVolume": 524288000,
  "totalDuration": 7,
  "durationUnit": "DAY",
  "orderUsage": 0,
  "data_usage_remain": 524288000,
  "validity_usage_remain": 7,
  "pin": "3266",
  "puk": "58695894",
  "apn": "internet",
  "esimStatus": "GOT_RESOURCE",
  "smsStatus": 2,
  "dataType": 1,
  "packageDetails": {
    "name": "Qatar 500MB 7Days",
    "code": "PWZ5FXSJ3",
    "volume": 524288000,
    "duration": 7,
    "location": "QA",
    "price": 4800,
    "currency": "NGN",
    "locationLogo": "https://flagcdn.com/w320/qa.png",
    "description": "",
    "speed": "3G/4G/5G",
    "coverage": [
      {
        "locationName": "Qatar",
        "locationLogo": "https://flagcdn.com/w320/qa.png",
        "locationCode": "QA",
        "operatorList": [
          {
            "operatorName": "Vodafone",
            "networkType": "4G"
          },
          {
            "operatorName": "ooredoo",
            "networkType": "5G"
          }
        ]
      }
    ]
  },
  "isActive": true,
  "createdAt": "2025-11-10T21:56:47.267Z",
  "updatedAt": "2025-11-10T21:56:47.726Z",
  "user": "69120363ed042b4afb7aca90",
  "transactionRef": "69125f9e56d7f09edabbaf1f",
  "__v": 0
}

​
Key Response Fields

FieldTypeDescription
transactionIdstringTransaction/eSIM unique identifier
iccidstringIntegrated Circuit Card ID (eSIM identifier)
acstringFull LPA activation code (LPA:1smdpsmdpmatching-id)
qrCodeUrlstringFull URL to QR code image for scanning
shortUrlstringShortened URL for QR code
data_usage_remainnumberRemaining data in bytes
totalVolumenumberTotal data allowance in bytes
validity_usage_remainnumberRemaining validity days
totalDurationnumberTotal validity duration
expiredTimestringeSIM expiry date (ISO 8601)
pinstringeSIM PIN code
pukstringeSIM PUK code
apnstringAccess Point Name for data connection
packageDetailsobjectPackage information with coverage details
Data Values in Bytes: totalVolume and data_usage_remain are in bytes. Divide by 1073741824 to convert to GB, or 1048576 for MB.