Create a geofence
POST/v2/geofence/create
Define a geographic zone — circle, polygon, or isochrone (real drive-time
contour) — tied optionally to a customer/loan. When a customer's location
ping falls outside (exit) or inside (enter) the zone, a geofence_breach
webhook fires automatically.
Polygon and isochrone fences are stored as a compacted H3 cell cover (the
same representation /v2/service-area uses), so breach checks are an
array-overlap test rather than live geometry — no slower than a circle
fence. cell_count in the response is the pre-compaction cover size.
Request
Responses
- 201
- 403
Geofence created
The endpoint requires an account-scoped API key. Legacy keys without an account identity cannot access tenant data. Also returned when the requested resource (loan, schedule) is registered to another account.