Actions5
- Company Actions
Overview
This node integrates with the Polish Statistics Office (GUS) API to retrieve company information based on various identifiers. Specifically, the "Get by REGON" operation allows users to fetch detailed company data using a REGON number, which is a unique identifier assigned to entities in Poland.
Common scenarios for this node include:
- Verifying company details during onboarding or compliance checks.
- Enriching datasets with official company information.
- Automating business intelligence workflows that require up-to-date company data.
For example, a user can input a REGON number and receive structured company information such as name, type, and registration details directly from the official GUS database.
Properties
| Name | Meaning |
|---|---|
| REGON Number | The REGON number to search for (a unique company identifier in Poland). |
| Additional Options | A collection of optional settings: |
| - Auto Login | Whether to automatically login to the API (true/false). |
| - BIR Version | BIR API version to use; options are "1.0" or "1.1". |
| - Auto Solve Captcha | Whether to automatically solve captchas using an external anti-captcha service (true/false). |
| - Request Timeout (seconds) | Timeout for API requests in seconds; recommended 30+ seconds due to potential slowness (min 5, max 120). |
| - Include Raw Response | Whether to include the original raw response from the GUS API as binary data (true/false). |
Output
The node outputs JSON objects containing the company data retrieved from the GUS API. The structure varies depending on the specific data returned by the API but generally includes company details keyed by standard fields.
If the "Include Raw Response" option is enabled, the node also attaches the original raw API response as binary data. This raw data may be in XML or JSON format and provides the full unprocessed response for advanced use cases or debugging.
In case a captcha challenge is required by the API and automatic solving is not enabled, the output will contain an error message indicating the need to solve the captcha manually.
If no data is found for the given REGON number, the node outputs a message indicating no data was found.
Dependencies
- Requires an API key credential for authenticating with the GUS API.
- Optionally requires an anti-captcha.com API key if automatic captcha solving is enabled.
- Network connectivity to the GUS API endpoints.
- Recommended to configure request timeout to at least 30 seconds due to possible slow responses from the GUS API.
Troubleshooting
- Captcha Required: If the API returns a captcha challenge and auto-solving is disabled or no anti-captcha API key is provided, the node will output an error asking the user to solve the captcha manually or enable auto-solving.
- Timeouts and Connection Errors: Common network errors like socket hang-ups, connection resets, or timeouts may occur due to the GUS API's instability or slowness. Increasing the request timeout or retrying later often resolves these issues.
- No Data Found: If the REGON number does not correspond to any company, the node outputs a message indicating no data was found.
- Invalid API Key or Environment: Initialization failures usually indicate incorrect API credentials or environment configuration. Verify the API key and whether sandbox or production mode is selected.
- Report Type Errors (for Full Report operation): When fetching full reports, some report types may not be valid for certain entities. The node tries multiple report types automatically and throws an error if none succeed.
Links and References
- GUS (Polish Statistics Office) Official Website
- REGON Identifier Explanation
- Anti-Captcha Service (for automatic captcha solving)
- Node-regon GitHub Repository (underlying client library used)