Geotag Schema
Field reference for geotag (location) data in enriched output.
| Field | Type | Optional | Description |
|---|---|---|---|
| geotagId | String (max 36) | No | Unique identifier for geotag. |
| counterpartyName | String (max 128) | No | Name of counterparty (brand). |
| counterpartyLabel | String (max 128) | No | Name and short address of counterparty. |
| houseNumber | String (max 32) | Yes | The building number. |
| street | String (max 36) | Yes | Street the building is located on. |
| neighbourhood | String (max 32) | Yes | Commonly a district within a town. |
| locality | String (max 40) | Yes | City, town or village. |
| city | String (max 40) | Yes | City. Can be the same value as locality. |
| county | String (max 36) | Yes | County. Can be the same value as city. |
| region | String (max 36) | Yes | Region. Can be the same value as county. |
| postcode | String (64) | Yes | Postcode of geotag. We estimate this in the event it wasn’t provided by the data source we use by considering surrounding geotags that have a postcode. While the field is optional, it’s very rare we don’t return it. More than one candidate postcode is returned, separated by semicolons, in a few exceptional cases. |
| latitude | Double | No | WGS84 latitude. Maximum of 6 decimal places. |
| longitude | Double | No | WGS84 longitude. Maximum of 6 decimal places. |
| l3CounterpartyCategory | String (max 32) | Yes | The level 3 category (industry). |
| postcodeEstimated | Boolean | No | True if we’ve estimated the postcode by considering surrounding geotags. |
| postcodeErrorKm | Float | Yes | If we’ve estimated the postcode, the distance the location is from the geotag we used to estimate the postcode. |