Company domain check
The service tests whether an email address belongs to a domain representing a company.
| Syntax | /svc/2.0/address/companydomain/<address> |
| Example | /svc/2.0/address/companydomain/foo@bar.com |
| Parameter | An ASCII email address as last part of the URL |
Result
<companyDomainStatus>
<infoId>bar.com</infoId>
<result>1</result>
</companyDomainStatus>
or
{"infoId": "bar.com", "result": 1}
- result: the evaluation result
- 0: no company domain found
- 1: company domain found
- infoId: if result == 1, this contains the ID (domain name) for looking up more information about a company domain resource.
Functionality
If a match is found a positive result (1) is returned. The ID of the matching entry, the domain name, is also returned for further lookup.
Information about a company domain resource
The company info API call returns information about company resources.
| Syntax | /svc/2.0/info/companydomain/<id> |
| Example | /svc/2.0/info/companydomain/bar.com |
| Parameter | An ID (domain name) as the last part of the URL |
The company domain resources contain descriptions that are language-specific, the economic classifications. To get these descriptions in a specific language, add a HTTP Accept-language header to the request. The service will then return the descriptions in the requested language, if available, otherwise in the default language defined for each schema.
Result
<companyDomainInfo>
<id>bar.com</id>
<orgName>Bar.Com GmbH</orgName>
<addressStreet>Barstrasse 11</addressStreet>
<addressCity>Neumarkt</addressCity>
<addressZipCode>92318</addressZipCode>
<addressLatitude>11.000001</addressLatitude>
<addressLongitude>49.111110</addressLongitude>
<countryCode>de</countryCode>
<classifications>
<classification>
<id>34.10</id>
<description>Herstellung von Kraftwagen und Kraftwagenteilen</description>
<lang>de</lang>
<type>wz2003</type>
</classification>
</ classifications>
<companyDomainInfo>
or
{
"id":"bar.com",
"orgName":"Bar.Com GmbH",
"addressStreet":"Barstrasse 11",
"addressCity":"Neumarkt",
"addressZipCode":"92318",
"countryCode": "de",
"addressLatitude": 11.000001,
"addressLongitude": 49.111110,
"classifications": [
{"id":"34","text":"Herstellung von Kraftwagen und Kraftwagenteilen", "type": "wz2003", "lang": "de"}
]
}
The structure of the result document is:
- id: the ID of the resource, which is also the domain name representing the company
- orgName: the name of the company
- addressStreet/City/ZipCode: postal address data for the company
- countryCode: ISO 639-1 country code for the address
- addressLatitude/Longitude: geographic coordinates for the company address
- classifications: zero or more economic classification entries describing the area of economic activity for this company
- id: ID of the classification entry accoding to the schema used
- type: the classification schema used in this entry, possible values:
- wz2003: older German classification, see Klassifikation der Wirtschaftszweige, Ausgabe 2003
- wz2008: recent German classification, see Klassifikation der Wirtschaftszweige, Ausgabe 2008
- nace2: EU classification, see NACE Rev. 2 - Statistical classification of eceonomic activities
- isic4: UN classification, see International Standard Industrial Classification of All Economic Activities, Rev.4
- lang: language code for the description; can be influenced by the Accept-language header, see above;
- description: descriptive text for the classification entry, available in various languages
Functionality
If no data is available for an ID the server will signal this with HTTP response code 204 (No Content) and return no result (null).
The descriptive texts are available in different languages. The service will try to find the best match for the language specified in the Accept-language header, or fall back to a default language if it cannot.
The available language editions are:
- wz2003: default = de, available = de
- wz2008: default = en, available = de, en
- nace2: default = en, available = bg, cs, da, de, el, en, es, et, fi, fr, hu, it, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sv, tr
- isic4: default = en, available = en, es, fr