Octane REST API
  1. Mobile Flows
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • v1
        • Create Order (NBN Activation)
        • Create Order (NBN Modification)
        • Create Order (NBN Disconnection)
        • Cancel (NBN Activation) Order
        • Get Order Detail (NBN)
        • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. Mobile Flows

Reset eSIM Profile

Overview#

Use this flow to reset an eSIM (as part of troubleshooting an issue with an eSIM activation).

Description#

This flow can be performed during the activation flow if the user has downloaded their profile but is unable to use their eSIM. You can only perform the Reset eSIM if the eSIM profile is an error status (listed below). If the reset request fails then you will need to perform a sim swap (ensuring you adhere to ACMA high risk transaction rules around OTP).

Business Rules#

Reset eSIM can only be performed if the profile status is one of the following: RELEASED, LINKED, AVAILABLE, ERROR

Key#

IconDescription
telcoinabox.pngTelcoinabox
SP_verysmall.pngService Provider / Website

API Sequence#

StepActionPublisherConsumerAPI GuideM/OComments/Other Info
1Confirm Profile Statustelcoinabox.pngSP_verysmall.pngGet eSIM DetailsMandatoryUse 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.
2Reset Profile Statustelcoinabox.pngSP_verysmall.pngManage eSIMOptionalUse 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
3Request an OTPtelcoinabox.pngSP_verysmall.pngManage OTPOptional (If performing ID validation by another method or with own OTP solution)Use requestType = getOtp
4Verify an OTPtelcoinabox.pngSP_verysmall.pngManage OTPOptional (If performing ID validation by another method or with own OTP solution)Use requestType = verifyOtp
5Perform SIM Swaptelcoinabox.pngSP_verysmall.pngReplace a SIMOptionalIf 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
6Query Ordertelcoinabox.pngSP_verysmall.pngQuery an OrderOptionalCheck the status of the order (if using to poll orders to completion limit requests to 1 every 30 mins).
7Retrieve QR Codetelcoinabox.pngSP_verysmall.pngGet eSIM DetailsOptionalIf 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
Previous
Activate Postpaid (Port MSN - eSIM)
Next
Mobile Data Pool Flow
Built with