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

Request
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
200

Ok

400

Invalid country code.

401

A user with the specified ukey was not found.

402

Chosen country is licensed.

403

Transaction limit reached.

404

No data found for specified country.

get/postcodeapiserver/api/PcodeFormatValid
Response samples
application/json; charset=utf-8
{
  • "IsFormatValid": true
}

Get list of postcodes for a specific locality

Get list of postcodes for a specific locality

Request
query Parameters
Country
required
string 2 characters

Country ISO2 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
Responses
200

Ok

400

Invalid country code, Limit can not be 0, null or more than 1000.

401

A user with the specified ukey was not found.

402

Chosen country is licensed.

403

Transaction limit reached.

404

No data found for specified country and locality.

get/postcodeapiserver/api/PcodesForLoc
Response samples
application/json; charset=utf-8
No sample

Get list of localities for a specific postcode

Get list of localities for a specific postcode

Request
query Parameters
Country
required
string 2 characters

Country ISO2 code

Example: Country=DE
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
Responses
200

Ok

400

Invalid country Code, Limit can not be 0, null or more than 1000 rows.

401

A user with the specified ukey was not found.

402

Chosen country is licensed.

403

Transaction limit reached.

404

No data found for specified country and postcode

get/postcodeapiserver/api/LocsForPcode
Response samples
application/json; charset=utf-8
No sample

Check if a postcode belongs to a locality.

Check if a postcode belongs to a locality.

Request
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
200

Ok

400

Invalid country code.

401

A user with the specified ukey was not found.

402

Chosen country is licensed.

403

Transaction limit reached.

404

No data found for specified country, postcode and locality.

get/postcodeapiserver/api/MatchLocPcode
Response samples
application/json; charset=utf-8
No sample

Get list of postcodes for a specific address. ```

Get list of postcodes for a specific address.

This is a prototype api function for addresses in Sweden, Switzerland and Poland.
Request
query Parameters
Country
required
string 2 characters

Country ISO2 code

Example: Country=DE
Loc
required
string

Locality name

Example: Loc=BERN
Str
required
string

Street name

Example: Str=Wankdorffeld
Hnum
required
string

House number

Example: Hnum=123
Limit
required
number [ 1 .. 1000 ]

Maximum number of results returned

Example: Limit=25
header Parameters
ukey
required
string
Responses
200

Ok

400

Invalid country code.

401

A user with the specified ukey was not found.

402

Chosen country is licensed.

403

Transaction limit reached.

404

No data found for specified address.

get/postcodeapiserver/api/PostcodeLookup
Response samples
application/json; charset=utf-8
No sample