Producer Gateways

Producer gateways query an external source and return a result list. They do not modify any object. Use script type producerGateway with "scope": "GENERAL".

Producer scripts are exposed via the Sources API. See Sources for the endpoint reference and response format.

---

CompanySearch

Script type: producerGateway
Gateway name: CompanySearch

Searches a national business register by company name and returns a list of matching companies.

Supported countries:

Source	Countries
KvK	NL
Companies House	GB
OpenCorporates	DE FR BE AT CH LU IT ES DK SE NO FI IE PL SG HK NZ

Input parameters:

Name	Type	Required	Description
countryCode	TEXT	Yes	ISO country code (see supported countries above)
query	TEXT	Yes	Company name search query

Output: A list of results, each with:

Name	Type	Description
key	TEXT	Composite key COUNTRY:registrationNumber — pass directly to CompanyRegister or companyLookupGateway
registrationNumber	TEXT
name	TEXT
active	BOOLEAN
legalForm	TEXT
city	TEXT
postalCode	TEXT
country	TEXT
registrationDate	DATE
endDate	DATE

{
  "name": "CompanySearch",
  "type": "producerGateway",
  "scope": "GENERAL",
  "gateway": "CompanySearch",
  "parameters": [
    { "name": "countryCode", "dataType": "TEXT" },
    { "name": "query",       "dataType": "TEXT" }
  ]
}

---

CompanyLookup

Script type: producerGateway
Gateway name: companyLookupGateway

Fetches the full company profile for a single company by composite key. Intended for use after a CompanySearch result is selected; pass the key field from the search result directly. Supports the same countries as CompanySearch.

Input parameters:

Name	Type	Required	Description
key	TEXT	Yes	Composite key COUNTRY:registrationNumber (e.g. NL:12345678)

Output: Same fields as CompanyRegister.

{
  "name": "CompanyLookup",
  "type": "producerGateway",
  "scope": "GENERAL",
  "gateway": "companyLookupGateway",
  "parameters": [
    { "name": "key", "dataType": "TEXT" }
  ]
}

---

CompanyRelations

Script type: producerGateway
Gateway name: companyRelationsGateway

Returns the directors, officers, shareholders, and other position holders for a Dutch company. Data is sourced from the webservices.nl KvK extract (€3.47 per call). Currently available for NL only.

Input parameters:

Name	Type	Required	Description
countryCode	TEXT	Yes	ISO country code. Currently only NL is supported.
registrationNumber	TEXT	Yes	8-digit KvK registration number.

Output: A list of position records — one item per role held at the company.

Name	Type	Description
relationType	TEXT	SHARES, DIRECTOR, PROXYHOLDER, or OTHER
subjectRole	TEXT	Role label for the company (always "Company")
counterpartyRole	TEXT	Role label for the holder ("Shareholder", "Officer", or "Counterparty")
functionType	TEXT	KvK function type code
functionTitle	TEXT	Function title
functionDescription	TEXT	Function description
functionAuthorizationSigningPower	TEXT	Signing power description
functionAuthorizationDescription	TEXT	Authorization description
startDate	DATE	Function start date
endDate	DATE	Function end date
authorizationStartDate	DATE	Authorization start date
authorizationEndDate	DATE	Authorization end date
dateSince	DATE	Date since the position is held
personFullName	TEXT	Full name — person holders only
personFirstName	TEXT
personLastName	TEXT
personInitials	TEXT
personTitle	TEXT
personGender	TEXT
personDateOfBirth	DATE
organizationName	TEXT	Organisation name — organisation holders only
organizationRegistrationNumber	TEXT	KvK number of the holding organisation

The holder is either a person or an organisation — the two field groups are mutually exclusive.

{
  "name": "CompanyRelations",
  "type": "producerGateway",
  "scope": "GENERAL",
  "gateway": "companyRelationsGateway",
  "parameters": [
    { "name": "countryCode",        "dataType": "TEXT" },
    { "name": "registrationNumber", "dataType": "TEXT" }
  ]
}

---

OrganizationTree

Script type: producerGateway
Gateway name: organizationTreeGateway

Returns the corporate organisation tree for a Dutch company via webservices.nl (€0.10 per call, cached for 30 days). Currently available for NL only. Returns a single record.

Input parameters:

Name	Type	Required	Description
countryCode	TEXT	Yes	ISO country code. Currently only NL is supported.
registrationNumber	TEXT	Yes	8-digit KvK registration number.

Output fields:

Name	Type	Description
registrationNumber	TEXT	KvK registration number of the root company
name	TEXT	Company name
root	OBJECT	Root node of the organisation tree

Each node in root (and its children, recursively) has:

Name	Type	Description
id	TEXT	Node identifier
name	TEXT	Entity name
type	TEXT	Entity type
children	ARRAY	Child nodes (same structure)

{
  "name": "OrganizationTree",
  "type": "producerGateway",
  "scope": "GENERAL",
  "gateway": "organizationTreeGateway",
  "parameters": [
    { "name": "countryCode",        "dataType": "TEXT" },
    { "name": "registrationNumber", "dataType": "TEXT" }
  ]
}