About this endpoint
What it does
Validates a postal address from query parameters using OpenStreetMap/Nominatim data. Typo-tolerant and fuzzy: unmatched or missing fields (e.g. a partial street) don't sink the lookup — the query is progressively relaxed and matched at the city/state/country level where a precise match isn't possible. Returns a match status, confidence score, resolved address, coordinates, and per-field match flags.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| address | String | No | Free-text address (preferred). |
| street | String | No | Street address line. |
| city | String | No | City name. |
| state | String | No | State or region. |
| postcode | String | No | Postal or ZIP code. |
| country | String | No | Country name or code. |
Response
Returns a JSON object with the overall match verdict, a confidence and risk score, and the resolved address alongside per-field flags showing which submitted components matched.
| Attribute | Type | Description |
|---|---|---|
| success | Boolean | Whether the request succeeded. |
| code | Integer | Numeric response code. |
| geocoder_ok | Boolean | Whether the underlying geocoder responded successfully. |
| valid | Boolean | Whether a usable address match was found. |
| status | String | Match quality — exact, close, partial, or not_found. |
| confidence | Number | Match confidence (0–100). |
| risk_score | Number | Address-related fraud risk score. |
| input | Object | The submitted fields plus the constructed search query. |
| resolved | Object | The best-matched address — label, components, coordinates, and OSM reference. |
| matches | Object | Per-field boolean flags showing which submitted components matched the resolved address. |
| disclaimer | String | Notes that this is OSM/Nominatim-based, not postal-authority (CASS) certified. |
| model_version | String | Address validation model version. |
| request_id | String | Unique identifier for this request. |



