Postcode Lookup (1.0)

Download OpenAPI specification:Download

Postcode and Locality Lookup services for address validation

Checks if postcode is in correct format

Checks if postcode is in correct format

query Parameters
Country
required
string 2 characters

Country ISO2 code

Example: Country=CH
pcode
required
string

Post code

Example: pcode=3006
header Parameters
ukey
required
string

Responses

Response samples

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

Get list of postcodes for a specific locality

Get list of postcodes for a specific locality

query Parameters
Country
required
string 2 characters

Country ISO2 code

Example: Country=FR
Loc
required
string

Locality name

Example: Loc=BERN
Limit
number [ 1 .. 1000 ]

Maximum number of results returned

Example: Limit=25
header Parameters
ukey
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of localities for a specific postcode

Get list of localities for a specific postcode

query Parameters
Country
required
string 2 characters

Country ISO2 code

Example: Country=DE
Pcode
required
string

Postalcode

Example: Pcode=3063
Limit
number [ 1 .. 1000 ]

Maximum number of results returned

Example: Limit=25
header Parameters
ukey
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Check if a postcode belongs to a locality.

Check if a postcode belongs to a locality.

query Parameters
Country
required
string 2 characters

Country ISO2 code

Example: Country=DE
Pcode
required
string

Postalcode

Example: Pcode=3006
Loc
required
string

Locality name

Example: Loc=BERN
header Parameters
ukey
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
No sample