Response Models

IntelligenceResponse

The standard response format for both single and bulk address intelligence requests.

Field	Type	Description
status	Integer	HTTP status code
items	Array	List of IntelligenceItem objects
errors	Array	Error information (null if no errors)
metadata	Object	Additional information about the response

IntelligenceItem

Contains risk intelligence data for a single address.

Field	Type	Description
identifier	String	UPRN or address string that was searched
risk_factors	Object	Risk data for the address
metadata	Object	Additional information about the address

RiskFactors

Standardised risk information broken down by category.

Field	Type	Description
flood	Object	Flood risk information
crime	Object	Crime risk information
natural_hazards	Object	Natural hazards risk information
emergency_services	Object	Emergency services information

Risk Scoring

Risk scores are typically represented as:

Field	Type	Description
score	Number	Numerical risk score (typically 0-100)
class	String	Risk classification (e.g., "low", "medium", "high")
label	String	Human-readable risk label