Developer portal

Documentation

This API offers valuable data for assessing whether to engage in business with a company. Its strength lies in the ability to define custom templates with sets of rules that influence the API's response. These rules act as alarm thresholds, triggering a true/false alarm state. When configured correctly, each indicator will display an alarm status, providing a comprehensive view of the company's risk level.

Entities in the API:

Indicators: Actual data points representing company events, including historical data.
Templates: User-defined configurations of rules applied to indicator data.
Rules: Definitions with user-defined parameters that build the conditions to filter indicator data.

Customize Your Experience with Risk API Templates:

To query the Risk API, a user-defined template is required. This template can be created in the "Risk Templates" section, accessible via the settings panel. During the creation process, users select one of the predefined templates and configure it with custom parameters and thresholds. Once saved, the templates for your organization will appear in the list at the root of the "Risk Templates" section. Each template is assigned a templateId, which is then used to query the API through the GET /{templateId}/{companyId} endpoint. This applies the template to the indicator data for the specified company.

Within the "Risk Templates" section, users can create, list, and modify existing templates. Additionally, a changelog is available to help users easily track changes made to templates within their organization.

Primary Endpoint:

After obtaining a templateId a user can now query the API via GET /{templateId}/{companyId} endpoint. This will applying the template to the indicator data of the specified company.

Helper Endpoints: These endpoints complement the UI-based approach to managing templates. The write endpoint have been disabled initially but its possible to list entities via the API.

The sandbox examples consist of 5 companies with mocked indicator data and 2 pre-configured templates. In a production environment, the indicators are recalculated daily based on real company data, while the templates can be adjusted at any time through the settings GUI. The parameter values in these sandbox templates are purely fictional and not recommendations for production use. In production, customers should define thresholds that suit their specific needs. For advice on configuring templates, don’t hesitate to contact Roaring support. For this demonstration, the current date is mocked to 2024-01-01, as several indicators depend on date calculations.

1. Full Sandbox Template (4ecbaaaa-139f-4196-b365-477c87878919)

The full sandbox template is designed to identify a broad range of risks effectively. It includes balanced thresholds and active monitoring of key indicators such as board changes, revenue efficiency, and regulatory compliance. The template aims to catch companies with operational instability, financial issues, or regulatory non-compliance.

Key Characteristics:

Balanced thresholds for indicators like board changes, address changes, and financial performance.
Comprehensive coverage: Monitors both financial and non-financial risks, including compliance with tax and registration regulations.
Multi-dimensional risk detection, ensuring companies with various risk profiles are identified.

2. Alternative Weaker Sandbox Template (a0b55461-b2c3-409e-871b-3083ab5779fb)

This weaker template demonstrates how lenient thresholds and disabling certain indicators can reduce the effectiveness of risk detection. It uses overly lenient thresholds and disables several indicators. It highlights the impact of omitting important indicators from the API response, which may suit specific customer needs but also introduces the risk of overlooking key issues.

Key Characteristics:

Higher thresholds: Indicators like board changes and address changes have lenient limits, reducing sensitivity.
Disabled indicators: Some key metrics, like revenue efficiency and industry code changes, are omitted from the API response.
Flexible configuration: Shows how the API allows customization to fit specific customer needs, but also demonstrates the potential downsides of a misaligned setup.

`templateId` required	string id of risk template
`companyId` required	string id of company

indicatorName	description	defaultValue
fTaxReg	Whether the company is registered for f-tax	false
vatReg	Whether the company is registered for VAT	false
arbAvgReg	Whether the company is registered for employee contribution	false
missingAuditor	Whether the company currently lacks auditor	-
meanAgeOfRepresentatives	Mean age of the current board	-
boardChangeCount	Tracks the number of times the board of directors has been changed per month	0
addressChangeDates	Tracks the dates that the address of the company has been changed	0
industryCodeChanges	Tracks the industry code changes with date and code	0
registrationDate	Registration date of the company	-
orgDataChanges	Number of changes to base company information for periods	0

Risk indicators

Documentation

Sandbox Examples

Endpoints

Find company risk information by company id

Find risk template by id

Find all risk templates that are available for you company

Documentation

1. Full Sandbox Template (4ecbaaaa-139f-4196-b365-477c87878919)

2. Alternative Weaker Sandbox Template (a0b55461-b2c3-409e-871b-3083ab5779fb)

Indicators and default values

Company Indicator Data

1. 5560572850 Company in High-Risk Status (Bankruptcy, Frequent Changes)

2. 5564881422 Company with Stable Operations and Minor Changes

3. 5564779444 Company with Recent Growth and Organizational Changes

4. 5567164818 Newly Registered Company with No Historical Data

5. 5564866803 Company with Missing Auditor and Regulatory Issues