Postcode Lookup (1.1)

Download OpenAPI specification:Download

E-mail: postcode@upu.int Terms of Service

Postcode and Locality Lookup services for address validation

PcodeFormatValid

Checks if postcode is in correct format.

Request

query Parameters

Country required	string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH
pcode required	string Post code Example: pcode=3006

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Invalid country code.

401

Invalid credentials.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/PcodeFormatValid

Response samples

application/json; charset=utf-8

{"FormatStatus": "Undefined",
"PcodeFormat": [{"pcodeFormat": "string",
"charsEncoded": "string"
}
]
}

GetPcodeFormat

Returns postcode format for a country.

Request

query Parameters

Country

required

string [ 2 .. 3 ] characters

Country ISO2 or ISO3 code

Example: Country=CH

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Invalid country code.

401

Invalid credentials.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/GetPcodeFormat

Response samples

application/json; charset=utf-8

[{"pcodeFormat": "string",
"charsEncoded": "string"
}
]

LocalityLike

Returns a list of localities and postal regions that begin with the string Loc in the input.

Request

query Parameters

Country required	string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH
Loc required	string Locality name Example: Loc=BERN

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Invalid country code.

401

Invalid credentials.

402

Chosen country is licensed.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/LocalityLike

Response samples

application/json; charset=utf-8

{"loc_prime": "string",
"loc_name": "string",
"loc_Id": "string",
"postal_region": "string",
"loc_with_context": "string"
}

LocalityValid

Returns official name for a given locality.

Request

query Parameters

Country required	string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH
Loc required	string Locality name Example: Loc=BERN

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Invalid country code.

401

Invalid credentials.

402

Chosen country is licensed.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/LocalityValid

Response samples

application/json; charset=utf-8

{"localityOfficial": "string",
"localityGiven": "string",
"localityId": "string"
}

PcodesForLoc

Returns list of postcodes for a locality.

Request

query Parameters

Country required	string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=FR
Loc required	string Locality name Example: Loc=BERN
Limit required	number [ 1 .. 1000 ] Maximum number of results returned Example: Limit=25

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Country code is invalid or limit is out of range (1..1000).

401

Invalid credentials.

402

Chosen country is licensed.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/PcodesForLoc

Response samples

application/json; charset=utf-8

[{"localityOfficial": "string",
"localityGiven": "string",
"localityId": "string",
"postcode": "string"
}
]

PcodesForLocId

Returns list of postcodes for given locality ID. It is intended to take as an input ID of locality selected by end user from the list of localities returned by function LocalityLike.

Request

query Parameters

Country required	string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH
Locid required	string Locality ID Example: Locid=2613933317911
Limit required	number [ 1 .. 1000 ] Maximum number of results returned Example: Limit=25

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Invalid country code.

401

Invalid credentials.

402

Chosen country is licensed.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/PcodesForLocId

Response samples

application/json; charset=utf-8

{"pcode": "string"
}

LocsForPcode

Returns list of localities for a postcode.

Request

query Parameters

Country required	string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CHE
Pcode required	string Postalcode Example: Pcode=3063
Limit required	number [ 1 .. 1000 ] Maximum number of results returned Example: Limit=25

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Country code is invalid or limit is out of range (1..1000).

401

Invalid credentials.

402

Chosen country is licensed.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/LocsForPcode

Response samples

application/json; charset=utf-8

[{"localityId": "string",
"locality": "string",
"postcode": "string",
"adm1": "string",
"adm2": "string",
"adm3": "string",
"adm4": "string"
}
]

MatchLocPcode

Checks if a postcode is valid for a locality.

Request

query Parameters

Country required	string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH
Pcode required	string Postalcode Example: Pcode=3006
Loc required	string Locality name Example: Loc=BERN

header Parameters

ukey required	string
callerID	string Application identification key

Responses

200

400

Invalid country code.

401

Invalid credentials.

402

Chosen country is licensed.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/MatchLocPcode

Response samples

application/json; charset=utf-8

[{"localityId": "string",
"locality": "string",
"postcode": "string",
"adm1": "string",
"adm2": "string",
"adm3": "string",
"adm4": "string"
}
]