Ethernet API Summary
Basic page
API Name
What does it do?
Geographic Address Management API
- Enter a postcode to return a full valid UK address, using BT's NAD system (synced with Royal Mail PAF) or where address does not exist/is inaccurate, manually enter an address…
Etherway Fibre
API Basic page
Etherway Product Characteristics:
Product Display Name on Business Zone
Current Online Journey
Product Alias Name - API Journey
Comments
Etherway
Etherway
Business Zone
Attribute Name
API Journey
Attribute Name…
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…
Product order (WHC/WHC Express)
Product Documentation
Place an order for WHC/WHC Express and any of its core assets; company, numbers, sites and users(WHC Express does not support site and numbers as orderable entity).
Once order is created and submitted, further notifications related to order progression…
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.
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…
Etherflow Connected
API Basic page
Product Alias Name - API Journey
Comments
Etherflow - Connected
API Journey
Attribute Name
Sample value
Business Zone
Attribute Allowed Value
API Journey
Attribute Allowed Value
Format/Regex
Mandatory/Optional
Comments…
Etherway Superfast GEA
API Basic page
Product Display Name on Business Zone
Current Online Journey
Product Alias Name - API Journey
Comments
Etherway Superfast GEA
Etherway Superfast GEA
Product…
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.
WHC APIs
Basic page
API Name
What does it do?
Pre-Order APIs
Number Portability Check API
- Enter a number to verify if this is capable of being ported.
Geographic Address Management API
- Enter a postcode to return a full valid UK address, using…
Knowledge centre
Page Builder
Knowledge centre
Getting started
It’s easy to get started with our suite of APIs and start to discover how our APIs can…
BT Wholesale HubCo WHCE
Product Documentation
Place orders for Wholesale Hosted Communications Express from your systems to BT Wholesale HubCo.
Home Network
Product
Verifies that the customers phone is currently connected to EE's Network
This product will enable you to check whether the customers phone is currently connected to the EE network. We will not give you the location, only a True or False to whether they are on our network.
Sim Swap - CAMARA
Product Documentation
API interface is used by an application to get information about a mobile line latest SIM swap date. It can be easily integrated and used through this secured API and allows SPs (Service Provider) to get this information an easy…
KYC Match - CAMARA
Product
KYC Camara Match with Fuzzy Logic enables flexible identity matching by comparing user-submitted data with BT & EE records, allowing for minor variations and inconsistencies.
The Camara KYC Match API enables real-time identity verification by comparing a user’s mobile subscription data with personal details provided during onboarding. It confirms whether the individual is the legitimate owner of the mobile number, helping…
Getting started
Documentation page
Welcome to the BT developer portal. This guide outlines the end-to-end journey for integrating with our APIs, from initial exploration to launching your application in the production environment.
The process follows four main steps. Each step has links to…
KYC Age Verify - CAMARA
Product
KYC Camara Age Verify confirms a user's age eligibility by securely checking BT & EE subscriber data, enabling compliant access to age-restricted services.
The KYC Age Verify API checks if the subscriber associated with a given phone number is equal to or older than a specified age. This is particularly useful for services that require age verification, such as gambling, alcohol sales, or adult content. The…
Technical Components
Documentation page
Global Fabric Technical Components
Global Fabric takes a modular approach to provide you with cloud-like flexibility so that your network can adapt with your business needs, whilst also providing you with greater control over your Total Cost of Ownership…
Order Journey
Documentation page
Order Journey
Our super-simple order journey, its as easy as 1, 2 3
The three key questions are:
1.Where do you want to connect from?
Choose where you want to connect from, by planning your network deployment using our interactive location tool providing…
Back to top