Filter By
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…
Call Divert
Product Documentation
This product confirms an outbound call is going to its intended number, and isn’t being diverted to a potentially fraudulent one – giving customers more security and greater peace of mind.
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.
Charge eligibility
Product Documentation
API product can check whether monetary charge can be applied onto a customer’s EE PAYM/PAYG mobile account. This should be used prior to using the Charge API.
Validate and qualify company
Product Documentation
Use this API to validate key data before placing an order on WHC/WHC Express.This will prevent order submission failures.
Validate the required unique fields, 'Company Name & Company Domain', are not already in use before generating a unique service…
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.
Product Order (Ethernet)
Product Documentation
Place, modify and track Ethernet orders across Etherway Fibre (EAD), Etherflow Connected, Etherflow Internet and Etherway Superfast GEA (SOGEA & FTTP).
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 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.
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.
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.
Back to top