API v2 Documentation

Registers and activates a SIM or eSIM number. Performs ICC validation (SIM only), document/age validation, and the activation call. Checks wallet balance before activation, but does not charge the wallet nor trigger recharge or bundle in this step.

After a successful activation, follow the corresponding flow depending on the SIM type:

Body (JSON):

{
  "productId": "PO_Mali_M",
  "brand": "Lebara",
  "name": "Juan",
  "surname": "Pérez",
  "surname2": "García",
  "documentNumber": "12345678A",
  "dateOfBirth": "1990-05-15",
  "nationalityId": "ES",
  "iccId": "89340712341234567890",
  "simType": "sim",
  "identificationType": "personal-identity-code",
  "email": "user@example.com",
  "language": "eng"
}

Body fields:

Success response:

{
  "data": {
    "msisdnId": "612345678",
    "qrCode": "LPA:1$sm-..."
  },
  "message": "Activation completed successfully.",
  "meta": { "requestId": "..." }
}

Success data fields:

Possible errors:

Step 2 — Charge the user's wallet and trigger the external recharge for the number. Call this after a successful POST /activation.

For physical SIM: charges only the difference between the product price and the SIM facial value. If the facial value already covers the full product price, the wallet is not charged and the operation succeeds immediately. In that case, you may also skip this endpoint entirely and call /bundlecash directly instead of invoking /recharge + /bundle separately.

Body (JSON):

{
  "mobileNumber": "612345678"
}

Body fields:

Success response:

{
  "data": {
    "msisdnId": "612345678",
    "valueCharged": 5.00
  },
  "message": "Recharge completed successfully. 5 EUR have been deducted from the wallet.",
  "meta": { "requestId": "..." }
}

Possible errors:

Step 3a (physical SIM) — Purchases the bundle to apply the product tariff to the number.

Body (JSON):

{
  "mobileNumber": "612345678"
}

Body fields:

Success response:

{
  "data": {
    "msisdnId": "612345678",
    "provisionId": "PROV-123456"
  },
  "message": "Bundle purchased successfully.",
  "meta": { "requestId": "..." }
}

Possible errors:

Combines the recharge (/recharge) and bundle purchase (/bundle) into a single call. Can be used in two scenarios:

• eSIM activations — shortcut that replaces both /recharge and /bundle.
• Physical SIM activations where the product price ≤ facial value — since no recharge is needed, you can skip /recharge and /bundle and call this endpoint directly to apply the bundle in one step.

Body (JSON):

{
  "mobileNumber": "612345678"
}

Body fields:

Success response:

{
  "data": {
    "msisdnId": "612345678",
    "basketReference": "REF-123",
    "basketId": "BKT-456",
    "localReference": "LOC-789"
  },
  "message": "BundleCash applied successfully.",
  "meta": { "requestId": "..." }
}

Possible errors:

Step 4 — Deactivates roaming control for the activated number. Call this after bundle/bundlecash succeeds. For Lyca Globe products, the operation is skipped automatically and success is returned.

Body (JSON):

{
  "mobileNumber": "612345678"
}

Body fields:

Success response:

{
  "data": { "msisdnId": "612345678" },
  "message": "Roaming deactivated successfully.",
  "meta": { "requestId": "..." }
}

Possible errors:

Get the facial value (activation cost) for a given ICC ID. Used to determine how much balance the SIM already has before activation.

Path params:

Query params:

Response:

{
  "data": {
    "value": 10.00
  },
  "meta": { "requestId": "..." }
}

Get MSMVL activation history for the authenticated user.

Query params:

Response:

{
  "data": {
    "activationHistory": [
      {
        "id": 1,
        "msisdnId": "612345678",
        "qrCode": "LPA:1$sm-...",
        "createdAt": "2026-03-11T10:00:00.000Z"
      }
    ],
    "total": 42
  },
  "message": "Activation history retrieved successfully.",
  "meta": { "requestId": "..." }
}

Validate if an ICC ID (SIM card identifier) is available for activation.

Query params:

Validate minimum age requirement (must be at least 18 years old).

Query params:

Validate an identification document number.

Query params:

Get the list of available products for a brand.

Query params:

Get the operator info for a phone number (current operator, origin, portability status).

Get balance for a phone number.

Query params:

Get comprehensive MSISDN info (ICC ID, IMSI, PINs, PUKs, status, product, balance, bonuses, QR code).

Query params:

Get active services for a phone number.

Query params:

Get eSIM activation QR info (URL and request date) for a phone number.

Query params:

Get inventory info (ID and brand) for a mobile number.

Path params:

Response:

{
  "data": {
    "id": "INV_12345",
    "brand": "Lebara"
  },
  "meta": { "requestId": "..." }
}