Skip to main content
Version: 🚧 Next

Providers Overview - Business Decisions & Configuration Guide

Table of Contents​

  1. Introduction
  2. Provider Types & Categories
  3. Detailed Provider Analysis

Introduction​

This document provides a comprehensive overview of all available providers in Harmoney, organized by type and category. For each provider, key business decisions and questions are identified. For technical configuration details, refer to the provider-specific technical documentation linked from each provider section.

Provider Types & Categories​

Harmoney includes the following provider categories:

CategoryPurpose
Authentication & AuthorizationSSO, API authentication, user management
CommunicationEmail, SMS, notifications
Data IntegrationParty enrichment, identity verification, party data
Due Diligence & ComplianceCompliance screening, AML checks, risk assessment
Document ManagementDocument storage, assessment, generation
Field ManagementField visibility, custom fields, value generation
Data Processing & AutomationScheduled tasks, data export/removal, report generation
External SystemsFTP/SFTP, dashboards, external APIs

Detailed Provider Analysis​

1. AUTHENTICATION & AUTHORIZATION PROVIDERS​

1.1 SSO (Single Sign-On) Providers​

Functional Purpose: Enable automatic user authentication and registration using external identity systems (OAuth2, SAML, etc.)

Business Questions & Decisions:​

  1. User Registration Strategy: Should users be automatically registered when logging in via SSO with minimal data (First Name, Last Name, Mobile), or should manual registration always be required?
  2. Role Assignment: Which roles should be assigned to users post-authentication (SSO_ROLES vs SSO_ROLE_MAPPING)?
  3. SSO Usage Context: Where should SSO be available - login page only, invitation links, API gateway authentication, or all?
  4. Gateway Access: Should SSO users be able to authenticate via API gateway with bearer tokens?

2. COMMUNICATION PROVIDERS​

2.1 Email Providers​

Functional Purpose: Handle all outgoing email communication from the application (notifications, invitations, etc.)

Business Questions & Decisions:​

  1. Default Sender: What should the "From" address look like? It is recommended to use noreply@domain or environment-noreply@domain.

2.2 SMS Providers​

Functional Purpose: Send OTP codes and SMS-based notifications for authentication and verification

Business Questions & Decisions:​

  1. SMS Service Provider: Which SMS gateway should be used (Twilio, AWS SNS, custom provider)?
  2. Default Sender: What is the primary number or Alpha Sender ID (e.g., "Harmoney") that should appear on user devices?
  3. Regional Routing: Are there specific countries where a local sender number is required for better deliverability? If so, define these in the SMS_SENDER_PER_COUNTRY mapping.

3. DATA INTEGRATION PROVIDERS​

3.1 Party Providers​

Functional Purpose: Enrich party information or create new parties by pulling data from external systems

Available Implementations:​

General Business Questions (Applicable to All Party Providers):​

  1. Party Enrichment vs Creation: Should this provider only enrich existing parties, or can it create new parties?
  2. Geographic Scope: Which countries/regions should this provider support?
  3. Party Type Restrictions: Should this provider work for Individuals, Companies, Partnerships, or all types?
  4. Data Update Strategy: How frequently should party data be refreshed from this provider?
  5. External Reference Handling: Should matched parties be stored with external reference IDs for future lookups?
  6. Data Mapping: Agree on mapping between external data fields and Harmoney party fields (or party metadata)?
  7. Fallback Behavior: What should happen if the provider cannot find matching data?

3.1.1 Bankers Almanac Provider​

Specific Focus: Bank and financial institution data

3.1.2 Bureau Van Dijk Provider​

Specific Focus: Comprehensive company information and ownership data

3.1.3 Creditsafe/Graydon Provider​

Specific Focus: International company data enrichment with specialized deep-data (Fraud/Credit scores) for Belgium and legacy support for Benelux (BE, NL, LU) entities.

Specific Business Decisions:

  1. Provider Version & Type Selection:
    • Modern (Creditsafe): Use the unified CreditsafeV10PartyProvider for international coverage. This single class handles both primary company data and related parties.
    • Legacy (Graydon): If using the predecessor system (no longer extended), you must choose a specific implementation based on the data required: GraydonCompanyProvider, GraydonManagerProvider (for related parties), or GraydonRestUboProvider.
  2. Related Party Integration:
    • Automated Linking: Determine if the system should automatically map and link related entities. To enable this, specific mappings must be defined for relationTypeDirector, relationTypeShareholder, relationTypeSubsidiary, etc.
    • Volume Thresholds: To protect performance, use maxAssociatedPartiesCount (defaulting to 50). Decide if the system should fail the import if a corporate structure is too large to process.
  3. Regional Data Points (BE Only):
    • Decide if Fraud Risk Scores and Credit Scores should be captured for Belgian companies by defining the metadataKeyCreditScore and metadataKeyFraudRiskScore settings.
  4. Identifier Strategy:
    • By default, the Connect ID is stored in the party's external reference field. Determine if your business logic requires this to be moved to a specific metadata key using metadataKeyForExternalRefIdentifier to keep the reference field free for other internal IDs.
  5. Data Filtering:
    • Use the skipMappingFor configuration to define which data points (e.g., LEGAL_FORM) should be ignored during the mapping process to prevent overwriting validated internal data.

3.1.4 Kyckr Provider​

Specific Focus: Global company registration data

3.1.5 KYC Registry Provider​

Specific Focus: Enrichment of bank and company data (including UBOs) through the SWIFT KYC Registry using SWIFT/BIC lookups.

Specific Business Decisions:

  1. Related Parties: When fetching related party or UBO data, should ownership percentages be imported? If so, define the sharesMetadataKey (e.g., DIRECT_SHARE_PERCENTAGE) to map this data from the registry to the party's metadata.

3.1.6 Pappers Provider​

Specific Focus: French company data

Specific Business Decisions:

  1. France-Only: Confirm usage is restricted to French companies only.

3.1.7 VIES Provider​

Specific Focus: European VAT number validation

3.2 Dossier Providers​

Functional Purpose: Enrich dossier information or create new dossiers from external sources

3.2.1 Harmoney API Dossier Provider​

Functional Purpose: Enrich dossier information or create new dossiers from external sources

3.3 Identity Providers​

Functional Purpose: Retrieve and verify personal identity information from external systems (e-ID, biometrics, etc.)

3.3.1 Id Check (IDnow) Provider​

Specific Focus: ID document scanning and liveness detection

Specific Business Decisions:

  1. Flow Type Selection: Should users provide documents from desktop, mobile, or both?
  2. Liveness Check: Is liveness verification (video-based proof of life) required?

3.3.2 Connective Identity Hub Provider​

Specific Focus: Belgian ID and itsme mobile authentication

4. DUE DILIGENCE & COMPLIANCE PROVIDERS​

4.1 General Due Diligence Provider Concepts​

Functional Purpose: Screen parties against watchlists, sanctions, PEP lists, and other compliance databases

General Business Questions (Applicable to All DD Providers):​

  1. Screening Frequency: Should screening happen on-demand, at workflow stages, or periodically?
  2. DD Parameter Coverage: Which due diligence parameters are relevant to your risk model?
  3. Hit Handling: How should hits be handled (auto-reject, manual review, escalation)?
  4. Document Generation: Should screening reports be automatically generated and stored?
  5. Result Expiration: How long should due diligence results be cached before re-screening?
  6. Caching Strategy: Should cached results be used, or force fresh screening on rescreening?

4.2 External Due Diligence Providers​

4.2.1 World-Check Provider​

Specific Focus: Refinitiv-powered watchlist screening for PEPs, sanctions, and adverse media

Specific Business Decisions:

  1. Match Strength Filtering: Should only exact/strong matches be included (EXACT, STRONG, WEAK) in the detailed profiles of the PDF?
  2. Detailed Profiles: How many detailed profile reports should be included in the PDF document?
  3. Provider Types: Should all provider types be used (WATCHLIST, CLIENT_WATCHLIST, PASSPORT_CHECK) or specific ones?

4.2.2 LexisNexis Provider​

Specific Focus: Global AML, PEP, sanctions, and adverse media screening

Specific Business Decisions:

  1. Segment Mapping: Which LexisNexis segments map to which DD parameters?
  2. Relationship Matching: Should relationship-based matches be considered for hits?
  3. Search Configuration: Which predefined search should be used?, i.e. the configuration set up in Lexis Nexis.

4.2.3 Dow Jones Provider​

Specific Focus: Comprehensive watchlist screening with detailed profiles

Specific Business Decisions:

  1. Content Set Selection: Which content sets (e.g., AdverseMedia, StateOwnedCompanies, Location) are relevant?
  2. Search Type: What match strictness level is acceptable (precise/near/broad)?
  3. Additional Keywords: Should custom search keywords be used beyond party name?
  4. Detailed Profiles: How many detailed profile reports should be fetched?
  5. Country/Territory Mapping: How should multi-country parties be handled?

4.2.4 Creditsafe Due Diligence Provider​

Specific Focus: Comprehensive global AML screening with hit scoring

Specific Business Decisions:

  1. Dataset Selection: Which datasets should be screened?
  2. Hit Score Threshold: What minimum score triggers a HIT (75, 80, 85, 90, 95, 100)?
  3. Detail Level: How many detailed hit profiles should be included in the PDF?

4.2.5 SAS AML Due Diligence Provider​

Specific Focus: Comprehensive AML screening using Dow Jones integration via SAS

Specific Business Decisions:

  1. Dow Jones Configuration: What Dow Jones configuration should SAS use internally?

4.2.6 VIES Due Diligence Provider​

Specific Focus: European VAT number validation

4.2.7 APPC Google Provider​

Specific Focus: Negative news screening via Google search

Specific Business Decisions:

  1. Custom Keywords: Should specific keywords be used (fraud, corruption, terrorist ...)?
  2. Result Limits: How many search results should be retrieved (10 or 20)?
  3. PDF Results: How many results should be included in the generated PDF?

4.2.8 APPC Panama Provider​

Specific Focus: Offshore Leaks Database screening

Specific Business Decisions:

  1. Match Score Threshold: What minimum score should trigger a HIT?

4.2.9 Everial Due Diligence Provider​

Specific Focus: Document-based due diligence (analysis + consolidation against party data)

Specific Business Decisions:

  1. Party and Screening Type Selection: For which parties (individual, company, etc.) and for which topics of the party (e.g., bank account data) should the check be done?
  2. Document Selection: Which document types should trigger DD screening?
  3. Consolidation Strategy: Should extracted data be validated against known party data?
  4. Field Matching: Which document fields should be cross-referenced with party data?

4.3 Internal Due Diligence Providers​

4.3.1 Country List Check Provider​

Functional Purpose: Validate country data against configurable high-risk country lists

Specific Business Decisions:

  1. Risk Country Definition: Which countries should be classified as high-risk? What is the default risk evaluation for countries not in the high-risk list?
  2. Partial Matches: How should parties with multiple nationalities/addresses be handled?
  3. Individual vs Company Differences: Should different rules apply to individuals vs companies?

5. DOCUMENT MANAGEMENT PROVIDERS​

5.1 Document Providers​

Functional Purpose: Fetch documents from external systems and save them on parties, dossiers, or identities

Available Implementations:​

5.1.1 Bankers Almanac Document Provider​

Specific Focus: Financial institution documents via SWIFT/BIC code

5.1.2 Creditsafe Company Document Provider & Creditsafe Company Profile Document Provider​

Available Types:

  • Company documents (various document types)
  • Company profile documents (specific comprehensive profile)

Specific Business Decisions:

  1. Default Document Type: What should be the default document type for documents that are fetched?

5.1.3 KYC Registry Document Provider​

Specific Focus: SWIFT/BIC-based bank documents

5.1.4 Pappers Document Provider​

Specific Focus: French company documents

Specific Business Decisions:

  1. France Restriction: Confirm France-only usage is acceptable.

5.2 Document Assessment Providers​

Functional Purpose: Used to analyze, validate, and extract data from uploaded documents. These providers verify authenticity, perform OCR, and can cross-reference extracted data against the dossier to ensure consistency.

Available Implementations:​

General Business Decisions (All Providers):​

  1. Party and Screening Type Selection: For which parties (individual, company, etc.) and for which topics of the party (e.g., bank account data) should the check be done?
  2. Document Scope: Which documentTypes should be sent to the provider?
  3. Fallback Logic: If a provider fails, what is the fallbackAssessment value (e.g., MANUAL_CHECK_REQUIRED)?
  4. Result Mapping: How do provider-specific codes map to internal Harmoney assessment statuses?

5.2.1 Basylic Document Assessment Provider​

Specific Focus: Automated forensic fraud detection and data extraction. This is an asynchronous two-step process.

Specific Business Decisions:

  1. Folder Mapping: Which document types correspond to specific Basylic folder names?
  2. SLA Management: Given the asynchronous nature, what is the expected turnaround time for the scheduled check to complete?

5.2.2 DocTeller Document Assessment Provider​

Specific Focus: Synchronous OCR and structured data extraction with a focus on French official documents.

Specific Business Decisions:

  1. Field Mapping & Consolidation: Agree on which docTellerFieldName (provider-side) corresponds to which inputFieldPath in Harmoney?

5.2.3 Everial Document Assessment Provider​

Specific Focus: Advanced document analysis and data consolidation against existing records.

Specific Business Decisions:

  1. Consolidation Strategy: Should extracted data be cross-referenced with party records to verify identity?
  2. Mismatch Handling: How should data mismatches be handled (e.g., automatic rejection vs. flagging for manual review)?
  3. Visual Evidence: Should the provider generate thumbnails or cropped images of specific fields to assist the compliance officer during manual verification?

5.2.4 Everial Associated Parties Document Assessment Provider​

Specific Focus: Advanced document analysis and data consolidation against existing records for related parties

Specific Business Decisions: See above (5.2.3)

5.3 PDF Provider​

Functional Purpose: Generate PDF documents for reports, agreements, and summaries

6. FIELD MANAGEMENT PROVIDERS​

6.1 Field Definition Provider​

Functional Purpose: Configure field visibility, conditional behavior, and custom metadata fields

6.2 Field Value Provider​

Functional Purpose: Automatically generate field values (e.g., sequential dossier numbers)

Specific Business Questions & Decisions:​

  1. Sequence Pattern: What numbering pattern should be used (e.g., HARM-2023-0001)?
  2. Reset Strategy: Should sequences reset annually, by FSP, or continuously?
  3. Prefix/Suffix: Should sequences include prefixes (client code, FSP id, date)?
  4. Field Application: Which fields should use auto-generation (dossier number, party id)?
  5. Manual Override: Should users be able to manually set values for auto-generated fields?
  6. Visibility: Should auto-generated fields be hidden from users?

7. DATA PROCESSING & AUTOMATION PROVIDERS​

7.1 Scheduled Providers​

Functional Purpose: Execute tasks at specific intervals or on-demand

Provider Types:​

  • RescreeningProvider: Periodic screening with event triggers
  • DataExportProvider: Bulk export of parties and dossiers
  • DataRemovalScheduledProvider: Data retention and deletion
  • ReportGenerationProvider: Periodic report generation
  • UserRemovalProvider: Inactive user cleanup
  • UserSessionRemovalProvider: Inactive session cleanup

General Business Questions & Decisions (Applicable to All Scheduled Providers):​

  1. Automation Strategy: Which routine tasks should be automated vs manual?
  2. Scheduling Frequency: What execution schedule is optimal (daily, weekly, monthly)?
  3. System User: Which service account should be used for automated actions?
  4. Error Handling: How should automation failures be handled (retry, alert, skip)?
  5. Audit Trail: Should all automated actions be logged for compliance?

7.1.1 Basic Rescreening Provider​

Functional Purpose: Periodically trigger rescreening for selected dossiers

Specific Business Decisions:

  1. Rescreening Trigger: What events should trigger rescreening (time elapsed, status change, external alert)?
  2. Dossier Scope: Which dossiers should be rescreened (status-based, age-based, risk-based)?
  3. Outreach Integration: Should rescreening trigger customer outreach?
  4. Due Diligence Refresh: Should all DD checks be re-executed, or only selected providers?
  5. Risk Updates: Should rescreening update risk assessments automatically?

7.1.2 SAS AML Rescreening Provider​

Functional Purpose: Rescreening triggered by SAS AML alerts

Specific Business Decisions:

  1. Alert Monitoring: How frequently should SAS alerts be checked?
  2. Cached Result Override: Should SAS alerts force fresh DD checks, or use cached results?
  3. Alert Response: What actions should be triggered when SAS alerts occur?
  4. Escalation: How should high-risk alerts be escalated?

7.1.3 Data Export Scheduled Provider​

Functional Purpose: Bulk export of dossiers and parties to storage (typically for offboarding)

7.1.4 Data Removal Scheduled Provider​

Functional Purpose: Bulk delete dossiers/parties based on retention policies

Specific Business Decisions:

  1. Deletion Scope: Which dossiers/parties should be eligible for deletion?
  2. Related Data: Should associated parties/documents be deleted with dossiers?

7.1.5 Report Generation Scheduled Provider​

Functional Purpose: Periodically generate reports and store them for download

7.1.6 User Removal Scheduled Provider​

Functional Purpose: Automatically identifies and removes inactive users

Specific Business Decisions:

  1. Inactivity Threshold: How long must a user be inactive before they are flagged for removal?
  2. Retry Strategy: If an automated removal attempt fails (e.g., due to a database lock or system error), how long should the system wait before trying again?

7.1.7 User Session Removal Scheduled Provider​

Functional Purpose: Automatically identifies and removes inactive user sessions

Specific Business Decisions:

  1. Inactivity Threshold: How long must a user session be inactive before it is flagged for removal?
  2. Retry Strategy: If an automated removal attempt fails (e.g., due to a database lock or system error), how long should the system wait before trying again?

8. EXTERNAL SYSTEM PROVIDERS​

8.1 FTP Providers​

Functional Purpose: Connect to FTP/SFTP servers for file upload/download

Business Questions & Decisions:​

  1. Protocol Selection: Should FTP (insecure), SFTP (secure), or both be used?
  2. Directory Structure: How should exported files be organized on the FTP server?

8.2 Storage Provider​

Functional Purpose: Centralized file storage management (public and private files)

Business Questions & Decisions:​

  1. Storage Platform: Minio (self-hosted) vs Azure Blob (cloud)?
  2. Bucket Selection: On which bucket should private and public files be stored?

8.3 Dashboard Providers​

Functional Purpose: Embed external dashboards within Harmoney

8.3.1 Superset Dashboard Provider​

Functional Purpose: Enables the embedding of interactive Apache Superset dashboards and charts directly into the application.

Specific Business Decisions:

  1. Dashboard Selection: What is the unique dashboardId (UUID) for the specific Superset dashboard you want to embed?