Reset eSIM Profile
Overview
Description
Business Rules
Key
Icon | Description |
---|---|
Telcoinabox | |
Service Provider / Website |
API Sequence
Step | Action | Publisher | Consumer | API Guide | M/O | Comments/Other Info |
---|---|---|---|---|---|---|
1 | Confirm Profile Status | Get eSIM Details | Mandatory | Use requestType = SIM Details. Check profileState is one of the following: RELEASED, LINKED, AVAILABLE, ERROR. If profile state is not one of the above then proceed to step 3. | ||
2 | Reset Profile Status | Manage eSIM | Optional | Use orderType = Reset Esim, Use targetState = RELEASED. If the reset is successful you will receive the profileState of RELEASED in the response. If profileState is not RELEASED then the reset has failed, proceed to step 3 | ||
3 | Request an OTP | Manage OTP | Optional (If performing ID validation by another method or with own OTP solution) | Use requestType = getOtp | ||
4 | Verify an OTP | Manage OTP | Optional (If performing ID validation by another method or with own OTP solution) | Use requestType = verifyOtp | ||
5 | Perform SIM Swap | Replace a SIM | Optional | If moving to another eSIM then, Use esim = true, Use qrcode = true if you need Octane to send the QR code to the customers email address (Note that you must have a notification setup with the template code MBQRCODE in order for email QR code to be delivered by Octane). Use qrcode = false if you wish to retrieve the QR code via API and email or display to your customer from your system | ||
6 | Query Order | Query an Order | Optional | Check the status of the order (if using to poll orders to completion limit requests to 1 every 30 mins). | ||
7 | Retrieve QR Code | Get eSIM Details | Optional | If you have chosen isQRcode = false you can retrieve the QR code via API. requestType = QR Code, msn = serviceNumber returned in Query Order |
Modified at 2024-04-03 05:52:17