Lookup levels

Lookup responses are graded into 5 cumulative levels — each higher level adds attributes on top of the ones below it. Request a level with the level query param; the response is capped at your organization’s granted level.

Attribute	L1	L2	L3	L4	L5
Validity status	✓	✓	✓	✓	✓
Administrative address		✓	✓	✓	✓
Recent house address		✓	✓	✓	✓
Building use status			✓	✓	✓
Other building info				✓	✓
Point geometry (coordinates)					✓

L1 is free. L2–L4 are commercial (consume credits). L5 (exact coordinates) is restricted and granted on review.

Example

# L1 — validity only
curl "https://api.postcode.gov.ng/v1/lookup?code=EK-01-A03-FK-01&level=1"

# L5 — everything, incl. coordinates (requires granted L5 key)
curl "https://api.postcode.gov.ng/v1/lookup?code=EK-01-A03-FK-01&level=5" \
  -H "X-API-Key: nipost_live_xxx"

L5 response

{
  "data": {
    "postcode": "EK-01-A03-FK-01",
    "valid": true,
    "administrative_address": { "state_name": "EKITI", "lga_name": "ADO EKITI", "locality_name": "ADO EKITI", "zone": "SOUTH WEST" },
    "recent_house_address": { "recent": "NTA ROAD, BACK OF FABIAN HOTEL, ADO EKITI" },
    "building_use_status": "residential",
    "other_building_info": { "type": "Bungalow", "owner": "Private Ownership", "delivery_point": true },
    "point_geometry": { "type": "Point", "coordinates": [5.186046, 7.623567] }
  }
}

Need a higher level? Request it under Settings → KYB & Access in the dashboard.

Getting started

Concepts

Widget

Example

​Example

Example