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
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.
This endpoint can be called to find what services are available at a given address.
An address query parameter must be supplied specifying address ID and type as described above.
If required, a particular supplier or list of suppliers can be specified in the request; otherwise the Fibre Cafe will check with all suppliers as configured for the tenant.
Address identifier of provided type e.g. UPRN to check for service availability
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
If specified, the request will be sent only to the specified supplier(s)
curl -i -X GET \
'https://prod.fibregateway.com/v1/service-availability?address={%22id%22%3A%22200004033694%22%2C%22type%22%3A%22UPRN%22}&suppliers=SUPPLIER1%2CSUPPLIER2&postalCode=string&serviceTypes=BROADBAND%2CETHERNET' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string'Request successful - zero or more services were returned
Unique identifier to identify request and response events across the Fibre Cafe gateway
Returns the available services that a supplier has at the selected address along with site information
System identifier for a supplier on the Fibre Cafe
Address for location associated with the service order.
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Identifying name of the sub unit
Discriminator used to identify the property on a street
Name used to identify the street
Name used to identify the town or city
Name used to identify the country
More specific definition of a property within an urban area.
Optional qualifier for this address
System identifier for the source of this address information
List of services that are available at this address
Unique identifier for this service specification
Name of the service
[ { "supplier": "SUPPLIER1", "address": { … }, "serviceSpecifications": [ … ], "siteInformation": { … } } ]
Journey-led service availability check. Returns a summary of supplier availability, details of any existing lines at the address, and a set of self-describing order options that drive the ordering journey without requiring the consuming system to implement product eligibility or ordering rules.
Each order option includes the supported order types (NEW, TRANSFER, TAKEOVER, START) as an array — options that share the same supplier, service specification and characteristics (e.g. TRANSFER and TAKEOVER) are collapsed into a single entry. Each option also carries appointment requirements and the full set of required and optional service characteristics — pre-populated where the value is known from availability, or flagged as TENANT-sourced where the user must supply them.
Suppliers are queried in parallel. If a supplier fails or has no availability this is reflected in the availabilitySummary; order options are only returned for suppliers with AVAILABLE status.
Address identifier of provided type e.g. UPRN to check for service availability
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
If specified, the request will be sent only to the specified supplier(s)
curl -i -X GET \
'https://prod.fibregateway.com/v2/service-availability?address={%22id%22%3A%22200004033694%22%2C%22type%22%3A%22UPRN%22}&suppliers=SUPPLIER1%2CSUPPLIER2&serviceTypes=BROADBAND%2CETHERNET' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string'Request successful
Unique identifier to identify request and response events across the Fibre Cafe gateway
Address for location associated with the service order.
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Identifying name of the sub unit
Discriminator used to identify the property on a street
Name used to identify the street
Name used to identify the town or city
Name used to identify the country
More specific definition of a property within an urban area.
Optional qualifier for this address
System identifier for the source of this address information
Cross-supplier availability summary for the queried address.
True if at least one supplier returned availability and order options exist.
Number of suppliers that returned a result (AVAILABLE or UNAVAILABLE — excludes FAILED).
Per-supplier availability status.
System identifier for a supplier on the Fibre Cafe.
The availability status returned for a supplier:
Reasons for unavailability. Present when status is UNAVAILABLE.
Represents an error with code to denote origin/cause.
Physical lines or ONTs found at the address across all queried suppliers. Omitted when no existing infrastructure is present.
{ "address": { "identifier": { … }, "name": "TWENTY", "streetNumber": "20", "streetName": "Kingston Road", "locality": "string", "city": "Staines-Upon-Thames", "postcode": "TW184LG", "country": "UK", "subAddress": { … }, "qualifier": "Gold", "source": "OPENREACH", "additionalAttributes": [ … ] }, "availabilitySummary": { "serviceAvailable": true, "supplierCount": 2, "supplierResults": 1, "supplierStatus": [ … ] }, "existingLines": [ { … } ], "orderOptions": [ { … } ] }