- Marked submodules ai-mcp-pmm-controller, explorer-monorepo, and smom-dbis-138 as dirty to reflect recent changes. - Updated documentation to clarify operator script usage, including dotenv loading and task execution instructions. - Enhanced the README and various index files to provide clearer navigation and task completion guidance. Made-with: Cursor
8.2 KiB
OMNL HYBX Operational Run Book
Office Onboarding – ADF Asian Pacific Holding Singapore PTE LTD
1. Run Book Overview
This run book defines the step-by-step operational procedure to onboard a new corporate office into the OMNL HYBX financial infrastructure running on Apache Fineract (Mifos X).
The procedure ensures:
- Consistent office creation
- CIS (Client Information Sheet) verification
- KYC/KYB validation
- Wallet provisioning
- ISO 20022 transaction readiness
- Audit trail compliance
Instance: omnl.hybxfinance.io (or omnl.hybx.global). Set OMNL_FINERACT_BASE_URL in .env accordingly.
2. System Environment
| Component | System |
|---|---|
| Core Banking | Apache Fineract |
| Interface | Mifos X |
| Treasury | OMNL HYBX |
| Messaging | ISO 20022 |
| Wallet Infrastructure | HYBX Treasury Wallet |
| Audit Logs | OMNL Ledger |
3. Office Identity
| Field | Value |
|---|---|
| Office Name | ADF ASIAN PACIFIC HOLDING SINGAPORE PTE LTD |
| Company Number | 202328126M |
| Representative | MR. ANG KOK YONG |
| Title | CEO |
| Jurisdiction | Singapore |
| Parent Office | OMNL |
| Parent Office ID | 1 |
4. Roles & Responsibilities
| Role | Responsibility |
|---|---|
| Platform Administrator | Creates Office in Fineract |
| Compliance Officer | Verifies CIS and KYB |
| Treasury Operator | Creates institutional wallet |
| DevOps | Configures ISO-20022 node |
| Risk & Audit | Reviews onboarding log |
5. Required Documents
The following documents must be verified prior to office creation:
- Client Information Sheet (CIS)
- Company Registration
- Director Identification
- Corporate Address
- Banking Coordinates
- Compliance Verification
Documents are archived in:
HYBX/KYC/ADF_APAC_SINGAPORE/
6. Office Creation Procedure
Step 1 — Authenticate to OMNL HYBX
Ensure API access: load credentials from omnl-fineract/.env or repo root .env (OMNL_FINERACT_BASE_URL, OMNL_FINERACT_USER, OMNL_FINERACT_PASSWORD, OMNL_FINERACT_TENANT). Fineract uses Basic auth on each request (no separate token endpoint). Verify access with:
curl -s -u "${OMNL_FINERACT_USER}:${OMNL_FINERACT_PASSWORD}" \
-H "Fineract-Platform-TenantId: ${OMNL_FINERACT_TENANT:-omnl}" \
"${OMNL_FINERACT_BASE_URL}/offices"
Expected: HTTP 200 and a JSON array of offices.
Step 2 — Create Office
Endpoint: POST /fineract-provider/api/v1/offices
Payload:
{
"name": "ADF ASIAN PACIFIC HOLDING SINGAPORE PTE LTD",
"parentId": 1,
"openingDate": "2023-07-11",
"dateFormat": "yyyy-MM-dd",
"locale": "en",
"externalId": "202328126M"
}
cURL (from repo root with env loaded):
curl -X POST "${OMNL_FINERACT_BASE_URL}/offices" \
-u "${OMNL_FINERACT_USER}:${OMNL_FINERACT_PASSWORD}" \
-H "Fineract-Platform-TenantId: ${OMNL_FINERACT_TENANT:-omnl}" \
-H "Content-Type: application/json" \
-d '{
"name": "ADF ASIAN PACIFIC HOLDING SINGAPORE PTE LTD",
"parentId": 1,
"openingDate": "2023-07-11",
"dateFormat": "yyyy-MM-dd",
"locale": "en",
"externalId": "202328126M"
}'
Script (recommended, idempotent by externalId):
DRY_RUN=1 bash scripts/omnl/omnl-office-create-adf-singapore.sh # preview
bash scripts/omnl/omnl-office-create-adf-singapore.sh # create
Optional overrides: OPENING_DATE, ADF_SINGAPORE_EXTERNAL_ID, ADF_SINGAPORE_OFFICE_NAME. Script outputs OFFICE_ID_ADF_SINGAPORE=<id> on success.
Step 3 — Verify Office Creation
Confirm via:
GET ${OMNL_FINERACT_BASE_URL}/offices
(e.g. curl -s -u "..." -H "Fineract-Platform-TenantId: omnl" "${OMNL_FINERACT_BASE_URL}/offices")
Expected result:
- Office ID: <auto-generated>
- Parent Office: OMNL (id: 1)
- externalId: 202328126M
- Status: Active
Log entry created in HYBX_LEDGER / OFFICE_REGISTRY.
7. Corporate Profile Attachment
Create additional corporate data using Fineract Datatable.
Datatable name: office_corporate_profile
| Field | Value |
|---|---|
| representative_name | MR. ANG KOK YONG |
| representative_title | CEO |
| jurisdiction | Singapore |
| entity_type | Private Limited |
Create the datatable in Fineract (Administration → Register Datatables), link it to the Office entity, then populate a row for this office after creation.
8. Treasury Wallet Creation
After office creation, create the institutional treasury wallet.
| Parameter | Value |
|---|---|
| Wallet type | Corporate Treasury Wallet |
| Wallet ID format | HYBX-SG-ADF-001 |
| Currency | Multi-Currency |
| Vault | HYBX Treasury |
| Liquidity Access | Enabled |
| Settlement Mode | ISO 20022 |
(Wallet creation steps and API are defined in the Institutional Client Onboarding Run Book.)
9. ISO-20022 Messaging Enablement
Configure messaging endpoint for the office.
Required channels:
| Channel | Purpose |
|---|---|
| pacs.008 | Credit transfer |
| pacs.009 | Interbank settlement |
| camt.053 | Statement reporting |
| camt.056 | Payment recall |
Node registration: OMNL-HYBX-NODE-SG-ADF
10. Compliance Verification
Compliance officer confirms:
- ✔ CIS verified
- ✔ Corporate registration validated
- ✔ Representative identity verified
- ✔ Sanctions screening completed
Compliance approval logged in HYBX_COMPLIANCE_LEDGER.
11. Operational Activation
Once all steps are completed:
System status: OFFICE_STATUS = ACTIVE
Operational capabilities enabled:
- Wallet transactions
- Treasury participation
- Liquidity routing
- ISO-20022 transfers
12. Audit Trail
All steps recorded in:
- HYBX_LEDGER
- HYBX_AUDIT_LOG
Audit data includes:
- Timestamp
- Operator ID
- API request hash
- System response
13. Disaster Recovery
If onboarding fails:
- Rollback office creation (if created).
- Archive CIS and failure details in
HYBX/KYC/ADF_APAC_SINGAPORE/. - Generate failure log.
Rollback (delete office):
DELETE /fineract-provider/api/v1/offices/{officeId}
Note: Deleting an office may be restricted if the office has dependent data (clients, accounts). Resolve dependencies in UI/API first or contact platform admin.
14. Final Validation Checklist
| Validation | Status |
|---|---|
| Office created | ☐ |
| Corporate data attached | ☐ |
| Wallet created | ☐ |
| ISO-20022 enabled | ☐ |
| Compliance approved | ☐ |
| Audit logged | ☐ |
15. Office Hierarchy
OMNL (Head Office, ID: 1)
│
└── ADF ASIAN PACIFIC HOLDING SINGAPORE PTE LTD
16. Run Book Completion
Run book execution is complete when all validation checks pass and treasury wallet is active.
17. Related Documentation
- OMNL_FINERACT_CONFIGURATION.md — Base URL, tenant, credentials.
- PELICAN_MOTORS_OFFICE_RUNBOOK.md — Same POST /offices pattern.
- OMNL_OFFICES_POPULATE.md — Bulk office creation from entity master data.
- Institutional Client Onboarding Run Book (when available) — Client creation, wallet provisioning, KYB automation, and ISO-20022 routing under this office.