Skip to main content
Version: 18

Register companies for Creditsafe monitoring

Business goal​

This action puts the company parties of a dossier into the Creditsafe Global Monitoring portfolio of the white label. From that moment on, Creditsafe watches those companies and reports every relevant change.

It is the first step of event-based company monitoring. The complete flow is described on the Creditsafe monitoring rescreening provider page — read it before configuring this action.

:::warning This action is useless on its own Registering companies only makes sense in combination with the Creditsafe monitoring provider, the Creditsafe monitoring rescreening provider and the counterpart action CreditsafeMonitoringDeregister. Without the rescreening provider you pay for change events nobody reads; without the de-register action companies stay monitored forever. :::

What the action does​

  1. It looks up the Creditsafe monitoring provider named by its MONITORING_PROVIDER_IDENTIFIER setting, within the organization of the dossier's white label. When no provider with that identifier exists, the action fails — this is intentional, so a half-configured white label is visible instead of silently doing nothing.
  2. It collects the company parties of the dossier, limited to the associated party types configured on the monitoring provider (associatedPartyTypes). Individuals are never registered.
  3. Companies outside SUPPORTED_COUNTRIES of the monitoring provider are skipped.
  4. Companies without a Creditsafe Connect ID are skipped — they were not imported from Creditsafe and cannot be monitored. This is not an error.
  5. The remaining companies are added to the portfolio. A company that is attached to the dossier in several roles is registered once, and a company that is already in the portfolio stays as it is (no duplicate registration, no double billing), so re-running the action or re-approving a dossier is safe.
  6. It logs an automation event on the dossier stating how many companies were registered, how many were skipped for having no Connect ID, and how many were skipped for an unsupported country. A dossier whose companies were all skipped is therefore visible in the activity tab as such, instead of looking like a successful registration.

Configuration​

  1. Add the action CreditsafeMonitoringRegister.
  2. Link it to the event that marks the moment a dossier becomes "live", typically DOSSIER_APPROVED.
  3. Configure it asynchronously — the action talks to an external service.
{
  "className": "eu.myharmoney.app.bll.executors.events.creditsafe.CreditsafeMonitoringRegister",
  "type": "EVENT",
  "value": "DOSSIER_APPROVED",
  "synchronous": false,
  "enabled": true,
  "settings": {
    "MONITORING_PROVIDER_IDENTIFIER": "Creditsafe monitoring"
  }
}

Settings​

  • MONITORING_PROVIDER_IDENTIFIER (required): the identifier of the Creditsafe monitoring provider whose portfolio this action writes to. When the configuration is saved, Harmoney checks that a provider with this identifier exists in the organization.

:::danger All three configurations must name the same identifier The register action, the de-register action and the rescreening provider must all point at the same monitoring provider. If the actions write to one portfolio while the rescreening provider reads events from another, both sides succeed and the result is indistinguishable from a window in which nothing changed. Nothing validates this — only the existence of the named provider is checked at save time. :::

The scope of what gets registered (associated party types, countries, the portfolio ID and the metadata key holding the Connect ID) is still configured on the monitoring provider itself, not here.

The general action settings remain available, e.g. dossierFilter, failOnError, reportFailure and retryFailure.

:::tip Failures are retried only when it makes sense A temporary Creditsafe problem is retried automatically. A configuration problem (no monitoring provider, wrong portfolio) is not retried — it is logged on the dossier, where you can see it in the activity tab. :::

Settings: schema​

Settings Configuration