Filter By
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.
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.
OAuth 2
Product Documentation
OAuth 2 produces an access token which is required to authorise API calls for a given app.
Authentication
Product Documentation
OAuth 2 produces an access token which is required to authorise API calls for a given app.
Tenure
Product Documentation
The Subscriber Tenure API will allow Partners to enter a date and the product will return a True/ False answer as to if the customers subscription tenure with EE started before this date.
Global Voice Services
Product Documentation
BT one voice customer facing API specs and documentation.
Quote Management (Ethernet)
Product Documentation
Create and retrieve quotes for BT Wholesale Ethernet and Optical products. More information about this API is available in the 'Further information' tab.
The sandbox/test API is a dynamic test environment and should be used for onboarding and…
Order Management And Progress Updates
Product Documentation
Submit, amend or cancel an order, and receive notifications about the order status. This API is based on TMF622.
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.
Pagination
Back to top