Skip to main content

How to get the eSIMs Cloud sharing link through API

Updated

 

What is the eSIMs Cloud sharing link?

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)
  • Contact Us page (only if a brand has been set up)

You can learn how eSIMs Cloud sharing links work here.

You can set up your brand settings directly in the Partner Platform. Instructions are available here.

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

You can get the eSIMs Cloud sharing link and access code through the “Submit Order” and “Get eSIM” endpoints. Here’s how.

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 sharing link and access code to share with end users.

If a brand setting is set, the eSIMs Cloud sharing link will be branded:

 


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

If no brand settings are set, the eSIMs Cloud sharing link will be unbranded:

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

B. “Get eSIM” endpoint

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

If a brand setting is set, the eSIMs Cloud sharing link will be branded:


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

If no brand settings are set, the eSIMs Cloud sharing link will be unbranded:

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

Are the eSIMs Cloud sharing link and access code always available?

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

How will my customers use the eSIMs Cloud sharing link and access code?

Your customers simply need to open the sharing 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. If you haven’t set up a brand in the Partner Platform yet, please refer to this article.

Include the brand settings name in your order submission to link it to your brand. The brand_settings_name parameter is optional in the “Submit Order” request.

"brand_settings_name": "Test Brand"

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

PUT: /v2/sims/:sim_iccid/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 the brand as a null value. You can still access the eSIM information and share the link using the ICCID.

Related articles