Skip to main content
POST
/
v1
/
assembly
/
assemble
Assemble segments into a canonical postcode
curl --request POST \
  --url https://api.postcode.gov.ng/v1/assembly/assemble \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "state": "EK",
  "lga": "01",
  "district": "A03",
  "area": "FK",
  "unit": "01"
}
'
{
  "data": {
    "postcode": "EK-01-A03-FK-01",
    "display": "EK 01 A03 FK 01",
    "compact": "EK01A03FK01"
  }
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
state
string
required
Example:

"EK"

​
lga
string
required
Example:

"01"

​
district
string
required
Example:

"A03"

​
area
string
required
Example:

"FK"

​
unit
string
required
Example:

"01"

Response

200 - application/json

Assembled postcode

​
data
object