Address details
Address
Address details
Resolve a UK PAF address id into coordinates plus a formatted flat-level address.
GET
Address details
Overview
Resolves a single addressid — a UK PAF UDPRN taken from an autocomplete item — into its flat-level details: latitude, longitude, a formatted one-line address, the postcode, and the first address line.
Call this once the user selects a suggestion, to prefill the address form (including a map pin from lat/lng). The server proxies the Ideal Postcodes UK PAF API; the provider key stays server-side.
Authentication
Bearer <accessToken> required. Scope: user.
Path parameters
None.Query parameters
| Param | Type | Required | Notes | Example |
|---|---|---|---|---|
id | string | yes | The provider address id (UK PAF UDPRN) from an autocomplete item. Min length 1. | 17683155 |
Request body
None.Response — 200 OK
| Field | Type | Notes | Example |
|---|---|---|---|
lat | number | Latitude (WGS84). | 51.5539 |
lng | number | Longitude (WGS84). | -0.1658 |
formattedAddress | string | Non-empty address lines + post town, comma-joined. | Flat 118, Waxham, Mansfield Road, London |
postcode | string | UK postcode, provider-normalized. | NW3 2JL |
line1 | string | First address line. | Flat 118 |
Example response
Error responses
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_FAILED | id is missing or empty. |
| 401 | UNAUTHENTICATED | Missing, malformed, or expired access token. |
| 404 | NOT_FOUND | No address exists for the given id. |
| 502 | UPSTREAM_FAILURE | The address provider failed or returned an unexpected response. |
| 503 | ADDRESS_LOOKUP_NOT_CONFIGURED | The server has no API key configured for the selected ADDRESS_PROVIDER (LOQATE_API_KEY by default, or IDEAL_POSTCODES_API_KEY). |
Side effects
None — this is a pure read that proxies a third-party lookup.See also
- Address autocomplete — obtain an
idto resolve here.