# Find address details including UPRN, NAD and other identifiers.

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.

Endpoint: GET /addresses
Version: 1.17
Security: oauth2

## Header parameters:

  - `X-Request-ID` (string, required)
    Unique identifier to link request and response events across the Fibre Cafe gateway

  - `X-Conversation-ID` (string, required)
    Identifier to track message journey across the Fibre Cafe gateway

## 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.

## Response 200 fields (application/json):

  - `identifier` (object, required)
    Address identifier for location including type of identifier.

  - `identifier.id` (string, required)
    Address identifier of given type
    Example: "A00000031882"

  - `identifier.type` (string, required)
    Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
    Example: "NAD"

  - `identifier.additionalIdentifiers` (array)
    Additional address identifiers where available/required for subsequent operations

  - `name` (string)
    Identifying name of the sub unit
    Example: "TWENTY"

  - `streetNumber` (string)
    Discriminator used to identify the property on a street
    Example: "20"

  - `streetName` (string)
    Name used to identify the street
    Example: "Kingston Road"

  - `locality` (string)
    Name used to identify the area

  - `city` (string)
    Name used to identify the town or city
    Example: "Staines-Upon-Thames"

  - `postcode` (string)
    Postal code
    Example: "TW184LG"

  - `country` (string)
    Name used to identify the country
    Example: "UK"

  - `subAddress` (object)
    More specific definition of a property within an urban area.

  - `subAddress.unitNumber` (string)
    Discriminator used to identify the sub unit
    Example: "Floor 3"

  - `qualifier` (string)
    Optional qualifier for this address
    Example: "Gold"

  - `source` (string)
    System identifier for the source of this address information
    Example: "OPENREACH"

  - `additionalAttributes` (array)
    Additional attributes of an address (where available)
e.g.

- UNINHABITED
- HOTSITE
- TEMPORARY

  - `additionalAttributes.name` (string, required)
    Name of the attribute
    Example: "UNINHABITED"

  - `additionalAttributes.value` (string, required)
    Value for this attribute
    Example: "true"

## Response 400 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 401 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 422 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 500 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 501 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 502 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 504 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]


## Response 403 fields

## Response 503 fields