Guide to building your own eSIM proposition with eSIM Go

These guides will help you build your eSIM proposition with eSIM Go and start your eSIM journey with us. They have been designed to walk you through some of the basic functions and features of the eSIM Go Management Platform and our white-label API.

You don’t need to follow all the steps in order, and you might find you can even skip some areas, but the guides will help you get started.

If you need support at any time, please contact eSIM Go through our support section. One of our developers will answer any questions you may have, or if you’d like to schedule a call, please contact your account manager.

The first thing you’ll probably want to look at is our world-class pricing and network coverage.

We recommend doing this initially through the eSIM Go Management Portal, where you can view bundles and coverage through our wholesale webstore. You have the option to download a copy of our pricing and network coverage in Excel through the portal, where you can see the full list of all the countries we serve. You’ll also find full details of our different bundle sizes, costs and durations, along with our network partner names and network speeds (3G/4G and 5G).

We offer the option to view your full bundle catalogue through our API, using the “List Catalogue” command. This will enable you to list all bundles available to your organisation for ordering.

If you require specific information about a bundle, you can use our “Get Bundle from List” catalogue API call, which will display all the data about a specific bundle, including size, duration, speed and pricing.

A list of the different bundle names and monikers are contained in the “Downloadable Rate” sheet on the eSIM Management Portal.

eSIM Go also provides a library of country images for each destination, which our partners are free to use. Image URLs are provided within the “List Catalogue” API command.

The eSIM Go white label management API enables you to integrate your own platform, apps, and web stores directly into eSIM Go. The API allows developers to deploy services in real time, reducing the need to hold any bundle inventory.

We developed the API in partnership with start-ups who want to innovate and build new services on top of our technology stack. If you’ve built a service on the eSIM Go API or even have a new idea for a service, we want to hear from you!

To integrate with the eSIM Go API, first register and validate your eSIM Go account. Using your administrator account (the account you first registered with eSIM Go) open the settings page on the eSIM Go Management Portal. Under “API details”, you can view and copy your API token and set the Callback Settings URL endpoint, which will be used to send details of usage notifications.

The eSIM Go API is accessed through our developers’ area.

The API is available in cURL, HTTPie, Node, Go and Python, and contains code samples for each one. You can also call the API from the web pages by entering your API key in the field in the top right-hand corner of each page. This is a great way to troubleshoot and test your eSIM proposition.

If you require any support with API integration, there’s a lot of helpful information available on our support pages and resources register. Our development team is also on hand to support you and answer any questions – you can contact them through the eSIM Management Portal or our support pages.

Support Pages

Resources

After you have reviewed our pricing, the next step is to add credit in your organisation’s account. Credit can be added by credit card through the eSIM Go Management Portal via the top-up menu option. We can also accept BACS transfers. If you’re at the start of your journey, contact your account manager through the eSIM Go Management Portal, and we will arrange a no-obligation business review and provide you with test credit to get you started.

The minimum top-up amount is $250.

Once you have credit on your account, you can purchase data bundles. This can be done through the API or the eSIM Go Management Portal. See below for more details.

Your account credit is deducted when you purchase data bundles. Bundles can then be assigned to a new eSIM or used as a top-up to an existing eSIM.

eSIM Go provides an option to auto-top-up your account with a saved credit card once your account reaches the threshold you set. This ensures you never run out of credit and risk disrupting your service. A top-up can also be initiated via the API with a pre-saved credit card using the “Update your Organisation’s balance” API call.

If you need to check your balance at any time, you can use the “Get Your Organisation API” call.

eSIM Go works on the simple principle of two components: a data bundle and an eSIM.

A data bundle is assigned to an eSIM on first use, or as a top-up. Bundles can be stacked of different types and sizes, and the bundle duration only ever starts with the first 1KB of data is used. So for a 30 day 10GB bundle, the 30 days only commence when your customers uses the first few kb of data from their 10GB.

We recommend advising your customers to only activate data roaming on their device when they wish to start using the bundle. As eSIM Go offers all inclusive roaming in many of our bundles this prevents any accidental usage prior to arrival at their destination.

An eSIM may be used and topped-up for 12 months after the last usage date, allowing you to promote and market to your customers for future trips.

If you purchase a bundle and assign it to your inventory it has a validity of 12 months before it expires. If you have not assigned that bundle as a top-up or to a new eSIM it cannot then be used after those 12 months.

Purchasing bundles couldn’t be easier – just go through the eSIM Go Management Portal or our API.

The eSIM Go Management Portal has a wholesale webstore interface where you can purchase bundles by country, and even search for bundles that work across multiple countries.

Complete the second validation stage to purchase bundles and top-up your organisation’s account. Once you have credit on the eSIM Management Portal, simply choose the bundle you wish to purchase, select the quantity and then check out. You then have two options:

• Assign the bundle to a new eSIM - this assigns a new eSIM to your organisation, and the CSV data index file and QR code image are available to download. The CSV file contains all the data required to create your own customised QR code, including branding, etc
• Assign to inventory - this will place the bundle into your organisation’s stock. It can then be used any time in the next 12 months, either to assign to another new eSIM or as a top-up to an existing eSIM.

Once a bundle has been assigned to an eSIM, it’s removed from your organisation’s Inventory and can be viewed against the individual eSIM via the “View eSIM'' menu on the Management Portal. Here you can build your own successful eSIM business, without any previous development experience.

Alternatively, using the eSIM Go API, you can purchase and assign bundles in real time. This enables you to link your webstore, mobile app, or platform to eSIM Go and purchase and assign bundles, with no need to hold any bundle inventory. When your customer orders a new eSIM or top-up, you can order that bundle from eSIM Go and assign it to an eSIM straight away.

To order a bundle, use the “Process Orders” API call

The API call includes an option to assign to a new eSIM bundle after a successful order. The bundle names can be found either through the rate sheet, which can be downloaded through the eSIM Go Management Portal, or through the “List Catalogue” API command.

If you opt not to assign the bundle to a new eSIM, it will be transferred to your organisation's Inventory, where it can be assigned to an eSIM in the future.

If you need to view details of historical orders, the API call “Get all orders” will return a summary of each order, along with the order reference.

If you need specific details about an order, the “Get Specific Order” API call will provide additional information, including the date and associated costs.

When you purchase a bundle either through the eSIM Go Management Portal or API, you can immediately auto-assign those bundles to a new eSIM. If not, the bundles are assigned to your organisation's inventory for future use, either on a new eSIM or as a top-up to an existing eSIM.

Select the “Bundle Inventory” page to assign a bundle (or multiple bundles) to a new eSIM using the eSIM Management Portal. A CSV index and image file containing the QR codes can be downloaded on assignment. This file can then be used to create your bespoke QR codes with logos and branding.

Once you've assigned your bundle(s), select the “View eSIM” menu.

To assign a bundle as a top-up using the eSIM Go Management Portal, simply select the eSIM you wish to top-up from the “View eSIM'' menu and use the quick action button.

To assign a bundle using the API, the “Apply a Bundle to an eSIM with eSIM auto-assign” API call will enable you to:

• Provide an ICCID and apply that bundle as a top-up to an existing eSIM
• Provide no ICCID, and apply the bundle to a new eSIM

The response will provide you with the ICCID – the primary identifier for each eSIM.

If you apply a bundle by mistake, or a customer reports an eSIM as lost and stolen, you can revoke a bundle and remove it from the eSIM. This is particularly useful if your customer purchases a bundle by mistake, has an incompatible handset, or their device is network operator locked.

eSIM Go will return any unused revoked bundles to your organisation’s bundle inventory, where they can be reused. If a bundle has been started and revoked, any remaining data will be lost.

To revoke a bundle via the eSIM Go Management Portal:

• Select the eSIM from the “View eSIM'' menu and revoke the appropriate bundle, ensuring you pay attention to any queued bundles also associated with that eSIM.

To revoke a bundle using the API there are two options:

• To revoke all bundles associated to an eSIM, use the “Revoke all of the Bundles from an eSIM” API call.
• To remove one specific bundle, choose “Revoke a specific Bundle Assignment from an eSIM” API call.

You will need the ICCID, bundle name and the bundle assignment ID associated with that instance, which can be obtained through the list “Bundles applied to an eSIM call”.

eSIM Go provides the QR codes and associated index files through the eSIM Go Management Portal and the API pages.

If you wish to use the eSIM Go Management Portal, the index file containing all the data needed to create the QR code is provided when you assign the bundle to a new eSIM for the first time.

To find historical order data, you can go into the “Order History'' menu, under the “Buy eSIM” menu. Here you will be able to view all historical orders and their associated index and QR code image files.

If you just need the data for an individual eSIM, you can find it in the “View eSIM'' menu. Simply search and select the eSIM you want, and all the data you need will be within the pop-up.

It’s also possible to download the index and QR code files through the API pages using “Get QR codes for eSIMs from an Order or Bundle apply reference” API call.

You will need to enter the order reference to generate the file.

To get the information for a single eSIM, use the “Get eSIM details and status” API call.

This will return all the data required to create the QR code and additional information, such as the PUK and PIN code.

Once you have the information you need to create the QR code, you need the SM-DP address and matching ID values. You then need to use a QR Code generator, which are widely available. Simply present the info in the following format:

LPA:1$smdpAddress$matchingID

This will enable you to create your own branded QR codes.

eSIM Go will notify you at various stages of a bundle's lifecycle. Typically this will include:

• 50% data consumption
• 80% data consumption
• 100% data consumption

This information is sent through the “eSIM Usage” API.

To configure the URL, we will push notifications to login to the eSIM Go Management Portal and under settings, select “API Details”.

Once you have the usage notification, you can then opt to send it to the customer. This could be via email, push notifications via the app, WhatsApp or even SMS. eSIM Go enables you to send free* SMS messages to a customer’s eSIM, so you can automate notifications and even promote an additional bundle top-up when their data is running low.

*Messages are free of charge, but subject to a fair use policy.

To send an SMS to an eSIM, the eSIM must be successfully registered on a network, and the mobile handset must be switched on.

Messages can be sent through the eSIM Go Management Portal. Select the eSIM you wish to send an SMS to under the “View eSIM” menu. On the “eSIM details” pop-up, enter up to 160 characters and hit submit. The message will be delivered almost instantly.

This is ideal if your support teams need to communicate with customers in the case of queries or faults.

You can also send an SMS to the eSIM through the API using the “Send an SMS to eSIM” call.

The default sending CLI of the SMS is “eSIM”.

You can check the status of an eSIM through the eSIM Go Management Portal. Simply select the eSIM under the “View eSIM'' menu. Here you can see the status of that eSIM, including its installation status, bundle status and eSIM history.

You can also view the status of an eSIM using the API command “Get eSIM details and status”.

You will need the eSIM ICCID to place the API call, and this will provide you the key details of that eSIM. For example, whether the eSIM is installed in a handset. If you want to check the status of the bundle(s) applied to an eSIM, then the “Get the status of a Bundle to an eSIM” command will provide details of all bundles applied to an eSIM:

Here you will find the initial and remaining bundle quantity, start and end date, and time. Using this data, you create custom dashboards and graphical illustrations showing the remaining bundle data and days before the bundle expires.

Once you have registered for your eSIM Go account, you may want to add more users to access the eSIM Go Management Portal and manage your account details. Your account is known as an “organisation”, and there are two different user types; administrators and users.

By default, the email address used to register your organisation is the main administrator and organisation owner. You may create multiple administrators and users under each organisation account.

As an administrator, you can create users through the eSIM Go Management Portal, in your organisation settings. You can use the eSIM Go API to view your organisation's details using the “Get your Organisation” command.

You have two options if you need to obtain a full list of all eSIMs assigned to your organisation.

• Using the eSIM Go Management Portal, select the “View eSIM” menu. Order and filter the eSIMs and select “export” to download a file containing your eSIM estate's data.
• You can also obtain all eSIMs associated with your account through the API using the “List eSIMs assigned to you” API command:

This will provide you with a full list of all eSIMs assigned to your account.