Skip to content

Business modules catalogue

Module ids and names align with the public OpenPlatform modules page at https://fireflysoftware.io/openplatform/modules/ (platformModules / businessModules in the website sources).

Each business module and the shared identity services have a dedicated page with purpose, what the module owns, the repositories on disk, and OpenAPI links. This page is the map.

Map of the ten OpenPlatform module ids in firefly-oss
Read the grid left to right, then down. Each card is one module id. The page for that id lists the repositories.

How to use this catalogue

  1. Match the journey step (party, agreement, payment, loan, and so on) to a module id.
  2. Open that module page for repositories and layer prefixes (core-*, domain-*, exp-*).
  3. Use the OpenAPI index for published contracts; treat each repo README as authoritative for local run.
  4. Put anything outside Firefly behind an adapter. The current train pin is on Versioning and BOM.

Browse by module

customers Customers People, legal entities, relationships, and consent. onboarding Onboarding Data collection, KYC/KYB evidence, and journey status. products Products Commercial configuration for offers you sell. agreements Agreements Contracts, documents, and signature workflows. distribution Distribution Partner channels and distributor access. accounts Accounts Account records and related financial posts. payments Payments Orders, cards, rails, and PSP boundaries. lending Lending Origination, servicing, collateral, collections. risk Risk Risk and compliance operations for journeys. shared Shared services Identity and common services used across modules.

Inventory (module, page, status)

Status reflects documentation completeness for this hub as of 2026-10-18/19, not production readiness of the services.

Module id Page Repos linked (summary) Doc status
customers customers core-common-customer-mgmt, domain-customer-people Complete
onboarding onboarding exp-onboarding, domain-customer-kyc-kyb, core-common-kycb-mgmt Complete
products products product + pricing core/domain set Complete
agreements agreements contract + document core/domain Complete
distribution distribution distributor core/domain + exp-distributor Complete
accounts accounts accounts/ledger/GL + exp-accounts Complete
payments payments payments/cards/psdx/engine + libraries + exp-cards Complete
lending lending origination/servicing/collateral/collections + product lines + exp-lending Complete
risk risk scoring/provisioning/regulatory + bureau domain Complete
shared shared identity, SCA, notifications, org, config, profile, channel Complete

Insurance development areas (in IA, not separate module ids yet):

Area Page Dedicated firefly-oss repos Doc status
Policy lifecycle policy-lifecycle None published yet — reuses foundations Complete (honest gaps)
Underwriting underwriting None published yet Complete (honest gaps)
Claims claims None published yet Complete (honest gaps)
Financial flows financial-flows None published yet — uses payments Complete (honest gaps)

Layer conventions in firefly-oss

Prefix Typical role
core-* Persistence and core APIs for a bounded context
domain-* Domain orchestration (commands, sagas, queries)
exp-* Experience / BFF journeys for channels
library-* Shared libraries (rails, PSP interfaces, batch utilities)
app-* Standalone applications (for example authenticator)

GitHub organisation: https://github.com/firefly-oss

Unmapped local repositories

These exist under the local firefly-oss tree and are called out on module pages where relevant; they are not separate website module tiles:

  • core-common-modelhub, core-data-template, domain-data-business-intelligence — supporting data platforms (see shared)
  • library-common-batch — batch utilities
  • firefly-lending — mock OpenAPI sample only (see OpenAPI index)

API and event reference

Architecture and adapters

Still to deepen

  • Runtime ownership and deployment topology beyond the service-band map
  • Hosted OpenAPI / event packs for insurance development areas when repos exist
  • Filling domain-layer gaps where only core (or only exp) exists today