OpenAPI index¶
Known OpenAPI files under firefly-oss, grouped by OpenPlatform module
id. Prefer the *-sdk/src/main/resources/openapi.yml path when both that
file and api-spec/openapi.yml exist (they are commonly kept in sync for
SDK generation).
Status meanings
| Status | Meaning |
|---|---|
| Spec in repo | File present; treat it as the contract for that service |
| No published OpenAPI yet | Repository exists; no checked-in OpenAPI found in the usual SDK paths |
| Sample / mock | Illustrative or mock surface — not the production module contract |
GitHub organisation: https://github.com/firefly-oss
Customers (customers)¶
Module page: customers
| Repository | OpenAPI | Status |
|---|---|---|
core-common-customer-mgmt |
…/openapi.yml |
Spec in repo |
domain-customer-people |
…/openapi.yml |
Spec in repo |
Onboarding (onboarding)¶
Module page: onboarding
| Repository | OpenAPI | Status |
|---|---|---|
exp-onboarding |
…/openapi.yml |
Spec in repo |
domain-customer-kyc-kyb |
…/openapi.yml |
Spec in repo |
core-common-kycb-mgmt |
…/openapi.yml |
Spec in repo |
Products (products)¶
Module page: products
| Repository | OpenAPI | Status |
|---|---|---|
core-common-product-mgmt |
…/openapi.yml |
Spec in repo |
domain-product-catalog |
…/openapi.yml |
Spec in repo |
domain-core-pricing-engine |
…/openapi.yml |
Spec in repo |
domain-product-pricing |
…/openapi.yml |
Spec in repo |
core-common-pricing-mgmt |
— | No published OpenAPI yet |
Agreements (agreements)¶
Module page: agreements
| Repository | OpenAPI | Status |
|---|---|---|
core-common-contract-mgmt |
…/openapi.yml |
Spec in repo |
domain-common-contracts |
…/openapi.yml |
Spec in repo |
core-common-document-mgmt |
…/openapi.yml |
Spec in repo |
Distribution (distribution)¶
Module page: distribution
| Repository | OpenAPI | Status |
|---|---|---|
core-common-distributor-mgmt |
…/openapi.yml |
Spec in repo |
domain-distributor-branding |
…/openapi.yml |
Spec in repo |
domain-distributor-catalog |
…/openapi.yml |
Spec in repo |
exp-distributor |
…/openapi.yml |
Spec in repo |
Accounts (accounts)¶
Module page: accounts
| Repository | OpenAPI | Status |
|---|---|---|
core-banking-accounts |
…/openapi.yml |
Spec in repo |
domain-banking-accounts |
…/openapi.yml |
Spec in repo |
core-banking-ledger |
…/openapi.yml |
Spec in repo |
core-common-accounting-gl |
…/openapi.yml |
Spec in repo |
exp-accounts |
…/openapi.yml |
Spec in repo |
Payments (payments)¶
Module page: payments
| Repository | OpenAPI | Status |
|---|---|---|
core-banking-payments |
…/openapi.yml |
Spec in repo |
core-banking-cards |
…/openapi.yml |
Spec in repo |
domain-banking-cards |
…/openapi.yml |
Spec in repo |
core-banking-psdx |
…/openapi.yml |
Spec in repo |
exp-cards |
…/openapi.yml |
Spec in repo |
library-rails |
— | No published OpenAPI yet (library interfaces) |
library-psps |
— | No published OpenAPI yet (library interfaces) |
core-payments-engine |
— | No published OpenAPI yet |
Lending (lending)¶
Module page: lending
| Repository | OpenAPI | Status |
|---|---|---|
core-lending-loan-origination |
…/openapi.yml |
Spec in repo |
domain-lending-loan-origination |
…/openapi.yml |
Spec in repo |
core-lending-loan-servicing |
…/openapi.yml |
Spec in repo |
domain-lending-loan-servicing |
…/openapi.yml |
Spec in repo |
core-lending-collateral-management |
…/openapi.yml |
Spec in repo |
core-lending-delinquency-collections |
…/openapi.yml |
Spec in repo |
core-lending-personal-loans |
…/openapi.yml |
Spec in repo |
domain-lending-personal-loans |
…/openapi.yml |
Spec in repo |
core-lending-mortgage |
…/openapi.yml |
Spec in repo (note: SDK artifact uses mortgages) |
core-lending-asset-finance |
…/openapi.yml |
Spec in repo |
domain-lending-asset-finance |
…/openapi.yml |
Spec in repo |
core-lending-credit-cards |
…/openapi.yml |
Spec in repo |
core-lending-supply-chain-finance |
…/openapi.yml |
Spec in repo |
exp-lending |
…/openapi.yml |
Spec in repo |
firefly-lending |
openapi/lending.v1.yaml |
Sample / mock (title marks it as mock) |
Risk (risk)¶
Module page: risk
| Repository | OpenAPI | Status |
|---|---|---|
core-lending-credit-scoring |
…/openapi.yml |
Spec in repo |
domain-lending-credit-scoring |
…/openapi.yml |
Spec in repo |
core-lending-provisioning-risk |
…/openapi.yml |
Spec in repo |
core-lending-regulatory-compliance |
…/openapi.yml |
Spec in repo |
domain-data-credit-bureaus |
— | No published OpenAPI yet |
Shared services (shared)¶
Module page: shared
| Repository | OpenAPI | Status |
|---|---|---|
core-common-user-mgmt |
…/openapi.yml |
Spec in repo |
domain-core-security-center |
…/openapi.yml |
Spec in repo |
core-common-security-vault |
…/openapi.yml |
Spec in repo |
core-common-sca-mgmt |
…/openapi.yml |
Spec in repo |
domain-common-sca |
…/openapi.yml |
Spec in repo |
exp-security |
…/openapi.yml |
Spec in repo |
core-common-notification-services |
…/openapi.yml |
Spec in repo |
domain-common-notifications |
…/openapi.yml |
Spec in repo |
exp-notifications |
…/openapi.yml |
Spec in repo |
core-common-reference-master-data |
…/openapi.yml |
Spec in repo |
core-common-org-mgmt |
…/openapi.yml |
Spec in repo |
core-common-config-mgmt |
…/openapi.yml |
Spec in repo |
domain-core-configuration |
…/openapi.yml |
Spec in repo |
exp-profile |
…/openapi.yml |
Spec in repo |
exp-channel-management |
…/openapi.yml |
Spec in repo |
app-authenticator |
— | No published OpenAPI yet |
Insurance development areas¶
Insurance-specific OpenAPI surfaces are not published as dedicated
firefly-oss repositories yet. Foundation APIs live under the business
modules above. See Insurance development
areas.
Keeping this index honest¶
When you add or move a spec:
- Update the row for that repository here.
- Prefer linking the file that SDK generation uses.
- Mark sample or mock documents clearly (do not present them as the production contract).