Find address details including UPRN, NAD and other identifiers.

get/addresses

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.

Securityoauth2
Request
query Parameters
postalCode
string

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

uprn
string

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

name
string

Identifying name of address to filter when searching by postal code

streetNumber
string

Numeric identifier of address to filter when searching by postal code

streetName
string

Name identifying the street to filter when searching by postal code

supplier
string

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

header Parameters
X-Request-ID
required
string

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

X-Conversation-ID
required
string

Identifier to track message journey across the Fibre Cafe gateway

Responses
200

Request successful - zero or more addresses were returned

400

Bad request - supplied parameters were malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Cafe error

501

Not Implemented

502

Invalid response from the supplier

503

Fibre Cafe is temporarily unavailable

504

Timeout or no response from the supplier

Response samples
application/json
[
  • {
    • "identifier": {
      • "id": "A00000031882",
      • "type": "NAD",
      • "additionalIdentifiers": [
        • {
          • "id": "A00000031882",
          • "type": "NAD"
          }
        ]
      },
    • "name": "TWENTY",
    • "streetNumber": "20",
    • "streetName": "Kingston Road",
    • "locality": "string",
    • "city": "Staines-Upon-Thames",
    • "postcode": "TW184LG",
    • "country": "UK",
    • "subAddress": {
      • "name": "Strategic Imperatives",
      • "unitNumber": "Floor 3"
      },
    • "qualifier": "Gold",
    • "source": "OPENREACH",
    • "additionalAttributes": [
      • {
        • "name": "UNINHABITED",
        • "value": "true"
        }
      ]
    }
]