Regulated Onboarding Workflow
This module provides a reusable onboarding workflow template for regulated client intake scenarios where every decision must be reconstructable.
What Engineers Use It For
- Cross-document rule checks against structured onboarding playbooks
- Flag generation (
critical,warning,insight) with lineage metadata - Decision memo artifact generation for downstream review
- Commit-linked artifact provenance for every workflow output
Module
from briefcase_ai.workflows import BrokerDealerOnboardingWorkflow
from briefcase_ai.integrations.lakefs import ArtifactLineageClient
Quick Run (Example Script)
python examples/workflows/broker_dealer_onboarding_sdk.py --json
The script generates sample inputs (if missing), runs the workflow, and prints:
- source packet commit ID
- rule evaluation commit ID
- generated flags
- optional artifact commit ID for memo + result JSON
Programmatic Usage
from pathlib import Path
from briefcase_ai.integrations.lakefs import ArtifactLineageClient
from briefcase_ai.workflows import BrokerDealerOnboardingWorkflow
lineage = ArtifactLineageClient.from_env(
repository="regulated-ai-demo",
branch="main",
)
workflow = BrokerDealerOnboardingWorkflow(lineage)
result = workflow.run(
document_paths={
"A": Path(".../sample_client_application.txt"),
"B": Path(".../sample_client_beneficial_ownership.txt"),
"C": Path(".../sample_client_formation_docs.txt"),
"D": Path(".../sample_client_authorized_traders.txt"),
"E": Path(".../sample_client_tax_forms.txt"),
},
playbook_path=Path(".../onboarding_playbook_v4_2.json"),
history_csv=Path(".../submission_pattern_history.csv"),
output_dir=Path(".../output"),
write_outputs=True,
)
Output Shape
result includes:
lakefs.source_packet_commit_idlakefs.analysis_commit_idlakefs.memo_artifacts_commit_id(whenwrite_outputs=True)flags[*].source_commit_idflags[*].analysis_commit_idflags[*].source_object_urisdecision_memo_markdown
Why This Matters
This workflow pattern turns onboarding logic into reusable SDK primitives so teams can:
- keep control logic versioned and testable
- preserve artifact lineage by commit ID
- produce audit-ready evidence artifacts with deterministic structure