How to get the eSIMs Cloud sharing link through API

It is a link to the eSIMs Cloud platform, which securely shares all of the information that is needed for using an eSIM. It supports:

Multi-language capabilities, including installation and activation instructions

Direct installation link (for devices with iOS 17.4+)

Custom brand styling (branded QR codes and eSIMs Cloud pages)

eSIM information (current eSIM usage, technical details, supported countries and networks, and package history)

You can learn how eSIMs Cloud sharing links work here.

A. “Submit Order” Endpoint

Every time you make a successful Submit order call, the “Sharing“ data model is returned by default. It contains the eSIMs Cloud link and access code that can be shared with end users right away.

If a brand is set, the eSIMs Cloud link will show the branded version of eSIMs Cloud:


 "sharing": {
            "link": "https://esims.cloud/test-brand/jgxtu-pvk2fmh4",
            "access_code": "4436"
        },

If no brand is set, the eSIMs Cloud link will show the unbranded version of eSIMs Cloud:

"sharing": {
            "link": "https://esims.cloud/he4qy-kqc8u68t",
            "access_code": "8319"
        },

B. “Get eSIM” Endpoint

The eSIMs Cloud link and access code can be retrieved at any time by calling the Get eSIM using the eSIM's ICCID. The “Sharing“ data model is returned by default.

If a brand is set, the eSIMs Cloud link will show the branded version of eSIMs Cloud:


 "sharing": {
            "link": "https://esims.cloud/test-brand/jgxtu-pvk2fmh4",
            "access_code": "4436"
        },

If no brand is set, the eSIMs Cloud link will show the unbranded version of eSIMs Cloud:

"sharing": {
            "link": "https://esims.cloud/he4qy-kqc8u68t",
            "access_code": "8319"
        },

Yes, the sharing link and access code are always available in the Submit order and Get eSIM response. This applies regardless of whether the eSIM is branded or unbranded.

How will my customers use the link and the access code?

They just need to open the link and enter the access code. After that, they will be able to view all the eSIM details, including:

Package, country, region, name & data usage

Package details: validity period

ICCID number, network, and phone number (if applicable)

eSIM Instructions: Direct, QR code, and manual installation details for several devices

Support email and phone number are available on the Contact Us page

Customers can change the language on the Menu page

How do I assign a brand for an eSIM order?

Set up your brand by specifying the brand name in the Partner Platform.

Include this name (brand settings name) in your order submission to link it to your brand. The brand_settings_name parameter is optional in Submit order

"brand_settings_name": "Test Brand"

You can update the brand for a specific eSIM using the following endpoint:
Update eSIM brand

This endpoint allows you to modify the brand settings associated with a particular eSIM in the Airalo Partners API using the eSIM’s ICCID and the “brand settings name”.

The selected brand will be displayed when sharing links or emails.

To create an unbranded order, simply submit it without specifying a brand — set brand as a null value. You can still access the eSIM information and share the link using the ICCID.

How to get the eSIMs Cloud sharing link through API

What is the eSIMs Cloud sharing link?#

How do I get the eSIMs Cloud sharing link and access code for an eSIM?#

Are the sharing link and access code always available?#

How will my customers use the link and the access code?#

How do I assign a brand for an eSIM order?#

What is the eSIMs Cloud sharing link?

How do I get the eSIMs Cloud sharing link and access code for an eSIM?

Are the sharing link and access code always available?

How will my customers use the link and the access code?

How do I assign a brand for an eSIM order?