*Document(s)Required

Business goal

These classes validate whether a (configurable) set of documents is present. Depending on the class, they have additional behavior

Configuration

Enum value

Needs to contain a FlowStep identifier.

Some classes have limitations or behave differently depending on the selected flow step:

• Class FlowStepClientDocumentRequired only supports:
  • PROFILE_DOCUMENTS
    • Note: will only execute when the Client is not an Individual or when the Client is the Responsible.
  • CLIENT_DOCUMENTS
    • Note: will only execute when the Client is not an Individual.
  • CLIENT_INDIVIDUAL_PROFILE_DOCUMENTS
    • Note: will only execute when the Client is an Individual.
• Class IdentityProviderDocumentsPresent only supports:
  • IDENTITY_READOUT
  • IDENTITY_PROFILE
  • CLIENT_INDIVIDUAL_IDENTITY_READOUT
  • CLIENT_INDIVIDUAL_PROFILE
• Class FlowStepResponsibleDocumentRequired only supports:
  • PROFILE_DOCUMENTS

Settings

The settings of this validation consist primarily of:

• An errorCode to be translated & send to the FE.
• A set of validation settings:
  • A set of documentTypes that are required on the Client.
  • A list of nestedValidations that allows more complex document type filters.
  • A documentTypesCardinality that indicates whether only ONE or ALL document types or nested validations in the list are required.

Additionally, some classes support additional settings or need to be configured slightly different:

• Classes FlowStepClientDocumentRequired and FlowStepResponsibleDocumentRequired:
  • An optional partyType to only apply the validation when the Client is of a certain party type.
• Class DocumentsRequired:
  • The above validation settings are nested inside a validation field
  • A source field that defines what document set is validated. Holds one of:
    • IDENTITY: The client's identity documents.
    • DOSSIER: The dossier documents.
    • CLIENT: The client documents.