Skip to main content
Version: 🚧 Next

Action classes

Available classes​

ClassType(s)DescriptionRequired modules
AddDossierReviewSTATUSAdds the action for a review on the dossier, see Four-eyes principle
AddTaskToDossierEVENTAdd a task to a dossier.TASKS
ApproveAssociatedIndividualIdentitySTATUSApproves the identity of each associated individual, unless approval is not allowed by the validation rules.
ApproveBOCompanyUBO (deprecated)STATUSApproves the owners/members of each associated company/indivision/partnership on Back Office, unless approval is not allowed by the validation rules.
ApproveBOIndividualIdentity (deprecated)STATUSApproves the identity of each associated individual on Back Office, unless approval is not allowed by the validation rules.
ApproveNotEscalatedDossierSTATUSApprove a dossier (if an analyst-role is allowed to approve the dossier).
ApproveUboStructureSTATUSApproves the owners/members of the client (company/indivision/partnership), unless approval is not allowed by the validation rules.
ArchiveDossierSTATUS
AssignToDossierOwnerSTATUSAssign the dossier to the dossier owner.
BackOfficeAssociatedPartiesCddCheck (deprecated)STATUSExecute a due diligence check for each associated party on Back Office. Provider exceptions will lead to action failure.DUE_DILIGENCE
BackOfficeAutomationFinished (deprecated)EVENTTriggers the BACK_OFFICE_AUTOMATION_FINISHED event (to trigger further automation by a separate event).
BackOfficeInternalDossierEddCheck (deprecated)STATUSExecute a due diligence check on the dossier on Back Office. Provider exceptions are ignored.DUE_DILIGENCE
BackOfficeRbaCalculation (deprecated)STATUSRBA calculation on Back Office. The result is only stored when calculation is successful.RBA
CancelPendingSubmissionGroupsEVENTCancels pending submission group on the dossier. When no pending submission group is present, the action completes without changes.
ClearDossierAssigneeEVENTRemoves the dossier assignee.
ClearDossierReviewsSTATUSRemoves the action for a review on the dossier, see Four-eyes principle
ConvertDocumentFormatEVENTConverts an uploaded document to another format, keeping the same document record. Only tif and tiff to JPEG is supported. A document matching no conversion is left alone.
CopyDossierNumberToExternalReferenceEVENTCopies Dossier Number to Dossier External Reference.
CreateDefaultBankAccountEVENTCreate a bank account for the dossierDOSSIER_BANK_ACCOUNTS
CreateDossierEVENTCreates one or more dossiers (useful for testing).
CreateDossierSameClientEVENTCreates one dossier for the same client as the triggering dossier, optionally gated by an associated party filter.
CreditsafeMonitoringDeregisterEVENTRemoves the dossier's company parties from the Creditsafe monitoring portfolio, only when no other dossier still uses them. Requires the Creditsafe monitoring provider.
CreditsafeMonitoringRegisterEVENTRegisters the dossier's company parties with the Creditsafe monitoring portfolio, so their changes can be picked up by the Creditsafe monitoring rescreening provider. Requires the Creditsafe monitoring provider.
DeleteDossierEVENTPermanently removes a dossier.
DeleteDossierTasksEVENTDelete tasks in a dossier based on task identifiers, task status, and optional dossier or party filters.
DeletePartyEVENTPermanently removes a party.
DossierEventActionEVENT
DossierSetLifecycleEVENTThis action can be used to set the lifecycle of a dossier to a pre-configured value (using the lifecycle value in the settings, null is allowed and default when the setting isn't specified).
DossierStatusChangeSTATUS
DossierSummaryTakeSnapshotEVENT
DownloadDossierFromFileServerEVENT
ExportDataEVENTExports a single dossier or party as a JSON file to the platform's document storage. Driven by the Data Export scheduled provider.
ExtendExternalDescriptionEVENTExtends external description.
FetchAndUpdateClientEVENTFetch the party from a party provider (if 1 single provider is configured).
FetchCompanyInfoEVENTFetch the company info if a supported provider is available.
FetchExternalCompanyDocumentsEVENTFetch the external documents for a client company if a supported provider is available.
FetchUboInfoEVENTFetch UBO information from external UBO providers and store it in the UBO structure.
FrontOfficeAssociatedPartiesCddCheckSTATUSExecute a due diligence check for each associated party. Provider exceptions will lead to action failure.DUE_DILIGENCE
FrontOfficeAssociatedPartiesCddCheckV2STATUSExecute a due diligence check for each associated party. By default (useRbaConfiguration: true) the parties are the RBA subjects of the dossier, like FrontOfficeAssociatedPartiesCddCheck; with useRbaConfiguration: false they are selected by associatedPartyFilter, independently of the RBA configuration. Provider exceptions will lead to action failure.DUE_DILIGENCE
FrontOfficeAutomation (deprecated)EVENTSet the dossier in OPEN status (to trigger further automation). Requires a back office!
FrontOfficeAutomationFinished (deprecated)EVENTTriggers the FRONT_OFFICE_AUTOMATION_FINISHED event (to trigger further automation by a separate event).
FrontOfficeInternalDossierEddCheckSTATUSExecute a due diligence check on the dossier. Provider exceptions are ignored.DUE_DILIGENCE
FrontOfficeRbaCalculationSTATUSRBA calculation. The result is only stored when calculation is successful.RBA
GenerateAmlDocumentSTATUSAML
GenerateReportEVENTListens on GENERATE_REPORT_ASYNC events and generates a report result on the configured FSP for the given report identifier.Possible to configure the delimiter used for the report CSV using setting "DELIMITER" (default is "COMMA")FINANCIAL_SP_REPORTING
GenerateRbaReportEVENTGenerates and stores an RBA report.
ImportUboDataSTATUSProcesses a client's UboStructure raw JSON data and imports the natural persons as Client Owners (UBOs).UBO
InformReminderSentEVENTInforms someone that the counterparty has been reminded for information exchange completion by sending a new mail.
MailInvestorFlowFinishedEVENTINVESTOR_FLOW
MailStatusChangeDetailsSTATUS
MapDataPointToClientMetadataEVENTThis action searches the value of a data point and maps it to a client metadata field.
PerformClientOutreach (deprecated)EVENTPerforms a client outreach using a configured flow option. The supported flow options are: [DIRECT_INVESTOR_MAIL].\nNote that this automation only works for dossiers with a pending status. Superseded by PerformClientOutreachV2.
PerformClientOutreachV2EVENTPerforms a client outreach using a configured flow option (supported: DIRECT_INVESTOR_MAIL). With module INVESTOR_FLOW it invites all responsibles of the dossier and requires the dossier to be in its pending status. With module DOSSIER_INFORMATION_EXCHANGE it invites all individual counterparties of the dossier's current information exchange, which must already exist.
PerformDocumentAssessmentEVENTTriggers document assessment for non-system-generated documents on the dossier and its associated parties. V1 always skips already assessed documents. V2 supports configurable re-assessment via skipAlreadyAssessedDocuments setting (default: true). Manual assessments are never overwritten.
PerformStatusTransition EVENTPerforms a status transition for the dossier.
PublishToBackOffice (deprecated)STATUSBACK_OFFICE
RedirectExternally (deprecated)STATUS
RemindCounterpartyOnInformationExchangeCompletionEVENTReminds the counterparty on information exchange completion by sending a new mail.
RemoveDossierResponsiblesEVENTThis action can be used to remove all responsibles from a dossier if it meets specific filter criteria specified in settings.
ReopenDossierTaskEVENTReopen completed tasks in a dossier based on task identifiers and optional dossier or party filters.
SaveLastUsedFlowOptionToDossierEVENTSave last used flow option on the dossier metadata.INVESTOR_FLOW
ScheduleInviteCounterpartyReminderEVENTSchedules an event to remind the counterparty on a time defined by the settings.
SendMailEVENTSends a mail when a specific event occurs. Can be used for different types of mails.
SendMailOnDossierStatusChangeSTATUSSend an email when a dossier progresses into a specific dossier status. Recipient mail and email template can be customised (settings emailRecipient & emailTemplate)
SendCallbackEVENTPost a callback that was scheduled by TriggerCallbackEvent.
SendCallbackOnFailureEVENTPost a callback with status FAILED. Url can be overruled via 'callbackUrl' (supports variables). Body definable by setting 'href' (gateway url, supports variables $dossier.ref, $bo.ref, $fo.ref). Execution limited to failing event defined by setting 'triggeringEventType'. Configure linked to the FAILED event.
SendEmailToDossierRecipientEVENTSend an email when a dossier progresses into a specific dossier status. Supports dynamic & static email recipients and configurable email template
SendToBackOffice (deprecated)EVENTSend the dossier to Back Office using PARTNER_ADVISOR role (similar to PerformStatusTransition (target: AT_BACK_OFFICE).
SetDocumentValidityDateEVENTAutomation to set a "valid until" date on documents.What document validity applies to what documents can be defined by configuring document validity configurations in the settings of this automation.
SetDossierIntermediaryEVENTSets an intermediary FSP on a dossier by matching a configured identifier (exact, substring or regex) against the intermediaries available for the dossier's FSP.INTERMEDIARY
TriggerCallbackEventEVENTTriggers the SEND_CALLBACK event containing the payload for the body. Payload property 'href' definable by setting 'href' (gateway url, supports variables $dossier.ref, $bo.ref, $fo.ref).Payload property 'message' definable by setting 'message'.Payload property 'type' definable by setting 'type'.Payload property 'status' is SUCCESS unless validation fails for settings 'rbaScoreAvailable', 'rbaScoreUpToDate', 'requiredStatus'Url can be set via 'callbackUrl' (supports variables). If not set, external url from dossier is used. If not present, no callback event.Configure at the end of the automated flow.
UpdateDossierClientDataSTATUSUpdate metadata (key-value pairs) on a dossier and/or its main client
UploadDossierToFileServerSTATUSUploads a JSON representation of the dossier to the file server configured on the white label. A valid FTP identifier for setting PROVIDER_IDENTIFIER is REQUIRED! This action must be configured to return a specific version of our gateway model using the setting gatewayVersion.
UploadReportToFileServer (deprecated)STATUSUploads a generated report to the file server configured on the file transfer provider.A valid FTP identifier for setting PROVIDER_IDENTIFIER is REQUIRED! Superseded by UploadReportToFileServerV2.
UploadReportToFileServerV2STATUSUploads a generated report to the file server configured on the file transfer provider, using a filename template that supports ${financialSpName}, ${identifier}, ${timestamp}, ${timestamp:<pattern>} and ${documentName}. The optional reportIdentifiers limits the upload to those reports. A valid FTP identifier for setting PROVIDER_IDENTIFIER is REQUIRED!
DummyActionEVENT