Airalo Developer Platform
  1. Endpoints
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Partner with Airalo
    • Attribute descriptions
    • FAQ
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Guides
      • Step #1 - Authentication
    • Quick start
      • Request access token
      • Get packages
      • Submit order
      • Get installation instructions
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
        • Get top-up package list
        • Get eSIM package history
      • Notification
        • Understanding Webhooks: Asynchronous Communication for Modern Applications
        • Airalo Webhooks Optin and Flow
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Balance
        • Get balance
      • Request access token
        POST
      • Get compatible device list
        GET
      • Get packages
        GET
      • Submit order
        POST
      • Submit order async
        POST
      • Submit top-up order
        POST
      • Get eSIM
        GET
      • Get data usage
        GET
      • Get installation instructions
        GET
      • Update eSIM brand
        PUT
      • eSIM voucher
        POST
      • Refund Request
        POST
      • Future Orders
        POST
      • Cancel future orders
        POST
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
        • Get Order
        • Submit Order
        • Submit Top-up Order
      • eSIMs
        • Get eSIMs List
        • Get eSIM
        • Get Installation instructions
        • Get Data Usage
        • Get Top-up Package List
        • Get eSIM Package History
      • Order Statuses
        • Get Order Statuses List
        • Get Order Status Name
      • Packages
        • Get Packages
      • Compatible Devices
        • Get Compatible Device List
      • Notification
        • Low Data Notification
        • Credit Limit Notification
        • Webhook Definition
        • Webhook Simulator
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • TO DELETE Installation plugin backup
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY INTEGRATION
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Endpoints

Get eSIM

GET
/v2/sims/{sim_iccid}
This endpoint allows you to retrieve the details of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. You can include related data in the response by specifying optional parameters.
The access token, obtained from the "Request Access Token" endpoint, should be included in the request.
For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ
direct_apple_installation_url:
Partner API now supports direct installation on iOS devices. With the introduction of Universal Links by Apple, users with iOS 17.4 or higher can directly install eSIMs using a special URL, which can be provided to your end clients if they are using iOS version 17.4 or above.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/sims/?include=order,order.status,order.user,share' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'
Response Response Example
{
  "data": {
    "id": 11028,
    "created_at": "2023-02-27 08:30:14",
    "iccid": "8944465400000267221",
    "lpa": "lpa.airalo.com",
    "imsis": null,
    "matching_id": "TEST",
    "qrcode": "LPA:1$lpa.airalo.com$TEST",
    "qrcode_url": "https://sandbox.airalo.com/qr?expires=1763800214&id=13282&signature=93bc1599eaaea3175eb32a9f23b3961273e97f04c50ba1b57b68ac99bc6677df",
    "direct_apple_installation_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$wbg.prod.ondemandconnectivity.com$Y7MRQ886FCDJD4RH",
    "voucher_code": null,
    "airalo_code": null,
    "apn_type": "automatic",
    "apn_value": null,
    "is_roaming": true,
    "confirmation_code": "5751",
    "order": null,
    "brand_settings_name": "our perfect brand",
    "recycled": true,
    "recycled_at": "2025-05-05 10:52:39",
    "simable": {
      "id": 9647,
      "created_at": "2023-02-27 08:30:14",
      "code": "20230227-009647",
      "description": null,
      "type": "sim",
      "package_id": "kallur-digital-7days-1gb",
      "quantity": 1,
      "package": "Kallur Digital-1 GB - 7 Days",
      "esim_type": "Prepaid",
      "validity": "7",
      "price": "9.50",
      "data": "1 GB",
      "currency": "USD",
      "manual_installation": "<p><b>eSIM name: </b>Kallur Digital</p><p><b>Coverage:</b> Faroe Islands</p><p><b>To manually activate the eSIM on your eSIM capable device:</b></p><p>1. Settings> Cellular/Mobile> Add Cellular/Mobile Plan.</p><p>2. Manually enter the SM-DP+ Address and activation code.</p><p>3. Confirm the eSIM plan details</p><p>4. Label the eSIM.</p><p><b>To access Data:</b></p><p>1. Enable data roaming.</p><p><b>To top-up:</b></p><p></p><p>Visit airalo.com/my-esims or \"My eSIMs\" tab in your Airaloo app.</p><p><br></p>",
      "qrcode_installation": "<p><b>eSIM name:</b> Kallur Digital</p><p><b>Coverage: </b>Faroe Islands</p><p><b>To activate the eSIM by scanning the QR code on your eSIM capable device you need to print or display this QR code on other device:</b></p><p>1. Settings> Cellular/Mobile> Add Cellular/Mobile Plan.</p><p>2. Scan QR code</p><p>3. Confirm the eSIM plan details</p><p>4. Label the eSIM</p><p><b>To access Data:</b></p><p>1. Enable data roaming</p>",
      "installation_guides": {
        "en": "https://sandbox.airalo.com/installation-guide"
      },
      "status": {
        "name": "Completed",
        "slug": "completed"
      },
      "user": {
        "id": 120,
        "created_at": "2023-02-20 08:41:57",
        "name": "User Name",
        "email": "email@domain.com",
        "mobile": null,
        "address": null,
        "state": null,
        "city": null,
        "postal_code": null,
        "country_id": null,
        "company": "Company Name"
      },
      "sharing": {
        "link": "https://esims.cloud/our-perfect-brand/a4g5ht-58sdf1a",
        "access_code": "4812"
      }
    }
  },
  "meta": {
    "message": "succes"
  }
}

Request

Path Params
sim_iccid
string 
required
The ICCID of the eSIM for which you want to retrieve the details.
Query Params
include
string 
optional
Optional. A comma-separated string to include related data in the response. Possible values are "order", "order.status", "order.user" and "share".
Example:
order,order.status,order.user,share
Header Params
Accept
string 
required
Example:
application/json
Authorization
string 
required
Example:
Bearer {ACCESS_TOKEN}

Responses

🟢200Get eSIM (200)
application/json
Body
data
object 
required
id
integer 
required
created_at
string 
required
iccid
string 
required
lpa
string 
required
imsis
null 
required
matching_id
string 
required
qrcode
string 
required
qrcode_url
string 
required
direct_apple_installation_url
string 
required
voucher_code
null 
required
airalo_code
null 
required
apn_type
string 
required
apn_value
null 
required
is_roaming
boolean 
required
confirmation_code
string 
required
order
null 
required
brand_settings_name
string 
required
recycled
boolean 
required
true - if sim is recycled. - false - otherwise
recycled_at
string <date-time> | null 
required
Timestamp of when the sim was recycled in format Y-m-d H:i:s
simable
object 
required
meta
object 
required
message
string 
required
Modified at 2025-05-12 15:00:30
Previous
Submit top-up order
Next
Get data usage
Built with