Skip to main content
GET
/
esim
/
installation
Get Installation Instructions
curl --request GET \
  --url https://api.fyatu.com/api/v3/esim/installation \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "<string>",
  "data": {
    "ios": {
      "title": "<string>",
      "requirements": [
        "<string>"
      ],
      "steps": [
        {
          "step": 123,
          "title": "<string>",
          "description": "<string>"
        }
      ],
      "notes": [
        "<string>"
      ]
    },
    "android": {
      "title": "<string>",
      "requirements": [
        "<string>"
      ],
      "steps": [
        {
          "step": 123,
          "title": "<string>",
          "description": "<string>"
        }
      ],
      "notes": [
        "<string>"
      ]
    },
    "general": {
      "tips": [
        "<string>"
      ],
      "troubleshooting": [
        {
          "issue": "<string>",
          "solution": "<string>"
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_abc123def456",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Retrieve step-by-step eSIM installation instructions for different platforms (iOS, Android). Use these instructions to guide your users through the activation process.

Response Fields

FieldTypeDescription
iosobjectiOS installation instructions
androidobjectAndroid installation instructions
generalobjectGeneral tips and troubleshooting

Platform Object

FieldTypeDescription
titlestringPlatform title
requirementsarrayDevice requirements
stepsarrayStep-by-step instructions
notesarrayAdditional notes

Step Object

FieldTypeDescription
stepintegerStep number
titlestringStep title
descriptionstringDetailed description

Example Usage

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

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

// Display iOS instructions
console.log(data.ios.title);
data.ios.steps.forEach(step => {
  console.log(`${step.step}. ${step.title}: ${step.description}`);
});

// Display troubleshooting tips
data.general.troubleshooting.forEach(item => {
  console.log(`Problem: ${item.issue}`);
  console.log(`Solution: ${item.solution}`);
});

Example Response

{
  "success": true,
  "status": 200,
  "message": "Installation instructions retrieved successfully",
  "data": {
    "ios": {
      "title": "iPhone / iPad Installation",
      "requirements": [
        "iPhone XS, XR or newer",
        "iPad Pro (3rd generation) or newer with cellular",
        "iOS 12.1 or later",
        "Active internet connection (Wi-Fi or cellular)"
      ],
      "steps": [
        {
          "step": 1,
          "title": "Open Settings",
          "description": "Go to Settings > Cellular (or Mobile Data)"
        },
        {
          "step": 2,
          "title": "Add eSIM",
          "description": "Tap \"Add Cellular Plan\" or \"Add eSIM\""
        },
        {
          "step": 3,
          "title": "Scan QR Code",
          "description": "Scan the QR code provided, or tap \"Enter Details Manually\" to input the activation code"
        },
        {
          "step": 4,
          "title": "Label Your Plan",
          "description": "Give your eSIM a label (e.g., \"Travel Data\") for easy identification"
        },
        {
          "step": 5,
          "title": "Enable Data Roaming",
          "description": "Go to Settings > Cellular > [Your eSIM] and turn on \"Data Roaming\""
        },
        {
          "step": 6,
          "title": "Set as Default (Optional)",
          "description": "Choose this eSIM as your default for cellular data when traveling"
        }
      ],
      "notes": [
        "Ensure your device is connected to Wi-Fi during installation",
        "The eSIM can only be installed on one device at a time",
        "Keep your QR code safe - you may need it if you reset your device"
      ]
    },
    "android": {
      "title": "Android Installation",
      "requirements": [
        "eSIM-compatible Android device (Google Pixel 3+, Samsung Galaxy S20+, etc.)",
        "Android 10 or later recommended",
        "Active internet connection (Wi-Fi or cellular)"
      ],
      "steps": [
        {
          "step": 1,
          "title": "Open Settings",
          "description": "Go to Settings > Network & Internet > Mobile Network"
        },
        {
          "step": 2,
          "title": "Add eSIM",
          "description": "Tap the \"+\" or \"Add\" button, then select \"Download a SIM instead\""
        },
        {
          "step": 3,
          "title": "Scan QR Code",
          "description": "Scan the QR code provided, or enter the activation code manually"
        },
        {
          "step": 4,
          "title": "Confirm Installation",
          "description": "Review the carrier details and tap \"Download\" or \"Confirm\""
        },
        {
          "step": 5,
          "title": "Enable the eSIM",
          "description": "Once downloaded, enable the eSIM and turn on \"Data Roaming\""
        },
        {
          "step": 6,
          "title": "Set Data Preference",
          "description": "Go to SIM settings and select this eSIM for mobile data"
        }
      ],
      "notes": [
        "Steps may vary slightly depending on your device manufacturer",
        "Samsung devices: Settings > Connections > SIM Card Manager > Add eSIM",
        "Google Pixel: Settings > Network & Internet > SIMs > Add SIM"
      ]
    },
    "general": {
      "tips": [
        "Install the eSIM before your trip while you have stable internet",
        "You can install the eSIM but wait to activate it until you arrive",
        "Take a screenshot of your QR code as backup",
        "Data-only eSIMs do not support phone calls or SMS"
      ],
      "troubleshooting": [
        {
          "issue": "QR code not scanning",
          "solution": "Try entering the activation code manually, or ensure good lighting and camera focus"
        },
        {
          "issue": "No data connection after installation",
          "solution": "Ensure Data Roaming is enabled and the eSIM is selected for mobile data"
        },
        {
          "issue": "eSIM not appearing in settings",
          "solution": "Restart your device and check if your device supports eSIM"
        }
      ]
    }
  }
}

Platform-Specific Paths

iOS Settings Path

Settings > Cellular > Add Cellular Plan
or on newer iOS versions:
Settings > Cellular > Add eSIM

Android Settings Paths

BrandPath
Google PixelSettings > Network & Internet > SIMs > Add SIM
SamsungSettings > Connections > SIM Card Manager > Add eSIM
OnePlusSettings > Wi-Fi & Network > SIM & Network > Add eSIM

Best Practices

Use navigator.userAgent or similar to detect iOS vs Android and show relevant instructions first.
Supplement text instructions with screenshots or videos for each step.
Show both QR code scanning and manual entry options - some users may have difficulty scanning.
Display the requirements before installation so users can prepare (Wi-Fi connection, updated OS, etc.).

Common Issues

IssueCauseSolution
”eSIM not supported”Device/carrier lockUnlock device or use different device
”Cannot add cellular plan”iOS version outdatedUpdate to iOS 12.1+
No internet after installData roaming disabledEnable Data Roaming in settings
QR code won’t scanPoor image/lightingUse manual activation code
”Plan already active”QR code used beforeContact support for new QR code
Recommend users install eSIMs while still at home on Wi-Fi, then activate data roaming after arrival at their destination.

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Response

Installation instructions retrieved successfully

success
boolean
Example:

true

status
integer
Example:

200

message
string
data
object
meta
object