Filter By
SIM swap
Product Documentation
The SIM swap product offers a mechanism through which a service provider can request information about when the SIM card was last changed by the mobile customer.
Know Your Customer
Product
Validating and authenticating your customer’s identity
Overview
Whether it’s for shopping, travel or banking, customers are increasingly using their devices to get things done online. Many of these involve an initial account setup, which can be time consuming – and in the past, it’s been possible to set up…
Charge eligibility
Product Documentation
API product can check whether monetary charge can be applied onto a customer’s EE PAYM/PAYG mobile account. This should be used prior to using the Charge API.
Validate and qualify company
Product Documentation
Use this API to validate key data before placing an order on WHC/WHC Express.This will prevent order submission failures.
Validate the required unique fields, 'Company Name & Company Domain', are not already in use before generating a unique service…
Number portability check
Product Documentation
Check whether a particular number range (for WHC Express you can only port a particular number not number range) can be ported based on portState value in response.
Enter a number to verify if this is capable of being ported.
Product Order (Ethernet)
Product Documentation
Place, modify and track Ethernet orders across Etherway Fibre (EAD), Etherflow Connected, Etherflow Internet and Etherway Superfast GEA (SOGEA & FTTP).
Inbound Contact Global Traffic Controller
Product
Apply changes in real-time to your Inbound Contact Global service
Inbound Contact Global Call Traffic Controller API creates an entirely new method to manage, rebalance and reroute call traffic in real time. Choose from a range of access numbers, egress methods and routing logic.
The Controller API is the natural…
Ethernet
Product
End to End APIs for every step of the Wholesale Ethernet journey
Overview
BT Wholesale Ethernet (WE) is a national layer 2 Ethernet service*, targeting UK communication providers and It’s available across a number of bandwidth options from 0.2Mbps to 10Gbps.
As we evolve in a post-pandemic world, we are always looking…
Foreign Visitor API
Product Documentation
Provides volumes for the overall footfall of foreign visitors to the UK by country of origin, foreign visitors footfall locations, foreign visitors footfall based on their activity on the first day of arrival and foreign visitors footfall based on their…
UK Trips API
Product Documentation
Provides volumes of MSOA level origin destination trip connections at monthly and daily level for the UK population, API returns signed URL to access UK trips CSV file containing the data, time expiry for signed URL is 15 seconds. When data doesn't exist…
UK Travellers API
Product Documentation
Provides volumes of international journeys, journey returns and stay durations made by UK roamers as a cross-border origin-destination report with a trip origin abroad and a destination within the UK for UK nationals. Data is provided by international…
Document Management
Product Documentation
BT Document Management customer facing API specs and documentation.
IMEI Lookup
Product
Retrieves the IMEI for the associated MSISDN.
Overview
An IMEI stands for International Mobile Equipment Identity. Think of it as your phone's fingerprint — it's a 15-digit number unique to each device. We share IMEI numbers to enable tracking of smartphones that may be stolen or compromised
Our…
Address Management
Product Documentation
Search the Rest of BT (RoBT) and Openreach address databases to find address records and keys to be used in orders. Where no suitable matching address is found, create an address and obtain a temporary address key.
Wholesale Hosted Communications (WHC) & WHC Express
Product
Electronically pass orders for Wholesale Hosted Communication (WHC) from your systems to BT.
Overview
Wholesale Hosted Communications (WHC) and WHC Express APIs offer you an alternative to traditional portal-based order placement for both you, and your end customers.
WHC and WHC Express APIs enable you to pass orders directly to BT’s…
Order Notification Import Orders
Product Documentation
Automated notifications on progress of orders placed via the Import Order APIs will be sent directly to the provided URL ('callback URL') provided at onboarding.
Submit WHC Order
Product Documentation
Submit the order request using order reference received from ‘Create WHC order’ API response. This API could be used only once ‘Create WHC order’ posted successfully.
Multi Line Import Order
Product Documentation
Place, amend or cancel an order to port a Hosted Voice Multiline Number.
SingleLine/MultiLine import order
Product Documentation
Place, amend or cancel an order to port a Hosted Voice SingleLine/MultiLine number.
Once order creation request is sent then we will be getting acknowledgment immediately and further notifications related to order progression will be sent to callback url…
Reserve/RingFence numbers
Product Documentation
RingFence numbers for WHC
Order and allocate new numbers, and/or allocate ported number ranges to a WHC Company to then be onward consumed by its sites, features and users.
Enter a areaCode or location, along with a quantity, to order new telephone…
Activate port
Product Documentation
Activate the port and progress for SingleLine/MultiLine import and WHC Express orders.
Road Network
Product
Provides strategic insight into and around major road networks
Overview
This API is focused on providing understanding for strategic insight into and around Major Road Networks (MRN). A current governmental policy objective is identifying improvements and enhancements to infrastructure to enable improved…
Get available numbers
Product Documentation
Get available new numbers that you want to reserve against company, site or user.
Enter cugId or company service id or site service id to get available new or ported telephone numbers.
Encrypt personally identifying information
Product Documentation
This API product converts a customer’s mobile telephone number (MSISDN) into the secure tokenised Anonymised Mobile Subscriber Reference (AMSR) and vice versa.
Age Eligibility
Product Documentation
This product offers a mechanism for a service provider to request information related to a user’s mobile phone account which can be used for spotting potentially fraudulent behaviour.
Back to top