Enricher reference
On this page
- Brreg
- BvD
- Clearbit
- Companies House
- CVR
- DuckDuckGo
- Duns & Bradstreet
- Gleif
- Google Maps
- Knowledge Graph
- Libpostal
- Open Corporates
- PermId
- Vatlayer
- Web
In this article, you will find reference information about built-in enrichers in CluedIn.
Please note that the enrichers are not included in the CluedIn license. Each enricher is an open-source package provided by the CluedIn team for free to help you enrich your golden records with information from external sources.
Brreg
The Brreg enricher retrieves a wide range of information about Norwegian and foreign businesses operating in Norway. It supports the following endpoints:
-
http://data.brreg.no/enhetsregisteret/api/enheter/{id}, where{id}is the Brreg code. -
http://data.brreg.no/enhetsregisteret/api/enheter?page=0&size=30&navn={name}, where{name}is the company name.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.Bregg | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.Bregg | 4.0.1 | Source code |
| CluedIn.Provider.ExternalSearch.Bregg | 4.0.0 | Source code |
BvD
The BvD enricher retrieves a wide range of information about companies.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.BvD | 4.4.0 | Source code |
Clearbit
The Clearbit enricher retrieves company logo and domain information. It supports the following endpoint:
https://autocomplete.clearbit.com/v1/companies/suggest?query=
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.ClearBit | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.ClearBit | 4.1.1 | Source code |
| CluedIn.Provider.ExternalSearch.ClearBit | 4.1.0 | Source code |
| CluedIn.Provider.ExternalSearch.ClearBit | 4.0.0 | Source code |
Companies House
The Companies House enricher retrieves information about UK companies. This enricher uses the company name to return public information including registered office address, filing history, and so on.
The Companies House enricher supports the following endpoints:
-
https://api.companieshouse.gov.uk/search/company/{companyNumber}, where{companyNumber}is the Companies House number – this endpoint is called when the Companies House number is provided. -
https://api.companieshouse.gov.uk/search/companies?q={name}, where{name}is the company name – this endpoint is called when the Companies House number is not provided.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.CompanyHouse | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.CompanyHouse | 4.0.1 | Source code |
| CluedIn.Provider.ExternalSearch.CompanyHouse | 4.0.0 | Source code |
CVR
The CVR enricher retrieves a wide range of information about companies registered in Denmark. It supports the following endpoint:
http://{username}:{password}@distribution.virk.dk/cvr-permanent/_search, where{username} and {password}are the valid credentials for your CVR account.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.CVR | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.CVR | 4.1.1 | Source code |
| CluedIn.Provider.ExternalSearch.CVR | 4.1.0 | Source code |
| CluedIn.Provider.ExternalSearch.CVR | 4.0.2 | Source code |
| CluedIn.Provider.ExternalSearch.CVR | 4.0.1 | Source code |
| CluedIn.Provider.ExternalSearch.CVR | 4.0.0 | Source code |
DuckDuckGo
The DuckDuckGo enricher retrieves general information about organizations from the DuckDuckGo search engine. It supports the following endpoint:
https://api.duckduckgo.com
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.ExternalSearch.Providers.DuckDuckGo.Provider | 4.4.0 | Source code |
| CluedIn.ExternalSearch.Providers.DuckDuckGo.Provider | 4.3.0 | Source code |
| CluedIn.ExternalSearch.Providers.DuckDuckGo.Provider | 4.0.1 | Source code |
| CluedIn.ExternalSearch.Providers.DuckDuckGo.Provider | 4.0.0 | Source code |
Duns & Bradstreet
The Duns & Bradstreet enricher retrieves information about organizations. It supports the following endpoints:
-
{hostUrl}/data/duns/{dunsNumber}– this endpoint is called when the D&B number is provided. -
{hostUrl}/v1/match/extendedMatch– this endpoint is called when the D&B number is not provided.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.ExternalSearch.Providers.DNB | - | Contact CluedIn for details |
Gleif
The Gleif enricher retrieves information about organizations using the Legal Entity Identifier (LEI). It supports the following endpoint:
https://api.gleif.org/api/v1/lei-records?page[size]=1&page[number]=1&filter[lei]={leicode}, where{leicode}is the LEI code of the company.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.Gleif | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.Gleif | 4.0.1 | Source code |
| CluedIn.Provider.ExternalSearch.Gleif | 4.0.0 | Source code |
Google Maps
The Google Maps enricher cleans, standardizes, and enriches international postal addresses with geocoding information. This enricher returns correct information about company address.
The Google Maps enricher supports the following endpoints:
-
https://maps.googleapis.com/maps/api/place/textsearch/json?query={organizationName}{organizationAddress}{organizationCity}{organizationZip}{organizationState}{organizationCountry}– if organization name, address, city, zip, state, and country are provided. -
https://maps.googleapis.com/maps/api/place/textsearch/json?query={organizationName}– if organization name is provided. -
https://maps.googleapis.com/maps/api/place/textsearch/json?query={organizationAddress}– if organization address is provided. -
https://maps.googleapis.com/maps/api/place/textsearch/json?query={location}– if one of the addresses other than organization address is provided. -
https://maps.googleapis.com/maps/api/place/textsearch/json?query={location}&location={latitude}{longitude}– if one of the addresses other than organization address and latitude and longitude are provided. -
https://maps.googleapis.com/maps/api/place/textsearch/json?query=location={latitude}{longitude}– if latitude and longitude are provided. -
https://maps.googleapis.com/maps/api/place/details/json?placeid={id}– the ID is taken from the previous text search API (the result ofhttps://maps.googleapis.com/maps/api/place/textsearch/json).
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.GoogleMaps | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.GoogleMaps | 4.1.1 | Source code |
| CluedIn.Provider.ExternalSearch.GoogleMaps | 4.1.0 | Source code |
| CluedIn.Provider.ExternalSearch.GoogleMaps | 4.0.5 | Source code |
| CluedIn.Provider.ExternalSearch.GoogleMaps | 4.0.4 | Source code |
| CluedIn.Provider.ExternalSearch.GoogleMaps | 4.0.3 | Source code |
| CluedIn.Provider.ExternalSearch.GoogleMaps | 4.0.0 | Source code |
Knowledge Graph
The Knowledge Graph enricher retrieves descriptions of organizations using the Google Knowledge Graph API. It supports the following endpoint:
https://kgsearch.googleapis.com?query={nameOrUri}&key={apiKey}&limit=10&indent=true, where{nameOrUri}is the name or website of the organization and{apiKey}is your API key for accessing Google’s Knowledge Graph database.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.KnowledgeGraph | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.KnowledgeGraph | 4.0.1 | Source code |
| CluedIn.Provider.ExternalSearch.KnowledgeGraph | 4.0.0 | Source code |
Libpostal
The Libpostal enricher parses and normalizes street addresses using statistical NLP and open data. This enricher returns international street address.
The Libpostal enricher supports the following endpoint:
http://<host>:<port>/parser body = {query: {address}}
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.Libpostal | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.Libpostal | 4.1.2 | Source code |
| CluedIn.Provider.ExternalSearch.Libpostal | 4.1.1 | Source code |
| CluedIn.Provider.ExternalSearch.Libpostal | 4.1.0 | Source code |
| CluedIn.Provider.ExternalSearch.Libpostal | 4.0.0 | Source code |
Open Corporates
The Open Corporates enricher retrieves information on all companies worldwide. This enricher returns VAT/TAX number.
The Open Corporates enricher supports the following endpoints:
-
https://api.opencorporates.com/v0.4/companies/search?q={nameLookup}, where{nameLookup}is the name of company – this endpoint is called when no company codes can be found in golden record’s organization.codes.cvr, organization.codes.brreg, organization.codes.companyHouse, or organization.codes.cik -
https://api.opencorporates.com/v0.4companies/{jurisdictionCodeLookup.Jurisdiction}/{jurisdictionCodeLookup.Value}?format=json– this endpoint is called when there are company codes, so the jurisdiction of golden record will be retrieved and used in the API.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.OpenCorporates | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.OpenCorporates | 4.1.2 | Source code |
| CluedIn.Provider.ExternalSearch.OpenCorporates | 4.1.1 | Source code |
| CluedIn.Provider.ExternalSearch.OpenCorporates | 4.1.0 | Source code |
| CluedIn.Provider.ExternalSearch.OpenCorporates | 4.0.0 | Source code |
PermId
The PermId enricher retrieves information about organizations from the PermID database. It supports the following endpoints:
-
https://api-eit.refinitiv.com/permid– this API is called first. -
https://permid.org/api/mdaas/getEntityById/– this API is called second to get the social data.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.ExternalSearch.Providers.PermId.Provider | 4.4.0 | Source code |
| CluedIn.ExternalSearch.Providers.PermId.Provider | 4.0.1 | Source code |
| CluedIn.ExternalSearch.Providers.PermId.Provider | 4.0.0 | Source code |
Vatlayer
The Vatlayer enricher validates and cleans EU VAT numbers. It supports the following endpoint:
http://www.apilayer.net/api/validate?access_key={apiToken}&vat_number={vat}&format=1, where{apiToken}is your API key for retrieving information from the Vatlayer website and{vat}is the VAT number of the company.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.Provider.ExternalSearch.Providers.VatLayer | 4.4.0 | Source code |
| CluedIn.Provider.ExternalSearch.Providers.VatLayer | 4.0.1 | Source code |
| CluedIn.Provider.ExternalSearch.Providers.VatLayer | 4.0.0 | Source code |
Web
The Web enricher retrieves information about organizations through their websites. The Web enricher supports any website provided in the Website Vocab Key field of the enricher configuration.
| Package name | Package version | Source code |
|---|---|---|
| CluedIn.ExternalSearch.Providers.Web | 4.4.0 | Source code |
| CluedIn.ExternalSearch.Providers.Web | 4.1.2 | Source code |
| CluedIn.ExternalSearch.Providers.Web | 4.1.0 | Source code |
| CluedIn.ExternalSearch.Providers.Web | 4.0.0 | Source code |