Look up a Nigerian postcode
lookup_postcodeVerify whether a Nigerian NIPOST digital postcode is assigned to a building. Use this validation before relying on the postcode for address or building details.
Instructions
Confirm a postcode is assigned to a building. Free.
Address and building details are a paid lookup, listed as its own tool only when the server's NG_POSTCODE_MAX_LEVEL is 2 or more.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| level | No | Always 1. Address and building details are a separate paid tool. | |
| postcode | Yes | Code in any style, e.g. EK-01-A03-FK-01. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Why the answer may be incomplete, such as a test key. | |
| 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. |