This endpoint can be called to lookup addresses and, in particular, address identifiers (e.g. UPRN or NAD) 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 for the tenant - contact support for assistance.
Request successful - zero or more addresses were returned
Bad request - supplied parameters were malformed or missing mandatory parameters
Unauthorised access
The client is not permitted to access this resource
Unprocessable entity - invalid data was provided
Unexpected Fibre Gateway error
Not Implemented
Invalid response from the supplier
Fibre Gateway is temporarily unavailable
Timeout or no response from the supplier
[- {
- "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"
}
]
}
]