Business Onboarding Guide

Goal

Onboard a new business by adding configuration only:

backend/config/businesses/<businessId>/
├── business.json
└── templates.json

Optionally add OTP mappings in backend/config/otp-mappings.json.

Onboarding workflow

Step 1 — Scaffold configuration

node backend/scripts/create-business.mjs workspace --display-name "Workspace"

This creates draft files from backend/config/templates/.

Step 2 — Complete DLT metadata

Edit business.json:

• entityId — DLT principal entity ID
• defaultSenderId — approved sender ID

Edit each template in templates.json:

• templateId — DLT-approved template ID
• variables — ordered, typed placeholders matching DLT registration

Step 3 — Validate

npm run validate:businesses

Expected output:

• PASS — production-ready
• WARN — valid schema but placeholders or missing OTP mapping
• FAIL — schema or duplicate errors

Step 4 — Optional OTP mapping

Add to backend/config/otp-mappings.json:

{
  "workspace-app": {
    "business": "workspace",
    "templateKey": "LOGIN_OTP",
    "dltEnabled": false,
    "legacyRouteEnabled": true
  }
}

Step 5 — Verify in portal

Open /platform/businesses:

• Readiness table shows Production or Draft
• Onboarding checklist shows per-item status

Troubleshooting

See Business Validation Failure.