Sahal API
Developers · Sahal API

Sahal API

Sahal API allows authorised organisations and developers to integrate Sahal Digital Addresses into their own applications and systems.

How It Works

Sahal Address
MG-HD-B0001
Location
Mogadishu, Hodan
Coordinates
5.3114° N, 45.34° E
Map
Interactive map view
Authorised System
Your organisation system

Example

Input:
MG-HD-B0001
Output:
{
"code": "MG-HD-B0001",
"city": "Mogadishu",
"district": "Hodan",
"latitude": 5.3114,
"longitude": 45.342,
"verification_status": "verified"
}

API Functions

Search Address

Look up a Sahal address by its code (e.g. MG-HD-B0001).

Retrieve Address

Get full address details including city, district and status.

Retrieve Coordinates

Return GPS coordinates for a given Sahal address.

Verify Address Status

Check whether an address is Sahal Verified, pending, or needs review.

Search by Coordinates

Reverse-lookup: find the nearest Sahal address for a lat/lng pair.

Organisation Location Lookup

Authorised organisations can query locations within their workspace.

Address Verification API

Confirm that a Sahal address code exists and is current before onboarding a customer, dispatching a delivery or disbursing funds. Each call returns the building name, district, city, coordinates and verification status as JSON.

POST /functions/publicAddressApi

Authenticate with the API key issued to your organisation, sent in the x-api-key header.

Request

curl -X POST https://sahal-addresses.base44.app/functions/publicAddressApi \
  -H "Content-Type: application/json" \
  -H "x-api-key: sahal_live_your_key" \
  -d '{"action":"verify","code":"MG-HD-B0001"}'

Response 200

{
  "status": "success",
  "verified": true,
  "code": "MG-HD-B0001",
  "address_status": "approved",
  "verification_status": "verified",
  "building": { "name": "Hodan Plaza", "type": "shop", "unit": "Floor 1 · Shop 4" },
  "district": { "name": "Hodan", "code": "HD" },
  "city": { "name": "Mogadishu", "code": "MG" },
  "country": "Somalia",
  "coordinates": { "latitude": 2.0401, "longitude": 45.3406 },
  "plus_code": null,
  "map_url": "https://www.google.com/maps/search/?api=1&query=2.0401,45.3406",
  "organisation": "Example Fintech Ltd",
  "checked_at": "2026-10-02T09:14:00.000Z"
}
401 · Missing or unknown API key.404 · Address code not found — the response returns "verified": false.429 · Rate limit reached (120 requests per minute per key).

API keys are issued to licensed fintechs, delivery operators and partner organisations. Only a hash of your key is stored, and an admin can revoke it at any time.

Get API access

Secure Access Only

API keys are never exposed publicly. Access is granted to authorised organisations on request. All API calls are logged for audit and security purposes. To request API access, submit a pilot request or contact the Sahal team.

Documentation status: This page describes the Sahal API concept and planned functions. A public-facing production API endpoint is available on request for authorised partners. Existing internal services (address resolution, geocoding) are operational and power the Sahal platform.

Request API Access