| API Name | What does it do? |
| Pre-Order APIs | |
| Number Portability Check API | - Enter a number to verify if this is capable of being ported. |
| Geographic Address Management API |
- Enter a postcode to return a full valid UK address, using BT's NAD system (synced with Royal Mail PAF) or where address does not exist/is inaccurate, manually enter an address. |
| Single Line Import Order/ Multi-Line Import Order API | - Enter a area code or location, along with a quantity, to order new telephone numbers for a Company - Locate ported number orders that have had a LCP acceptance, and then allocate, ahead of the port date, to a Company |
| Verify Data API | - Used to retrieve the following key data for a Reseller; Sales Tag, Reseller ID, xxxx - Used to enter and verify whether proposed names for any of the following already exist, Company Domain, Site Name, Site Location Code, Device name (PBX), Trunk name, Username, Extension, Mac address |
| Validate and Qualify Company API | - Validate that the required unique fields, 'Company Name & Company Domain', are not already in use before generating a unique service reference ID that enables numbers to be reserved against a Company. |
| Get Available Numbers API | - Enter CUG ID or Company service id or Site service id to get available new or ported telephone numbers |
| Reserve Numbers (New and Ported) | - Reserve and ringfence numbers (new and ported) |
| Order APIs | |
| Create Order API | - Enter all necessary data to create a new Company along with the following assests; Company, Numbers, Sites, Users inc. add-ons and devices. - Enter all necessary data to create a new Single Line or Multi-Line Number Import, - Enter all necessary data to create a subsequent order to add more services to an existing Company including additional; Numbers, Sites, Users inc. add-ons and devices. |
| Submit Order API | - Submit order based on order reference created in create order API |
| Post Order APIs | |
| Port Activation API | - Post this API to activate the port once HV SL/ML order posted. |
| Order Notification API | - Used to electronically notify the reseller of the status of orders including; Order Acknowledge, Order Line Complete, Order Complete etc. |