A comprehensive set of APIs which enable you to validate an end-customer's address against the recognised national database e.g. Post Office, find a valid Local Area Code (LAC) for a given address and retrieve an address based on an address ID. You can test these API in a sandbox with a “try it out” feature or in production.
This section describes the API functions to validate an address.
Please note: In Germany we have a very strict dependency between LAC and address. Also the emergency call routing is based on the address. LAC and emergency Routing code must be identified via the coordinates of the address. Colt will get the coordinates internally via address doctor ADv4 and will allow to fetch the valid Local Area Code.
- validateAddress REST API- returns geo coordinates (latitude/longitude) along with validated address in response. These coordinates can be used to fetch the validLAC using the fetchLACbyLocation API.
- fetchLACbyLocation REST API- Address is optional Germany but Geo Coordinates (will be returned in validateAddress API response) are required in the request to get the validLAC in response.
If address is valid and LAC or coordinates are not returned in response, please reach out to us with the valid address details.
Parameters vary depending on the country. Please find a summary below:
Country |
validateAddress Parameter(s) country wise |
|
Austria, Denmark, , Germany, Netherlands, Sweden, UK |
houseNumber, streetName, city, postalCode, Country |
|
France |
houseNumber, streetName, streetType, city, postalCode, poBoxNumber, Country |
|
Belgium |
houseNumber, addressExtension, streetName, subLocality, city, postalCode, Country |
|
Italy |
houseNumber, streetName, streetType, subLocality, province, city, postalCode, country |
|
Portugal |
houseNumber, streetName, city, postalCode, district(sublocality), country |
|
Spain |
houseNumber, streetName, streetType, province, city, postalCode, country |
|
Switzerland |
houseNumber, streetName, city, postalCode, Country |
|
Ireland |
houseNumber, streetName, sublocality, city, postalCode, county, Country |
Our full list of terms and conditions, alongside our acceptable use policy is available below.
This section describes the API functions to fetch a valid LAC.
Below parameters are required to fetch the LAC along with country code.
|
Complete address |
Coordinates |
Postcode |
City |
Province |
House Number |
|
|
GB |
- |
- |
Yes |
- |
- |
- |
|
Spain |
- |
- |
Yes |
Yes |
- |
- |
|
Belgium |
- |
- |
Yes |
- |
- |
- |
|
Netherlands |
- |
- |
Yes |
- |
- |
Yes |
|
Ireland |
- |
- |
- |
Yes |
- |
- |
|
Italy |
- |
- |
- |
Yes |
Yes |
- |
|
Portugal |
- |
- |
Yes |
Yes |
- |
- |
|
Sweden |
- |
- |
Yes |
- |
- |
- |
|
Germany |
Yes (Optional) |
Yes |
- |
- |
- |
|
|
Austria, France, Denmark, Switzerland |
|
Enter any parameter, all LACs will be returned |
||||
API functions to get a validated address for an addressID.
{
"floorNumber": "",
"houseNumber": "5",
"buildingName": "",
"department": "",
"streetName": "DU NORD",
"municipality": "",
"city": "LE RAINCY",
"postalCode": "93340",
"country": "FR",
"streetType": "BOULEVARD",
"province": "SEINE SAINT DENIS",
"houseNumberExtension": "",
"subLocality": "",
"addressID": "1-13OZ91D"
}
API Details:
|
Status |
LIVE |
|
Version |
v1 |
|
Maturity status |
Production |
|
Endpoint (Production) |
https://apis.colt.net/addressManagement/resourceName |
|
Endpoint (Sandbox) |
https://sandbox.apis.colt.net/addressManagement/resourceName |