FAQs for API Partners

  • What is Keepgo API?

    The Keepgo API is a RESTful interface that allows you to integrate eSIM management, data bundle purchasing, and real-time data usage monitoring into your existing network operations and business processes.

  • Where can I find the API documentation?

    You can download the detailed API documentation from this link.

  • What are the integration options available?

    Keepgo offers two integration options: Full Integration: Suitable for partners with their own platform or mobile app, providing a complete cycle of services, including eSIM search, purchasing, and management. This level of integration requires using at least the main API commands. Light Integrat...

  • What are the main API commands available?

    The main API commands include: GET /bundles - Retrieve a list of available data bundles. GET /countries - Get a list of supported countries. POST /line/{ICCID}/refill - Refill a specific eSIM line. GET /account_balance - Check the account balance. GET /network_providers - Retrieve a list of netw...

  • Can I view a list of additional API functions?

    Yes, additional API functions are available and can be beneficial during eSIM integration. Some of these include: GET /transactions - Retrieve a list of transactions. PUT /line/{ICCID}/turn_off_auto_refill - Deactivate auto-refill for a specific line. GET /line/{ICCID}/available_refills - View a...

  • How can I manage eSIM lines?

    You can manage eSIM lines using various commands: POST /line/{ICCID}/turn_on_auto_refill - Activate auto-refill for an eSIM line. GET /line/{ICCID}/available_refills - View available refill options for an eSIM line. GET /line/{ICCID}/get_details - Retrieve detailed information about an eSIM line...

  • How do I ensure device compatibility with eSIM technology?

    Before purchasing an eSIM line, users should confirm their device supports eSIM technology. The GET /esim_enabled_devices command provides an up-to-date list of compatible devices that partners can display on their platform.

  • How do users purchase eSIM bundles?

    Users can purchase eSIM bundles by selecting their desired country and browsing available bundles through the GET /bundles command. After selecting a bundle and completing the payment, a new line is created using the POST /line/create command, and the user receives an LPA code for eSIM installati...

  • What is the Auto-refill feature?

    The Auto\-refill feature ensures users never run out of data by automatically refilling their line when the data balance falls below 100MB\. This feature can be activated using the POST /line/\{ICCID\}/turn\_on\_auto\_refill command\.

  • Can I revoke the existing API keys and get a new one?

    Partners can regenerate/revoke the API token from their Admin Account by themselves. Navigate to API credentials > press Reveal Token and then > press Refresh Token.

  • Can I change plans on the lines?

    Yes! Keepgo currently offers a manual process that allows the plan on the SIM to be switched between existing plans based on an exchange-rate system. On our roadmap, this will be available in the Admin account so partners can manage it independently. This is a unique feature which—together with t...

  • Can I manage pSIM lines via API?

    Yes. All standard API commands for managing eSIMs also apply to pSIMs: View available bundles Retrieve line details Perform refills and auto-refills

  • Can I order physical SIM cards (pSIM)?

    Yes. API/Provisioning partners can now order 3-in-1 physical SIMs directly through their personal account manager.

  • Do I need to create pSIM lines using the API?

    No. pSIM lines are pre-created and automatically added to your account upon order fulfillment. You’ll find them under the Physical Products tab.

  • How do I assign a plan to a pSIM?

    Once the pSIM is sold to a user, you can assign a data plan in two ways: Via API: POST /line/{iccid}/add_plan Manually from the Admin panel using the Add Plan button

  • How to add Unlimited plan via API

    Unlimited plans require a different integration flow than regular bundles. This article explains what has changed in the API and how to correctly add Unlimited plans to your product. Why Unlimited plans work differently Unlimited plans require additional processing time during line creation. Be...

  • Which bundles are available for pSIM?

    All newly released bundles — World and World Lite, Europe, Middle East, Africa, LATAM, APAC, and North America SIM cards.