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

Ok

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": [
    ]
}

Returns postcode format for a country.

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

Ok

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
[
  • {
    }
]

Returns official name for given locality.

Returns official name for 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

Ok

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"
}

Returns list of postcodes for a locality.

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

Ok

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
[
  • {
    }
]

Returns list of localities for a postcode.

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

Ok

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
[
  • {
    }
]

Checks if a postcode is valid for a locality.

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

Ok

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
[
  • {
    }
]

Returns list of valid postcodes for an address. ``

Returns list of valid postcodes for an address.

This is a prototype api function for addresses in Sweden, Switzerland and Poland.
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
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
callerID
string

Application identification key

Responses
200

Ok

400

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

401

A user with the given ukey was not found.

402

Chosen country is licensed.

403

Transaction limit reached.

404

Not found.

get/postcodeapiserver/api/PostcodeLookup
Response samples
application/json; charset=utf-8
[
  • {
    }
]