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.
Appointment Management
Product Documentation
List available engineering appointments and reserve an engineering visit.
Product And Network Availability
Product Documentation
Determine the services available at customer's location and the status of the existing installed services.
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.
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.
Document Management
Product Documentation
BT Document Management customer facing API specs and documentation.
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.
Address look-up
Product Documentation
This API product allows a developer to search for a specific postal address using detailed information (such as a house number + postcode) or return a candidate list of addresses.
Refund a customer
Product Documentation
Partners can refund transactions in relation to Direct Billing charges. Refunds must always relate to a Direct Billing original transaction.
Network identity
Product Documentation
This API product retrieves the mobile brand of a subscriber, to determine whether they are registered with EE, BT or with a mobile virtual network operator partner (MVNO).
SMS 2 factor authentication
Product Documentation
This API product provides 2 factor authentication flows via SMS, by creating and validating a numerical one-time pin for authenticating a customer via their mobile device.
Content lock
Product Documentation
This API product retrieves the level of content lock for a given account from 3 security levels.
Messaging
Product Documentation
The Messaging API enables a developer to send a single text message (SMS) to EE mobile customers.
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.
BT Wholesale HubCo WHCE
Product Documentation
Place orders for Wholesale Hosted Communications Express from your systems to BT Wholesale HubCo.
Generic Numbering API
Product Documentation
Generic Numbering API facilitates you to place Number Management and Numbering Porting orders.
Order and allocate, activation, deallocation, deactivation & DirectActivation new number.
Create, amend and cancel an order to port in a SingleLine/…
Travel Journey API Platform
Product Documentation
Active Intelligence public exposed transport API.
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…
Network session
Product Documentation
This API product is intended to be called via HTTP over the RAN for later lookup by an authorised client of the Network ID API product. This API resource is an open API that will cache the header enrichment data against a session id (supplied or…
Data pass eligibility
Product Documentation
Retrieves all data passes that this customer is eligible for, and presents them in a list.
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…
Back to top