---
title: "Look Up Addresses By Postcode"
method: GET
path: "/Address/Lookup"
tags: ["Address"]
---

# Look Up Addresses By Postcode

`GET /Address/Lookup`

**Requires permissions:** *Guardian* or *Parent*

Returns the deliverable addresses at a UK postcode (Royal Mail PAF, via Ideal Postcodes), already mapped onto the fields the details form uses. Advisory: the caller can always type an address instead. Returns Unavailable rather than an error when the service is not configured or is unreachable, so an outage never stops someone submitting their own address.

## Query parameters

- `postcode` string, nullable
- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Response `200`

Success — Found, NotFound or Unavailable

- LookupAddressResponse
  - `outcome` 0 | 1 | 2
  - `addresses` LookupAddressFoundAddress[]
    - `addressLine1` string, nullable
    - `addressLine2` string, nullable
    - `locality` string, nullable
    - `administrativeArea` string, nullable
    - `postcode` string, nullable
    - `country` string, nullable
    - `label` string
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/fab57bf5558a/schema)