Creditsafe monitoring provider

Version 1

🎯 Functional documentation

This provider is the connection to Creditsafe Global Monitoring. It holds the portfolio in which the white label's companies are monitored, and it is the single place where the portfolio and the Creditsafe credentials are configured.

The provider does nothing by itself: it has no schedule and is never triggered directly. It is used by three other configuration items:

Used by	For
CreditsafeMonitoringRegister	adding a dossier's companies to the portfolio
CreditsafeMonitoringDeregister	removing them again
Creditsafe monitoring rescreening provider	asking which monitored companies changed

:::info Read the full picture first The whole flow — from importing a company to rescreening it after a change — is described on the Creditsafe monitoring rescreening provider page. Configure this provider together with the two actions and the rescreening provider; on its own it has no effect. :::

Only company parties are monitored. Individuals are ignored, even when they match the configured associated party types.

⚙️ Configuration

Required authorization settings

• clientId
• clientSecret
• resourceUri: https://connect.creditsafe.com/v1/

Implementation class

eu.myharmoney.app.providers.monitoring.creditsafe.CreditsafeMonitoringProvider

Settings

• PORTFOLIO_ID (required): the numeric identifier of the Creditsafe Global Monitoring portfolio. Companies are added to this portfolio and its notification events are the ones that are read. Use a $vault{...} placeholder when the portfolio differs per white label.
• METADATA_KEY_IDENTIFIER: the party metadata key that holds the Creditsafe Connect ID. Configure exactly the same key as on the Creditsafe party provider (its setting metadataKeyForExternalRefIdentifier). Leave it empty when that provider stores the Connect ID in the party's external reference field instead.
• associatedPartyTypes: which parties of a dossier are registered. Any associated party type is accepted, and de-registration asks about exactly the same set, so a company is never taken out of the portfolio while another dossier still needs it. Defaults to CLIENT when the key is omitted; an empty list is rejected. Remember that only company parties are ever registered, so adding a type that only ever holds individuals has no effect.
• SUPPORTED_COUNTRIES: limits registration to companies established in these countries. When empty, all countries are registered. Note that this filter is only applied when registering: a company is always removed from the portfolio when its dossiers are gone, also when the country list changed in the meantime.
• PROVIDER_DISPLAY_NAME: the name shown in the UI.

This provider is included in the periodic provider health check. The check authenticates against Creditsafe Global Monitoring, so expired credentials or lost access show up as a failed provider in the admin panel instead of as a rescreening that quietly finds nothing.

:::warning Keep associatedPartyTypes aligned with the rescreening provider This setting decides which companies are registered; the same setting on the rescreening provider decides which companies are acted on. If the two drift apart you either pay for monitoring changes nobody looks at, or you look for changes on companies that were never registered. :::

:::note The consumers name this provider explicitly Both actions and the rescreening provider resolve this provider through their own MONITORING_PROVIDER_IDENTIFIER setting, in which they put this provider's identifier. A white label can therefore run several portfolios side by side, each with its own set of monitoring provider, register action, de-register action and rescreening provider — as long as all three consumers of a set name the same identifier. The portfolio itself and the rules that decide which company changes generate an event are managed in the Creditsafe UI, not in Harmoney. :::

Example

{
    "PROVIDER_DISPLAY_NAME": "Creditsafe monitoring",
    "PORTFOLIO_ID": "100001",
    "METADATA_KEY_IDENTIFIER": "external_ref_id",
    "SUPPORTED_COUNTRIES": [
        "BE",
        "LU",
        "NL"
    ],
    "associatedPartyTypes": [
        "CLIENT",
        "PARTY_RELATION",
        "DOSSIER_PARTY_RELATION"
    ]
}

Settings: schema

Settings Configuration

Examples