zimconnections-services.xyz
Open in
urlscan Pro
172.67.216.151
Public Scan
URL:
https://zimconnections-services.xyz/
Submission: On May 28 via automatic, source certstream-suspicious — Scanned from DE
Submission: On May 28 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* Authentication
* postGenerate auth and refresh JWT tokens
* Product Catalogue
* getGet created plans
* getGet plans list
* getGet plan details
* getGet destination plans
* getSearch for destination
* getGet Destinations supported by ZIM
* Order Management
* postCreate new order
* postAssign package
* getGet order list
* getGet order details
* Subscription Management
* getGet subscription list
* getGet subscription details
* putActivate subscription
* putExpire subscription
* putRefund subscription
* eSIM Management
* getGet eSIM list
* getGet eSIM Subscriptions
* getGet eSIM details and status
* putModify eSIM network state
* getRefresh an eSIM
* patchSubscribe to eSIM notifications
* Partners
* postCreate a new partner order
API docs by Redocly
ZIM CONNECTIONS (1.0.0)
Download OpenAPI specification:Download
The ZIM Connections API suite is a collection of interfaces intended for
server-to-server interaction via the internet, facilitating the provision of a
range of connectivity options to users. The primary purpose of these APIs is to
provide our partners with a streamlined process to order, activate, and oversee
the worldwide connectivity provided by ZIM Connections.
AUTHENTICATION
Methods to authenticate with our services
GENERATE AUTH AND REFRESH JWT TOKENS
This endpoint allows clients to authenticate and obtain a JWT token.
The request body should include the necessary authentication details based on
the specified grant type.
For initial token retrieval, provide the following information:
* clientId: The ID for the client
* clientSecret: The secret provided to each client for authentication
* grantType: Set to client_credentials
For token refresh, include the following details:
* clientId: The ID for the client
* clientSecret: The secret provided to each client for authentication
* grantType: Set to refresh_token
* refreshToken: A valid refresh token
REQUEST BODY SCHEMA: APPLICATION/JSON
One of
AccessTokenRefreshAccessToken
clientId
required
string
The ID for the client
clientSecret
required
string
The secret provided to each client for authentication
grantType
required
string
Enum: "client_credentials" "refresh_token"
The type of grant for authentication
RESPONSES
200
Success
post/auth/tokens
https://api.zimconnections/v1/auth/tokens
REQUEST SAMPLES
* Payload
Content type
application/json
Example
AccessTokenRefreshAccessTokenAccessToken
Copy
{
* "clientId": "00000abcd-3450-4c1f-ae23-99999zzzyyyxxx",
* "clientSecret": "AAAAAAGNwKpgM4-xxxxxxxxkWMGSIf5ieV3saD_000000000",
* "grantType": "client_credentials"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "accessToken":
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6ImQ3N2JhNDE0LTZmOWMtNDgzNC1hNGIwLWJiNThjNTg1MGMyYiIsInR5cGUiOiIiLCJzY29wZSI6ImV4dGVybmFsIiwiaWF0IjoxNjc4NzMyMzQ3LCJleHAiOjE2Nzg3MzQxNDcsImF1ZCI6Ikhj3QSSIsImlzcyI6IlpJTSBDb25uZWN0aW9ucyJ9.cE8FnrblY-4u_7SNCYLjbwIoc3w2d-W_3M3Uds9VEe8",
* "refreshToken":
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6ImQ3N2JhNDE0LTZmOWMtNDgzNC1hNGIwLWJiNThjNTg1MGMyYiIsInR5cGUiOiIiLCJzY29wZSI6ImV4dGVybmFsIiwiaWF0IjoxNjc4NzMyMzQ3LCJleHAiOjE2ODAyMzIzNDcsImF1ZCI6IkFQSSIsImlzcyI6IlpJTSBDb25uZWN0aW9ucyJ9.e1E4L4I3EAFn1xf9_Ob3f6MjmP206oo9aMmg61WC-80",
* "expiresIn": 3600000
}
PRODUCT CATALOGUE
Contains APIs to get ZIM Plans
GET CREATED PLANS
Retrieves a list of the created packages
QUERY PARAMETERS
footprintCode
string
Example: footprintCode=GBR
ISO 3166-1 alpha-3 code for the country
page
integer <int32>
Example: page=1
The page number to retrieve
perPage
integer <int32>
Example: perPage=20
The number of records to return per page
RESPONSES
200
Success
404
Not Found
get/products/packages
https://api.zimconnections/v1/products/packages
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "data": [
* {
* "_id": "63063d81a7838dcebe12210f",
* "productCode": "TRU302GBGBR",
* "provider": "ESIMGO",
* "name": "Local United Kingdom - 1 Day - 1 GB",
* "data": 1,
* "duration": 7,
* "durationUnit": "DAYS",
* "dataUnit": "GB",
* "callsDuration": 7,
* "callsUnit": "DAYS",
* "scope": "REGIONAL",
* "type": "DATA",
* "smsCount": 300,
* "priceGbp": 10,
* "priceUsd": 8,
* "priceEur": 9,
* "providerLogo": "https://api.zimconnections.com/esimgo-logo.png",
* "destinationName": "United Kingdom",
* "footprintCode": "GBR",
* "flagCode": "GB"
}
]
}
GET PLANS LIST
Get data plans for a particular destination
QUERY PARAMETERS
page
integer <int32>
Example: page=1
The page number to retrieve
perPage
integer <int32>
Example: perPage=20
The number of records to return per page
RESPONSES
200
Success
404
Not Found
get/products/plans
https://api.zimconnections/v1/products/plans
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "data": [
* {
* "_id": "63f49bf14c882833ee7dfcb2",
* "productCode": "esimg_3GB_30D_CA_U",
* "provider": "ESIMGO",
* "providerLogo":
"https://zim-services.s3.amazonaws.com/providers/esimgo.svg",
* "name": "Local CAN - 30 days - 3 GB",
* "duration": 30,
* "data": 3,
* "destinationName": "Canada",
* "flagCode": "CA",
* "priceEur": 19.5,
* "priceGbp": 17,
* "priceUsd": 18.5,
* "dataUnit": "GB",
* "durationUnit": "DAYS",
* "footprintCode": "CAN",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "scope": "LOCAL"
},
* {
* "_id": "625d80ef4c7f223ba766fd9e",
* "productCode": "TRU305GBCZE",
* "provider": "TRUPHONE",
* "name": "Local Czech Republic - 30 Days - 5 GB",
* "duration": 30,
* "data": 5,
* "providerLogo":
"https://zim-services.s3.amazonaws.com/providers/truphone.svg",
* "destinationName": "Czech Republic",
* "flagCode": "CZ",
* "priceEur": 17,
* "priceGbp": 14,
* "priceUsd": 19,
* "dataUnit": "GB",
* "durationUnit": "DAYS",
* "footprintCode": "CZE",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "scope": "LOCAL"
}
],
* "page": 1,
* "totalPages": 10
}
GET PLAN DETAILS
Get the details of a particular plan using the productCode
PATH PARAMETERS
query
required
string
Example: TRU305GBCZE
The product code of the plan
RESPONSES
200
Success
404
Not Found
get/products/plans/{query}
https://api.zimconnections/v1/products/plans/{query}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "_id": "625d80ed4c7f223bad66fd9e",
* "productCode": "TRU305GBCZE",
* "provider": "TRUPHONE",
* "name": "Local Czech Republic - 30 Days - 5 GB",
* "duration": 30,
* "data": 5,
* "providerLogo":
"https://zim-services.s3.amazonaws.com/providers/truphone.svg",
* "destinationName": "Czech Republic",
* "flagCode": "CZ",
* "priceEur": 17,
* "priceGbp": 14,
* "priceUsd": 19,
* "dataUnit": "GB",
* "durationUnit": "DAYS",
* "footprintCode": "CZE",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "scope": "LOCAL"
}
GET DESTINATION PLANS
Get all the products of a particular destination
PATH PARAMETERS
footprintCode
required
string
Example: GBR
The code of the footprint where the product has connectivity
RESPONSES
200
Success
404
Not Found
get/products/destinations/{footprintCode}
https://api.zimconnections/v1/products/destinations/{footprintCode}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "Local": {
* "data": [
* {
* "_id": "6304f8ba796ab9cbd077c59a",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 1 Day - 1 GB",
* "destinationName": "United Kingdom",
* "duration": 1,
* "durationUnit": "DAYS",
* "data": 1,
* "dataUnit": "GB",
* "flagCode": "GB",
* "footprintCode": "GBR",
* "priceGbp": 5,
* "priceEur": 6,
* "priceUsd": 6,
* "providerLogo": "https://api.zimconnections.com/truphone-logo.png"
},
* {
* "_id": "6304f8ba796ab9cbdadfafda",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 30 Day - 5 GB",
* "destinationName": "United Kingdom",
* "duration": 30,
* "durationUnit": "DAYS",
* "data": 5,
* "dataUnit": "GB",
* "flagCode": "GB",
* "footprintCode": "GBR",
* "priceGbp": 10,
* "priceEur": 11,
* "priceUsd": 12,
* "providerLogo": "https://api.zimconnections.com/truphone-logo.png"
}
]
},
* "Regional": {
* "ORANGEEU": {
* "data": [
* {
* "_id": "6470dd9cd17bcd22776de07d",
* "productCode": "ORANGEEU8GB14D",
* "provider": "ORANGE",
* "name": "Regional ORANGEEU - 14 days - 8 GB",
* "duration": 14,
* "durationUnit": "Days",
* "data": 8,
* "dataUnit": "GB",
* "priceGbp": 20,
* "priceEur": 23,
* "priceUsd": 24.5,
* "footprintCode": "ORANGEEU",
* "flagCode": "ORANGEEU",
* "callsDuration": 30,
* "callsUnit": "MINUTES",
* "smsCount": 200,
* "type": "VOICE_AND_DATA",
* "scope": "REGIONAL",
* "destinationName": "OrangeEu"
},
* {
* "_id": "6470x69dd17ccd22756de080",
* "productCode": "ORANGEEU20GB14D",
* "provider": "ORANGE",
* "name": "Regional ORANGEEU - 14 days - 20 GB",
* "duration": 14,
* "durationUnit": "Days",
* "data": 20,
* "dataUnit": "GB",
* "priceGbp": 30,
* "priceEur": 35,
* "priceUsd": 37.5,
* "footprintCode": "ORANGEEU",
* "flagCode": "ORANGEEU",
* "callsDuration": 120,
* "callsUnit": "MINUTES",
* "smsCount": 1000,
* "type": "VOICE_AND_DATA",
* "scope": "REGIONAL",
* "destinationName": "ORANGEEU"
}
],
* "supportedCountries": [
* {
* "_id": "647dd34a92534dd67192b263",
* "name": "Andorra",
* "footprintCode": "AND",
* "flagCode": "AD",
* "region": "ORANGEEU"
},
* {
* "_id": "647dd34ab0534dd67192b264",
* "name": "Aaland Islands",
* "footprintCode": "ALA",
* "flagCode": "AX",
* "region": "ORANGEEU"
}
]
}
},
* "Globals": {
* "Global": {
* "data": [
* {
* "_id": "63f49b14c882833ee70fsb2",
* "productCode": "esimg_3GB_30D_CA_U",
* "provider": "ESIMGO",
* "providerLogo":
"https://zim-services.s3.amazonaws.com/providers/esimgo.svg",
* "name": "Local CAN - 30 days - 3 GB",
* "duration": 30,
* "data": 3,
* "destinationName": "Canada",
* "flagCode": "CA",
* "priceEur": 19.5,
* "priceGbp": 17,
* "priceUsd": 18.5,
* "dataUnit": "GB",
* "durationUnit": "DAYS",
* "footprintCode": "CAN",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "scope": "LOCAL"
},
* {
* "_id": "6304f8ba796ab9ccdadfafda",
* "provider": "TRUPHONE",
* "providerLogo":
"https://zim-services.s3.amazonaws.com/providers/esimgo.svg",
* "name": "Local United Kingdom - 30 Day - 5 GB",
* "duration": 30,
* "data": 5,
* "destinationName": "United Kingdom",
* "priceGbp": 10,
* "priceEur": 11,
* "priceUsd": 12,
* "dataUnit": "GB",
* "durationUnit": "DAYS",
* "footprintCode": "GBR",
* "flagCode": "GB",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "scope": "LOCAL"
}
],
* "supportedCountries": [
* {
* "_id": "647dd34a90534dd67192b231",
* "name": "Belgium",
* "flagCode": "BE",
* "region": "EUROPEGO"
},
* {
* "_id": "647dd34a90534dd67192b232",
* "name": "Bulgaria",
* "flagCode": "BG",
* "region": "EUROPEGO"
}
]
},
* "GlobalPlus": {
* "data": [
* {
* "_id": "63f49b14c882833ee70fsb2",
* "productCode": "esimg_3GB_30D_CA_U",
* "provider": "ESIMGO",
* "providerLogo":
"https://zim-services.s3.amazonaws.com/providers/esimgo.svg",
* "name": "Local CAN - 30 days - 3 GB",
* "duration": 30,
* "data": 3,
* "destinationName": "Canada",
* "flagCode": "CA",
* "priceEur": 19.5,
* "priceGbp": 17,
* "priceUsd": 18.5,
* "dataUnit": "GB",
* "durationUnit": "DAYS",
* "footprintCode": "CAN",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "scope": "LOCAL"
},
* {
* "_id": "6304f8ba796ab9ccdadfafda",
* "provider": "TRUPHONE",
* "providerLogo":
"https://zim-services.s3.amazonaws.com/providers/esimgo.svg",
* "name": "Local United Kingdom - 30 Day - 5 GB",
* "duration": 30,
* "data": 5,
* "destinationName": "United Kingdom",
* "priceGbp": 10,
* "priceEur": 11,
* "priceUsd": 12,
* "dataUnit": "GB",
* "durationUnit": "DAYS",
* "footprintCode": "GBR",
* "flagCode": "GB",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "scope": "LOCAL"
}
]
}
},
* "bestSeller": [
* {
* "_id": "6304f8ba796ab9cbdadfafda",
* "productCode": "productCode",
* "provider": "ESIMGO",
* "providerLogo": "https://link",
* "name": "Global Plus - 7 days - 1 GB",
* "duration": 7,
* "data": 1,
* "destinationName": "GlobalPlus",
* "flagCode": "GLOBALPLUS",
* "priceEur": 4.5,
* "priceGbp": 4,
* "priceUsd": 4.5,
* "dataUnit": "GB",
* "footprintCode": "GLOBALPLUS",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "unlimitedRegionsFootprint": [ ],
* "scope": "GLOBAL",
* "durationUnit": "DAYS",
* "features": "Data only, Top-Up",
* "supportedCountries": [
* {
* "_id": "647dd34a90534dd67192b191",
* "name": "Armenia",
* "flagCode": "AM",
* "region": "GLOBALPLUS",
* "plansType": "GLOBALPLUS",
* "footprintCode": "ARM"
},
* {
* "_id": "647dd34a90534dd67192b192",
* "name": "Bulgaria",
* "flagCode": "BG",
* "region": "GLOBALPLUS",
* "plansType": "GLOBALPLUS",
* "footprintCode": "BGR"
}
]
},
* {
* "_id": "6304f8ba796ab9cbdadfafda",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 30 Day - 5 GB",
* "destinationName": "United Kingdom",
* "duration": 30,
* "durationUnit": "DAYS",
* "data": 5,
* "dataUnit": "GB",
* "flagCode": "GB",
* "footprintCode": "GBR",
* "priceGbp": 10,
* "priceEur": 11,
* "priceUsd": 12,
* "scope": "LOCAL",
* "providerLogo": "https://api.zimconnections.com/truphone-logo.png"
}
]
}
SEARCH FOR DESTINATION
Get data plans for a particular destination
PATH PARAMETERS
query
required
string
Example: United Kingdom
The property of the destination. can be a name, flagCode, or footprintCode.
RESPONSES
200
Success
404
Not Found
get/products/destinations/search/{query}
https://api.zimconnections/v1/products/destinations/search/{query}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "name": "United States of America",
* "displayName": "USA",
* "isAvailable": true,
* "count": 20,
* "footprintCode": "GBR",
* "flagCode": "GB"
}
GET DESTINATIONS SUPPORTED BY ZIM
Get all the countries ZIM offers inside a particular continent
QUERY PARAMETERS
continentName
required
string
Example: continentName=Europe
The name of the continent
page
integer <int32>
Example: page=1
The page number to retrieve
perPage
integer <int32>
Example: perPage=20
The number of records to return per page
RESPONSES
200
Success
404
Not Found
get/products/destinations
https://api.zimconnections/v1/products/destinations
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "name": "Europe",
* "destinations": [
* {
* "name": "UK",
* "displayName": "United Kingdom",
* "isAvailable": true,
* "footprintCode": "GBR",
* "flagCode": "GB",
* "count": 27
},
* {
* "name": "Poland",
* "displayName": "Poland",
* "isAvailable": true,
* "footprintCode": "POL",
* "flagCode": "PL",
* "count": 25
}
],
* "page": 1,
* "lastPage": 10
}
ORDER MANAGEMENT
Contains all order management endpoints
CREATE NEW ORDER
Creates a new ZIM order
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
productCode
required
string
The product code for the plan
orderCountry
required
string
The country of the plan
subscriber
required
object (Subscriber)
eSIM plan consumer
deviceInfo
required
object (DeviceInfo)
Information about the subscriber's device
operationType
required
string
Enum: "ACTIVATION" "TOPUP"
Generates a new eSIM with a subscription when it's an activation, adds a new
subscription on topups
activationDate
string
subscription activation date(Can be from 1 to 30 days - leave empty for
immediate usage)
iccid
string
ICCID of the eSIM(Only required whenever the operationType is TOPUP)
RESPONSES
201
Success
404
Not Found
post/orders/create
https://api.zimconnections/v1/orders/create
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "productCode": "esimg_3GB_30D_GB_U",
* "orderCountry": "CA",
* "subscriber": {
* "firstName": "john",
* "lastName": "doe",
* "email": "johndoe@example.com",
* "countryOfResidence": "CA"
},
* "deviceInfo": {
* "id": "xxxxxxxxxx",
* "OS": "ios",
* "model": "iPhone XS"
},
* "operationType": "ACTIVATION",
* "activationDate": "2021-02-05T17:20:32Z",
* "iccid": 8944245764472111000
}
RESPONSE SAMPLES
* 201
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "order": {
* "_id": "622112eb84840ed446f538905",
* "provider": "ORANGE",
* "userEmail": "johndoe@test.com",
* "status": "COMPLETED",
* "createdAt": "2022-09-02T06:11:59.479162Z",
* "output": {
* "iccid": "8944178600000251201",
* "subscriptionId": "63119eaf4840ed456f536201"
},
* "links": {
* "qrcode": "https://linktoqrcode.com"
}
}
}
ASSIGN PACKAGE
Assigns a new package to an eSIM from the stock. Please note that this API is
specifically designed to work with 'FLOLIVE'. Compatibility with other providers
is not available.
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
productCode
required
string
The product code for the plan
iccid
required
string
ICCID of the eSIM
priority
number
Subscription order of priority; the higher the numeric value, the higher
priority the subscription receives.
RESPONSES
201
Success
404
Not Found
post/orders/assign
https://api.zimconnections/v1/orders/assign
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "productCode": "FLO1100MBUSA",
* "iccid": "8944245764472111062",
* "priority": 50
}
RESPONSE SAMPLES
* 201
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "order": {
* "_id": "622112eb84840ed446f538905",
* "provider": "ORANGE",
* "userEmail": "johndoe@test.com",
* "status": "COMPLETED",
* "createdAt": "2022-09-02T06:11:59.479162Z",
* "output": {
* "iccid": "8944178600000251201",
* "subscriptionId": "63119eaf4840ed456f536201"
},
* "links": {
* "qrcode": "https://linktoqrcode.com"
}
}
}
GET ORDER LIST
Get a list of all orders created by ZIM
QUERY PARAMETERS
after
string <ISO 8601 Date-time>
Example: after=2022-02-21T00:00:00Z
Filter by order created after this date
before
string <ISO 8601 Date-time>
Example: before=2022-02-21T00:00:00Z
Filter by order created before this date
page
integer >= 1
Default: 1
Example: page=1
The page to fetch
pageSize
integer [ 1 .. 40 ]
Default: 1
Example: pageSize=1
The total number of pages that can be fetched
status
string
Enum: "ACCEPTED" "FULFILLING" "COMPLETED" "FAILED"
Filter by order status
userEmail
string
Filter by user email
iccid
string
Filter by iccid
RESPONSES
200
Success
403
Bad request
get/orders
https://api.zimconnections/v1/orders
RESPONSE SAMPLES
* 200
* 403
Content type
application/json
Copy
Expand all Collapse all
{
* "data": [
* {
* "_id": "63063d81a7838dcebe12210e",
* "provider": "TRUPHONE",
* "status": "ACCEPTED",
* "type": "TOPUP",
* "userEmail": "johndoe@example.com",
* "createdAt": "2021-08-23T15:02:25.605Z",
* "output": {
* "subscriptionId": "63063d81a7838dcebe12920d"
},
* "links": {
* "qrcode": "https://someqrcodelink.com"
}
},
* {
* "_id": "53063d81a7838dcebe12211e",
* "provider": "ESIMGO",
* "status": "PENDING",
* "type": "ACTIVATION",
* "userEmail": "johndoe@example.com",
* "createdAt": "2021-08-23T15:02:25.605Z",
* "output": {
* "subscriptionId": "63063d81a7838dcebe12922s",
* "iccid": "8944245764472111162"
},
* "links": {
* "qrcode": "https://someqrcodelink.com"
}
}
],
* "page": 1,
* "pageSize": 10
}
GET ORDER DETAILS
Retrieves the details of a particular order
PATH PARAMETERS
orderId
required
string
The ID of the order needs to be fetched
RESPONSES
200
Success
404
Order Not Found
get/orders/{orderId}
https://api.zimconnections/v1/orders/{orderId}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "_id": "63063d81a7838dcebe12210e",
* "provider": "TRUPHONE",
* "status": "ACCEPTED",
* "userEmail": "johndoe@example.com",
* "output": {
* "iccid": "22948109819024",
* "subscriptionId": "63063d51a7838dcebe12920d"
},
* "links": {
* "qrcode": "https://examplelink.com"
}
}
SUBSCRIPTION MANAGEMENT
Fetch & view eSIM subscriptions for multiple providers
GET SUBSCRIPTION LIST
Fetch list of subscriptions
QUERY PARAMETERS
after
string <ISO 8601 Date-time>
Example: after=2022-02-21T00:00:00Z
Filter by subscriptions created after this date
before
string <ISO 8601 Date-time>
Example: before=2022-02-21T00:00:00Z
Filter by subscriptions created before this date
page
integer >= 1
Default: 1
Example: page=1
The page to fetch
pageSize
integer [ 1 .. 40 ]
Default: 1
Example: pageSize=1
The total number of pages that can be fetched
status
string
Enum: "ACTIVE" "EXPIRED" "PENDING" "DEPLETED"
Filter by subscription status
userEmail
string
Example: userEmail=john@doe.com
Filter by user email
simId
string
Example: simId=89056579945643
Filter by iccid
productCode
string
Example: productCode=T893411GBGBR
Filter by the product code
provider
string
Enum: "ESIMGO" "WTR" "ORANGE" "TRUPHONE"
Filter by provider
subscriptionId
string
Example: subscriptionId=63067e0323f3b78bf9665056
Filter by subscription ID
RESPONSES
200
Success
404
Not Found
get/subscriptions
https://api.zimconnections/v1/subscriptions
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "subscriptions": [
* {
* "_id": "63067e0323f3b78bf9665056",
* "userEmail": "john@doe.com",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 1 Day - 1 GB",
* "productCode": "T893411GBGBR",
* "simId": "8976478600002774876",
* "activationDate": "2023-06-05T17:01:32Z",
* "expiryDate": "2023-06-06T17:01:32Z",
* "status": "EXPIRED",
* "initialBalance": 1073741824,
* "currentBalance": 0,
* "spentBalance": 1073741824,
* "balanceUnits": "Bytes",
* "refunded": false,
* "soldProductPrice": 5,
* "soldProductCurrency": "GBP",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "createdAt": "2022-09-24T10:06:53.682Z",
* "updatedAt": "2022-09-24T10:49:01.811Z"
},
* {
* "_id": "63067e0003f3b78bf9665056",
* "userEmail": "john@doe.com",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 1 Day - 1 GB",
* "productCode": "T890011GBGBR",
* "simId": "8976478609902774876",
* "activationDate": "2023-06-05T17:01:32Z",
* "expiryDate": "2023-06-06T17:01:32Z",
* "status": "EXPIRED",
* "initialBalance": 1073741824,
* "currentBalance": 0,
* "spentBalance": 1073741824,
* "balanceUnits": "Bytes",
* "refunded": false,
* "soldProductPrice": 5,
* "soldProductCurrency": "GBP",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "createdAt": "2022-09-24T10:06:53.682Z",
* "updatedAt": "2022-09-24T10:49:01.811Z"
}
],
* "total": 2,
* "page": 1,
* "pageSize": 40
}
GET SUBSCRIPTION DETAILS
Fetch the details of a subscription
PATH PARAMETERS
subscriptionId
required
string
The ID of the subscription
RESPONSES
200
Success
404
Not Found
get/subscriptions/{subscriptionId}
https://api.zimconnections/v1/subscriptions/{subscriptionId}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "_id": "63067e0323f3b78bf9665056",
* "userEmail": "john@doe.com",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 1 Day - 1 GB",
* "productCode": "T893411GBGBR",
* "simId": "8976478600002774876",
* "activationDate": "2023-06-05T17:01:32Z",
* "expiryDate": "2023-06-06T17:01:32Z",
* "status": "EXPIRED",
* "initialBalance": 1073741824,
* "currentBalance": 0,
* "spentBalance": 1073741824,
* "balanceUnits": "Bytes",
* "refunded": false,
* "soldProductPrice": 5,
* "soldProductCurrency": "GBP",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "createdAt": "2022-09-24T10:06:53.682Z",
* "updatedAt": "2022-09-24T10:49:01.811Z"
}
ACTIVATE SUBSCRIPTION
Activates a subscription by setting the activation date to now. Please note that
this API is specifically designed to work with 'TRUPHONE'. Compatibility with
other providers is not available.
PATH PARAMETERS
subscriptionId
required
string
The ID of the subscription
RESPONSES
200
Success
404
Not Found
put/subscriptions/{subscriptionId}/activate
https://api.zimconnections/v1/subscriptions/{subscriptionId}/activate
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "message": "Subscription activated successfully!"
}
EXPIRE SUBSCRIPTION
Expires a subscription by setting the expiration date to now
PATH PARAMETERS
subscriptionId
required
string
The ID of the subscription
RESPONSES
200
Success
404
Not Found
409
Conflict
put/subscriptions/{subscriptionId}/expire
https://api.zimconnections/v1/subscriptions/{subscriptionId}/expire
RESPONSE SAMPLES
* 200
* 404
* 409
Content type
application/json
Copy
{
* "message": "Subscription expired successfully!"
}
REFUND SUBSCRIPTION
Refunds a subscription - the subscription should NOT be consumed for this to
work. Please note that this API is specifically designed to work with 'FLOLIVE'
& 'eSIMGO'. Compatibility with other providers is not available.
PATH PARAMETERS
subscriptionId
required
string
The ID of the subscription
RESPONSES
200
Success
404
Not Found
409
Conflict
500
Something else
put/subscriptions/{subscriptionId}/refund
https://api.zimconnections/v1/subscriptions/{subscriptionId}/refund
RESPONSE SAMPLES
* 200
* 404
* 409
* 500
Content type
application/json
Copy
{
* "message": "Subscription refunded successfully!"
}
ESIM MANAGEMENT
Contains all eSIM management APIs
GET ESIM LIST
This endpoint is coming soon, it returns a list of paginated eSIMs with the
relevant info
QUERY PARAMETERS
page
integer >= 1
Default: 1
Example: page=1
The page to fetch
pageSize
integer [ 1 .. 40 ]
Default: 1
Example: pageSize=1
The total number of pages that can be fetched
status
string
Enum: "RELEASED" "DOWNLOADED" "INSTALLED"
Filter by eSIM status
userEmail
string
Example: userEmail=john@doe.com
Filter by user email
provider
string
Enum: "ESIMGO" "WTR" "ORANGE" "TRUPHONE" "FLOLIVE"
Filter by the eSIM provider
networkState
string
Enum: "ACTIVE" "SUSPEND" "TERMINATED"
Filter by the eSIM network state - works only with 'FLOLIVE'
lastKnownLocation
string
Filter by the last known location for the eSIM - works only with 'FLOLIVE'
RESPONSES
200
Success
400
Successful response
get/esims
https://api.zimconnections/v1/esims
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
{
* "data": [
* {
* "_id": "63063d81a7838dcebe12210f",
* "iccid": "8944245764472111162",
* "provider": "ESIMGO",
* "status": "INSTALLED",
* "networkState": "ACTIVE",
* "imsi": "123123123",
* "imei": "123123123",
* "msisdn": "312312312",
* "matchingId": "5C-1MG7UF-1K5012T",
* "links": {
* "qrcode": "https://someurlforqrcodelink.com"
},
* "userEmail": "johndoe@example.com",
* "type": "DATA",
* "createdAt": "2021-02-05T17:20:32Z",
* "updatedAt": "2021-02-05T17:20:32Z",
* "lastAssignedIpAddress": "10.84.8.208",
* "lastKnownLocation": {
* "longitude": 230,
* "latitude": 70.5
},
* "lastConnectedNetwork": {
* "mcc": "257",
* "mnc": "02",
* "lac": "16",
* "cid": "2224"
},
* "isInDataSession": true,
* "lastDataSession": null,
* "lastRatType": "LTE_M"
}
],
* "page": 1,
* "pageSize": 40,
* "total": 1
}
GET ESIM SUBSCRIPTIONS
This endpoint is used to fetch the subscriptions of a particular eSIM
PATH PARAMETERS
iccid
required
string
The ICCID of the eSIM
QUERY PARAMETERS
page
integer >= 1
Default: 1
Example: page=1
The page to fetch
pageSize
integer [ 1 .. 40 ]
Default: 1
Example: pageSize=1
The total number of pages that can be fetched
RESPONSES
200
Success
404
Not Found
get/esims/{iccid}/subscriptions
https://api.zimconnections/v1/esims/{iccid}/subscriptions
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "data": [
* {
* "_id": "63067e0323f3b78bf9665056",
* "userEmail": "john@doe.com",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 1 Day - 1 GB",
* "productCode": "T893411GBGBR",
* "simId": "8976478600002774876",
* "activationDate": "2023-06-05T17:01:32Z",
* "expiryDate": "2023-06-06T17:01:32Z",
* "status": "EXPIRED",
* "initialBalance": 1073741824,
* "currentBalance": 0,
* "spentBalance": 1073741824,
* "balanceUnits": "Bytes",
* "refunded": false,
* "soldProductPrice": 5,
* "soldProductCurrency": "GBP",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "createdAt": "2022-09-24T10:06:53.682Z",
* "updatedAt": "2022-09-24T10:49:01.811Z"
},
* {
* "_id": "63067e0003f3b78bf9665056",
* "userEmail": "john@doe.com",
* "provider": "TRUPHONE",
* "name": "Local United Kingdom - 1 Day - 1 GB",
* "productCode": "T890011GBGBR",
* "simId": "8976478609902774876",
* "activationDate": "2023-06-05T17:01:32Z",
* "expiryDate": "2023-06-06T17:01:32Z",
* "status": "EXPIRED",
* "initialBalance": 1073741824,
* "currentBalance": 0,
* "spentBalance": 1073741824,
* "balanceUnits": "Bytes",
* "refunded": false,
* "soldProductPrice": 5,
* "soldProductCurrency": "GBP",
* "type": "DATA",
* "callsDuration": 0,
* "callsUnit": "MINUTES",
* "smsCount": 0,
* "createdAt": "2022-09-24T10:06:53.682Z",
* "updatedAt": "2022-09-24T10:49:01.811Z"
}
],
* "total": 2,
* "page": 1,
* "pageSize": 40
}
GET ESIM DETAILS AND STATUS
Retreives the details of an eSIM
PATH PARAMETERS
iccid
required
string
The ICCID of the eSIM needs to be fetched
RESPONSES
200
Success
404
Not Found
get/esims/{iccid}
https://api.zimconnections/v1/esims/{iccid}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "_id": "63063d81a7838dcebe12210f",
* "iccid": "8944245764472111162",
* "provider": "ESIMGO",
* "status": "INSTALLED",
* "networkState": "ACTIVE",
* "imsi": "123123123",
* "imei": "123123123",
* "msisdn": "312312312",
* "matchingId": "5C-1MG7UF-1K5012T",
* "links": {
* "qrcode": "https://someurlforqrcodelink.com"
},
* "userEmail": "johndoe@example.com",
* "type": "DATA",
* "createdAt": "2021-02-05T17:20:32Z",
* "updatedAt": "2021-02-05T17:20:32Z",
* "lastAssignedIpAddress": "10.84.8.208",
* "lastKnownLocation": {
* "longitude": 230,
* "latitude": 70.5
},
* "lastConnectedNetwork": {
* "mcc": "257",
* "mnc": "02",
* "lac": "16",
* "cid": "2224"
},
* "isInDataSession": true,
* "lastDataSession": null,
* "lastRatType": "LTE_M"
}
MODIFY ESIM NETWORK STATE
This endpoint will allow clients to change the LCP status of a single
subscriber. Please note that this API is specifically designed to work with
'FLOLIVE'. Compatibility with other providers is not available.
PATH PARAMETERS
iccid
required
string
ICCID of the eSIM to update the status
REQUEST BODY SCHEMA: APPLICATION/JSON
networkState
required
string
Enum: "ACTIVE" "SUSPEND" "TERMINATED"
The desired network lifecycle state
RESPONSES
200
Successful response
400
Successful response
put/esims/{iccid}
https://api.zimconnections/v1/esims/{iccid}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "networkState": "ACTIVE"
}
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
{
* "message": "string"
}
REFRESH AN ESIM
This endpoint is used to refresh an eSIM. Please note that this API is
specifically designed to work with 'FLOLIVE' & 'ESIMGO'. Compatibility with
other providers is not available.
PATH PARAMETERS
iccid
required
string
The ICCID of the eSIM that needs to be refreshed
QUERY PARAMETERS
eventType
integer
Default: 0
Enum: 0 5 15 25
Determines on which domain type to perform the action. Valid values are 0 for
All, 5 for circuit switching, 15 for packet switching, and 25 for LTE. If not
provided, the default is 0 - Applicable only with 'FLOLIVE'.
RESPONSES
200
Success
404
Not Found
get/esims/{iccid}/refresh
https://api.zimconnections/v1/esims/{iccid}/refresh
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "message": "eSIM refreshed successfully!"
}
SUBSCRIBE TO ESIM NOTIFICATIONS
Register eSIM profile notifications via webhook for a given threshold
QUERY PARAMETERS
webhookUrl
string
Example: webhookUrl=https://www.webhook.com/webhook
The URL that ZIM Connections will call when the threshold is reached
isEnabled
boolean
Configure the notifications on or off
threshold
boolean
Threshold to receive the notification on
RESPONSES
201
Success
patch/client/notifications/update
https://api.zimconnections/v1/client/notifications/update
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
{
* "message": "Notifications settings updated successfully"
}
PARTNERS
Contains all APIs related to partners
CREATE A NEW PARTNER ORDER
API endpoint to create a new order based on the provided details. This will send
an email to the client with the order details.
AUTHORIZATIONS:
oAuth2
HEADER PARAMETERS
api-key
required
string
API key for authentication
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
subscriber
required
object
productCode
required
string
Product code associated with the order.
RESPONSES
200
Order successfully created.
400
Bad request. Required fields might be missing or contain invalid data.
post/partners/orders
https://api.zimconnections/v1/partners/orders
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "subscriber": {
* "firstName": "string",
* "lastName": "string",
* "email": "user@example.com"
},
* "productCode": "string"
}
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
{
* "message": "string",
* "data": {
* "_id": "63063d81a7838dcebe12210f",
* "provider": "TRUPHONE",
* "type": "ACTIVATION",
* "userEmail": "johndoe@example.com",
* "status": "RELEASED",
* "output": {
* "iccid": 894447860000030000,
* "subscriptionId": "63119eaf4840ed456f5389gg"
},
* "links": {
* "qrcode": "https://someurlforqrcodelink.com"
},
* "createdAt": "2021-08-23T15:02:25.605Z"
}
}