Complete Mobile

Use the Complete Mobile API to activate existing SIMs or new eSIMs via a TMF-aligned, RESTful interface.

1. Get access token
   
   Authenticate using an OAuth 2.0 bearer token. Use this token in the Authorization header for all subsequent requests.
    
2. Construct productOrder payload
    
   Construct a JSON payload and send it to the /productOrder endpoint. Whether you are creating a new subscription or modifying an existing one, this is your single endpoint for all order-related tasks.
    
3. Define order items
    
   Inside your order, an array of productOrderItem objects defines the specific actions you want to perform.
   • New activations: Use action: "add". Link a subscription to a physical SIM with a productRelationship or to a new eSIM with a productOrderItemRelationship.
   • Port-ins: Add a nested "PORTIN" item to a new subscription order, providing the PAC code and number to be ported.
   • SIM swaps: Use action: "modify" on an existing subscription to link it to a new SIM.
   • To create a mixed order, add the required blocks for each action to the array.
      
4. Submit the order
   
   Send the complete JSON payload to the /productOrder endpoint.
   
   The API returns a synchronous 202 Accepted status code if your request is valid.
   
   Note: This confirms we have received your request. The unique BT order reference is not created yet; it will be sent in the first notification.
    
5. Listen for order notifications
   
   After accepting your order with a 202 Accepted status, our system processes it in the background. We send asynchronous webhook notifications to your system as the order progresses through states like acknowledged, inProgress, and finally completed or failed.