API to validate the VAT / tax ID of an end-customer against the information held by the EU Commission
VAT validation API<Content will be added>
APIs to enable you to download daily or consolidated unrated call records (CDRs) for your end-customer billing, or rated monthly CDRs and non-usage charges such as number activation or port-in charges for your cost reconciliation.
<content will be added>
<content>
A standard format for unrated CDRs applies to our reseller and wholesale product portfolio. This standard CDR format is harmonised across all Colt countries and applies to existing and new products going forward in Colt Online.
Please note: There is an ASCII Control Character (Line Feed, HEX 0A) after the last field 19 “End of record”. This Control character generates a new line for the next CDR and shows that the actual CDR ends. Normally you can ignore this control character except you use a HEX-Editor to process your CDRs.
Please Note: The first CDR file will appear in Colt Online after the first call has been made.
API details
|
Status |
LIVE |
|
Version |
v1 |
|
Maturity status |
Production |
|
Endpoint (Production) |
https://apis.colt.net/usageManagement |
|
Endpoint (Sandbox) |
https://sandbox.apis.colt.net/ausageManagement |
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.
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 |
API to generate an access token to authorize Voice Wholesale SIP API calls.
OAuth 2.0 is the industry-standard protocol for authorization. This API returns an JSON web token (JWT) which is required to authorize API calls for a given app.
You can request up to 5 CLIENT_ID + CLIENT_Secret per company account.
API features
API Rate Limit
An API rate limit will be applied to protect our platforms from excessive resource usage caused by external attacks or misconfiguration from our customers. We will count API requests and return a HTTP 429 (Too Many Requests) response when the quota (XXX) is exceeded. In case you would reach the limit, you will have to wait max YYY secs before we will process again the requests.
API details
Status LIVE
Version v1
Maturity status PRODUCTION
Endpoint (Production) https://apis.colt.net/authentication
Endpoint (Sandbox) https://sandbox.apis.colt.net/authentication
Errors returned by Auth API
|
Http response |
code |
reason |
message |
details (for reference only) |
|
400 Bad request Colt will return a HTTP-400 error when the request is malformed or invalid. See the message of the error for tips before trying again. |
001 |
Validation not met |
The request is missing authorization parameter. |
The request is missing authorization parameter |
|
002 |
Validation not met |
The request is missing grant_type. |
The request is missing grant_type |
|
|
003 |
Validation not met |
The request is missing content_type header |
The request is missing content_type header |
|
|
004 |
Validation not met |
The request is missing APIGWTrackingId. |
The request is missing APIGWTrackingId |
|
|
005 |
Validation not met |
Invalid input parameter |
The request contains
|
|
|
006 |
Validation not met |
The authorization grant type is not supported by authorization server |
The authorization grant type is not supported by authorization server |
|
|
401 Unauthorized Colt returns a HTTP-401 error when the specified user’s authorization parameter is either invalid or missing or expired. Ensure the provided credentials are valid. |
001 |
Authentication error |
The authorization parameter is missing. |
Client authentication failed due to no client authentication included in the request. |
|
002 |
Authentication error |
The authorization parameter is not valid. |
Client authentication failed due to unsupported authentication method other than Basic. |
|
|
415 Unsupported Media Type Colt will returns a HTTP-415 error when the content-type of the request is incorrect. Ensure the request header contains Content-Type: ‘application/x-www-form-urlencoded’ and try again. |
001 |
Validation not met |
The format of the posted body is not supported by the endpoint. |
The format of the posted body is not supported by the endpoint. |
|
500 Internal server error Colt will return a HTTP-500 Error when an unknown error occurs. If you receive a HTTP-500 error from the Colt API, please open a support ticket with the original request and the response returned. Please be sure to remove any passwords or sensitive information from the support ticket. |
001 |
Internal error |
An unknown internal error occurred |
Generic failure message used if no more precise code can be provided. |
|
002 |
internal error |
O Auth server failed. |
The server failed to generate access token |
|
|
503 Service unavailable Colt will return a HTTP-503 error if the service is unavailable for some reason, such as when there are no servers available to serve the request or if the system is at capacity. If you receive a HTTP-503 error from the Colt API, please try the request again. If you continue to receive HTTP-503 errors, please open a support ticket with the original request and the response returned. Please be sure to remove any passwords or sensitive information from the support ticket. |
001 |
service unavailable |
The service is temporarily unavailable |
Backend unavailable. |