Gateways Reference

Gateways are platform services that scripts can call. The "gateway" property in a script definition names the gateway, e.g. "gateway": "CompanyRegister".

A script that names a gateway the platform installation does not have still loads: the model status reports a WARNING, and the script fails only when it runs. Which gateways exist is a property of the installation, not of your model.

Stability

Each gateway is either stable or beta:

• A stable gateway's contract is covered by the compatibility guarantee. Its contract is either the archetype it works on (Invoice fills commons.invoice), or the names of its parameters and targets, which are frozen.
• A beta gateway works, but its contract may still change in a later release. A script that uses one is reported as an INFO finding in the model status. Several beta gateways are planned to become archetype-driven.

A gateway script's apiVersion names the version of the gateway's contract it was written for (default 1). A version higher than the gateway supports is a warning.

See Gateway Scripts for how to wire gateways into script definitions.

note

Calls made through gateways to external services count against per-tenant rate limits. When a limit is reached the platform returns HTTP 429 and the calling script or import stops. See External Service Limits for configuration and the usage endpoint.

Function gateways

Function gateways enrich an object by returning structured data that is written back to the object's fields.

Gateway	Stability	Purpose
Ai	stable	Extracts structured field values from free-form text using Gemini
DocumentTriage	stable	Classifies a document and generates a title using Gemini
Invoice	stable	Extracts structured invoice data from a PDF via Google Document AI, into the commons.invoice archetype
Echo	beta	Reflects input parameters back as output — useful for testing
MarkdownConversion	beta	Converts a PDF to Markdown via Google Document AI
AddressSearch	beta	Looks up a Dutch address by postal code and house number
CompanyExtract	beta	Fetches an official company extract PDF (NL only)
CompanyRegister	beta	Enriches an object with company data from KvK (NL) or Companies House (GB)
DataEnrichment	beta	POSTs field values to a configurable HTTPS endpoint and merges the response

See Function Gateways for the full reference.

Producer gateways

Producer gateways query an external source and return a result list. They do not modify any object.

Gateway	Stability	Purpose
CompanySearch	beta	Searches a national business register by company name
CompanyLookup	beta	Fetches the full company profile for a single company by composite key
CompanyRelations	beta	Directors, officers, and shareholders for a Dutch company (NL only)
OrganizationTree	beta	Corporate organisation tree for a Dutch company (NL only)

See Producer Gateways for the full reference.

Consumer gateways

Consumer gateways call an external service and do not return a result.

Gateway	Stability	Purpose
Webhook	stable	Sends an HTTP request to a configurable endpoint
DatastoreReplicator	stable	Replicates object data to an analytical datastore (BigQuery) in micro-batches
Mail	beta	Sends a transactional email
UserInvitation	beta	Creates a user invitation and sends a confirmation email

See Consumer Gateways for the full reference.