Address Support

Addresses must be provided based on identifier and type. Currently the Fibre Gateway supports the following address identifiers:

UPRN - Unique Property Reference Number
NAD / DistrictCode - Openreach National Address Database key - used by BT Wholesale.
ROBT - Rest of BT alternate address key.

When returning results, suppliers should provide the details they hold for this location to allow tenants to reconcile with their records.

Example:

Copy

Copied

{
  "address": {
    "identifier": {
      "id": "200004033694",
      "type": "UPRN"
    },
    "name": "TWENTY",
    "streetNumber": "20",
    "streetName": "Kingston Road",
    "locality": "",
    "city": "Staines-Upon-Thames",
    "postcode": "TW184LG",
    "country": "UK",
    "subAddress": {
      "name": "Strategic Imperatives",
      "unitNumber": "Floor 3"
    }
  }
}

When using BT/Openreach with UPRN based suppliers, tenants need to pass additional address identifiers

e.g.

Copy

Copied

{
  "identifier": {
    "id": "10091846447",
    "type": "UPRN",
    "additionalIdentifiers": [
      {
        "id": "A15104646284",
        "type": "NAD"
      },
      {
        "id": "LS",
        "type": "DistrictCode"
      },
      {
        "id": "R09598326361",
        "type": "ROBT"
      }
    ]
  }
}

The address lookup endpoint can be used to retrieve these values.