Filter By
IPEX SingleLine/MultiLine Import Order
Product Documentation
Create, amend and cancel and an order to port in a IP Exchange SingleLine/MultiLine number. It also allows to cease a imported IP Exchange SingleLine/MultiLine number.
IPEX New Number
Product Documentation
Order and allocate, activation & deactivation new number, to a IP Exchange users.
Enter a National Number Group (NNG) along with a quantity (between 1 - 100), to order new telephone numbers.
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.
BT Wholesale HubCo WHCE
Product Documentation
Place orders for Wholesale Hosted Communications Express from your systems to BT Wholesale HubCo.
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…
Verify data
Product Documentation
Validate the service provider information and the data they are using, in order to prevent potential duplicate order failures.
Used to retrieve the following key data for a Reseller: sales tag, reseller id, xxxx.
Used to enter and verify whether proposed…
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…
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.
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.
Appointment Management
Product Documentation
List available engineering appointments and reserve an engineering visit.
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…
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.
Activate port
Product Documentation
Activate the port and progress for SingleLine/MultiLine import and WHC Express orders.
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.
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.
Tenure
Product
Retrieves the Tenure for the associated MSISDN
Overview
The Subscriber Tenure API will return a True or False answer as to if the customers subscription tenure (rather than the contract tenure) with EE has been longstanding.
Know Your Customer
Product Documentation
Know Your Customer (KYC) match offers a mechanism through which a service provider can submit end user (customer) information to validate such as name, address, mobile telephone number to a mobile network operator for comparison against their records. The…
Account Takeover Protection
Product Documentation
Account Takeover Protection uses a suite of attributes relating to the SIM, network and the device that help businesses identify fraudulent behaviour and protect their end customers. Account checks relate to the SIM (SIM Swap), the network (call forward…
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.
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.…
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…
Footfall Data
Product
Provides data on overall footfall in the UK
Overview
The Footfall API provides volumes for overall footfall, footfall density, mobility (time spent in or away home area location) and visits (footfall excluding population observed in home location) for the UK population
Location Analytics
Product
Access insights on footfall activity across any location in UK
The Location Insights API provides reports on visits, home catchment and repeat visits for standard geographies and sites in UK.
Back to top