Skip to content
Address Lookup/
Find address details incl...

Fibre Cafe : Tenant API (1.17)

Introduction

The Fibre Cafe is a scalable, unified platform to support L2C provisioning, in-life modification/cease and T2R trouble resolution between communication providers (CP) and network operators or aggregators.

CPs are known as 'tenants' on the Fibre Cafe and communicate with this API - the Fibre Cafe's Tenant API. The network operators and aggregators providing the underlying services are known as 'suppliers'.

The Fibre Cafe will route requests from this API to appropriate supplier(s). Tenants will be configured to use suppliers based on requirements and commercial agreements.

Initial availability and appointing requests are synchronous. Ordering requests are asynchronous with confirmation and updates via KCIs (Keep Customer Informed).

Note: Order updates (KCIs) will be sent to the Tenant Updates API which the tenant must implement. __

© 2022-2026 Strategic Imperatives

Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://prod.fibregateway.com/v1

Address Lookup

Used to look up address identifiers and details for a given postal code or UPRN.

This is not implemented by all suppliers - it is primarily provided to assist with NAD/District Code lookup for suppliers operating on the Openreach network.

This follows the concepts in TMF673 - Address Management API.

Operations

Find address details including UPRN, NAD and other identifiers.

Request

This endpoint can be called to lookup addresses and, in particular, address identifiers (e.g. NAD and District Code) to use in subsequent calls.

Postal code or UPRN must be supplied. When using postal code, additional context such as house name, street number and/or street should be supplied to reduce returned results (results may be truncated by the underlying address source).

Availability of this endpoint requires an address source to be configured - it is primarily provided to assist with NAD/District Code lookup for suppliers operating on the Openreach network.

Security
oauth2
Query
postalCodestring

Postal code of address to lookup - this or UPRN must be supplied

uprnstring

UPRN of address to lookup - this or postal code must be supplied

namestring

Identifying name of address to filter when searching by postal code

streetNumberstring

Numeric identifier of address to filter when searching by postal code

streetNamestring

Name identifying the street to filter when searching by postal code

supplierstring

Supplier to use. If not specified, the tenant's default configured supplier will be used.

Headers
X-Request-IDstringrequired

Unique identifier to link request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

curl -i -X GET \
  'https://prod.fibregateway.com/v1/addresses?postalCode=string&uprn=string&name=string&streetNumber=string&streetName=string&supplier=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string'

Responses

Request successful - zero or more addresses were returned

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/jsonArray [
identifierobject(AddressIdentifier)required

Address identifier for location including type of identifier.

identifier.​idstring[ 1 .. 20 ] charactersrequired

Address identifier of given type

Example: "A00000031882"
identifier.​typestring^[A-Za-z]{1,15}$required

Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT

Example: "NAD"
identifier.​additionalIdentifiersArray of objects(SecondaryAddressIdentifier)non-empty

Additional address identifiers where available/required for subsequent operations

namestring[ 1 .. 50 ] charactersread-only

Identifying name of the sub unit

Example: "TWENTY"
streetNumberstring[ 1 .. 50 ] charactersread-only

Discriminator used to identify the property on a street

Example: "20"
streetNamestring[ 1 .. 100 ] charactersread-only

Name used to identify the street

Example: "Kingston Road"
localitystring[ 1 .. 50 ] charactersread-only

Name used to identify the area

citystring[ 1 .. 50 ] charactersread-only

Name used to identify the town or city

Example: "Staines-Upon-Thames"
postcodestring[ 1 .. 12 ] charactersread-only

Postal code

Example: "TW184LG"
countrystring[ 1 .. 50 ] charactersread-only

Name used to identify the country

Example: "UK"
subAddressobject(SubAddress)read-only

More specific definition of a property within an urban area.

qualifierstring[ 1 .. 50 ] charactersread-only

Optional qualifier for this address

Example: "Gold"
sourcestring^\w{1,20}$

System identifier for the source of this address information

Example: "OPENREACH"
additionalAttributesArray of objects(AddressAttribute)>= 0 items

Additional attributes of an address (where available) e.g.

  • UNINHABITED
  • HOTSITE
  • TEMPORARY
]
Response
application/json
[
  {
    "identifier": { … },
    "name": "TWENTY",
    "streetNumber": "20",
    "streetName": "Kingston Road",
    "locality": "string",
    "city": "Staines-Upon-Thames",
    "postcode": "TW184LG",
    "country": "UK",
    "subAddress": { … },
    "qualifier": "Gold",
    "source": "OPENREACH",
    "additionalAttributes": [ … ]
  }
]

Service Availability

Retrieve what services (if any) the supplier has available for a given address.

This follows the concepts in TMF645 - Service Qualification API and TMF673 - Address Management API.

Operations

Quote Management

Create and manage a quote to provide service at requested sites. This follows the concepts in TMF648 - Quote Management API.

Operations

Appointment Management

Retrieve and reserve appointments for installing or maintaining a service at a given address.

This follows the concepts in TMF646 - Appointment API.

Operations

Order Management

Create and manage an order to provide, cease or modify a service at a given address.

This follows the concepts in TMF641 - Service Ordering Management API.

Operations

Service Test Management

Operations

Service Problem Management

Operations