Create a service area
POST/v2/service-area
Defines a coverage zone for "do you serve this address?" checks. Three ways to define it:
- isochrone —
center+minutes(+ optionalmode): everything reachable within a drive time. The honest definition for Accra, where a 5 km radius can be 15 or 90 minutes away. - circle —
center+radius_km: simple radius. - polygon —
polygon: a custom[lng, lat]exterior ring.
The area is converted once to a compacted H3 cell cover, so every subsequent check is a single indexed set-membership lookup — no geometry math per check. Very large areas are automatically built at a coarser resolution to stay within storage limits.
Request
Responses
- 201
- 400
- 403
Service area created
Validation error (missing fields, area too large, bad coordinates)
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.