Skip to main content
Version: 🚧 Next

Identity

🎯 Functional documentation​

The Harmoney application already captures a significant amount of identity-related data on the Party Individual entity, such as first and last name, date of birth, address, etc. The identity module aims to capture a person's identification data or credentials. This represents data that can be used as evidence to verify or prove a person’s identity, rather than the identity itself.

Behaviour details​

On FSP side​

  • Identity data is only editable when identity is in status OPEN
  • When identity data is changed:
    • identitySource is set to MANUAL
    • verifiedBy user and timeVerification are reset (= "confirmed by" data)
    • timeUpdated field of the individual associated with the identity is updated
  • Identity status is always editable:
    • If the identity is in status APPROVED, it can only be reopened. → doing so will reset all the existing identity data
    • If the identity status is not APPROVED, changing the status will have no effect on other identity data
  • Using an identity provider:
    • Data fetched from the identity provider is always patched onto the current identity data
    • If the current identity was in status APPROVED then the identity data will be reset
    • If the current identity documents were provided by the identity provider, then those are removed (to avoid duplicates)
    • Identity source is set to EID

In the information exchange​

  • Behavior is the same for all identities, regardless if the identity belongs to a client, responsible, UBO, etc
  • In general, every update to identity data or documents will set the identity status to SUBMITTED
    • exception: when updating only identity documents manually
  • Identity data is always editable in the identity flowstep by the responsible

    • if no identity data was changed by the responsible and identity was already in status APPROVED, the identity is left as-is

    • if any identity data was changed or if the identity status was not APPROVED:

      → verifiedBy user and timeVerification are set (based on the current user)

      → doing so will reset all the existing identity data

  • Identity documents are only editable when the identity isn't in status APPROVED
    • This is on purpose to make sure identity data won't be cleared when updating documents (the flow step to provider documents is most likely the last one)
  • Using an identity provider:
    • Data fetched from the identity provider is always patched onto the current identity data
    • If the current identity was in status APPROVED then all existing identity data will be reset
    • If the current identity documents were provided by the identity provider, then those are removed (to avoid duplicates)
    • (?) Identity source is NOT set to EID
    • Identity status is set to SUBMITTED

Configuration​

Enable the module IDENTITY

Settings​

Settings Configuration

Examples