Skip to main content
Version: 19

Import UBO Data

Business goal​

Processes a client's UboStructure raw JSON data and imports the natural persons as Client Owners (UBOs).

This action is meant to be used in combination with the FetchUboInfo action, which is responsible for fetching the UBO data from the external provider and storing it as raw JSON on the client.

It features a safe-merge architecture: it updates or removes UBOs provided by the configured provider while strictly protecting human-entered (manual) UBOs and UBOs imported from other third-party providers.

Configuration​

  1. Add the action ImportUboData.
  2. Link this action to an appropriate event or status transition (e.g., a dossier status change where UBO resolution is required).
  3. Configure the settings (see below) to specify which provider's data is being imported.

:::warning Fail-Safe Guardrail To prevent accidental data loss due to misconfiguration, this action includes a strict built-in guardrail. The system verifies the incoming payload against the configured uboProviderType mapping.

  • If the data sitting in the UBO Structure belongs to a different provider (e.g., action expects GRAYDON but Ubo Structure data contains BVD references), the action will immediately abort.
  • If the UBO Structure payload completely lacks valid external party references, the action will also abort, ensuring it never blindly overwrites the database. :::

Settings​

Required Settings​

  • uboProviderType (ENUM) : The external provider acting as the source for this import (e.g., GRAYDON, BVD, etc.).
info

This setting acts as a critical safety mechanism. It provides the mapping of supported UBO providers to their associated external party reference prefixes. The system uses this to safely identify and overwrite only the historical data previously imported by this specific provider, while manual entries or records from other providers are perfectly preserved.

Optional Settings​

  • maxAssociatedPartiesCount : Used to limit the amount of associated parties that can be imported from a Provider to prevent performance issues. The default value is 50. If the payload exceeds this number, the import is aborted.
  • associatedPartyFilter : Filter that triggers the action if at least one associated party matches the criteria.
  • dossierFilter : Filter that triggers the action only if the dossier matches the criteria.
  • failOnError : Marks the event as failed and stops subsequent actions when an exception occurs.
  • reportFailure : Sends an error report (e.g., email) when the action ends in failure.
  • retryFailure : Retries the action automatically when it fails.

Settings Configuration

Examples