| Simvox Inc | International Data Plans

Getting Started

This guide outlines the integration process for users to order eSIMs using the Our Platform's API . Follow these steps for a successful implementation.

Before starting, You can create an account via the Sign Up

Step 1: Obtain a Bearer Token

To authenticate API requests, you must first obtain a Bearer token:

Navigate to your API Key Management Page

Click on "New Key"

Store this key securely and use it as the Bearer token in all API requests

Authentication Example

                                                    GET /v1/esims HTTP/1.1

                Host: api.simvox.com

                Authorization: Bearer YOUR_API_TOKEN

Step 2: Check available Data Plans.

To check available data plans, you can use the following endpoint:

POST /v1/packages?country=fr

{
    "status": {
        "code": 200,
        "msg": ""
    },
    "response": [
        {
            "id": "bd9f7f7852381da1ac0c4fa1aa009e8e",
            "policy": "bonbon-mobile-7days-1gb",
            "iso": "FR",
            "type": "sim",
            "price": "4.50",
            "amount": "1000",
            "day": "7",
            "is_unlimited": "0",
            "title": "France 1000 MiB - 7 Days - airal...",
            "data": "1000",
            "short_info": null,
            "voice": null,
            "text": null
        },
    ...
    ]
}

Step 3: Create new order for eSIM/Data plan.

After registration, you can create an order for new esim and order a data plan for existing eSIM:

POST /v1/order

{
    "status": {
        "code": 200,
        "msg": ""
    },
    "response": {
        "id": "oid_AKN9DRoxwe7w",
        "title": "Romania-1 GB 5 Days",
        "type": "esim",
        "price": "1.50",
        "package_id": "87fd8f2c14c0fa9976b376c0b94b7c42",
        "status": "completed",
        "date_created": "2025-02-12 18:32:30"
    }
}

Step 4: Check eSIM Status

Confirm the status of the eSIM:

GET /v1/esims/89450012345678901234

Response Example:

{
    "status": {
        "code": 200,
        "msg": ""
    },
    "response": {
        "id": "b930bb6a08ed2f7ee75064b50b6d2d5d",
        "iccid": "89450012345678901234",
        "activation_code": "LPA:1$consumer.e-sim.global$TN20241122181144361972EE4C",
        "manual_code": "TN202412181144361972EEVS4C",
        "smdp_address": "consumer.e-sim.global",
        "auto_apn": 1,
        "apn": "globaldata",
        "state": "DISABLED",
        "service_status": "ACTIVE",
        "network_status": "ENABLED",
        "tag": "",
        "date_created": "2025-02-12 18:32:30"
    }
}

API Documentation