{ "item": [ { "id": "cbf77ed9-5d20-458e-8ebf-3e21cc77d091", "name": "Callback", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a00f18a3-46c1-49cb-ba77-c044abe783e0", "name": "eSIM Usage Callback", "request": { "name": "eSIM Usage Callback", "description": { "content": "**Note:** V3 of the Callback system is now available and provides additional data as well as HMAC signature validation.\n**This must be enabled in the eSIM Portal.**\nV2 of the Callback system is still available by default, but will be disabled in the future.\n\n To enable it on the eSIM Portal go to Account Settings -> API Details -> Callback Version.\n\n\n**Description:**\nThe eSIMGo API offers a callback functionality that provides real-time notifications about eSIM activity, including data consumption and balance. This feature allows for tracking usage, automating responses, and customizing notifications, enhancing customer account management.\nKey benefits include real-time updates, usage tracking, automated responses, and customizable notifications.\nWhen data is used on an eSIM, a usage event can be sent to a URL defined by you in the eSIM Portal. The usage event will report the current bundle in use by an eSIM, and its remaining data.\n\n To set up the URL in the eSIM Portal go to Account Settings -> API Details -> Callback URL.\n\n\n\nExample of validating HMAC body in NodeJS:\n\n```javascript\nimport crypto from \"crypto\";\n\nconst signature = crypto\n .createHmac(\"sha256\", key) // key is your API Key\n .update(body) // body is the raw (string) request body\n .digest(\"base64\");\n\nconst matches = signature === signatureHeader;\n```\n\nValidation uses your API Key as the HMAC key.\nThe body of the request is the raw (string) request body, and should not be parsed as JSON before validation.\n\n**Note:** Bundle names are case sensitive e.g. \"esim_1GB_7D_IM_U\".\n\n**Request Body Notes:**\n- The \"try\" button for this endpoint is **NOT** functional\n- The schema defines an example message that is sent to the configured callback URL.\n- For more information on callback notification types, Please see the [Notifications Page](/api/notifications#overview).\n", "type": "text/plain" }, "url": { "path": [ "your-usage-callback-url", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"alertType\": \"\",\n \"bundle\": {\n \"id\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a8a23b90-3003-49c4-9f51-eef3cac4e2b9", "name": "Successful response", "originalRequest": { "url": { "path": [ "your-usage-callback-url", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"alertType\": \"\",\n \"bundle\": {\n \"id\": \"\",\n \"reference\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "53dc2211-ec3f-4aa1-b6dc-1c3d4a72dc85", "name": "Orders", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ec27a4dd-1e1d-4eec-8b7f-4b9836525a22", "name": "List orders", "request": { "name": "List orders", "description": { "content": "Get details on all previous orders, including total cost and contents. Response data is paginated.\n", "type": "text/plain" }, "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includeIccids", "value": "", "description": "Set to true to include eSIM data (ICCID, Matching ID and SMDP Address) in the response, and an ICCIDs array.\n" }, { "disabled": false, "key": "page", "value": "", "description": "Page number to return.\n" }, { "disabled": false, "key": "limit", "value": "", "description": "Number of results to return per page.\n" }, { "disabled": false, "key": "createdAt", "value": "", "description": "Specifies the date range for filtering orders. This parameter has a 'lte:' prefix to specify the end date. For example, to query orders from March 1, 2024, to March 31, 2024, use the following format: `createdAt=gte:2024-03-01T00:00:00.000Z&createdAt=lte:2024-03-31T23:59:59.999Z`.\n" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "90b28e55-6ce5-480c-8541-d00e7fb83e0f", "name": "OK", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeIccids", "value": "" }, { "key": "page", "value": "" }, { "key": "limit", "value": "" }, { "key": "createdAt", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order\": [\n {\n \"esims\": [\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n },\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n }\n ],\n \"type\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"quantity\": \"\",\n \"subTotal\": \"\",\n \"pricePerUnit\": \"\",\n \"AllowReassign\": \"\"\n },\n {\n \"esims\": [\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n },\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n }\n ],\n \"type\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"quantity\": \"\",\n \"subTotal\": \"\",\n \"pricePerUnit\": \"\",\n \"AllowReassign\": \"\"\n }\n ],\n \"total\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"statusMessage\": \"\",\n \"orderReference\": \"\",\n \"createdDate\": \"\",\n \"assigned\": \"\",\n \"sourceIP\": \"\",\n \"runningBalance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e7b1f2d-3b03-47b9-b341-ad5a2074f3e5", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeIccids", "value": "" }, { "key": "page", "value": "" }, { "key": "limit", "value": "" }, { "key": "createdAt", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43cff5d4-3af8-440f-90ba-a84f7ac793bd", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeIccids", "value": "" }, { "key": "page", "value": "" }, { "key": "limit", "value": "" }, { "key": "createdAt", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3c254e2-9fa7-43f8-881c-8ebb2cb449e6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeIccids", "value": "" }, { "key": "page", "value": "" }, { "key": "limit", "value": "" }, { "key": "createdAt", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a025755-6bf5-4dcf-b185-930abdc0e2b2", "name": "Server Error", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeIccids", "value": "" }, { "key": "page", "value": "" }, { "key": "limit", "value": "" }, { "key": "createdAt", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45e41344-efbb-481b-a7a0-fdf050c788d4", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeIccids", "value": "" }, { "key": "page", "value": "" }, { "key": "limit", "value": "" }, { "key": "createdAt", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "906bd558-ffad-4afc-8526-54f0a53b3159", "name": "Create orders", "request": { "name": "Create orders", "description": { "content": "Orders can be validated and processed using this endpoint.\n\nTotal will be deducted from your Organisation's balance.\n\n## Auto-assign\n\nBy specifying ICCID(s) of eSIM(s) belonging to your Organisation and setting 'assign' to true, a bundle can be automatically assigned to eSIM(s).\n\nIf specified ICCID(s) of eSIM(s) and the specified bundle(s) are not\ncompatible, and ‘allowReassign’ set to true, the bundle(s) will be\nassigned to new ICCID(s).\n\nBundle assignments to an eSIM are usually instant but please allow forup to 10 minutes for the bundle to fully process. While the bundle is processing the eSIM can be successfully installed and the eSIM will register onto a network if within coverage.\n\nThe Bundle Status can be checked through [Get the Status of a bundle assigned to an eSIM](/api/v2_4/operations/esimsiccidbundlesname/get/)\n\n## Branding Profile ID:\n\nThis is optional and only used if you have multiple branding profiles. It allows you to generate an eSIM with a specific branding profile instead of the default (first) one. To find the Profile ID:\n\n1. Log in to your portal account\n\n2. Navigate to \"eSIM Branding\"\n\n3. Locate the desired branding profile\n\n4. Note the Profile ID associated with it\n\nIf not specified, the default (first) branding profile will be used.\n\n## Usage:\n\n- eSIM ICCIDs can only be specified if assign is set to true\n- If assign is set to true, but no ICCIDs are provided, bundles are\n assigned to new eSIMs\n- If ICCIDs are provided, quantity is required to match the number of\n ICCIDs for each bundle\n- If quantity is specified and assign is set to false, the quantity of\n that bundle is purchased into inventory\n- If new bundles and specified eSIM ICCIDs are not compatible and\n‘allowReassign’ set to true, bundles will be assigned to new ICCIDs\n- To use profile id ensure that assign is set to true\n", "type": "text/plain" }, "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"assign\": \"\",\n \"order\": [\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n },\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n }\n ],\n \"profileID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fc623c28-7e3b-455f-a5f1-9d6a59fb5877", "name": "OK", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"assign\": \"\",\n \"order\": [\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n },\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n }\n ],\n \"profileID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order\": [\n {\n \"type\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"subTotal\": \"\",\n \"pricePerUnit\": \"\",\n \"AllowReassign\": \"\"\n },\n {\n \"type\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"subTotal\": \"\",\n \"pricePerUnit\": \"\",\n \"AllowReassign\": \"\"\n }\n ],\n \"total\": \"\",\n \"valid\": \"\",\n \"currency\": \"\",\n \"createdDate\": \"\",\n \"assigned\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9844d14-7e6c-41f9-aab6-d2a15a4ab4cb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"assign\": \"\",\n \"order\": [\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n },\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n }\n ],\n \"profileID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf327833-86eb-43db-ac31-bf00cd362f89", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"assign\": \"\",\n \"order\": [\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n },\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n }\n ],\n \"profileID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2312fa01-31c9-4c75-9f8c-831f6dd39c91", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"assign\": \"\",\n \"order\": [\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n },\n {\n \"type\": \"\",\n \"quantity\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"allowReassign\": \"\"\n }\n ],\n \"profileID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df509c54-d4dc-4eb5-b00c-c8caf3c420ad", "name": "Get order detail", "request": { "name": "Get order detail", "description": { "content": "Get details on an order, including total cost and contents\n", "type": "text/plain" }, "url": { "path": [ "orders", ":orderReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "orderReference", "description": "(Required) (Required) Reference for your order" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9999815a-024f-41af-9aa6-ff6d6af38ffe", "name": "OK", "originalRequest": { "url": { "path": [ "orders", ":orderReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "orderReference", "description": "(Required) (Required) Reference for your order" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order\": [\n {\n \"esims\": [\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n },\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n }\n ],\n \"type\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"quantity\": \"\",\n \"subTotal\": \"\",\n \"pricePerUnit\": \"\",\n \"AllowReassign\": \"\"\n },\n {\n \"esims\": [\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n },\n {\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\"\n }\n ],\n \"type\": \"\",\n \"item\": \"\",\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"quantity\": \"\",\n \"subTotal\": \"\",\n \"pricePerUnit\": \"\",\n \"AllowReassign\": \"\"\n }\n ],\n \"total\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"statusMessage\": \"\",\n \"orderReference\": \"\",\n \"createdDate\": \"\",\n \"assigned\": \"\",\n \"sourceIP\": \"\",\n \"runningBalance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93cabd35-d831-4c95-adf3-51461d155922", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "orders", ":orderReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "orderReference", "description": "(Required) (Required) Reference for your order" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89dc70fa-0234-40f0-b7d5-592e57944646", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "orders", ":orderReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "orderReference", "description": "(Required) (Required) Reference for your order" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab4a6836-a2be-460a-99e3-b9a4509852c5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "orders", ":orderReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "orderReference", "description": "(Required) (Required) Reference for your order" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccbffa0f-6d1e-4d38-9dfb-9e1b9fd06eb9", "name": "Server Error", "originalRequest": { "url": { "path": [ "orders", ":orderReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "orderReference", "description": "(Required) (Required) Reference for your order" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b41da35-1c1a-4a99-9ecf-a131518a2763", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "orders", ":orderReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "orderReference", "description": "(Required) (Required) Reference for your order" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2f7b108f-06d0-433f-be15-1f76d9f41ed0", "name": "eSIMs", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "df8c4a4e-1597-475f-8023-e0ea02d88cdd", "name": "List eSIMs", "request": { "name": "List eSIMs", "description": { "content": "This endpoint retrieves all eSIMs currently assigned to your organization. It provides a comprehensive view of your eSIM inventory with flexible options for data retrieval and management.\n\n**Key Features:**\n 1. Pagination: Efficiently manage large datasets by specifying the page number and items per page.\n 2. Sorting: Customize the order of results using the 'direction' and 'orderBy' parameters.\n 3. Filtering: Refine your search with multiple filter options for precise data retrieval.\n", "type": "text/plain" }, "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page of ESIMs to return" }, { "disabled": false, "key": "perPage", "value": "", "description": "Number of ESIMs to return per page" }, { "disabled": false, "key": "direction", "value": "", "description": "Direction of ordering" }, { "disabled": false, "key": "orderBy", "value": "", "description": "Name of column to order by" }, { "disabled": false, "key": "filterBy", "value": "", "description": "Name of column to filter by. eSIMs can be filtered by ICCID, Customer Reference, Last Action (Bundle Refund, Bundle Applied, Bundle Revoked, eSIM Updated, eSIM Refreshed, eSIM Utilisation Alert), Last Action Date and SIM Assignment Date." }, { "disabled": false, "key": "filter", "value": "", "description": "Value to filter by" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "078032e6-9ca3-45c7-941e-4ca687c0faa7", "name": "A list of your eSIMs", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "filterBy", "value": "" }, { "key": "filter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"esims\": [\n {\n \"iccid\": \"\",\n \"customerRef\": \"\",\n \"msisdn\": \"\",\n \"lastAction\": \"\",\n \"actionDate\": \"\",\n \"physical\": \"\",\n \"assignedDate\": \"\",\n \"state\": \"\"\n },\n {\n \"iccid\": \"\",\n \"customerRef\": \"\",\n \"msisdn\": \"\",\n \"lastAction\": \"\",\n \"actionDate\": \"\",\n \"physical\": \"\",\n \"assignedDate\": \"\",\n \"state\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f84868b3-5c15-4e52-8062-a616c002c8e8", "name": "Bad Request - returned when incorrect data given", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "filterBy", "value": "" }, { "key": "filter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c38c05f-f833-4e71-822d-c4f86124a402", "name": "Unauthorised - returned when the api token is invalid", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "filterBy", "value": "" }, { "key": "filter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd6d5790-9075-418d-9597-0a340c17c389", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "filterBy", "value": "" }, { "key": "filter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f61f18b4-cd42-4424-ac4c-3e04d3d73c48", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "filterBy", "value": "" }, { "key": "filter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "819385fc-95e4-407d-a5d9-98c0ce4a45c0", "name": "Update eSIM Details", "request": { "name": "Update eSIM Details", "description": { "content": "A feature that enables the association of a unique identifier with an eSIM. This functionality allows for the integration of relevant operational data, such as customer order IDs.\n", "type": "text/plain" }, "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "iccid", "value": "", "description": "(Required) ICCID of eSIM" }, { "disabled": false, "key": "customerRef", "value": "", "description": "(Required) New Customer Reference" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"customerRef\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e9832dca-7c40-4c58-b0f7-672284bb37d8", "name": "OK", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "iccid", "value": "" }, { "key": "customerRef", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"customerRef\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "998340a8-b6f8-4d2c-833a-cd985020aae7", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "iccid", "value": "" }, { "key": "customerRef", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"customerRef\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1066f610-2def-4f7d-8c9d-f60a3815b9fa", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "iccid", "value": "" }, { "key": "customerRef", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"customerRef\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "749d8e51-fb34-4b25-811d-69874a0f5bb5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "iccid", "value": "" }, { "key": "customerRef", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"customerRef\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cde93b0-115e-44bb-8d9b-0b45dc9aebe0", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "iccid", "value": "" }, { "key": "customerRef", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"customerRef\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cd002ae-dd5a-49ee-a620-114a160e0e46", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "iccid", "value": "" }, { "key": "customerRef", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"iccid\": \"\",\n \"customerRef\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c86c3767-2a7c-4444-be42-7184e3d01a97", "name": "Apply Bundle to an eSIM", "request": { "name": "Apply Bundle to an eSIM", "description": { "content": "# eSIM Provisioning and Bundle Application Endpoint\n\nThis endpoint allows you to obtain a new eSIM with a pre-applied Bundle or apply a Bundle to an existing eSIM.\n\n## Key Features:\n1. Assign Bundles to new or existing eSIMs\n2. Option to request multiple eSIMs with the same Bundle\n3. Ability to assign different Bundles to separate new eSIMs\n\n## Usage Guidelines:\n- Provide either 'Bundle' or 'Bundles' parameter\n- ICCID is optional for existing eSIMs\n- 'Repeat' parameter for multiple new eSIMs (incompatible with ICCID)\n- Bundle names are case-sensitive (e.g., \"esim_1GB_7D_IM_U\")\n\n## Important Notes:\n- Requires pre-purchased Bundles in your account inventory\n- Bundle activation usually instant, but allow up to 10 minutes for full processing\n- eSIM can be installed and registered on a network during processing\n- The Bundle Status can be checked through [Get the Status of a bundle assigned to an eSIM](/api/v2_4/operations/esimsiccidbundlesname/get/)\n- Deactivated eSIMs cannot have bundles applied and will return a 400 Bad Request error\n\nThe endpoint always returns the ICCID in the response.\n", "type": "text/plain" }, "url": { "path": [ "esims", "apply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"iccid\": \"\",\n \"repeat\": \"\",\n \"allowReassign\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "388cc175-f812-4b9c-be11-22a32e93dd9e", "name": "Success message", "originalRequest": { "url": { "path": [ "esims", "apply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"iccid\": \"\",\n \"repeat\": \"\",\n \"allowReassign\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"esims\": [\n {\n \"iccid\": \"\",\n \"status\": \"\",\n \"bundle\": \"\"\n },\n {\n \"iccid\": \"\",\n \"status\": \"\",\n \"bundle\": \"\"\n }\n ],\n \"applyReference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b42b4a4-44e1-4769-9fc6-a1904091e58f", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", "apply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"iccid\": \"\",\n \"repeat\": \"\",\n \"allowReassign\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bc45c3a-ecf9-456d-bea4-fcf46a3b73f6", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", "apply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"iccid\": \"\",\n \"repeat\": \"\",\n \"allowReassign\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "792ac1e9-43e1-4888-9b44-390d2ad9355f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", "apply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"iccid\": \"\",\n \"repeat\": \"\",\n \"allowReassign\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2153773e-f067-4722-beb8-d264ecbcc91f", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", "apply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"iccid\": \"\",\n \"repeat\": \"\",\n \"allowReassign\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d8b665-bab7-43c4-b1fd-5f8ebe7466b2", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", "apply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"iccid\": \"\",\n \"repeat\": \"\",\n \"allowReassign\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56ffe0c9-4578-47ff-914f-f142e4ecabc0", "name": "Get eSIM Install Details", "request": { "name": "Get eSIM Install Details", "description": { "content": "# eSIM SMDP+ Details Retrieval Endpoint\n\nThis API endpoint retrieves eSIM SMDP+ details based on provided Order or Apply References.\n\n## Key features:\n\n1. Input: One or multiple reference numbers can be submitted via query parameters.\n2. Output: For each reference, the system returns:\n - ICCID (Integrated Circuit Card Identifier)\n - SMDP+ (Subscription Manager Data Preparation) address\n - Matching ID\n3. Output format options:\n - Default: text/csv\n - Alternative formats: application/json, application/zip\n - Format selection is controlled via the 'Accept' header in the request\n4. Special functionality: When requesting 'application/zip', the response is a ZIP file containing QR code images in PNG format.\n\nDeactivated eSIMs will return a 410 Gone error.\n", "type": "text/plain" }, "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "reference", "value": "", "description": "(Required) Order Reference or Apply Reference" }, { "disabled": false, "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "168f3e1d-a19b-410d-84b5-8b9e2eeb7c8e", "name": "OK", "originalRequest": { "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reference", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"iccid\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\",\n \"profileStatus\": \"\",\n \"pin\": \"\",\n \"puk\": \"\",\n \"firstInstalledDateTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58e15f65-c494-43d5-8881-a134f9c3ba6e", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reference", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "133b5d2f-917d-42f0-b9e1-56c32a79441b", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reference", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f817862-e7b1-4a1a-a99c-990351b54308", "name": "Gone - returned when the eSIM has been deactivated", "originalRequest": { "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reference", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79f6ecd5-1ab4-43e2-a05f-eef8b637ca99", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reference", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb5b41f-854f-4056-921e-61a4676ecc5a", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reference", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed011e5d-e905-4afa-9d94-eecd8435136c", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reference", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d20b3dd-167a-4909-9355-b27e482193f2", "name": "Get eSIM details", "request": { "name": "Get eSIM details", "description": { "content": "This endpoint allows you to retrieve detailed information about a\nspecific eSIM using its ICCID (Integrated Circuit Card Identifier).\n\neSIM profile statuses:\n\n**Released** - The eSIM is not installed. If there is a firstInstalledDateTime then the eSIM has been installed previously and then uninstalled again.\n\n**Installed** - The eSIM is installed.\n\n**Downloaded** - This is unlikely to be seen very often. It would be when the bundle has been delivered to LPA, but the eSIM has not yet been released.\n\n**Unavailable** - An eSIM in this status cannot be installed. We recommend reissuing a new eSIM instead, especially if the eSIM is not already installed.\n\n**Deactivated** - The eSIM has been deactivated and can no longer be used.\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "698474df-3456-4cee-8265-c5a3b274e607", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"iccid\": \"\",\n \"msisdn\": \"\",\n \"pin\": \"\",\n \"puk\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\",\n \"profileStatus\": \"\",\n \"firstInstalledDateTime\": \"\",\n \"customerRef\": \"\",\n \"appleInstallUrl\": \"\",\n \"androidInstallUrl\": \"\",\n \"brandingId\": \"\",\n \"profileName\": \"\",\n \"state\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ca3c42-5c3b-467f-b872-281616c60f84", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8257a726-e6cb-4cf5-a314-dcbad60639c9", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1059f074-2809-4b5c-80ac-6e02ab26196e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1026622c-25e7-4b11-a96a-aa1f43c3d4d4", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec84e7c9-adf7-429c-bbb5-9f30b4da0d18", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b273d36-5cba-43c3-8df3-8251b5c31c9a", "name": "Delete eSIM", "request": { "name": "Delete eSIM", "description": { "content": "This endpoint allows you to delete a specific eSIM.\n\n**IMPORTANT:** Deleting an eSIM will revoke all bundles without a refund, and \nwill remove the eSIM from your account - you will no longer be able to access it.\nThis process is irreversible.\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a664a536-1ad3-4e41-884f-fbe1f57bd1d5", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db095a75-eaba-453d-8e71-8c3d5368fff2", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a6cc0d-5332-48b2-8dc9-fe3a584148f1", "name": "Unauthorised - returned when the api token is invalid or the user does not have permission to query the given ICCID", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4310705c-77b3-47d9-b699-3ccc68afe953", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b368c30-9de8-4b3e-bfcd-3ea4c9ecd72a", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4aadcde5-eccf-46cc-aabf-f7722a77a3b5", "name": "Get eSIM history", "request": { "name": "Get eSIM history", "description": { "content": "This endpoint returns the history of a specific eSIM. It provides a chronological list of actions performed on the eSIM, including bundle assignments and their states.\n\nThis endpoint is useful for tracking the lifecycle of an eSIM, including bundle assignments, updates, and other significant events.\n\nBundle Assignment States:\n- **Bundle Applied:**\n The bundle has been successfully assigned to the eSIM\n- **eSIM Updated:**\n The eSIM Reference has been updated.\n- **eSIM Refreshed:**\n eSIM was forcibly disconnected from the network, prompting it to reestablish its connection.\n- **eSIM Utilisation Alert:**\n A notification has been triggered due to the eSIM reaching a certain usage threshold.\n- **eSIM Returned:**\n The eSIM is no longer assigned to your organisation after undergoing the returns process.\n- **Bundle Refunded To Balance:**\n The unused bundle has been credited back to the organization's account balance.\n- **Bundle Refunded to Inventory:**\n The unused bundle has been returned to the organization's inventory for potential reassignment.\n- **Bundle Revoked:**\n The bundle has been removed from the eSIM.\n- **eSIM First Attachment:**\n The eSIM has successfully connected to a mobile network for the first time since activation.\n- **eSIM First Use:**\n The eSIM has been used for the first time to consume data service.\n- **Bundle Expired:**\n The bundle's validity period has ended and/or has been used in full. It is no longer active or usable.\n- **Bundle Lapsed:**\n The bundle has become inactive after no activity for 12 months.\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f44b00da-66f5-4c1b-8a4f-88c89cc0c76d", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"\",\n \"bundleName\": \"\",\n \"date\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22a7d0ac-889d-4e99-a0dc-16d1a8e7516e", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38aee89c-6788-45d4-ae33-4586262bf998", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f20060fb-a7a1-477f-82c2-d7c3afbfef13", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f47d462b-2d5c-45cf-987f-672fd4cd9590", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a3c2a8-da59-400a-993a-8df079c0526b", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c85868e-b79b-4b01-853e-77b11acff092", "name": "Refresh eSIM", "request": { "name": "Refresh eSIM", "description": { "content": "This request generates a cancel location request to the network, prompting it to reestablish its connection.\nPlease note that this process disconnects the customer from the network and should be used solely for troubleshooting. It is not intended for canceling locations in bulk.\n\nDeactivated eSIMs cannot be refreshed and will return a 400 Bad Request error.", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "62740cf3-097f-47bf-9c29-57d46c090686", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9095f48e-f718-43aa-98de-31c2e904ff77", "name": "Bad Request - returned when request format is not accepted or when the eSIM is deactivated", "originalRequest": { "url": { "path": [ "esims", ":iccid", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22560c5c-496e-44b2-acdb-d37658bd7bd9", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9899074-1aa3-48e9-bc18-ecea8f8ef36c", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae4c0f81-d3db-4f5c-8ae8-e7bbfbb39e8e", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d209da06-3224-4ff3-8034-07c6fbeff837", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7668b4e1-bf88-498a-8c8b-13b5e589ae4e", "name": "Check eSIM and Bundle Compatibility", "request": { "name": "Check eSIM and Bundle Compatibility", "description": { "content": "To ensure optimal service, eSIM Go utilizes multiple providers. As a result, certain bundles may be incompatible with existing eSIMs if they originate from different providers, preventing eSIM top-ups.\n\n This endpoint is designed to verify eSIM-bundle compatibility.", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "compatible", ":bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "bundle", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "dab246d6-d422-4240-89cc-d6a892c6a951", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "compatible", ":bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "bundle", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"compatible\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e18c2ee-95f2-48f4-baef-54e8e8ab48a6", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "compatible", ":bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "bundle", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fb396fb-aa15-4d60-87ef-c1df74d26a83", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "compatible", ":bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "bundle", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "351dcf73-6f40-4b2e-bdce-b7a4833e6586", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "compatible", ":bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "bundle", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9c71e14-8ef6-46ce-9c6d-6612b7ddb2cb", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "compatible", ":bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "bundle", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "334756b6-f2bb-4c54-a993-dd24b4ea81f5", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "compatible", ":bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "bundle", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "185fe291-1ee4-4153-9127-68a8f8d7a3e3", "name": "Send SMS to eSIM", "request": { "name": "Send SMS to eSIM", "description": { "content": "The Send SMS endpoint is a powerful feature of the eSIMGo API that allows you to send text messages directly to eSIMs. This endpoint becomes particularly useful when combined with eSIMGo's real-time notification system, which provides updates about eSIM activity through callback functionality. The callback should be set up separatelly.\n\n Key points:\n\n1. Message requirements:\n - UTF-8 compliant\n - Length: 1-160 characters\n\n2. Default recipient: 'eSIM' (currently the only supported value)\n - Custom identifiers available upon request\n\nNote: For custom identifiers, please contact your Account Manager.\n\nDeactivated eSIMs cannot receive SMS messages.\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"message\": \"message\",\n \"from\": \"eSIM\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "efd9599d-f3df-4243-81b0-26d352e450e0", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"message\",\n \"from\": \"eSIM\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f05e36fc-d52e-4f4f-8b72-01fd5c26d04f", "name": "Bad Request - returned when request format is not accepted or when the eSIM is deactivated", "originalRequest": { "url": { "path": [ "esims", ":iccid", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"message\",\n \"from\": \"eSIM\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac63d12-d9c9-432a-9b55-df65366709f5", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"message\",\n \"from\": \"eSIM\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c96ea222-4458-4a43-a81c-33b34674f936", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"message\",\n \"from\": \"eSIM\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "482ab8f4-f8aa-4844-89dc-795d07bb45e3", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"message\",\n \"from\": \"eSIM\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b051345-8eb9-472e-b63f-956fdecb0957", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"message\",\n \"from\": \"eSIM\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e47f837-b62e-4e95-8006-cd581127142f", "name": "List Bundles applied to eSIM", "request": { "name": "List Bundles applied to eSIM", "description": { "content": "This endpoint allows you to retrieve a list of all bundles that have been applied to a specific eSIM. This endpoint is useful for tracking the service history and current status of an eSIM.\n\nRemaining data can be found here.\n\nEach Bundle can have multiple assignments.\n\nBundle Assignment States:\n- **Processing:**\n The bundle assignment is currently processing.\n This is usually instant but can, on occasion, take up to 10 minutes to complete.\n The eSIM can still be installed and will register on a network while the bundle is processing.\n- **Queued:**\n The bundle has been successfully assigned, has not been used yet, and is queued for use.\n- **Active:**\n The bundle has successfully been used.\n It has data remaining and is within the bundle duration.\n- **Depleted:**\n The bundle has no data remaining but is still within the bundle duration.\n- **Expired:**\n The bundle has expired, and the bundle duration has been exceeded.\n- **Revoked:**\n The bundle has been revoked, and is no longer on the esim.\n- **Lapsed:**\n The bundle has expired without being used and is no longer on the eSIM.\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includeUsed", "value": "", "description": "Include used & expired Bundles\nBackward compatibility for v2.1\n" }, { "disabled": false, "key": "limit", "value": "", "description": "Number of assignments to return. Must be between 1 and 200. Default is 15\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "eb957595-9b92-42ee-8927-cc76ea649ca8", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeUsed", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"bundles\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"assignments\": [\n {\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ],\n \"id\": \"\",\n \"callTypeGroup\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"assignmentDateTime\": \"\",\n \"assignmentReference\": \"\",\n \"bundleState\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ],\n \"id\": \"\",\n \"callTypeGroup\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"assignmentDateTime\": \"\",\n \"assignmentReference\": \"\",\n \"bundleState\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"assignments\": [\n {\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ],\n \"id\": \"\",\n \"callTypeGroup\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"assignmentDateTime\": \"\",\n \"assignmentReference\": \"\",\n \"bundleState\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ],\n \"id\": \"\",\n \"callTypeGroup\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"assignmentDateTime\": \"\",\n \"assignmentReference\": \"\",\n \"bundleState\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c452854-8613-4114-bcbf-cc5cd18e0050", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeUsed", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58a0f9cf-8312-4e5d-adc2-3c31ec8b5090", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeUsed", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d01274e-6a79-4c21-9f9c-745c10db75b0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeUsed", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac6971d7-2286-4e7d-86dd-7ce4d63ce083", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeUsed", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9bb2595-925b-49b0-a962-2c58718a9354", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeUsed", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b46fafe5-7ef8-43ab-9a21-34e297f7bfc6", "name": "Get applied Bundle status", "request": { "name": "Get applied Bundle status", "description": { "content": "Provides details about an individual assignment of a Bundle applied to an eSIM.\n\n Bundle Assignment States:\n - **Processing:** The bundle assignment is currently processing. This is usually\n instant but can occasionally take up to 10 minutes to complete. The eSIM\n can still be installed and will register on a network while the bundle is\n processing.\n - **Queued:** The bundle has been successfully assigned, has not been used yet,\n and is queued for use.\n - **Active:** The bundle has successfully been used. It has data remaining and\n is within the bundle duration.\n - **Depleted:** The bundle has no data remaining but is still within the bundle\n duration.\n - **Expired:** The bundle has expired, and the bundle duration has been exceeded.\n - **Revoked:** The bundle has been revoked and is no longer on the eSIM.\n - **Lapsed:** The bundle has expired without being used and is no longer on the eSIM.\n\nNotes:\n - If multiple of the same bundle are applied to a single eSIM, the status\n bundle with the latest assignment will be returned.\n - Bundle names are case sensitive and should be typed exactly as shown,\n e.g., \"esim_1GB_7D_IM_U\".\n - Remaining data can be found in the response.\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "509787ec-6713-4482-86ec-9414049d74c0", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assignments\": [\n {\n \"id\": \"\",\n \"callTypeGroup\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"assignmentDateTime\": \"\",\n \"assignmentReference\": \"\",\n \"bundleState\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\",\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"callTypeGroup\": \"\",\n \"initialQuantity\": \"\",\n \"remainingQuantity\": \"\",\n \"assignmentDateTime\": \"\",\n \"assignmentReference\": \"\",\n \"bundleState\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"unlimited\": \"\",\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"initialAmount\": \"\",\n \"remainingAmount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76ec1be7-bbe1-4c1e-b0b0-90e8f779d10c", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47e43385-c375-4374-a976-377bfeb06521", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33afcc51-d249-48f4-b540-4eba92570cc5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80d96536-81b3-4d5f-9711-acce9137269a", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a9c178a-4a9a-46a3-9f08-2ae68876f528", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16f53f39-304f-4a58-b916-5a1d45dc3c51", "name": "Revoke applied Bundle", "request": { "name": "Revoke applied Bundle", "description": { "content": "This endpoint is used to revoke the latest assignment of a given bundle type from an eSIM. It requires two parameters: the ICCID of the eSIM and the name of the bundle to be revoked. If the specified ICCID has multiple bundles with the same name, the oldest unused bundle will be revoked.\n\nExample:\nFor an eSIM with ICCID 8943108165015003887 that has the following bundles:\n\n• ESIM_1G_UK (Assignment ID: 243)\n\n• ESIM_1G_UK (Assignment ID: 245)\n\n• ESIM_1G_US (Assignment ID: 247)\n\nIf you revoke the \"ESIM_1G_UK\" bundle, the oldest unused assignment (ID: 243) will be revoked.\n\n\n\nIf a bundle assignment has not been started and no data has been consumed, the bundle assignment can either be returned to the inventory or credited back to the organisations balance. If the bundle assignment has started, or was purchased outside of their permitted refund period, typically 60 days, it cannot be returned to the inventory or taken as a credit.\n\n**IMPORTANT:** Access to the refund functionality is **disabled by default**. To enable refunds (either to inventory or balance), you must first contact your account manager. Without this feature enabled, this endpoint will only revoke the bundle assignment **without a refund**.\n\n**Note:** Bundle names are case sensitive and should be typed like the following \"esim_1GB_7D_IM_U\".\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "refundToBalance", "value": "", "description": "If Applicable, refund the value of this bundle to organisation balance" }, { "disabled": false, "key": "offerId", "value": "", "description": "If Applicable, the offerId of the bundle to revoke. Needed for refunding to balance. You can find offerID (also known as Assigment ID) by querying “Get applied Bundle status” endpoint." }, { "disabled": false, "key": "type", "value": "", "description": "type `validate` will provide options for the revoke and the behaviours, if any. type `transaction` will execute the revoke. Defaults to `transaction`" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/v2_4/operations/catalogue/get) API call.\nExample: `esim_10GB_30D_IM_U`\n" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bfe97b64-cdc8-4912-b8ee-46334fa1af12", "name": "Success message", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "refundToBalance", "value": "" }, { "key": "offerId", "value": "" }, { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/v2_4/operations/catalogue/get) API call.\nExample: `esim_10GB_30D_IM_U`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe43ab9-fdc5-4965-ab74-a60b7d8bfd17", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "refundToBalance", "value": "" }, { "key": "offerId", "value": "" }, { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/v2_4/operations/catalogue/get) API call.\nExample: `esim_10GB_30D_IM_U`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0692426-1d3b-45ae-bdc3-a17832e11b30", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "refundToBalance", "value": "" }, { "key": "offerId", "value": "" }, { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/v2_4/operations/catalogue/get) API call.\nExample: `esim_10GB_30D_IM_U`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6769f2b5-3212-43be-be7d-0bfff8203749", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "refundToBalance", "value": "" }, { "key": "offerId", "value": "" }, { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/v2_4/operations/catalogue/get) API call.\nExample: `esim_10GB_30D_IM_U`\n" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73b777f0-89bb-469d-a0b9-4f4fc67cac63", "name": "Revoke specific Bundle", "request": { "name": "Revoke specific Bundle", "description": { "content": "This endpoint revokes a specific bundle from an eSIM using assignment ID.\n\n If a bundle assignment has not been started and no data has been consumed, the bundle assignment can either be returned to the inventory or credited back to the organisations balance. If the bundle assignment has started, or was purchased outside of their permitted refund period, typically 60 days, it cannot be returned to the inventory or taken as a credit.\n\n **IMPORTANT:** Access to the refund functionality is **disabled by default**. To enable refunds (either to inventory or balance), you must first contact your account manager. Without this feature enabled, this endpoint will only revoke the bundle assignment **without a refund**.\n \n**Note:** Bundle names are case sensitive and should be typed like the following \"esim_1GB_7D_IM_U\".\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "bundles", ":name", "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "", "description": "type `validate` will provide options for the revoke and the behaviours, if any. type `transaction` will execute the revoke. Defaults to `transaction`" }, { "disabled": false, "key": "refundToBalance", "value": "", "description": "If Applicable, refund the value of this bundle to organisation balance" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) (Required) ID of individual Bundle Assignment to revoke from an eSIM. You can find Assigment ID by querying “Get applied Bundle status” endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a878319b-4e28-4b54-881c-fa27db292e27", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "refundToBalance", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) (Required) ID of individual Bundle Assignment to revoke from an eSIM. You can find Assigment ID by querying “Get applied Bundle status” endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aac56c7-11a0-4f04-9a61-5ef0c07ed3ce", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "refundToBalance", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) (Required) ID of individual Bundle Assignment to revoke from an eSIM. You can find Assigment ID by querying “Get applied Bundle status” endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cde20c00-42f8-423e-bc10-4ce07a140d8a", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "refundToBalance", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) (Required) ID of individual Bundle Assignment to revoke from an eSIM. You can find Assigment ID by querying “Get applied Bundle status” endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed24905-684b-416c-9737-98ee8ee7696a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "refundToBalance", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) (Required) ID of individual Bundle Assignment to revoke from an eSIM. You can find Assigment ID by querying “Get applied Bundle status” endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77ff7ecd-2f47-48de-ba17-0592b31f4e72", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "refundToBalance", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) (Required) ID of individual Bundle Assignment to revoke from an eSIM. You can find Assigment ID by querying “Get applied Bundle status” endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75412237-0dbb-498d-9e05-646ab7bfb4a9", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "refundToBalance", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_1GB_7D_REUP_V2`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) (Required) ID of individual Bundle Assignment to revoke from an eSIM. You can find Assigment ID by querying “Get applied Bundle status” endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb3823e1-b07a-4b52-9929-235693ee7901", "name": "Suspend or unsuspend an eSIM", "request": { "name": "Suspend or unsuspend an eSIM", "description": { "content": "This endpoint allows you to suspend or unsuspend an eSIM using its ICCID.\n\nWhen an eSIM is suspended, it will not be able to connect to the network. This can be useful for temporarily disabling an eSIM without revoking it entirely.\n\nTo suspend an eSIM, set `suspend` to `true`. To unsuspend an eSIM, set `suspend` to `false`.\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"suspend\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3901a44e-f319-4b5f-a4f7-181184f9a7d6", "name": "Suspend status set successfully", "originalRequest": { "url": { "path": [ "esims", ":iccid", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"suspend\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53bd383-e4cf-42bc-94c4-f6109ae94108", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"suspend\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fc07121-a2ac-4591-989e-a71e8c4dd3f3", "name": "Unauthorised - returned when the api token is invalid or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"suspend\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67216114-c1ce-47ea-85ad-113766769efa", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"suspend\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f21b670-1473-4e71-a128-4b6b775d4f70", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"suspend\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b3f73ed-2317-4ccd-946c-d966a551d766", "name": "Get eSIM Location", "request": { "name": "Get eSIM Location", "description": { "content": "This endpoint provides the most recent location and associated network operator information for a specified eSIM.", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1b1b9eff-72eb-4f86-af2b-aaad70682a44", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mobileNetworkCode\": \"\",\n \"networkName\": \"\",\n \"networkBrandName\": \"\",\n \"country\": \"\",\n \"lastSeen\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b277bc3-ce7f-45ff-8d1f-f1eac767fe15", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "020f66a6-305c-4dfb-b4fd-70cbe58a0726", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94945b99-4021-4f73-8d4b-fcf6bdbc38fb", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a23fcc94-7b8f-4b3a-b81c-cc8c22789462", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e99a06a3-4c33-4dcd-ae37-de78f6b10955", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ed9bd6d8-7ecd-4660-8caf-1315536e73e1", "name": "eSIMs (Deprecated)", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9c9f8297-3ca7-4fe3-9b94-74425ef202a7", "name": "Get QR codes for eSIMs from an Order or Bundle apply reference (Deprecated)", "request": { "name": "Get QR codes for eSIMs from an Order or Bundle apply reference (Deprecated)", "description": { "content": "Get multiple QR codes by providing an Order or Apply Reference. Returns multiple QR codes as `.PNG` contained in a `.ZIP`.\n\nDeactivated eSIMs will return a 410 Gone error.\n\nDeprecated: See `/esims/assignments`\n", "type": "text/plain" }, "url": { "path": [ "esims", "qr", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "key": "Accept", "value": "application/zip" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8c847536-b80c-44a9-ab1e-bc996b610733", "name": "QR code image in a ZIP file", "originalRequest": { "url": { "path": [ "esims", "qr", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/zip" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/zip" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "269eabb0-bb8a-4a39-90bb-4d51b276ede6", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", "qr", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93ada7ad-e47a-4b91-86b8-69c13490c69b", "name": "Unauthorised - returned when the api token is invalid or the user does not have permission to query the given ICCID", "originalRequest": { "url": { "path": [ "esims", "qr", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e04e714b-cb53-4908-b367-148063043973", "name": "Gone - returned when the eSIM has been deactivated", "originalRequest": { "url": { "path": [ "esims", "qr", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb489bd5-563b-4e83-b1a6-18cf924ea4a2", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", "qr", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "661bc90e-1e16-4f34-b0f1-330013028f09", "name": "Get CSV containing eSIMs from an Order or Bundle apply (Deprecated)", "request": { "name": "Get CSV containing eSIMs from an Order or Bundle apply (Deprecated)", "description": { "content": "Get eSIM SMDP+ details by providing an Order or Apply Reference.\n\nContains ICCID, SMDP+ address and Matching ID.\n\nDeprecated: See `/esims/assignments`\n", "type": "text/plain" }, "url": { "path": [ "esims", "csv", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "additionalFields", "value": "" }, { "disabled": false, "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "660313bc-6182-4a19-ad38-d20fb09421db", "name": "CSV", "originalRequest": { "url": { "path": [ "esims", "csv", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e42f323-4f60-4e4b-87c8-4e5520de07c3", "name": "Bad Request - returned when the given ICCID is not found and/or permission to view this ICCID is not granted", "originalRequest": { "url": { "path": [ "esims", "csv", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51f0b5bc-5f28-4fab-9444-5607f05c18b9", "name": "Unauthorised - returned when the api token is invalid", "originalRequest": { "url": { "path": [ "esims", "csv", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fce7f0aa-26e8-4f51-aeba-3d4a70ddf346", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", "csv", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "additionalFields", "value": "" }, { "key": "additionalFields", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) Order Reference or Apply Reference" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b40194d2-851d-4633-be0a-c03435a08655", "name": "Apply a Bundle to an eSIM (Deprecated)", "request": { "name": "Apply a Bundle to an eSIM (Deprecated)", "description": {}, "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7ca87365-6092-4524-bd37-2cce64353dde", "name": "OK", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eff1293-297e-446f-b7ca-0d6d1229e7d2", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58dcc57c-b130-4fa2-97a3-9527f018698a", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d10c10c4-c8c6-48a4-a247-9f8bf3916867", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bac15b6f-1969-4f6f-a33b-16c2241901a3", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0464d84b-0dab-415c-859a-79db610c2daa", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) (Required) The ICCID of the eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "183086f7-47e9-492a-af52-51f0826447f4", "name": "Revoke a specific Bundle Assignment from an eSIM (Deprecated)", "request": { "name": "Revoke a specific Bundle Assignment from an eSIM (Deprecated)", "description": { "content": "Revokes a single assignment of a given Bundle type.\n\ne.g. Can remove 1 month from a 1-year Bundle.\n\n**Note:** Bundle names are case sensitive and should be typed like the following \"esim_1GB_7D_IM_U\".\n", "type": "text/plain" }, "url": { "path": [ "esims", ":iccid", "bundles", ":name", "applications", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "", "description": "type `validate` will provide options for the revoke and the behaviours, if any. type `transaction` will execute the revoke. Defaults to `transaction`" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/#get-/catalogue) API call.\nExample: `esim_10GB_30D_IM_U`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) ID of individual Bundle Assignment to revoke from an eSIM" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0f01c2a5-79da-4049-b370-ae0ead231b05", "name": "Success message", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "applications", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/#get-/catalogue) API call.\nExample: `esim_10GB_30D_IM_U`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) ID of individual Bundle Assignment to revoke from an eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f6b0143-6c2c-4a14-8c30-d8f76f6bba7f", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "applications", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/#get-/catalogue) API call.\nExample: `esim_10GB_30D_IM_U`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) ID of individual Bundle Assignment to revoke from an eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9465370a-17a6-4004-a0c0-6dd8c6e21ad2", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "applications", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/#get-/catalogue) API call.\nExample: `esim_10GB_30D_IM_U`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) ID of individual Bundle Assignment to revoke from an eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1c17586-7843-4422-ad7d-38621f0ad69e", "name": "Server Error", "originalRequest": { "url": { "path": [ "esims", ":iccid", "bundles", ":name", "applications", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iccid", "description": "(Required) The ICCID of the eSIM" }, { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) Name of Bundle\n\nFormat as defined in [List Catalogue](/api/#get-/catalogue) API call.\nExample: `esim_10GB_30D_IM_U`\n" }, { "disabled": false, "type": "any", "value": "", "key": "assignmentId", "description": "(Required) ID of individual Bundle Assignment to revoke from an eSIM" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ddff1b4f-2841-498c-80a7-17c248e5f51e", "name": "Organisation", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "25e4f324-e967-4933-a782-9e7028ff7484", "name": "Get Current Organisation Details", "request": { "name": "Get Current Organisation Details", "description": { "content": "This endpoint allows you to retrieve comprehensive information about your organisation, including details of all associated users.", "type": "text/plain" }, "url": { "path": [ "organisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f748815a-8c17-493b-be02-3438f66ac701", "name": "OK", "originalRequest": { "url": { "path": [ "organisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"taxLiable\": \"\",\n \"addr1\": \"\",\n \"addr2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"postcode\": \"\",\n \"callbackUrl\": \"\",\n \"notes\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"balance\": \"\",\n \"testCredit\": \"\",\n \"testCreditExpiry\": \"\",\n \"businessType\": \"\",\n \"website\": \"\",\n \"productDescription\": \"\",\n \"users\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"role\": \"\",\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\",\n \"timeZone\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"role\": \"\",\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\",\n \"timeZone\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "120cec69-3996-4f28-9ceb-7651fc9be170", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "organisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb7b83c8-b317-4387-9a1a-d95925ab0189", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "organisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3bbd35a-9398-4cef-90b2-db914919e094", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "organisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15cf4f89-995f-4e95-8b36-d3a2009c857c", "name": "Server Error", "originalRequest": { "url": { "path": [ "organisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b060ef24-cf32-4e1b-ba35-e166e7bc50ec", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "organisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d287c352-65f1-4dbb-92c6-069ff3e96256", "name": "Topup Organisation Balance", "request": { "name": "Topup Organisation Balance", "description": { "content": "Update the pre-payed balance held by your organisation. Initial payment is done using the Portal: https://portal.esim-go.com/. This will store your card details for future use. Follow up payments can be done using the API.\n\n Note: 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.\n", "type": "text/plain" }, "url": { "path": [ "organisation", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "amount", "value": "", "description": "(Required) The amount of to be charged to the saved card" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "5d7ca8e2-28de-4aae-b8ed-ecd0b91c3c54", "name": "OK", "originalRequest": { "url": { "path": [ "organisation", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"balance\": \"\",\n \"ref\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2966b899-9ba4-4f6e-b334-e744d9bc06cd", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "organisation", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7a0136b-f57d-4009-8d26-adce044bf71e", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "organisation", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dc2cb0f-5ec3-4b70-a925-84cf26b58c9e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "organisation", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83339855-fe6c-4f21-af61-c9def4baf367", "name": "Server Error", "originalRequest": { "url": { "path": [ "organisation", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2825f774-4111-4212-8403-38056bda99fb", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "organisation", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa27f9d7-4dca-4985-bfed-0a43c8cbc90d", "name": "Get Bundle Groups", "request": { "name": "Get Bundle Groups", "description": { "content": "This endpoint returns a list of the groups of Bundles available for your Organisation to order. Bundles in eSIM Go are categorised into groups.\n\n Name of the bundle group depends on your account tier. In the example below you will find the groups description for **standard** organisation tier.\n\n Standard Fixed\n * All these bundles are for a finite and fixed amount of data.\n * eg. the moniker for a Standard Fixed Turkey 1GB 7 Days bundle is esim_1GB_7D_TR_V2\n\n Standard Long Duration\n * All these bundles are for a finite and fixed amount of data.\n * eg. the moniker for a Standard 50GB 90 Days Long Duration Bundle is esim_50GB_90D_RGBS_V2\n\n Standard Unlimited Lite\n * These bundles will provide 1GB of unthrottled data every 24 hours, once this is depleted data will be throttled to 512kbps. This repeats each day for the duration of the bundle.\n * eg. the moniker for a Standard Unlimited Lite Turkey 1 day bundle is esim_UL_1D_TR_V2\n\n Standard Unlimited Essential\n * These bundles will provide 1GB of unthrottled data every 24 hours, once this is depleted data will be throttled to 1.25mbps. This repeats each day for the duration of the bundle.\n * eg. the moniker for a Standard Unlimited Lite Turkey 1 day bundle is esim_ULE_1D_TR_V2\n\n Standard Unlimited Plus\n * These bundles will provide 2GB of unthrottled data every 24 hours, once this is depleted data will be throttled to 2mbps. This repeats each day for the duration of the bundle.\n * eg. the moniker for a Standard Unlimited Plus Turkey 1 day bundle is esim_ULP_1D_TR_V2\n", "type": "text/plain" }, "url": { "path": [ "organisation", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "31860efb-7f27-4747-91da-df81adbe78ee", "name": "OK", "originalRequest": { "url": { "path": [ "organisation", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"name\": \"\",\n \"priceListUrl\": \"\",\n \"desc\": \"\",\n \"icon\": \"\"\n },\n {\n \"name\": \"\",\n \"priceListUrl\": \"\",\n \"desc\": \"\",\n \"icon\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a4b64b2-e7c2-4bfb-a323-3ef37592b9bb", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "organisation", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57cdb2f1-124f-4d25-80de-b597067e8268", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "organisation", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c489846-2454-44b7-a565-8b881c5c0cf3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "organisation", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c23a066-f584-4030-9ad4-0dbe64ec20e4", "name": "Server Error", "originalRequest": { "url": { "path": [ "organisation", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1d0e5ca-6f42-4ef8-bd16-21fef784f8b3", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "organisation", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "73f545a5-634e-4474-aecd-41265782d110", "name": "Inventory", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "22ca68f3-738d-44cb-8253-16574a8428e7", "name": "Get bundle inventory", "request": { "name": "Get bundle inventory", "description": { "content": "All of your Organisation's currently purchased Bundles and their remaining usages.\n", "type": "text/plain" }, "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "27ec6dbb-e0e4-41d7-901e-f484a51104e4", "name": "OK", "originalRequest": { "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"bundles\": [\n {\n \"name\": \"\",\n \"desc\": \"\",\n \"useDms\": \"\",\n \"available\": [\n {\n \"id\": \"\",\n \"total\": \"\",\n \"remaining\": \"\",\n \"expiry\": \"\"\n },\n {\n \"id\": \"\",\n \"total\": \"\",\n \"remaining\": \"\",\n \"expiry\": \"\"\n }\n ],\n \"countries\": [\n \"\",\n \"\"\n ],\n \"data\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"\",\n \"autostart\": \"\",\n \"unlimited\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ],\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"desc\": \"\",\n \"useDms\": \"\",\n \"available\": [\n {\n \"id\": \"\",\n \"total\": \"\",\n \"remaining\": \"\",\n \"expiry\": \"\"\n },\n {\n \"id\": \"\",\n \"total\": \"\",\n \"remaining\": \"\",\n \"expiry\": \"\"\n }\n ],\n \"countries\": [\n \"\",\n \"\"\n ],\n \"data\": \"\",\n \"duration\": \"\",\n \"durationUnit\": \"\",\n \"autostart\": \"\",\n \"unlimited\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ],\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c8416b2-3f2c-4d1d-9248-1685983c6bcd", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8723161-2a11-4296-ae36-690d7e4143ba", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f72105ee-abf6-46dc-bdba-4de8ccfc85aa", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f72f456-3338-4077-96b1-6a43d54c524b", "name": "Server Error", "originalRequest": { "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4c17952-abfa-47bd-a4dd-a6e71a076330", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53cbf00e-efd2-4539-a9df-c799ad0c0357", "name": "Refund bundle from inventory", "request": { "name": "Refund bundle from inventory", "description": { "content": "Refunds an item in the inventory to the organisations balance.\n\n\nTakes a usageId and a quantity.\n\n\nThe usageId's can be found by querying the /inventory endpoint.\n\n\nThe quantity of a refund cannot exceed the remaining quantity left for the specific usageId. If you wish to refund multiple usageId's, multiple calls to this endpoint will need to be done. \n \n\nIf the bundle was purchased outside of their permitted refund period, typically 60 days, it cannot be refunded.\n\n\n**IMPORTANT:** Access to the refund functionality is **disabled by default**. To enable refunds, you must first contact your account manager.\n", "type": "text/plain" }, "url": { "path": [ "inventory", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"usageId\": \"\",\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ecf5f82-872a-4b69-a867-7db7d6f26258", "name": "OK", "originalRequest": { "url": { "path": [ "inventory", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"usageId\": \"\",\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da0de7cb-1a27-47d1-b8c1-4f9d415d75bf", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "inventory", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"usageId\": \"\",\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da79de42-38af-459f-8197-8752de55854e", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "inventory", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"usageId\": \"\",\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad57c529-e913-4be7-a0fb-bafd96f18216", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "inventory", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"usageId\": \"\",\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44c49df6-aec4-46a1-ae6e-f00dc9bcb1a8", "name": "Server Error", "originalRequest": { "url": { "path": [ "inventory", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"usageId\": \"\",\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0acd6c77-6d89-4279-bdb0-e294cf8f47e4", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "inventory", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Content-Type", "value": "", "description": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"usageId\": \"\",\n \"quantity\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "211587a0-5dce-41f8-9c0b-1c8d538cb65a", "name": "Catalogue", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8eb3b065-5c70-40ce-bd8a-035de7c60463", "name": "Get Bundle catalogue", "request": { "name": "Get Bundle catalogue", "description": { "content": "List all Bundles available to your Organisation for ordering.\nBundle names can be used with the `/orders` endpoint to place an order.\n\n **Filters**\n \n When applying filters to the catalogue endpoint, we recommend that you use the following steps:\n\n *Group*\n \n The group filter will ensure that the response received only contains bundles from the group you are targeting. eg. Standard Fixed\n\n *Country*\n \n The country filter uses ISO codes, which are readily available in the rate sheet that is sent out periodically. eg. Turkey = TR, United Arab Emirates = AE.\n\n *Region*\n \n The region filter uses region names to retrieve all bundles that are available for a given region.\n\n\n **Please note:** When querying the catalogue the response should be saved for later use to keep in line with the Technical Service Agreement - Platform services - \"Frequent and consistent polling of services is not allowed, we respectfully request our customers and partners to only make requests when information or data is required.\"\n", "type": "text/plain" }, "url": { "path": [ "catalogue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page of Bundles to return" }, { "disabled": false, "key": "perPage", "value": "", "description": "Number of Bundles to return per page" }, { "disabled": false, "key": "direction", "value": "", "description": "Direction of ordering" }, { "disabled": false, "key": "orderBy", "value": "", "description": "Name of column to order by" }, { "disabled": false, "key": "description", "value": "", "description": "Wildcard search for description" }, { "disabled": false, "key": "group", "value": "", "description": "Filter by Bundle Group (exact value) e.g. `Standard eSIM Bundles`" }, { "disabled": false, "key": "countries", "value": "", "description": "Comma-separated list of country ISO codes to filter by. This will search for Bundles that include at least one of the countries as their base country. e.g. `GB, US`" }, { "disabled": false, "key": "region", "value": "", "description": "This will return Bundles that have a base country in the specified region. e.g. `Europe`" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c736c69c-6e35-4e54-be31-eef8e86ffb5f", "name": "OK", "originalRequest": { "url": { "path": [ "catalogue" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "description", "value": "" }, { "key": "group", "value": "" }, { "key": "countries", "value": "" }, { "key": "region", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ],\n \"countries\": [\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n },\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n }\n ],\n \"dataAmount\": \"\",\n \"duration\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ],\n \"autostart\": \"\",\n \"unlimited\": \"\",\n \"roamingEnabled\": [\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n },\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n }\n ],\n \"price\": \"\",\n \"billingType\": \"\",\n \"profileName\": \"\",\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ],\n \"countries\": [\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n },\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n }\n ],\n \"dataAmount\": \"\",\n \"duration\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ],\n \"autostart\": \"\",\n \"unlimited\": \"\",\n \"roamingEnabled\": [\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n },\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n }\n ],\n \"price\": \"\",\n \"billingType\": \"\",\n \"profileName\": \"\",\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1184adaf-1014-42ff-a77c-c4bdad00681a", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "catalogue" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "description", "value": "" }, { "key": "group", "value": "" }, { "key": "countries", "value": "" }, { "key": "region", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b715dfaf-334f-43ab-9a8a-90f4fcc80d2a", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "catalogue" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "description", "value": "" }, { "key": "group", "value": "" }, { "key": "countries", "value": "" }, { "key": "region", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53d1e0cc-7e5c-4e8c-b29b-b88b4fc366a9", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "catalogue" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "description", "value": "" }, { "key": "group", "value": "" }, { "key": "countries", "value": "" }, { "key": "region", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72af9e5c-4b06-474b-9f5e-b5252306ac35", "name": "Server Error", "originalRequest": { "url": { "path": [ "catalogue" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "description", "value": "" }, { "key": "group", "value": "" }, { "key": "countries", "value": "" }, { "key": "region", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10110e22-4d2c-4e01-a913-f34272a60dbe", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "catalogue" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "perPage", "value": "" }, { "key": "direction", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "description", "value": "" }, { "key": "group", "value": "" }, { "key": "countries", "value": "" }, { "key": "region", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0fa8e782-90dc-44e1-8686-4d397aeb9a36", "name": "Get Bundle details from catalogue", "request": { "name": "Get Bundle details from catalogue", "description": { "content": "Get details of a specific Bundle from your Organisation's catalogue.\n**Note:** Bundle names are case sensitive e.g. \"esim_1GB_7D_IM_U\".", "type": "text/plain" }, "url": { "path": [ "catalogue", "bundle", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle to get countries for. Bundle names are case sensitive." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e5f9b5d5-3a5c-4b0a-a0c0-eaf722a5bacb", "name": "OK", "originalRequest": { "url": { "path": [ "catalogue", "bundle", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle to get countries for. Bundle names are case sensitive." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"countries\": [\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n },\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n }\n ],\n \"dataAmount\": \"\",\n \"duration\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ],\n \"autostart\": \"\",\n \"unlimited\": \"\",\n \"roamingEnabled\": [\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n },\n {\n \"name\": \"\",\n \"region\": \"\",\n \"iso\": \"\"\n }\n ],\n \"price\": \"\",\n \"group\": [\n \"\",\n \"\"\n ],\n \"billingType\": \"\",\n \"profileName\": \"\",\n \"allowances\": [\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n },\n {\n \"type\": \"\",\n \"service\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"unit\": \"\",\n \"unlimited\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b92250f-0533-4476-8593-bfa93906b1cc", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "catalogue", "bundle", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle to get countries for. Bundle names are case sensitive." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33010caf-823e-4f52-9cff-010964733d1d", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "catalogue", "bundle", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle to get countries for. Bundle names are case sensitive." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24af3c7b-63ca-45e4-90fa-899ea628d97a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "catalogue", "bundle", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle to get countries for. Bundle names are case sensitive." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "038607b1-3b77-4a9c-9274-f8be3350a215", "name": "Server Error", "originalRequest": { "url": { "path": [ "catalogue", "bundle", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle to get countries for. Bundle names are case sensitive." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73cd0e2a-dee1-453c-a72f-def5babbcc60", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "catalogue", "bundle", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "name", "description": "(Required) (Required) Name of Bundle to get countries for. Bundle names are case sensitive." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce26d31e-d6d4-4a9a-992f-c4e0275b840a", "name": "Consumption - Get Prices", "request": { "name": "Consumption - Get Prices", "description": { "content": "Get current per GB prices for all countries available to your Organisation.\nPrices are grouped by country and include the profile name for each price.\nThe response includes a hash that can be used to detect changes in pricing data.\n\n**Note:** This endpoint is only available to customers that are on Consumption billing.\n", "type": "text/plain" }, "url": { "path": [ "catalogue", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fd282c86-4a01-4036-aa63-d1c696ed4c29", "name": "OK", "originalRequest": { "url": { "path": [ "catalogue", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hash\": \"\",\n \"prices\": [\n {\n \"country\": {\n \"iso\": \"\",\n \"name\": \"\"\n },\n \"prices\": [\n {\n \"id\": \"\",\n \"price\": \"\",\n \"currency\": \"\",\n \"profile\": \"\",\n \"country\": {\n \"iso\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"price\": \"\",\n \"currency\": \"\",\n \"profile\": \"\",\n \"country\": {\n \"iso\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n {\n \"country\": {\n \"iso\": \"\",\n \"name\": \"\"\n },\n \"prices\": [\n {\n \"id\": \"\",\n \"price\": \"\",\n \"currency\": \"\",\n \"profile\": \"\",\n \"country\": {\n \"iso\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"price\": \"\",\n \"currency\": \"\",\n \"profile\": \"\",\n \"country\": {\n \"iso\": \"\",\n \"name\": \"\"\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afb4d98e-f885-4ffb-9b9d-835120733cf2", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "catalogue", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac50b3d7-a6bc-4fc8-a3ad-2f90ed5f41c0", "name": "Unauthorised - returned when the api token is invalid or the Organisation is not a Consumption partner", "originalRequest": { "url": { "path": [ "catalogue", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2f7c109-7d4c-44be-bf80-78d27a7188d8", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "catalogue", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b15a569-2dbd-4d12-84ac-c14070f0db5e", "name": "Server Error", "originalRequest": { "url": { "path": [ "catalogue", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "867742a5-fd69-45a3-bf8c-58f25e611bbc", "name": "Networks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8a4f33b1-4c29-4c13-8f3e-f1ceb49c12c1", "name": "Get Country Network Data", "request": { "name": "Get Country Network Data", "description": { "content": "This endpoint is used to return the networks for a country/countries searched for either by an array of countires or ISO codes (ISOs).\n\n Alternatively, it can be toggled to return all countries and their\nnetworks.\n\n Please refer to the rate sheet, availible to download in the eSIM Go\nManagement Portal for a full list of country names and ISO codes.\n", "type": "text/plain" }, "url": { "path": [ "networks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "countries", "value": "", "description": "List of Countries e.g. United Kingdom, United States" }, { "disabled": false, "key": "isos", "value": "", "description": "List of ISOs e.g. GB, US" }, { "disabled": false, "key": "returnAll", "value": "", "description": "Used to toggle returning of all Countries e.g. true/false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "062db418-941e-4b04-9680-ad450e4e9e15", "name": "OK", "originalRequest": { "url": { "path": [ "networks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countries", "value": "" }, { "key": "isos", "value": "" }, { "key": "returnAll", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"countryNetworks\": [\n {\n \"name\": \"\",\n \"networks\": [\n {\n \"name\": \"\",\n \"brandName\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tagid\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"brandName\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tagid\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"name\": \"\",\n \"networks\": [\n {\n \"name\": \"\",\n \"brandName\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tagid\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"brandName\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tagid\": \"\",\n \"speed\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f366cad5-6a7f-4aee-b700-a64d4f62042f", "name": "Bad Request - returned when request format is not accepted", "originalRequest": { "url": { "path": [ "networks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countries", "value": "" }, { "key": "isos", "value": "" }, { "key": "returnAll", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "191dbb73-7906-4e73-8d11-4f0e7b1f42f0", "name": "Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user", "originalRequest": { "url": { "path": [ "networks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countries", "value": "" }, { "key": "isos", "value": "" }, { "key": "returnAll", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c3c0284-b2ba-4a4f-96a1-3b385c0911bc", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "networks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countries", "value": "" }, { "key": "isos", "value": "" }, { "key": "returnAll", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a54fcd0-dba2-4f0b-8929-2e96a2431747", "name": "Server Error", "originalRequest": { "url": { "path": [ "networks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countries", "value": "" }, { "key": "isos", "value": "" }, { "key": "returnAll", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc23abc6-05b3-4b1f-929e-de786c5bf54b", "name": "Processing - Please come back later or use the *Retry-After* (seconds) header", "originalRequest": { "url": { "path": [ "networks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countries", "value": "" }, { "key": "isos", "value": "" }, { "key": "returnAll", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "disabled": false, "key": "Accept", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.esim-go.com/v2.5", "key": "baseUrl" } ], "info": { "_postman_id": "2101bd45-fef2-4a70-9984-4e508024f3f8", "name": "eSIM Go API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "To access the eSIMGo API, you need to authenticate your requests using an API key. \nHere's a brief overview of the authentication process:\n 1. Assuming that you have created account already:\n - Log into your eSIMGo account at https://sso.esim-go.com/login.\n - Navigate to Account Settings -> API Details to find your API key.\n - Keep your API key secure and avoid sharing it with others.\n 2. API Key Usage:\n - Include your API key in the header of all eSIMGo API requests.\n - Use the header key 'X-API-KEY' with your API key as the value.\n 3. Security Scheme:\n - The eSIMGo API uses an HTTP security scheme type for authentication.\n 4. Authorization Types:\n - The API supports 'apiKeyAuth' authorization type.\n" } }