Get locations in a geometry

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns the Veridion business locations found inside a supplied site boundary.

Run in Postman



When to use it

To identify who operates on a site you already hold. You have a parcel, building footprint, yard, or facility boundary, from assessor data, a property dataset, or your own GIS, and you need the businesses active within it.

To establish whether a site is single or multi-tenant. result_count is the occupant count for the boundary, so a single call tells you whether a business is the sole operator there or one of several.

To verify occupancy where the address is unreliable. Large industrial and infrastructure sites often have several entrances or assigned addresses, inconsistent street naming, or no street number at all. The boundary identifies the site unambiguously where an address cannot.

To connect external parcel or asset data to company intelligence. Each returned location carries the operating company's veridion_id, which is the link from your spatial data to the rest of Veridion.

👍

If you have an address rather than a boundary

Use Resolve an address to a location instead. It takes a free text address and identifies the business operating there, optionally confirming a specific company at that address.


Required fields

The request payload must include one of the following, and only one:

  • geometry: the site boundary, as a WKT string.
  • bbox: the site boundary, as a bounding box.

Supplying both returns a 400.

FieldTypeNotes
geometrystringA WKT POLYGON or MULTIPOLYGON.
bboxarray of 4 numbers[min_lon, min_lat, max_lon, max_lat].

Input requirements

Coordinates must be WGS84, with longitude before latitude. Coordinates outside valid ranges are rejected, which catches parcel data still in a projected coordinate system such as State Plane or NAD83. Reversed axis order is not rejected, because the coordinates remain valid, so it produces a wrong result rather than an error.

The boundary must be a single site. Boundaries above the maximum area are rejected. Geometry Search is scoped to a parcel, building, yard, campus, or facility, not to a neighbourhood or a region.

LimitValue
Maximum area1 km², roughly 247 acres
Maximum vertices per shape100, summed across the parts of a multipolygon

Geometry must be well formed. Unclosed rings, self-intersecting rings, and incorrect ring winding order are rejected.

A multipolygon is treated as a single boundary. Use it where one site is made up of disjoint parts, for example a parcel split by a road or an easement. A location falling inside more than one part is returned once.


Successful responses

When the request is successful, a standard 200 OK HTTP status will be sent along with the expected JSON. The response uses the standard paginated envelope:

  • result: the locations found inside the boundary, as an array.
  • result_count: the total number of locations matched, after any confidence filtering; it represents the occupant count for the site, which is what tells you whether a business is the sole operator there or one of several.
  • next_cursor and has_more: paging state.

A 200 OK does not mean a business was found. An empty result array with result_count: 0 is a valid answer, and means no Veridion business location was found inside the boundary.

Each item in result is a standard location object, with an additional match_details object:

FieldTypeNullableDescription
match_details.confidence_scoredecimalNoHow confident we are that this business operates inside the supplied boundary, from 0 to 1.
match_details.match_basisstringNofootprint_overlap where the location was matched on its building footprint, point_in_boundary where it was matched on its coordinate.
match_details.overlap_ratiodecimalYesThe share of the building footprint that falls inside the boundary. null for point_in_boundary.
📖

Interpreting the results

For what the confidence score means and how to choose a threshold, see Matching methodology.

For a comprehensive list of all data points returned on a location, see the Response fields and types page.


Error responses

If the request is unsuccessful, the API will return one of the below HTTP status responses:

  • 400 Bad Request, for any of the input problems below.
  • other standard HTTP error responses, detailed in the Response codes section.
CaseCause
Both inputs suppliedgeometry and bbox were both present.
No input suppliedNeither geometry nor bbox was present.
Unsupported formatgeometry was not WKT.
Malformed geometryUnclosed rings, self-intersecting rings, or incorrect winding order.
Coordinates out of rangeCoordinates are not valid WGS84 longitude and latitude, commonly because the geometry is still in a projected coordinate system.
Too many verticesThe shape exceeds the vertex limit.
Area too largeThe boundary exceeds the maximum area.

Any error response follows a specific structure. Please see the Error response format section for more details.

Query Params
number

Locations scoring below this value are excluded from the response.

string
Defaults to 100

Number of results to be returned per page. Default value: 100, Maximum value: 200.

string

Cursor returned by a previous call as next_cursor. Bound to the query that produced it. Opaque string (<=1024)

string

Optional cap on the total number of records returned across the pagination session. Integer value (1 - 10000).

Body Params
string

The site boundary, as a WKT string (POLYGON or MULTIPOLYGON).

bbox
array of numbers

Array of 4 numbers (e.g. [min_lon, min_lat, max_lon, max_lat])

bbox
Headers
string
required

Your individual OAuth Bearer token (e.g. Authorization: Bearer <your_access_token>).

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json