Files
proxmox/docs/04-configuration/OMNL_FINERACT_CONFIGURATION.md
defiQUG 7ac74f432b chore: sync docs, config schemas, scripts, and meta task alignment
- Institutional / JVMTM / reserve-provenance / GRU transport + standards JSON
- Validation and verify scripts (Blockscout labels, x402, GRU preflight, P1 local path)
- Wormhole wiring in AGENTS, MCP_SETUP, MASTER_INDEX, 04-configuration README
- Meta docs, integration gaps, live verification log, architecture updates
- CI validate-config workflow updates

Operator/LAN items, submodule working trees, and public token-aggregation edge
routes remain follow-up (see TODOS_CONSOLIDATED P1).

Made-with: Cursor
2026-03-31 22:31:39 -07:00

3.4 KiB

OMNL Fineract API Configuration

Last updated: 2026-02-10
Tenancy: https://omnl.hybxfinance.io/

Overview

The OMNL tenancy runs Apache Fineract (Mifos) at https://omnl.hybxfinance.io/. API access uses HTTP Basic and a required tenant header. This deployment does not use separate HTTP request signing (no extra signature headers on each call).

Item Value
Base URL https://omnl.hybxfinance.io/fineract-provider/api/v1
Swagger UI swagger-ui/index.html
Tenant ID omnl
Auth Basic — either Authorization: Basic <base64(username:password)> or the same value from POST …/authentication as base64EncodedAuthenticationKey

Credentials

  • Username: app.omnl
  • Password: Store only in .env or a secrets manager; do not commit.

Use the workspace root .env or the omnl-fineract/ directory env (see below).

Environment Variables

In root .env or omnl-fineract/.env:

OMNL_FINERACT_BASE_URL=https://omnl.hybxfinance.io/fineract-provider/api/v1
OMNL_FINERACT_TENANT=omnl
OMNL_FINERACT_USER=app.omnl
OMNL_FINERACT_PASSWORD=<your-password>

Root .env.example includes commented placeholders for these variables.

Submodule Directory: omnl-fineract/

The omnl-fineract directory at the repo root contains:

  • .env.example / .env.template — Template env files (no real password).
  • .gitignore — Ignores .env and logs.
  • README.md — Quick start and API reference.
  • SETUP.md — Step-by-step setup and verification.

To use it:

  1. cd omnl-fineract && cp .env.example .env
  2. Edit .env and set OMNL_FINERACT_PASSWORD.
  3. Source .env and run scripts or curl as in omnl-fineract/README.md.

This directory can later be moved to its own repository and added as a git submodule.

Verifying the API

# With env loaded (e.g. source .env)
curl -s -u "${OMNL_FINERACT_USER}:${OMNL_FINERACT_PASSWORD}" \
  -H "Fineract-Platform-TenantId: ${OMNL_FINERACT_TENANT}" \
  "${OMNL_FINERACT_BASE_URL}/offices"

Expected: HTTP 200 and a JSON array of offices.

Optional login step (returns the same Basic credential Fineract expects):

curl -s -X POST "${OMNL_FINERACT_BASE_URL}/authentication" \
  -H "Fineract-Platform-TenantId: ${OMNL_FINERACT_TENANT}" \
  -H "Content-Type: application/json" \
  -d "{\"username\":\"${OMNL_FINERACT_USER}\",\"password\":\"${OMNL_FINERACT_PASSWORD}\"}" \
| jq -r '.base64EncodedAuthenticationKey'
# Then: Authorization: Basic <that value>

Helper: scripts/omnl/omnl-fineract-authentication-login.sh.