Check device compatibility

This endpoint checks whether a specific device supports eSIM, so you can confirm your customer has an eSIM-capable device before they purchase. Send the device's hardware model identifier and receive a simple supported true or false answer, without downloading and matching the full compatible device list yourself.

Important Notes:

Authentication: Pass the access token obtained from the Request Access Token endpoint in the request headers.

Hardware compatibility only: This endpoint checks whether the device hardware supports eSIM. It does not detect whether the device is carrier-locked. A carrier-locked device can be eSIM-capable and still be unable to install an eSIM from another provider. We recommend showing your customers a short notice asking them to confirm their device is carrier-unlocked before purchase.

Device not in the list: A response of supported: false with reason not_in_compatible_list means the model was not found in Airalo's compatible device list. It does not necessarily mean the device lacks eSIM support. In this case, we recommend asking customers to check their device settings rather than blocking the purchase.

Up-to-date data: The check uses the same compatible device list as the Get compatible device lite list endpoint. That list is updated regularly, so newly supported devices are recognised automatically.

Usage recommendation: Call this endpoint before processing eSIM orders.

How to get the device model

Send the device's hardware model identifier, not its marketing name (for example iPhone13,2, not "iPhone 12"). Both values below can be read without any extra permission.

iOS (Swift)

Reference: uname(3) — Apple Developer manual page (machine: machine hardware platform)

Android (Kotlin)

Reference: android.os.Build.MODEL — Android Developers

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Supported Device

application/json

Bodyapplication/json

Example

{
  "data": {
    "supported": true,
    "reason": null,
    "device": {
      "os": "ios",
      "brand": "Apple",
      "name": "iPhone 17 Pro"
    }
  }
}

🟢200Device not found in the compatible device list

How to get the device model#

Request

Request Code Samples

Responses

How to get the device model