Filter By
Foreign Visitor Data
Product
Provides data on footfall of foreign visitors in UK
Overview
This API 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…
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 Traveller Data
Product
Provides data on international journeys of UK roamers
Overview
The UK Traveller Data API 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.…
UK Trips Data
Product
Provides data on UK-wide origin-destination matrix
Overview
The UK Trips Data API provides volumes of Middle Layer Super Output areas (MSOA) level origin destination trip connections at monthly and daily level for the UK population.
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…
Address Management (Ethernet)
Product Documentation
Set an address using a UK postcode, or manually create a temporary one, before placing an order.
Appointment Management (Ethernet)
Product Documentation
Users can query for appointment slots based on particular date and book engineer appointment. This is only for standard appointments of Etherway Superfast GEA product.
Order Notification Import Orders (Ethernet)
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.
Product Qualification (Ethernet)
Product Documentation
Provides a standardized mechanism for placing a qualification request, to check offer eligibility with all of the necessary parameters.
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.
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.
Complete Mobile order management and notifications
Product Documentation
These APIs allow you to submit and manage Compete Mobile orders. These APIs use OAuth2 for authentication and are based on the TMF622 API.
external-camara-sim-swaps-api-v1
Proxy Specification
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…
Age Eligibility
Product
Make transactions smoother and safer with Age Eligibility
Overview
As online shopping and contactless service and payments grow in popularity, it’s becoming more important to be able to check a customer’s age remotely. Our Age Eligibility API can help identify customers who are eligible to benefit from a…
KYC Age Verify
Proxy Specification
This API provides the customer with the ability to check if the user of the line is older than a provided age, in order to provide API customer's age-restricted services, access to its age-restricted website etc.
Back to top