Esim go docs. Note: Bundle names are case sensitive e.

Esim go docs. The quantity of a refund cannot exceed the remaining quantity left for the specific usageId. 4. Bundles are grouped into categories. One time notification that is sent the first time an eSIM successfully uses any data to the nearest 1kb. 0 The Send SMS endpoint is a powerful feature of the eSIMGo API that allows you to send text messages directly to eSIMs. May 21, 2025 · eSIM Go API Release notes2. The purpose for Option 1 is if you require Some common eSIM related terminology explainedCommon eSIM-related terminology, explained The world of mobile communications is full of acronyms and seemingly arcane terminology. Filtering This callback is used to notify when either the existing eSIM Voice or SMS bundle has expired (i. This is usually instant but can, on occasion Get details of a specific Bundle from your Organisation's catalogue. eSIM technology is a product of this environment so it can be bewildering at first. g. This endpoint becomes particularly useful when combined with eSIMGo's real-time notification system, which provides updates about eSIM activity through callback functionality. This endpoint enables you to receive a new eSIM with the specified Bundle pre-applied. If you wish to refund multiple usageId's, multiple calls to this endpoint will need to be done. APN (Access Point Name) The APN is all the information your phone uses Why let others sell data roaming to your customers when it's this easy to do it yourself? Now's the time to add mobile to your premium extras… eSIM Go: Simple. If you wish to raise or lower this amount, please contact your account manager. Key points: Message requirements: UTF-8 compliant Length In order to use the eSIM Go API you will need to access your API Token (also referred to as an API Key), firstly either Create an account or if you already have an account then Log into your accoun The date of the Last Action performed on the ESIM http --timeout 3600 GET 'https://api. From wholesale eSIM API to affiliate eSIM solutions, keep your customer base connected with industry leading prices and increase customer loyalty. 22 (RSP Technical Specification) for EID using the ITU-T E. What eSIM profiles are available from eSIM Go? How are eSIM profiles delivered? How can I access the API? eSIM Go provides eSIM profiles - but what exactly are they? How are eSIM profiles priced? The eSIM Go API provides access to notifications in response to events within the platform. We recommend reissuing a new eSIM instead, especially if the eSIM is not already installed. This is usually instant but can occasionally take up to 10 minutes to complete. May 25, 2021 · Esim This Go eSIM module processes eUICC IDentifier (EID) used in the context of Remote Provisioning and Management of the eUICC (eSIM) in according to GSM Association Official Document SGP. Once your balance goes below the threshold set by you in your eSIM Go Portal; the topup will be automatically triggered, and this notification sent. This endpoint returns the history of a specific eSIM. To enable it on the eSIM Portal go to Account Settings -> API Details -> Callback Version. 30 (27 June 2025) Platform upgrade and bug fixes New - My Account page filtering For users with access to “My Account” now have a option to filter the data New - eSIM Branding Profile selection available in Portal When purchasing a bundle via the Portal, a dropdown is now present to select which eSIM Branding Profile to use. First though, you’ll learn how to test that the ordering process is working. Remaining data can be found here. Once you’ve topped up your account with a Card or by BACS you can use your balance to buy eSIMs. Bundle names can be used with the /orders endpoint to place an order. You can register as an Why let others sell data roaming to your customers when it's this easy to do it yourself? Now's the time to add mobile to your premium extras… eSIM Go: Simple. The eSIM Go API is an easy-to-use RESTful API, compatible with common API development and testing tools. If no ICCID is provided, a new eSIM will be assigned to you, and the Bundle applied. been fully used). Key Features: Pagination: Efficiently manage large datasets by specifying the page number and items per page. Definitions eSIM Go Management Portal eSIM Go User Interface which can be accessed through a desktop web browser and enables the partner to view dashboards and individual eSIM information. Get details on all previous orders, including total cost and contents. A feature that enables the association of a unique identifier with an eSIM. com/v2/esims/$ICCID 200 Success - Your eSIM has been updated Select media type application/json object message Status of api functions which do not return data string Get details on an order, including total cost and contents eSIM Go API Collections. All of your Organisation's currently purchased Bundles and their remaining usages. If no ICCID is provided, as well as only providing a Bundle, Repeat can be This endpoint provides the most recent location and associated network operator information for a specified eSIM. com/v2. Self-serve your way to real-time integration of your own platform, mobile apps and web stores directly into the eSIM Go technology stack, with full technical and commercial control of your eSIM estate. 200 API details Select media type application/json Array<string> Previous Next Set to true to include eSIM data (ICCID, Matching ID and SMDP Address) in the response, and an ICCIDs array. This endpoint is useful for tracking the lifecycle of an eSIM, including bundle assignments, updates, and other significant events. List all Bundles available to your Organisation for ordering. eSIM Go uses a ‘pre-paid’ system, so there’s no need to worry about end of the month bills. Takes a usageId and a quantity. 2. Server eSIM Provisioning and Bundle Application Endpoint This endpoint allows you to obtain a new eSIM with a pre-applied Bundle or apply a Bundle to an existing eSIM. 1 / eSIMs / Get CSV containing eSIMs from an Order or Bundle apply Path Parameters iccid required string The ICCID of the eSIM name required string Name of Bundle assignmentId required string ID of individual Bundle Assignment to SMS must be UTF-8 compliant; with a minimum length of 1, and maximum length of 160 characters. Usage: Either provide Bundle or Bundles. e. “eSIMGoTopup” - Topup applied by eSIM Go. 4 (17 September 2024) This release introduces two new communication channels for a smoother user experience. Bundle names are case sensitive and should be typed like the following “esim_1GB_7D_IM_U”. eSIM data download. It would be when the bundle has been delivered to LPA, but the eSIM has not yet been released. We’ll answer some common commercial and technical questions which new API users have. Alternatively, and for easy use in the browser with GET requests, the API Key can be passed as a query parameter. com/v2 Authentication Required (None Applied) RESPONSE List all Bundles available to your Organisation for ordering. Activate eSIM using an activation code When using an activation code to activate an eSIM profile, the LPA fetches an activation code from the carrier app and downloads the profile. The below assumes that you have already Located And Entered Your A The ICCID of the eSIM string matchingId Activation Code for eSIM string smdpAddress The SMDP+ Address of the eSIM string profileStatus The status of the eSIM profile string Allowed values: Released Downloaded Installed Unavailable pin The PIN of the eSIM string puk The PUK of the eSIM string firstInstalledDateTime First install date and time We would like to show you a description here but the site won’t allow us. Refunds an item in the inventory to the organisations balance. Key features: Input: One or multiple reference numbers can be submitted via query parameters. This endpoint is designed to verify eSIM-bundle compatibility. At expiry or exhaustion the MSISDN is no longer available (e. We will use four steps to provide our user with a new eSIM and data bundle: Add a bundle to your eSIM. 5 / eSIMs (Deprecated) / Get QR codes for eSIMs from an Order or Bundle apply reference (Deprecated) get /esims/assignments Server eSIM SMDP+ Details Retrieval Endpoint This API endpoint retrieves eSIM SMDP+ details based on provided Order or Apply References. Bundle Assignment States: Processing: The bundle assignment is currently processing. 4 403 Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json object message Status of api functions which do not return data string By the end of this guide you’ll be able to use the eSIM Go API to supply your end users with a QR code for their new eSIM and data bundle. The eSIM Go API provides access to notifications in response to events within the platform. e. 5. Installed - The eSIM is installed. Description: The eSIMGo API offers a callback functionality that provides real-time notifications about eSIM activity, including data consumption and balance. The eSIM Go API is your passport to infinite eSIM possibilities. Output: For each reference, the system returns: ICCID (Integrated Circuit Card Identifier) eSIM Go Support eSIM Troubleshooting with Your Customers eSIM Compatible Devices Coverage FAQ Platform & API Support Guides UK Domestic Support Guides Release Notes Why let others sell data roaming to your customers when it's this easy to do it yourself? Now's the time to add mobile to your premium extras… eSIM Go: Simple. If you DO NOT want the eSIM to be given back to eSIM Go, ensure the eSIM either: Is installed Has more than 1 bundle on it at the time of revoking Revokes latest assignment of a given Bundle type. 2 Authentication Required (None Applied) RESPONSE Server eSIM Provisioning and Bundle Application Endpoint This endpoint allows you to obtain a new eSIM with a pre-applied Bundle or apply a Bundle to an existing eSIM. When data is used on an eSIM, a usage event can be sent to a URL defined by you in the eSIM Portal. Download QR Codes User installs the eSIM on a Set up your eSIM Go accountTo buy and sell eSIMs using our API you must first: Create and verify an eSIM Go account - this should take just a few minutes Locate and input your API Key - used to authenticate your API calls Top up your account balance - by bank card or BACS transfer Create and verify an eSIM Go account Creating an eSIM Go account takes just a few minutes. These will be visible in the eSim Go Portal and allow you to easily download the eSIM data if new eSIMs were assigned: Alternatively, and for easy use in the browser with GET requests, the API Key can be passed as a query parameter. Sorting: Customize the order of results using the 'direction' and 'orderBy' parameters. 3 / eSIMs (Deprecated) / Get QR codes for eSIMs from an Order or Bundle apply reference (Deprecated) This endpoint provides the most recent location and associated network operator information for a specified eSIM. For more information on how to register a Webhook for receiving Notifications, please see the API Specification 403 Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json object message Status of api functions which do not return data string API v2. Unavailable - An eSIM in this status cannot be installed. Downloaded - This is unlikely to be seen very often. 4 / Overview eSIM Go API (2. 29 (19 June 2025) Platform When creating a new eSIM using the API you have the ability to do so by either generating your own QR code or using the eSIM Go API to download a QR code. It’s important to note that actual usage of the eSIM bundle is not necessary for these notifications. Bundles in eSIM Go are categorised into groups. Orders can be validated and processed using this endpoint. Queued: The bundle has been successfully assigned, has Note: The minimum top-up amount is $1000 and the maximum daily top-up is set at $5000. Bundle Assignment States: Bundle Applied: The bundle has been successfully assigned to the eSIM To ensure optimal service, eSIM Go utilizes multiple providers. Get CSV containing eSIMs from an Order or Bundle apply Get eSIM details and status Get history of an eSIM Refresh an eSIM Check that an eSIM is compatible with a bundle Send an SMS to eSIM List Bundles applied to an eSIM Apply a Bundle to an eSIM (Deprecated) Get the status of a Bundle applied to an eSIM Organisation Store API v2. by your end user), the eSIM will be returned to your account. Jul 5, 2023 · When ordering a bundle via the API, you have the option to test if the order will be successful before you commit to the purchase. 5 / Overview eSIM-Go API (2. Bundle Assignment States: Bundle Applied: The bundle has been successfully assigned to the eSIM Get details on all previous orders, including total cost and contents. 118, the international telecommunication Jun 18, 2025 · The section below describes activating an eSIM through a carrier app using an activation code. If specified ICCID (s) of eSIM (s) and the specified bundle (s) are not compatible, and ‘allowReassign’ set to true, the bundle (s) will be assigned to new ICCID (s). The eSIM Go Challenge is a simple tool for weighing up the optimum approach – API, Powered by Breeze or Breeze affiliate – based on factors like objective, available resources and scale. docs. com Set to true to include eSIM data (ICCID, Matching ID and SMDP Address) in the response, and an ICCIDs array. Navigate to Account Settings -> API Details to find Any commercial model can be aligned with eSIM Go's complete eSIM product ecosystem, enabling business partners to embed our capabilities into their product via API, co-brand a fully managed eSIM service or pursue an affiliate route. 5 A feature that enables the association of a unique identifier with an eSIM. You must include your API key in the header of all eSIM Go API requests using X-API-KEY. esim-go. reached the end of its allotted duration) or depleted (i. This is usually instant but can, on occasion After a minimum of 4 days: if during the returns process, the eSIM is now installed (e. Note: Requires the eSIM to have an MSISDN Format as defined in List Catalogue API call. QR codes and CSV data for eSIMs can now be downloaded in bulk formats. com 403 Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json object message Status of api functions which do not return data string 200 Success - Your eSIM has been updated Select media type application/json object message Status of api functions which do not return data string The eSIM Go management portal gives you a smooth, visual interface to your eSIM business. This will replace the 1% notification which can be removed. Auto-assign By specifying ICCID (s) of eSIM (s) belonging to your Organisation and setting 'assign' to true, a bundle can be automatically assigned to eSIM (s). First use can be used to notify your end-users their bundle has now started and the bundle duration has started. The only requirement is that the eSIM successfully registers on a network in a new country. 403 Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json object message Status of api functions which do not return data string “Topup” - Manual topup by you. If a bundle assignment has not been started and Refunds an item in the inventory to the organisations balance. If you wish to refund multiple usageId’s, multiple calls to this endpoint will need to be done. The callback should be set up separatelly. 2/catalogue/bundle/ {name}' \ X-API-Key:'$API_KEY' \ Content-Type:'application/json' This endpoint returns the history of a specific eSIM. This returns a list of the groups of Bundles available for your Organisation to order. Example: esim_10GB_30D_IM_U assignmentId required string ID of individual Bundle Assignment to revoke from an eSIM Server eSIMGo API - https://api. 0) To access the eSIMGo API, you need to authenticate your requests using an API key. eSIM Go API Collections. This glossary is designed to help you get your bearings fast. This Go eSIM module processes eUICC IDentifier (EID) used in the context of Remote Provisioning and Management of the eUICC (eSIM) in according to GSM Association Official Document SGP. Navigate to Account Settings -> API Details to find About the eSIM Go Travel API The most flexible and scalable way to provide your users with truly global data connectivity at compelling prices This page introduces you to the fundamentals of the eSIM Go API. to receive inbound voice calls or SMS notifications). The eSIM can still be installed and will register on a network while the bundle is processing. . Global brands in travel, MNO/MVNO, fintech and more trust eSIM Go to generate revenue and increase customer loyalty. Organisations can now set daily spend alerts to help monitor account usage, and Apple Quick Install URLs have been made readily accessible for both API and Portal users. Note: If email notifications are enabled in your eSIM Go Portal, these notifications will also be emailed to your Organisation owner. Note: From v2. V2 of the Callback system is still available by default, but will be disabled in the future. eSIM data will only be available on small (<= 5 eSIMs) orders. It provides a chronological list of actions performed on the eSIM, including bundle assignments and their states. Get details on all previous orders, including total cost and contents Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json Common eSIM-related terminology, explained The world of mobile communications is full of acronyms and seemingly arcane terminology. curl https://api. Updated endpoints: List eSIMs assigned to you Get all orders Get your Organisation’s inventory List catalogue Get history of an eSIM Bundle Apply operations will now create an order with bundleAssignment as the item type. Get details of a specific Bundle from your Organisation's catalogue. 0 onwards, this data will be included by default. IMPORTANT: If there are no bundles left on the eSIM AFTER the revoke, AND if the eSIM is not installed, the eSIM may undergo the eSIM Go returns process. For more detailed reference documentation, refer to the sidebar. 3 GET / eSIMGo API What eSIM profiles are available from eSIM Go? How are eSIM profiles delivered? How can I access the API? eSIM Go provides eSIM profiles - but what exactly are they? How are eSIM profiles priced? A location update notification is sent each time an eSIM registers in a new country that it hasn’t visited in the last 24 hours. 200 API details Select media type application/json Array<string> Previous Next 200 Success - Your eSIM has been updated Select media type application/json object message Status of api functions which do not return data string Quick Start Guides About the eSIM Go Travel API Set up your eSIM Go account Order your first eSIM eSIM glossary Reference API v2. Catalogue for getting information on available Bundles for purchasing as well as an Inventory endpoint for viewing your purchased Bundles. 1/esims/$ICCID This endpoint retrieves all eSIMs currently assigned to your organization. To begin, download the Postman Collection here or grab the OpenAPI Specification here. com/login. 02 (Remote Provisioning of Embedded UICC Technical Specification) and SGP. AuthenticationapikeyAuth Security scheme type: http Previous Next This endpoint allows you to retrieve a list of all bundles that have been applied to a specific eSIM. eSIM Go Developer Documentation Our API aggregates telecom services across the globe, providing easy access and complete control. Response data is paginated. If a bundle assignment has not been started and This endpoint returns a list of the groups of Bundles available for your Organisation to order. 118 (ITU-T Recommendation E. For more information on how to register a Webhook for receiving Notifications, please see the API Specification Auto-assign By specifying ICCID (s) of eSIM (s) belonging to your Organisation and setting 'assign' to true, a bundle can be automatically assigned to eSIM (s). This functionality allows for the integration of relevant operational data, such as customer order IDs. Note: In some cases, it may take up to 5 minutes for your eSIM bundles to be delivered See all 14 articles How does eSIM Go work? What eSIM profiles are available from eSIM Go? How are eSIM profiles delivered? How can I access the API? eSIM Go provides eSIM profiles - but what exactly are they? How are eSIM profiles priced? Tell me more about eSIMs Will my eSIM work in a Smart Watch? Can I send SMS or make phone calls using my eSIM? eSIM Go API Release notes2. Note: Bundle names are case sensitive e. 5 Quick Start Guides About the eSIM Go Travel API Set up your eSIM Go account Order your first eSIM eSIM glossary Reference API v2. It provides a comprehensive view of your eSIM inventory with flexible options for data retrieval and management. Unique identifiers can be assigned to your Organisation on request. Total will be deducted from your Organisation’s balance. Order your first eSIMBy the end of this guide you’ll be able to use the eSIM Go API to supply your end users with a QR code for their new eSIM and data bundle. For larger orders, see the GET request for this endpoint. This endpoint is useful for tracking the service history and current status of an eSIM. Key Features: Assign Bundles to new or existing eSIMs Option to request multiple eSIMs with the same Bundle Ability to assign different Bundles to separate new eSIMs Usage This endpoint revokes a specific bundle from an eSIM using assignment ID. API v2. The usage event will report the current bundle in use by an eSIM, and it's remaining data. Key Features: Assign Bundles to new or existing eSIMs Option to request multiple eSIMs with the same Bundle Ability to assign different Bundles to separate new eSIMs Usage Quick Start Guides About the eSIM Go Travel API Set up your eSIM Go account Order your first eSIM eSIM glossary Reference API v2. If an ICCID is provided as well as only a Bundle, the Bundle will be applied to the eSIM for that ICCID. 200 API details Select media type application/json Array<string> Previous Next API v2. Developers can exploit the power of our user-friendly API and eSIM enabling infrastructure to build new and compelling value propositions for their clients. The start of the returns process will REMOVE the eSIM from your account - you will no longer be able to access it. Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json Selling mobile connectivity plans to end users around the globe is simple, thanks to the eSIM Go API. Each Bundle can have multiple assignments. 5 This endpoint enables you to receive a new eSIM with the specified Bundle pre-applied. eSIM Go Management API Interface used to manage eSIM’s and mobile data bundles and is connected to the Shopify Application. “AutoTopup” - If enabled, your balance will be automatically topped up using the card details from your last successful manual topup. 3. 5 Provides details about an individual assignment of a Bundle applied to an eSIM. This endpoint is used to return the networks for a country/countries searched for either by an array of countires or ISO codes (ISOs). get /esims/assignments Server eSIM SMDP+ Details Retrieval Endpoint This API endpoint retrieves eSIM SMDP+ details based on provided Order or Apply References. View your purchased bundles, active eSIMs and historical usage figures. Quick Start Guides About the eSIM Go Travel API Set up your eSIM Go account Order your first eSIM eSIM glossary Reference API v2. 1 GET / eSIMGo API **IMPORTANT:** If there are no bundles left on the eSIM AFTER the revoke, AND if the eSIM is not installed, the eSIM may undergo the eSIM Go returns process. This endpoint allows you to retrieve a list of all bundles that have been applied to a specific eSIM. This defaults to eSIM and is the only supported value by default. This endpoint retrieves all eSIMs currently assigned to your organization. Offer your own digital mobile service with the ultimate eSIM experts. Please contact your Account Manager to discuss this. 02 (Remote P If multiple of the same bundle are applied to a single eSIM, the status bundle with the latest assignment will be returned. Output: For each reference, the system returns: ICCID (Integrated Circuit Card Identifier) REQUEST API Server https://api. The usageId's can be found by querying the /inventory endpoint The quantity of a refund cannot exceed the remaining quantity left for the specific usageId. Here’s a brief overview of the authentication process: Assuming that you have created account already: Log into your eSIMGo account at https://sso. Filtering Thanks to eSIM Go, offering eSIM data plans to your customers is easily within your grasp – it's just a question of which model is best for you. eSIM Go API Historic Release notesNew eSIM Apply endpoint added to enable users to receive a new eSIM with a Bundle pre-applied if no eSIM is provided in the request. End-User Means an individual user of the eSIM service provided by the partner All of your Organisation's currently purchased Bundles and their remaining usages. REQUEST API Server https://api. As a result, certain bundles may be incompatible with existing eSIMs if they originate from different providers, preventing eSIM top-ups. After a minimum of 4 days: if during the returns process, the eSIM is now installed (e. 403 Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json object message Status of api functions which do not return data string 403 Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json object message Status of api functions which do not return data string 403 Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user Select media type application/json object message Status of api functions which do not return data string This callback is used to notify when a Voice or SMS bundle has been added to an available eSIM and therefore the corresponding MSISDN has been enabled. com Server eSIMGo API - https://api. Get details on an order, including total cost and contents Once your balance goes below the threshold set by you in your eSIM Go Portal; the topup will be automatically triggered, and this notification sent. "esim_1GB_7D_IM_U". 5 API v2. kaqqp zkbu vppk sijysn aatu avuh knexao yotm uxsqp atgnqhpf