Skip to main content

Complete Mobile

  • Wholesale

Complete Mobile offers business mobility solutions via the Wholesale/resale channels, from basic data and calling to value-added services.

Integrating Complete Mobile into your business applications increases self-serve, agility and flexibility to operate your mobile services.

The following information is to help you order BT Wholesale Complete Mobile products using our APIs. 

You can use our APIs for the following types of orders: 

  • Activate an existing physical SIM for a customer.
  • Activate a digital eSIM for a compatible device.

 

Get startedAPI reference Tutorials

APIs included

BT

OAuth 2

Identity and Authentication

OAuth 2 produces an access token which is required to authorise API calls for a given app.

Product Documentation

Complete Mobile order management and notifications

Wholesale

These APIs allow you to submit and manage Compete Mobile orders. These APIs use OAuth2 for authentication and are based on the TMF622 API.

Product Documentation

How it works

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
     
    In your JSON payload, include:
     
    • your externalId,
    • requested dates,
    • relatedParty account information, and
    • an array of productOrderItem objects.
  3. Define order items
     
    Populate the productOrderItem array with the building blocks for each activation. You can combine different types in a single order.

    • For each existing SIM activation, add one item:
      Create a single productOrderItem for the subscription.  Inside its product object, use a productRelationship to link to the existing SIM's serial number.
    • For each new eSIM activation, add a pair of items:
      Create two productOrderItem objects:
      • The first defines the new eSIM product.
      • The second defines the subscription service and uses a productOrderItemRelationship to link back to the ID of its corresponding eSIM item.

    To create a mixed order, add the required blocks for each activation to the array. 

  4. Submit the order

    Send the complete JSON payload in a POST request 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

    Prepare to receive asynchronous status notifications from our system.

Getting started

Whether you are exploring our sandbox or are ready to integrate, we have the resources you need.

If you are new to our portal, the first step is to register and create a sandbox application. This will give you the credentials to start making test calls to the API.

If you are already registered, dive into our comprehensive technical documentation to understand the API in detail. Our tutorials provide step-by-step guidance for the most common use cases.

Get startedAPI reference Tutorials

Benefits and features

 

  • Fast, reliable 4G and 5G throughout the UK
  • Flexibility with 30-day SIM-only terms
  • Simple, risk-free roaming that you can monetise
  • Data packages and price caps that give customers peace of mind

Product detailsContact us

a blond woman sitting in an office in front of a monitor

Help and support

Have questions? 

Explore our Knowledge Centre. Find "how-to" guides to walk you through setup and app creation, visit the troubleshooting section to resolve common errors, and get quick answers in our FAQ.

Knowledge Centre

Unfamiliar with a term?

Our glossary defines the key technical terms and acronyms used across the developer portal.                                                                                                                           

Glossary

Contact us

If you need to contact our support team, use the contact form. 

Back to top