Associated party data filter

The associated party data filter can be used in various places to:

• check if a party has a certain association to a dossier
• retrieve a set of parties based on their associations to a dossier

It is possible to filter based on the data of the association as well as based on the properties of the party itself.

The filter can be used in various places:

• Actions: to determine which parties should be considered for actions. For example, a certain action should only be executed for parties that are a related party of the dossier and have relationType:foo.
• Validations: to determine which parties should be considered for validations. For example, a validation should only be executed for parties of type individual with maritalStatus:married.
• Flow Definitions: to determine which flow steps are applicable to which parties. For example, a flow step should only be added in the flow if the party is on the UBO list and the percentage is above a certain threshold.
• Form Definitions: to determine which sections should be shown for which parties.
• ...

Settings Configuration

Structure

The filter consists of the following components:

• associatedPartyTypes (required): Specifies which associated parties must be retained. For certain association types, additional filtering can be performed on the data points of the association. Not that this is an OR condition. If you add multiple association types, parties that match any of the specified types will be retained.
• partyTypes: An optional list of PartyType. When set, only parties of these types are retained.
• partyFilter: An optional filter that applies to the party itself. See Party Filter for details.

The fields above are combined using an AND condition. This means that a party must match: ((any of the associatedPartyTypes) AND (any of the partyTypes if specified) AND (the partyFilter if specified)).

AssociatedPartyTypes

This field designates which associated parties will be included. The available association types include:

• Client: client
• Owners (UBOs) of the client: clientOwners
• Related parties of the client: clientRelatedParties
• Signatories of the client: clientSignatories
• Related parties of the dossier: dossierRelatedParties
• Insured persons: insuredPersons
• Beneficiaries: beneficiaries
• Responsibles (when using module INVESTOR_FLOW): responsibles
• Individual counterparties (when using module DOSSIER_INFORMATION_EXCHANGE): counterpartyIndividuals
• Selected signatories for an information exchange: selectedSignatory

An association type may have an optional filter. This can be useful to further narrow down which parties should be retained.

Examples

Filtering a flow step to be displayed only for a selected signatory

{
  "associatedPartyFilter": {
    "associatedPartyTypes": {
      "selectedSignatory": {}
    }
  }
}

Complex example using multiple conditions

{
    "associatedPartyFilter": {
        "associatedPartyTypes": {
            "clientRelatedParties": {
                "filter": {
                    "equals": {
                        "fieldPath": "relationType",
                        "value": "foo"
                    }
                }
            },
            "dossierRelatedParties": {
                "filter": {
                    "equals": {
                        "fieldPath": "relationType",
                        "value": "bar"
                    }
                }
            }
        },
        "partyTypes": [
            "INDIVIDUAL"
        ],
        "partyFilter": {
            "equals": {
                "fieldPath": "individual.maritalStatus",
                "value": "married"
            }
        }
    }
}