Address Intelligence

Retrieve risk intelligence data for a specific property by UPRN (Unique Property Reference Number) or address search.

By UPRN

GET /api/address/{uprn}?code={your_access_code}

Where {uprn} is the unique property reference number.

By Address Search

GET /api/address?code={your_access_code}&query={address_query}&country={country_code}&provider={provider_id}

Parameters

Parameter	Description	Required	Default
query	Address search string	Yes (for address search)	N/A
country	ISO country code	No	gb
provider	Data provider to use	No	STAC
code	Access code provided by Insync Digital	Yes	N/A

Example Request

GET /api/address/10023456789?code=your_access_code

With headers:

x-api-key: your-api-key
x-client-id: your-client-id
x-correlation-id: 123e4567-e89b-12d3-a456-426614174000

Example Response

{
  "status": 200,
  "items": [
    {
      "identifier": "10023456789",
      "risk_factors": {
        "flood": {
          "overall": {
            "score": 25.5,
            "class": "low",
            "label": "Low Risk"
          },
          "river": {
            "score": 15.2,
            "class": "low"
          },
          "surface": {
            "score": 30.8,
            "class": "medium"
          },
          "coastal": {
            "score": 5.0,
            "class": "very_low"
          },
          "ea_rating": "Low"
        },
        "crime": {
          "burglary": {
            "score": 42.3,
            "class": "medium"
          },
          "criminal_damage": {
            "score": 38.7,
            "class": "medium"
          }
        },
        "natural_hazards": {
          "subsidence": {
            "score": 56.2,
            "class": "high"
          },
          "windstorm": {
            "value": 28.9
          }
        },
        "emergency_services": {
          "fire_station": {
            "drive_time": 8.5,
            "remoteness": {
              "score": 35.6,
              "class": "medium"
            }
          }
        }
      },
      "metadata": {
        "location_type": "residential"
      }
    }
  ],
  "metadata": {
    "intel_status": "complete",
    "location_type": "residential",
    "found": true
  }
}