openapi: 3.2.0
info:
title: Connectivity eSIM Profile Management API
description: Connectivity APIs help users manage their connectivity through APIs.
version: 1.0.0
servers:
- url: https://api.korewireless.com/connectivity
description: Production
security:
- {}
- Auth: []
- api_key: []
tags:
- name: eSIM Profile Management
description: API to manage eSIM Switch related activities for a given account
Refer to the eSIM switch article on the KORE Help Center for additional information
paths:
/v1/accounts/{account-id}/esim-profile-switch-requests/{esim-profile-switch-request-id}:
get:
tags:
- eSIM Profile Management
summary: Finds Switch Request By eSIM Profile Switch Request ID
description: Get details of a specific switch request by eSIM Profile Switch Request ID
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
esim-profile-switch-request-id:
type: string
example: cmp-cpro-request-00000
description: Unique identifier of the switch request
activation-profile-id:
type: string
example: cmp-cpro-request-00000
description: Unique identifier of the activation profile
switch-request-type:
type: string
enum:
- SwitchProfile
- DownloadProfile
- EnableProfile
- DeleteProfile
description: The type of eSim operation requested
switch-request-date:
type: string
example: '2022-11-16T07:43:02.428Z'
description: Date of switch request creation
switch-request-status:
type: string
example: Completed
description: 'Current status of the switch request '
total-switch-processing:
type: integer
description: eSIM switches in progress
total-switch-failed:
type: integer
description: eSIMs that failed to switch
total-switch-completed:
type: integer
description: 'Switches completed '
total-switch-pending-network-connection:
type: integer
description: 'eSIMs in the request waiting for the device to come online '
total-switch-requested:
type: integer
description: eSIMs in the request
eids:
type: array
items:
type: object
properties:
eid:
type: string
example: '000000000000000000000000000'
description: Unique identifier of the eSIM
new-subscription-id:
type: string
example: cmp-k1-subscription-0000000000
description: Unique identifier of the subscription that has been allocated to the eSIM as part of switching
old-subscription-id:
type: string
example: cmp-k1-subscription-0000000000
description: Unique identifier of the subscription that has previously been active on the eSIM
switch-status:
type: string
example: Completed
description: Switch status of the eSIM
switch-error-message:
type: string
example: Error Message
description: Reason for switch failure of the eSIM
$$ref: '#/components/schemas/200FindsSwitchRequestByeSIMProfileSwitchRequestID0'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error-message:
type: string
description: Reason for failure
example: error
status:
type: string
description: Status of the response
example: No records found / Invalid input
$$ref: '#/components/schemas/400FindsSwitchRequestByeSIMProfileSwitchRequestID0'
'401':
description: Unauthorised User
content:
application/json:
schema:
required:
- error
- message
type: object
properties:
error:
type: integer
format: int32
message:
type: string
$$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'404':
description: The Specified Resource Was Not Found
content:
application/json:
schema:
type: object
properties:
INFO:
type: string
$$ref: '#/components/schemas/NotFound_Error'
'500':
description: Server Error
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
parameters:
- name: esim-profile-switch-request-id
description: The unique identifier of the switch request
in: path
required: true
schema:
type: string
- name: account-id
description: The unique identifier of your account
in: path
required: true
schema:
type: string
x-code-samples:
- lang: cURL
label: cURL
source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/'' \
--header ''Accept: application/json'''
- lang: js
label: NodeJs
source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n"
- lang: java
label: Java
source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();"
- lang: cs
label: C#
source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
- lang: PHP
label: Php
source: " '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
- lang: py
label: Python
source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
security:
- {}
- Auth: []
- api_key: []
/v1/accounts/{account-id}/esim-profile-switch-requests:
get:
tags:
- eSIM Profile Management
summary: Lists All Switch Requests
description: Get details of all switch requests by EID
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
total-pages:
type: integer
description: Total number of pages
page:
type: integer
description: Page number
total-records:
type: integer
description: Total number of records
records:
type: array
items:
type: object
properties:
switch-request-type:
type: string
enum:
- SwitchProfile
- DownloadProfile
- EnableProfile
- DeleteProfile
description: The type of eSim operation requested
switch-request-date:
type: string
example: '2022-11-16T07:43:02.428Z'
format: dateTime
description: Date of switch request creation
switch-request-status:
type: string
example: Pending
description: Current status of switch request
total-switch-processing:
type: integer
description: eSIM switches in progress
total-switch-failed:
type: integer
description: eSIMs that failed to switch
esim-profile-switch-request-id:
type: string
example: cmp-cpro-request-00000
description: Unique identifier of the switch request
total-switch-completed:
type: integer
example: '2022-11-17T13:12:39.469Z'
description: Switches completed
total-switch-pending-network-connection:
type: integer
description: eSIMs in the request waiting for the device to come online
total-switch-requested:
type: integer
description: eSIMs in this request
activation-profile-id:
type: string
example: cmp-prov-ap-000000
description: Unique identifier of the activation profile
$$ref: '#/components/schemas/200ListsAllSwitchRequests0'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Status of the response
example: error
error-message:
type: string
description: Reason for request failure
example: No records found / Invalid input
$$ref: '#/components/schemas/400ListsAllSwitchRequests0'
'401':
description: Unauthorised User
content:
application/json:
schema:
required:
- error
- message
type: object
properties:
error:
type: integer
format: int32
message:
type: string
$$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'404':
description: The Specified Resource Was Not Found
content:
application/json:
schema:
type: object
properties:
INFO:
type: string
$$ref: '#/components/schemas/NotFound_Error'
'500':
description: Server Error
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
parameters:
- name: eid
description: The unique identifier of the eSIM
in: query
required: false
schema:
type: string
- name: page
description: Page number
in: query
required: false
schema:
type: number
- name: take
description: Number of records
in: query
required: false
schema:
type: number
- name: account-id
description: The unique identifier of your account
in: path
required: true
schema:
type: string
x-code-samples:
- lang: cURL
label: cURL
source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests?eid=&page=&take='' \
--header ''Accept: application/json'''
- lang: js
label: NodeJs
source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests?eid=&page=&take=',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n"
- lang: java
label: Java
source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests?eid=&page=&take=\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();"
- lang: cs
label: C#
source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests?eid=&page=&take=\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
- lang: PHP
label: Php
source: " '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests?eid=&page=&take=',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
- lang: py
label: Python
source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests?eid=&page=&take=\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
security:
- {}
- Auth: []
- api_key: []
post:
tags:
- eSIM Profile Management
summary: Create A Switch Request
description: Create a switch profile request for an account. Downloads a new profile to the eSIM, activates the new subscription, enables the new profile in the eSIM, and deactivates or suspends the old subscription, or (optionally) the old subscription remains active and is subject to MRC
requestBody:
content:
application/json:
schema:
type: object
properties:
activation-profile-id:
type: string
example: cmp-pp-ap-000000
description: Unique identifier of the activation profile
exclude-deactivation:
type: boolean
example: false
description: This can be set as true to keep the old subscription active
skip-session-check:
type: boolean
example: false
description: Used to skip the initial in-session check for an eSIM
disable-autoretry:
type: boolean
example: false
description: Disables retry of RSP steps based on in-session event when set to true, when set to false the RSP step will be retried max 5 times
suspend-old-subscription:
type: boolean
example: false
description: This can be set as true to suspend the old subscription if the suspend state is eligible
sku:
type: string
description: The Stock Keeping Unit (SKU) number of a device type with an embedded SIM which is required for switching to VZW profile if IMEI is not provided
example: VZW00000000
subscriptions:
type: array
items:
type: object
properties:
eid:
type: string
example: '0000000000000000000000000'
description: Unique identifier of the eSIM
imei:
type: string
example: '12121212121212'
description: IMEI is a 14 - 16 digit identifier of the device which is required for switching to VZW profile
required:
- eid
description: Devices to be switched
service-type-info:
type: object
properties:
aus-ipnd-info:
type: object
properties:
address:
type: string
description: Address of the user
example: uniqueStr
title:
type: string
description: Title of the user (Mr/Mrs/Ms)
example: Mr/Mrs/Ms
first-name:
type: string
description: First Name of the user
example: uniqueStr
last-name:
type: string
description: Last Name of the user
example: uniqueStr
description: IPND information is mandatory for activating a KORE TELS2 subscription
description: Carrier specific information required for activating a subscription
required:
- activation-profile-id
- subscriptions
$$ref: '#/components/schemas/CreateASwitchRequest0'
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
description: Status of request submission
data:
type: object
properties:
esim-profile-switch-request-id:
type: string
example: cmp-cpro-request-00000
description: Unique identifier of the request created
message:
type: string
example: Your request has been acknowledged
description: Acknowledgement message
$$ref: '#/components/schemas/200CreateASwitchRequest0'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
description: Status of request submission
error-message:
type: string
example: Invalid eIds / Imei
description: Reason for request failure
validation-error:
type: array
items:
type: object
properties:
eid:
type: string
example: '00000000000000000000000000000'
description: Unique identifier of the rejected eSIM
error-message:
type: string
example: Cannot be switched to the requested profile
description: Reason for the rejection of the EID
$$ref: '#/components/schemas/400CreateASwitchRequest0'
'401':
description: Unauthorised User
content:
application/json:
schema:
required:
- error
- message
type: object
properties:
error:
type: integer
format: int32
message:
type: string
$$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'404':
description: The Specified Resource Was Not Found
content:
application/json:
schema:
type: object
properties:
INFO:
type: string
$$ref: '#/components/schemas/NotFound_Error'
'500':
description: Server Error
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
parameters:
- name: account-id
description: The unique identifier of your account
in: path
required: true
schema:
type: string
x-code-samples:
- lang: cURL
label: cURL
source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"exclude-deactivation\": \"\",\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\",\n \"suspend-old-subscription\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"address\": \"\",\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\"\n }\n }\n}'"
- lang: js
label: NodeJs
source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"exclude-deactivation\": \"\",\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\",\n \"suspend-old-subscription\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"address\": \"\",\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\"\n }\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n"
- lang: java
label: Java
source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"activation-profile-id\\\": \\\"\\\",\\n \\\"subscriptions\\\": [\\n {\\n \\\"eid\\\": \\\"\\\",\\n \\\"imei\\\": \\\"\\\"\\n },\\n {\\n \\\"eid\\\": \\\"\\\",\\n \\\"imei\\\": \\\"\\\"\\n }\\n ],\\n \\\"exclude-deactivation\\\": \\\"\\\",\\n \\\"skip-session-check\\\": \\\"\\\",\\n \\\"disable-autoretry\\\": \\\"\\\",\\n \\\"suspend-old-subscription\\\": \\\"\\\",\\n \\\"sku\\\": \\\"\\\",\\n \\\"service-type-info\\\": {\\n \\\"aus-ipnd-info\\\": {\\n \\\"address\\\": \\\"\\\",\\n \\\"title\\\": \\\"\\\",\\n \\\"first-name\\\": \\\"\\\",\\n \\\"last-name\\\": \\\"\\\"\\n }\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();"
- lang: cs
label: C#
source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"activation-profile-id\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"eid\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imei\"\": \"\"\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"eid\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imei\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"exclude-deactivation\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"skip-session-check\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"disable-autoretry\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"suspend-old-subscription\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"sku\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"service-type-info\"\": {\" + \"\\n\" +\n@\" \"\"aus-ipnd-info\"\": {\" + \"\\n\" +\n@\" \"\"address\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"title\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"first-name\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"last-name\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
- lang: PHP
label: Php
source: " '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"exclude-deactivation\": \"\",\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\",\n \"suspend-old-subscription\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"address\": \"\",\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\"\n }\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
- lang: py
label: Python
source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests\"\n\npayload = json.dumps({\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"exclude-deactivation\": \"\",\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\",\n \"suspend-old-subscription\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"address\": \"\",\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\"\n }\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
security:
- {}
- Auth: []
- api_key: []
/v1/accounts/{account-id}/esim-profile-switch-requests/retry:
post:
tags:
- eSIM Profile Management
summary: Retry Switch Request
description: 'Retry a failed switch request or skip failed step of a switch request.
Note: The only step that can be skipped for a switch request is the session check step. If the device is not online the request may fail at the next step.'
requestBody:
content:
application/json:
schema:
type: object
properties:
esim-profile-switch-request-id:
type: string
description: Unique identifier of the switch request
example: cmp-cpro-request-0000000
eids:
type: array
items:
type: string
example: '235543656577454322'
description: The array of unique identifiers of the eSIM
skip-session-check:
type: boolean
description: Used to skip in-session check for an eSIM
default: 'false'
required:
- esim-profile-switch-request-id
- eids
- skip-session-check
$$ref: '#/components/schemas/RetrySwitchRequest0'
responses:
'200':
description: 200 response
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Response status
example: success
data:
type: object
properties:
message:
type: string
description: Acknowledgement message
example: Request requeued successfully!
retry-response:
type: object
properties:
accepted-eids:
type: array
items:
type: string
example: '235543656577454322'
description: EIDs accepted for retry
rejected-eids:
type: array
items:
type: string
example: '235543656577454322'
description: EIDs rejected for retry
description: Details of EIDs
description: Response data
$$ref: '#/components/schemas/200RetrySwitchRequest0'
'400':
description: Bad Request
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Response status
example: error
data:
type: object
properties:
message:
type: string
description: Error message
example: Request cannot be requeued!
retry-response:
type: object
properties:
rejected-eids:
type: array
items:
type: string
example: '235543656577454322'
description: EIDs rejected for retry
description: Details of EIDs
description: Response data
$$ref: '#/components/schemas/400RetrySwitchRequest0'
'401':
description: Unauthorised User
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
required:
- error
- message
type: object
properties:
error:
type: integer
format: int32
message:
type: string
$$ref: '#/components/schemas/Error'
'403':
description: Forbidden
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'404':
description: The Specified Resource Was Not Found
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
INFO:
type: string
$$ref: '#/components/schemas/NotFound_Error'
'409':
description: Request Conflict
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
status:
type: string
errorMessage:
type: string
$$ref: '#/components/schemas/400_Error'
'500':
description: Server Error
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'502':
description: Bad Gateway
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'503':
description: Service Unavailable
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'504':
description: Gateway Timeout
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
parameters:
- name: account-id
description: The unique identifier of your account
in: path
required: true
schema:
type: string
x-code-samples:
- lang: cURL
label: cURL
source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/retry' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"esim-profile-switch-request-id\": \"\",\n \"eids\": [\n \"\",\n \"\"\n ],\n \"skip-session-check\": \"false\"\n}'"
- lang: js
label: NodeJs
source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/retry',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"esim-profile-switch-request-id\": \"\",\n \"eids\": [\n \"\",\n \"\"\n ],\n \"skip-session-check\": \"false\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n"
- lang: java
label: Java
source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"esim-profile-switch-request-id\\\": \\\"\\\",\\n \\\"eids\\\": [\\n \\\"\\\",\\n \\\"\\\"\\n ],\\n \\\"skip-session-check\\\": \\\"false\\\"\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/retry\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();"
- lang: cs
label: C#
source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/retry\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"esim-profile-switch-request-id\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"eids\"\": [\" + \"\\n\" +\n@\" \"\"\"\",\" + \"\\n\" +\n@\" \"\"\"\"\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"skip-session-check\"\": \"\"false\"\"\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
- lang: PHP
label: Php
source: " '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/retry',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"esim-profile-switch-request-id\": \"\",\n \"eids\": [\n \"\",\n \"\"\n ],\n \"skip-session-check\": \"false\"\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
- lang: py
label: Python
source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-switch-requests/retry\"\n\npayload = json.dumps({\n \"esim-profile-switch-request-id\": \"\",\n \"eids\": [\n \"\",\n \"\"\n ],\n \"skip-session-check\": \"false\"\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
security:
- {}
- Auth: []
- api_key: []
/v1/accounts/{account-id}/esim-profile-enable-requests:
post:
tags:
- eSIM Profile Management
summary: Create An Enable Profile Request
description: Create an enable profile request for an account. Enables a specified profile on the eSIM.
requestBody:
content:
application/json:
schema:
type: object
properties:
enable:
type: object
properties:
subscriptions:
type: array
items:
type: object
properties:
eid:
type: string
description: The unique identifier of the eSIM
example: '000000000000000000000'
iccid:
type: string
description: Unique identifier of the profile to be enabled
example: '0000000000000000'
required:
- eid
- iccid
description: ' '
skip-session-check:
type: boolean
example: false
description: Used to skip the initial in-session check for an eSIM
disable-autoretry:
type: boolean
example: false
description: Disables retry of RSP steps based on in-session event when set to true, when set to false the RSP step will be retried max 5 times
required:
- subscriptions
description: Enable profile request
required:
- enable
$$ref: '#/components/schemas/CreateAnEnableProfileRequest0'
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
request-id:
type: string
description: The unique identifier of the request created
example: cmp-cpro-request-11111
message:
type: string
description: Acknowledgement message
example: Your request has been acknowledged
description: Response object
status:
type: string
description: The status of request submission
example: success
$$ref: '#/components/schemas/200CreateAnEnableProfileRequest0'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error-message:
type: string
description: Reason for request failure
example: Invalid EIDs
validation-error:
type: array
items:
type: object
properties:
error-message:
type: string
description: Reason for the rejection of the EID
example: EID not found
eid:
type: string
description: The unique identifier of the rejected eSIM
example: '000000000000000000000'
description: Error response object
status:
type: string
description: The status of request submission
example: error
$$ref: '#/components/schemas/400CreateAnEnableProfileRequest0'
'401':
description: Unauthorised User
content:
application/json:
schema:
required:
- error
- message
type: object
properties:
error:
type: integer
format: int32
message:
type: string
$$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'404':
description: The Specified Resource Was Not Found
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
INFO:
type: string
$$ref: '#/components/schemas/NotFound_Error'
'409':
description: Request Conflict
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
status:
type: string
errorMessage:
type: string
$$ref: '#/components/schemas/400_Error'
'500':
description: Server Error
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'502':
description: Bad Gateway
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'503':
description: Service Unavailable
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'504':
description: Gateway Timeout
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
parameters:
- name: account-id
description: The unique identifier of your account
in: path
required: true
example: cmp-pp-org-000
schema:
type: string
x-code-samples:
- lang: cURL
label: cURL
source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-enable-requests' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"enable\": {\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n },\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\"\n }\n}'"
- lang: js
label: NodeJs
source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-enable-requests',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"enable\": {\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n },\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n"
- lang: java
label: Java
source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"enable\\\": {\\n \\\"subscriptions\\\": [\\n {\\n \\\"eid\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n },\\n {\\n \\\"eid\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n }\\n ],\\n \\\"skip-session-check\\\": \\\"\\\",\\n \\\"disable-autoretry\\\": \\\"\\\"\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-enable-requests\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();"
- lang: cs
label: C#
source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-enable-requests\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"enable\"\": {\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"eid\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"eid\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"skip-session-check\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"disable-autoretry\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
- lang: PHP
label: Php
source: " '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-enable-requests',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"enable\": {\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n },\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\"\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
- lang: py
label: Python
source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-enable-requests\"\n\npayload = json.dumps({\n \"enable\": {\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n },\n {\n \"eid\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\"\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
security:
- {}
- Auth: []
- api_key: []
/v1/accounts/{account-id}/esim-profile-download-requests:
post:
tags:
- eSIM Profile Management
summary: Create A Download Profile Request
description: Create a download profile request for an account. Downloads a new profile to the eSIM and activates the subscription.
requestBody:
content:
application/json:
schema:
type: object
properties:
download:
type: object
properties:
activation-profile-id:
type: string
description: The unique identifier of the activation profile
example: cmp-prov-ap-11111
skip-session-check:
type: boolean
example: false
description: Used to skip the initial in-session check for an eSIM
disable-autoretry:
type: boolean
example: false
description: Disables retry of RSP steps based on in-session event when set to true, when set to false the RSP step will be retried max 5 times
sku:
type: string
description: The Stock Keeping Unit (SKU) number of a device type with an embedded SIM which is required for switching to VZW profile if IMEI is not provided
example: VZW00000000
subscriptions:
type: array
items:
type: object
properties:
eid:
type: string
description: The unique identifier of the eSIM
example: uniqueStr
imei:
type: string
description: IMEI is a 14 - 16 digit identifier of the device which is required for activating a KORE VZW subscription
example: '111111111111111'
required:
- eid
description: ' '
service-type-info:
type: object
properties:
aus-ipnd-info:
type: object
properties:
address:
type: string
description: Address of the user
example: uniqueStr
title:
type: string
description: Title of the user (Mr/Mrs/Ms)
example: Mr/Mrs/Ms
first-name:
type: string
description: First Name of the user
example: uniqueStr
last-name:
type: string
description: Last Name of the user
example: uniqueStr
description: IPND information is mandatory for activating a KORE TELS2 subscription
description: Carrier specific information required for activating a subscription
required:
- activation-profile-id
- subscriptions
description: Download profile request
required:
- download
$$ref: '#/components/schemas/CreateADownloadProfileRequest0'
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
request-id:
type: string
description: The unique identifier of the request created
example: cmp-cpro-request-11111
message:
type: string
description: Acknowledgement message
example: Your request has been acknowledged
description: Response object
status:
type: string
description: The status of request submission
example: success
$$ref: '#/components/schemas/200CreateADownloadProfileRequest0'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error-message:
type: string
description: Reason for request failure
example: Invalid EIDs
validation-error:
type: array
items:
type: object
properties:
error-message:
type: string
description: Reason for the rejection of the EID
example: uniqueStr
eid:
type: string
description: The unique identifier of the rejected eSIM
example: uniqueStr
description: Error response object
status:
type: string
description: The status of request submission
example: error
$$ref: '#/components/schemas/400CreateADownloadProfileRequest0'
'401':
description: Unauthorised User
content:
application/json:
schema:
required:
- error
- message
type: object
properties:
error:
type: integer
format: int32
message:
type: string
$$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'404':
description: The Specified Resource Was Not Found
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
INFO:
type: string
$$ref: '#/components/schemas/NotFound_Error'
'409':
description: Request Conflict
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
status:
type: string
errorMessage:
type: string
$$ref: '#/components/schemas/400_Error'
'500':
description: Server Error
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'502':
description: Bad Gateway
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'503':
description: Service Unavailable
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
'504':
description: Gateway Timeout
headers:
Access-Control-Allow-Origin:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Methods:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Credentials:
style: simple
explode: false
schema:
type: string
Access-Control-Allow-Headers:
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: object
properties:
message:
type: string
$$ref: '#/components/schemas/xxx_Error'
parameters:
- name: account-id
description: The unique identifier of your account
in: path
required: true
example: cmp-pp-org-000
schema:
type: string
x-code-samples:
- lang: cURL
label: cURL
source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-download-requests' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"download\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"address\": \"\",\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\"\n }\n }\n }\n}'"
- lang: js
label: NodeJs
source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-download-requests',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"download\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"address\": \"\",\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\"\n }\n }\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n"
- lang: java
label: Java
source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"download\\\": {\\n \\\"activation-profile-id\\\": \\\"\\\",\\n \\\"subscriptions\\\": [\\n {\\n \\\"eid\\\": \\\"\\\",\\n \\\"imei\\\": \\\"\\\"\\n },\\n {\\n \\\"eid\\\": \\\"\\\",\\n \\\"imei\\\": \\\"\\\"\\n }\\n ],\\n \\\"skip-session-check\\\": \\\"\\\",\\n \\\"disable-autoretry\\\": \\\"\\\",\\n \\\"sku\\\": \\\"\\\",\\n \\\"service-type-info\\\": {\\n \\\"aus-ipnd-info\\\": {\\n \\\"address\\\": \\\"\\\",\\n \\\"title\\\": \\\"\\\",\\n \\\"first-name\\\": \\\"\\\",\\n \\\"last-name\\\": \\\"\\\"\\n }\\n }\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-download-requests\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();"
- lang: cs
label: C#
source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-download-requests\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"download\"\": {\" + \"\\n\" +\n@\" \"\"activation-profile-id\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"eid\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imei\"\": \"\"\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"eid\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imei\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"skip-session-check\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"disable-autoretry\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"sku\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"service-type-info\"\": {\" + \"\\n\" +\n@\" \"\"aus-ipnd-info\"\": {\" + \"\\n\" +\n@\" \"\"address\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"title\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"first-name\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"last-name\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
- lang: PHP
label: Php
source: " '{{baseUrl}}/v1/accounts/{account-id}/esim-profile-download-requests',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"download\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"skip-session-check\": \"\",\n \"disable-autoretry\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"address\": \"\",\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\"\n }\n }\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
- lang: py
label: Python
source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/esim-profile-download-requests\"\n\npayload = json.dumps({\n \"download\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"eid\": \"\",\n \"imei\": \"\"\n },\n {\n \"eid\": \"