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.
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 |
Resource Name
|
Operation |
Resource Name |
|
Validate Address |
/v1/validateAddress |
|
FeGettch Local Area Code (LAC) |
/v1/LACByLocation |
|
Get Address (using addressID) |
/v1/address/{addressID} |
The Address Management APIs can be used to validate address, get Local Area Code (LAC) and retrieve addresses. These API will help you to reduce the order failures, thereby providing improved customer experience. The APIs identifies address components and validates them.
You can use these APIs for all 20 countries (please refer to ‘Country Code’ tab for country list).
The APIs provides field level validation checks, including suggestions if address is partially correct. It also attempts to infer missing or incorrect address components.
It also standardizes the address which can be used for placing activation/port-in/address update orders and also returns/stores the latitude/longitude coordinates (only for Germany) for the provided 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.
Our full list of terms and conditions, alongside our acceptable use policy is available below.
Please find below country codes supported in Colt APIs:
|
Country |
Country Code |
|
Zone A |
|
|
Austria |
AT |
|
Belgium |
BE |
|
Denmark |
DK |
|
France |
FR |
|
Germany |
DE |
|
Ireland |
IE |
|
Italy |
IT |
|
Netherlands |
NL |
|
Portugal |
PT |
|
Spain |
ES |
|
Sweden |
SE |
|
Switzerland |
CH |
|
United Kingdom |
GB |
|
Zone B |
|
|
Luxembourg |
LU |
|
Slovakia |
SK |
|
Finland |
FI |
|
Norway |
NO |
|
Czech Republic |
CZ |
|
Romania |
RO |
|
Poland |
PL |
POST/validateAddress API validates the address using country specific parameters.
Parameters vary depending on the country. Please find a summary below:
|
Country |
validateAddress Parameter(S) country wise |
|
Austria, Denmark, , Germany, Netherlands, Sweden, UK, Zone B countries |
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, sublocality, country |
|
Spain |
houseNumber, streetName, streetType, province, city, postalCode, country |
|
Switzerland |
houseNumber, streetName, city, postalCode, country |
|
Ireland |
houseNumber, streetName, sublocality, city, postalCode, county, country |
GET/LACByLocation API to get Local Area Code (LAC) for a given location.
Below parameters are required to fetch the LAC along with country code.
|
Complete address |
Coordinates (latitude/longitude) |
postalCode |
city |
province |
houseNumber | |
|
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 |
||||
‘additionalInfo’ will return comments from Colt if you’re trying to find a LAC which is valid but available for Wholesale SIP (Number Hosting).
GET/address/{addressID API to get address for a given addressId.
|
Request |
Response |
|
https://apis.colt.net/addressManagement/v1/address/1-C5QUF3?country=DE |
{ "houseNumber": "18", "streetName": "GERVINUSSTRAßE", "subLocality": "WESTEND-NORD", "city": "FRANKFURT AM MAIN", "province": "HESSEN", "postalCode": "60322", "country": "DE", "addressID": "1-C5QUF3", "latitude": "50.12206", "longitude": "8.67208" }
|