Look up a Nigerian postcode
lookup_postcodeValidate a Nigerian postcode and retrieve address details when needed: level 1 confirms assignment, while levels 2-5 return administrative, house, and building-use data.
Instructions
Confirm a postcode is assigned and, at higher levels, return its address details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| level | No | 1: validity only (free). 2: adds the administrative and recent house address. 3: adds building use. Levels 2+ consume NIPOST credits. | |
| postcode | Yes | Code in any style, e.g. EK-01-A03-FK-01. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| valid | Yes | Whether the code is assigned to a building. | |
| status | No | valid, not_found, or invalid for a malformed code. | |
| postcode | Yes | ||
| verified | No | ||
| point_geometry | No | Level 5, unstructured. | |
| building_use_status | Yes | Level 3 and up, e.g. residential. | |
| other_building_info | No | Level 4 and up, unstructured. | |
| recent_house_address | Yes | Level 2 and up. Personal data. | |
| administrative_address | Yes | Level 2 and up. |