logo
API docs by Redocly

Postcode Lookup (1.1)

Download OpenAPI specification:

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

Postcode and Locality Lookup services for address validation

PcodeFormatValid

Checks if postcode is in correct format.

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=CH

Country ISO2 or ISO3 code

pcode
required
string
Example: pcode=3006

Post code

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "FormatStatus": "Undefined",
  • "PcodeFormat": [
    ]
}

GetPcodeFormat

Returns postcode format for a country.

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=CH

Country ISO2 or ISO3 code

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

LocalityLike

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

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=CH

Country ISO2 or ISO3 code

Loc
required
string
Example: Loc=BERN

Locality name

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
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.

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=CH

Country ISO2 or ISO3 code

Loc
required
string
Example: Loc=BERN

Locality name

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "localityOfficial": "string",
  • "localityGiven": "string",
  • "localityId": "string"
}

PcodesForLoc

Returns list of postcodes for a locality.

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=FR

Country ISO2 or ISO3 code

Loc
required
string
Example: Loc=BERN

Locality name

Limit
required
number [ 1 .. 1000 ]
Example: Limit=25

Maximum number of results returned

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

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.

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=CH

Country ISO2 or ISO3 code

Locid
required
string
Example: Locid=2613933317911

Locality ID

Limit
required
number [ 1 .. 1000 ]
Example: Limit=25

Maximum number of results returned

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "pcode": "string"
}

LocsForPcode

Returns list of localities for a postcode.

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=CHE

Country ISO2 or ISO3 code

Pcode
required
string
Example: Pcode=3063

Postalcode

Limit
required
number [ 1 .. 1000 ]
Example: Limit=25

Maximum number of results returned

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

MatchLocPcode

Checks if a postcode is valid for a locality.

query Parameters
Country
required
string [ 2 .. 3 ] characters
Example: Country=CH

Country ISO2 or ISO3 code

Pcode
required
string
Example: Pcode=3006

Postalcode

Loc
required
string
Example: Loc=BERN

Locality name

header Parameters
ukey
required
string
callerID
string

Application identification key

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]