Download OpenAPI specification:Download
Postcode and Locality Lookup services for address validation
Checks if postcode is in correct format.
Country required | string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH |
pcode required | string Post code Example: pcode=3006 |
ukey required | string |
callerID | string Application identification key |
{- "FormatStatus": "Undefined",
- "PcodeFormat": [
- {
- "pcodeFormat": "string",
- "charsEncoded": "string"
}
]
}
Returns postcode format for a country.
Country required | string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH |
ukey required | string |
callerID | string Application identification key |
[- {
- "pcodeFormat": "string",
- "charsEncoded": "string"
}
]
Returns official name for given locality.
Country required | string [ 2 .. 3 ] characters Country ISO2 or ISO3 code Example: Country=CH |
Loc required | string Locality name Example: Loc=BERN |
ukey required | string |
callerID | string Application identification key |
{- "localityOfficial": "string",
- "localityGiven": "string",
- "localityId": "string"
}
Returns list of postcodes for a locality.
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 |
ukey required | string |
callerID | string Application identification key |
[- {
- "localityOfficial": "string",
- "localityGiven": "string",
- "localityId": "string",
- "postcode": "string"
}
]
Returns list of localities for a postcode.
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 |
ukey required | string |
callerID | string Application identification key |
[- {
- "localityId": "string",
- "locality": "string",
- "postcode": "string",
- "adm1": "string",
- "adm2": "string",
- "adm3": "string",
- "adm4": "string"
}
]
Checks if a postcode is valid for a locality.
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 |
ukey required | string |
callerID | string Application identification key |
[- {
- "localityId": "string",
- "locality": "string",
- "postcode": "string",
- "adm1": "string",
- "adm2": "string",
- "adm3": "string",
- "adm4": "string"
}
]
Returns list of valid postcodes for an address.
This is a prototype api function for addresses in Sweden, Switzerland and Poland.
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 |
ukey required | string |
callerID | string Application identification key |
[- {
- "localityId": "string",
- "locality": "string",
- "postcode": "string",
- "adm1": "string",
- "adm2": "string",
- "adm3": "string",
- "adm4": "string"
}
]