Address Match (bulk)

POST1 credit

POST/addresses/match

Fuzzy-match a free-text address + postcode to the most likely UPRN.

Overview

Filters by exact postcode then ranks by trigram similarity on the full address. Falls back to postcode-prefix match if nothing hits.

Handles messy input from forms, spreadsheets, CRMs. Returns the best match plus up to 4 alternatives, each with a confidence score.

Why this endpoint exists

Matching "Flat 2, 12a Bennett Rd" to 12A BENNETT ROAD, FLAT 2 is a two-week project in itself. This endpoint does it in one request.

Body parameters

addressstringRequired

Free-text address, e.g. "9 Bennett Road".

postcodestringRequired

UK postcode, e.g. "LS6 3HN". Case and hyphens are normalised automatically.

Response Schema

match

Object: { uprn, address, postcode, latitude, longitude, confidence }.

alternatives

Array of { uprn, address, postcode, confidence } (up to 4 items).

Example

RequestLive key

curl -X POST https://pmi-api-beta-7tvvt.ondigitalocean.app/v1/addresses/match \
  -H "Authorization: Bearer pmi_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"address":"9 bennett road","postcode":"LS6 3HN"}'

Try this endpoint with your own key

100 free credits, no card required.

Response200 OK

{
  "match": {
    "uprn": 72226425,
    "address": "9 BENNETT ROAD, LEEDS, LS6 3HN",
    "postcode": "LS6 3HN",
    "latitude": 53.8198,
    "longitude": -1.5721,
    "confidence": 0.94
  },
  "alternatives": [
    {
      "uprn": 72226528,
      "address": "12 BENNETT ROAD, LEEDS, LS6 3HN",
      "postcode": "LS6 3HN",
      "confidence": 0.52
    }
  ]
}

More about this endpoint

Use Cases

Clean up a spreadsheet or CRM export of landlord / tenant addresses and attach UPRNs.

Resolve addresses from web forms to canonical records.

Power an "is this your property?" confirmation step in a valuation flow.