Skip to main content
Version: 18

Flow Option definitions

Overview​

On Information Request:

  • DIRECT_INVESTOR_MAIL: Invites the counterparty by sending a mail that contains an url which navigates to the flow. Mail templates EMAIL_INFORMATION_EXCHANGE_INVITE or EMAIL_INVESTOR_FLOW_INVITE are used depending on the configured module.
  • DIRECT_INVESTOR_SMS: Invites the counterparty by sending an sms that contains an url which navigates to the flow (using OTP verification)
  • INVESTOR_MAIL: (only for counterparty individual) Invites the individual via mail template EMAIL_INVESTOR_FLOW_INVITE and requires the individual to be registered on the MyHarmoney platform.
  • GENERATE_URL: Returns an url which navigates to the flow. This url can be sent via any channel (e-mail, sms, etc.)
  • GENERATE_MAILTO: Returns a link which opens the default e-mail client of the user with an email template that contains an url which navigates to the flow.
  • GENERATE_CODE: (only for counterparty individual) Generates a code that can be used to enter the information exchange flow via a code input screen aka the 'short url page'. The customer could send a letter to the customer with this code.
  • IMPERSONATE: Allows the FSP user to complete the flow, by asking approval from the counterparty individual through OTP verification via SMS.
  • IMPERSONATE_NO_OTP:
    • (for counterparty individual) Allows the FSP user to complete the flow, without asking approval from the counterparty individual.
    • (for counterparty intermediary) Allows the FSP user to review the flow and provide data, without having access to the intermediary FSP (but confirming or signing won't be possible in this case). Note: Use the newer INSPECT flow option instead to avoid confusion!
  • INSPECT: Allows the FSP user to inspect the information exchange. In this mode, the FSP user can traverse the information exchange and update data where necessary. Signing the information exchange is not possible in this mode.
  • SIGNED_CONTRACT_V2: (only for counterparty individual) Similar to IMPERSONATE_NO_OTP, but it's required to upload a document of type SIGNED_CONTRACT upfront which proofs they are allowed to complete the flow on behalf of the counterparty.

On Information Delivery (these option are not available on FSP side in the UI):

  • DIRECT_SALES: This option allows initiation of the flow via Direct Sales.
  • INFORMATION_DELIVERY_INTERMEDIARY:This option allows initiation of the flow for counterparty intermediary.

Configuration​

Flow display mode​

The flow display mode defines the layout of the UI when the user enters the flow.

  • APPLICATION: The "standard" layout. Menu and headers are visible in the flow.
  • DIRECT: Top header is visible, but other menus are hidden.
  • INTEGRATED: Layout without any Harmoney application context and headers. Desigend to be embedded in an iframe.

The navigation mode determines the next step after successfully completing the flow.

  • INTERNAL: The application should redirect internally.
  • EXTERNAL: The application should redirect externally.
  • POST_MESSAGE: The application should post a message to a parent url. Useful inside iframe.
  • NONE: The application will display a message that the flow is finished and allow the user to download the signed PDF.

Settings​

Every flow option definition can have an authentication method configured:

  • authenticationMethod: Authentication method is supported for the following flow options: DIRECT_INVESTOR_MAIL, DIRECT_INVESTOR_SMS, GENERATE_URL, GENERATE_CODE, GENERATE_MAILTO.
    If no authentication method is configured in the settings, the default behavior will be: look for a single SSO provider for information request in the whitelabel authentication settings. If no SSO provider is found, the user can authenticate using SMS registration.
    If multiple SSO providers are available for the direct flow, it is required to configure the desired authentication method for each flow option. Otherwise, the user will get a configuration error when he enters the flow because multiple SSO providers are found. An authentication method consists of the following fields:
    • type: The type of authentication. Either BUILT_IN for the SMS registration or PROVIDER for an SSO provider.
    • providerIdentifier: Required when type is PROVIDER. Should be valid active SSO provider configured in the whitelabel authentication settings.

It's also possible to set the e-mail template that will be used to send the invitation to the user. This is only possible for flow options that send the invitation via e-mail.

  • emailTemplate: The email template that should be used to send the invitation. This can be a custom email template that you have defined in the application.

Depending on the navigation mode, additional settings may be available:

  • Navigation mode INTERNAL:
    • target containing the internal target to redirect to. Possible values are DOSSIER_DETAILS, FRONT_OFFICE_DOSSIER_DETAILS.
  • Navigation mode EXTERNAL:
    • url containing the external URL to redirect to.
  • Navigation mode POST_MESSAGE:
    • url containing the URL to send the message to.
    • message containing the message to send to the URL.
  • Navigation mode NONE: no extra settings available.

Example(s)​

{
  "authenticationMethod": {
    "type": "PROVIDER",
    "providerIdentifier": "SSO - <client>"
  },
  "emailTemplate": "INVESTOR_FLOW_INVITE",
  "target": "DOSSIER_DETAILS"
}