Location & Coverage

Endpoint

POST /partner/location/

Auth: None (public)

Purpose

Before creating a checkout session or provisioning a subscriber, verify that the address is serviceable by your network and obtain the location_hash you’ll pass to the provisioning endpoints.

Request body

{
  "service_provider_document_id": "uuid",
  "street": "string",
  "housenumber": "string",
  "postalcode": "string",
  "city": "string",
  "province": "string",
  "country": "Canada"
}

Response — 200 OK (serviceable)

{
  "serviceable": true,
  "location_hash": "a3f2b1c4e5",
  "location_identifier": "switch01/port12",
  "delivery_mode": "direct | home_drop",
  "unit_id": "uuid (home-drop MDU units only)"
}

Response — 200 OK (not serviceable)

{
  "serviceable": false,
  "location_hash": null
}

Usage in provisioning flows

Take the location_hash from this response and pass it to:

POST /partner/external-checkout/complete — CKO-03 direct delivery
POST /partner/provisioning/provider-initiated — PAY-03
POST /partner/external-checkout/sessions — M006 sessions

For home-drop units, use unit_id with delivery_mode: "home_drop" instead of location_hash.

In sandbox, use the test location hashes from Dashboard → Sandbox → Test locations — real address lookups return not-serviceable because sandbox locations are pre-seeded fixtures.

Overview

Plan Discovery

Provisioning

Reports

Checkout Utilities

Subscribers & Subscriptions

AI Support Agent

Provider Operations (Internal API)

Endpoint

Purpose

Request body

Response — 200 OK (serviceable)

Response — 200 OK (not serviceable)

Usage in provisioning flows

​Endpoint

​Purpose

​Request body

​Response — 200 OK (serviceable)

​Response — 200 OK (not serviceable)

​Usage in provisioning flows

Endpoint

Purpose

Request body

Response — 200 OK (serviceable)

Response — 200 OK (not serviceable)

Usage in provisioning flows