Skip to content
eSIM Go Developer Docs

Set up your eSIM Go account

To buy and sell eSIMs using our API you must first:

Create and verify an eSIM Go account

Creating an eSIM Go account takes just a few minutes. You can register as an individual or a business.

When you’re ready, you can get started on the sign up page or by clicking ‘sign-up’ on the eSIM Go home page:

Screenshot 2024-05-28 at 12.20.43.png

Account verification

Once you’ve verified an email address we’ll ask you to provide us with some business details. Note that, in order to use the API, you must have a verified account.

Untitled

Notification preferences

Almost there. At this stage you can choose the type of notifications you’d like to receive about your account. Don’t worry, you can change this later in the Portal Dashboard.

Untitled

Confirmation

We’ll show you a confirmation screen so you can check all your information is correct.

Untitled

Find and input your API Key

In order to use the eSIM Go API you will need to access your API Token (also referred to as an API Key) and input this to the Authorization section of the Management Portal.

This key is used to authenticate you, each time you make an API call.

  1. First, Log into your account.

    Screenshot 2024-05-28 at 14.01.51.png

  2. Click on the “Settings” button at the top of the menu bar

Untitled

  1. Click API DETAILS to open a new panel containing your API Key

Untitled

  1. Click on the “Copy to clipboard” button. This will copy the API Key which can then be pasted at a later stage.

Untitled

  1. Go to https://docs.esim-go.com/api/#auth
  2. You can now paste or enter your API Token into the API Key (X-API-Key) box > click “SET”

Untitled

  1. If successful you will now see in the top left corner of the “Authentication” section the message “API key applied”

Untitled

Top up your account balance

eSIM Go uses a ‘pre-paid’ system, so there’s no need to worry about end of the month bills. Once you’ve topped up your account with a Card or by BACS you can use your balance to buy eSIMs.

You can set up notifications to alert you when your balance is low. And you can set up an automatic top up, via the Portal.

The first time you top up must be done via the portal, or with a bank transfer if this has been agreed with your account manager. Subsequent payments can be made using the API. Here’s how to do that.

  1. Login to your account on the eSIM Go Portal.
  2. Click “Top-Up Account”

Untitled

  1. Enter the amount you wish to top up (the example used here is $250).

Now, enter the billing address that matches the card you wish to use. It is important these match otherwise the payment will fail.

The minimum top-up amount is $1000 and the maximum daily top-up is set at $5000. If you wish to raise or lower this amount, please contact your account manager.

Untitled

  1. Scroll down to the card payment section > Enter the card details which match the billing address above > Click “Top Up Account”

Untitled

  1. After a successful top-up you will notice your Current Balance has changed:

Topup has changed

You should also receive a confirmation email.

Make your first API call

Now you are ready to use the eSIM Go API to buy eSIMs and data bundles, apply them to a devices and communicate with your users by SMS.

You should now have the following in place:

  • A verified eSIM Go account
  • An API Key
  • Account balance topped up

Other account management guides