` | string | For `new` | Regulation title | - | | `--type <type>` | string | No | financial, data, environmental, general | 'general' | | `--id <id>` | string | For `update`/`view` | Regulation identifier | - | | `--content <path>` | string | No | Path to regulation content file | - | #### Response Format **Standard Output (new regulation):** ``` ✓ Regulation created successfully ID: reg-a1b2c3d4e5f6 Title: KYC Threshold Requirements Type: financial Status: draft Version: 1.0.0 Created: 2024-08-01T12:00:00Z ``` **JSON Output (`--json`):** ```json { "success": true, "regulation": { "id": "reg-a1b2c3d4e5f6", "title": "KYC Threshold Requirements", "type": "financial", "status": "draft", "version": "1.0.0", "created": "2024-08-01T12:00:00Z", "updated": "2024-08-01T12:00:00Z", "enforcementCount": 0 }, "proof": "pact-proof-a1b2c3d4e5f6g7h8" } ``` #### Examples ```bash # Create financial regulation pact-gov regulation new --title "Anti-Money Laundering Rules" --type financial # Update regulation pact-gov regulation update --id reg-a1b2c3d4 --title "Updated AML Rules" # View regulation details pact-gov regulation view --id reg-a1b2c3d4 --json # List all regulations pact-gov regulation list ``` ### publish Publishes regulations through multiple channels with scheduling and notification capabilities. #### Syntax ```bash pact-gov publish [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | Yes | Regulation ID to publish | - | | `--effective <date>` | string | No | Effective date (YYYY-MM-DD) | 30 days from now | | `--channels <list>` | string | No | Publication channels (comma-separated) | 'official-gazette,website,api' | | `--draft` | boolean | No | Publish as draft for review | false | #### Publication Channels - `official-gazette`: Official government publication - `website`: Government regulatory website - `api`: PACT Protocol API distribution - `email`: Stakeholder notification system #### Response Format **Standard Output:** ``` ✓ Regulation published successfully Regulation: kyc-threshold-2024 Status: published Effective Date: 2024-07-01 Channels: official-gazette, website, api Notifications Sent: 1,247 Publication ID: pub-x1y2z3a4b5c6 ``` **JSON Output (`--json`):** ```json { "success": true, "publication": { "id": "pub-x1y2z3a4b5c6", "regulationId": "kyc-threshold-2024", "status": "published", "effectiveDate": "2024-07-01", "publishedDate": "2024-06-01T10:00:00Z", "channels": ["official-gazette", "website", "api"], "notificationsSent": 1247 }, "proof": "pact-proof-b2c3d4e5f6g7h8i9" } ``` #### Examples ```bash # Standard publication pact-gov publish --regulation kyc-rules-2024 --effective "2024-07-01" # Draft publication pact-gov publish --regulation draft-crypto-tax --draft # Custom channels pact-gov publish --regulation privacy-law --channels "official-gazette,website,email" ``` ### enforce Creates and manages enforcement actions against entities for regulatory violations. #### Syntax ```bash pact-gov enforce [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | Yes | Regulation to enforce | - | | `--entity <id>` | string | Yes | Target entity identifier | - | | `--action <type>` | string | No | warn, fine, suspend | 'warn' | | `--severity <level>` | string | No | low, medium, high | 'medium' | #### Enforcement Actions | Action | Description | Typical Penalty | Resolution Time | |--------|-------------|-----------------|-----------------| | `warn` | Compliance warning | None | 14 days | | `fine` | Monetary penalty | $1,000 - $100,000 | 30 days | | `suspend` | Operation suspension | License suspension | 90 days | #### Response Format **Standard Output:** ``` ✓ Enforcement action created Action ID: enf-m3n4o5p6q7r8 Regulation: kyc-threshold-2024 Entity: company-alpha Action: fine Severity: high Penalty: $50,000 Deadline: 2024-08-15T23:59:59Z ``` **JSON Output (`--json`):** ```json { "success": true, "enforcement": { "id": "enf-m3n4o5p6q7r8", "regulationId": "kyc-threshold-2024", "entityId": "company-alpha", "action": "fine", "severity": "high", "penalty": "$50,000", "status": "active", "created": "2024-08-01T12:00:00Z", "deadline": "2024-08-15T23:59:59Z" }, "proof": "pact-proof-c3d4e5f6g7h8i9j0" } ``` #### Examples ```bash # Issue warning pact-gov enforce --regulation kyc-rules --entity acme-corp --action warn # Apply fine pact-gov enforce --regulation data-protection --entity tech-startup --action fine --severity high # Suspend operations pact-gov enforce --regulation aml-screening --entity suspicious-entity --action suspend ``` ### audit Performs comprehensive regulatory compliance audits with configurable depth and scope. #### Syntax ```bash pact-gov audit [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | No | Regulation to audit or "all" | 'all' | | `--period <period>` | string | No | Audit period (e.g., 2024Q1, 2024) | '2024Q1' | | `--entity <id>` | string | No | Specific entity to audit | 'all' | | `--depth <level>` | string | No | basic, standard, comprehensive | 'standard' | #### Audit Depth Levels | Level | Description | Coverage | Typical Duration | |-------|-------------|----------|------------------| | `basic` | High-level compliance check | Key metrics only | 1-2 hours | | `standard` | Standard audit procedures | Core requirements | 1-2 days | | `comprehensive` | Full regulatory audit | All requirements | 1-2 weeks | #### Response Format **Standard Output:** ``` Audit Report for 2024Q1 Summary: Entities Audited: 156 Compliance Rate: 87% Issues Found: 23 Findings by Severity: High Risk [██░░░] 3 issues Medium Risk [████░] 8 issues Low Risk [██████] 12 issues Top Violations: 1. Incomplete KYC documentation (8 entities) 2. Missing transaction monitoring (5 entities) 3. Delayed reporting requirements (4 entities) ``` **JSON Output (`--json`):** ```json { "success": true, "audit": { "id": "audit-d4e5f6g7h8i9j0k1", "period": "2024Q1", "regulation": "all", "entitiesAudited": 156, "complianceRate": 0.87, "findings": [ { "id": "finding-1", "entity": "company-alpha", "regulation": "kyc-threshold-2024", "severity": "high", "description": "Incomplete KYC documentation", "recommendation": "Complete customer verification within 30 days" } ], "summary": { "highRisk": 3, "mediumRisk": 8, "lowRisk": 12 }, "generated": "2024-08-01T14:00:00Z" }, "proof": "pact-proof-d4e5f6g7h8i9j0k1" } ``` #### Examples ```bash # System-wide audit pact-gov audit --regulation all --period 2024Q1 # Specific regulation audit pact-gov audit --regulation kyc-rules --entity acme-corp --depth comprehensive # Quick entity audit pact-gov audit --entity tech-startup --depth basic ``` ### report Generates comprehensive regulatory reports in multiple formats with detailed analytics. #### Syntax ```bash pact-gov report [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--type <type>` | string | No | compliance, enforcement, impact | 'compliance' | | `--format <format>` | string | No | json, csv, pdf, html | 'pdf' | | `--period <period>` | string | No | Report period | '2024Q1' | | `--output <path>` | string | No | Custom output file path | auto-generated | #### Report Types | Type | Description | Content | Use Case | |------|-------------|---------|----------| | `compliance` | Compliance overview | Rates, trends, violations | Regulatory oversight | | `enforcement` | Enforcement actions | Actions, penalties, outcomes | Performance tracking | | `impact` | Regulatory impact | Economic effects, costs | Policy analysis | #### Response Format **Standard Output:** ``` ✓ Report generated successfully Type: Compliance Report Period: 2024Q1 Format: PDF File: compliance-report-2024q1-20240801.pdf Size: 2.4 MB Report Highlights: • Overall compliance rate: 87% • Enforcement actions: 45 • Total penalties: $2.3M • Trend: +5% improvement from 2023Q4 ``` **JSON Output (`--json`):** ```json { "success": true, "report": { "id": "report-e5f6g7h8i9j0k1l2", "type": "compliance", "period": "2024Q1", "format": "pdf", "filePath": "./compliance-report-2024q1-20240801.pdf", "fileSize": "2.4 MB", "generated": "2024-08-01T15:00:00Z", "metrics": { "complianceRate": 0.87, "enforcementActions": 45, "totalPenalties": "$2,300,000", "trendImprovement": 0.05 } }, "proof": "pact-proof-e5f6g7h8i9j0k1l2" } ``` #### Examples ```bash # Generate compliance report pact-gov report --type compliance --format pdf --period 2024Q1 # Enforcement statistics pact-gov report --type enforcement --format csv --output enforcement.csv # Impact assessment pact-gov report --type impact --format html --period 2024 ``` ### framework Manages regulatory frameworks for organizing related regulations into coherent structures. #### Syntax ```bash pact-gov framework [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--create <name>` | string | No | Create new framework | - | | `--list` | boolean | No | List all frameworks | false | | `--add-regulation <id>` | string | No | Add regulation to framework | - | | `--framework <name>` | string | Conditional | Target framework name | - | #### Response Format **Standard Output (create):** ``` ✓ Framework created successfully ID: framework-f6g7h8i9j0k1 Name: Financial Services Framework Status: active Regulations: 0 Created: 2024-08-01T16:00:00Z ``` **Standard Output (list):** ``` Regulatory Frameworks: Financial Services Framework Status: active Regulations: 12 Created: 2024-01-15 Updated: 2024-07-20 Data Protection Framework Status: active Regulations: 8 Created: 2024-02-01 Updated: 2024-06-15 Environmental Framework Status: draft Regulations: 3 Created: 2024-07-01 Updated: 2024-07-30 ``` **JSON Output (`--json`):** ```json { "success": true, "frameworks": [ { "id": "framework-f6g7h8i9j0k1", "name": "Financial Services Framework", "status": "active", "regulationCount": 12, "created": "2024-01-15T10:00:00Z", "updated": "2024-07-20T14:30:00Z" } ], "proof": "pact-proof-f6g7h8i9j0k1l2m3" } ``` #### Examples ```bash # Create framework pact-gov framework --create "Digital Asset Framework" # List all frameworks pact-gov framework --list # Add regulation to framework pact-gov framework --add-regulation kyc-rules --framework "Financial Services Framework" ``` ### consult Manages public consultations for regulatory development with stakeholder engagement tracking. #### Syntax ```bash pact-gov consult [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | Conditional | Regulation ID for consultation | - | | `--duration <period>` | string | No | Consultation duration (e.g., 30d) | '30d' | | `--channels <list>` | string | No | Consultation channels | 'website,email,public-forum' | | `--summary` | boolean | No | Show consultation summary | false | #### Response Format **Standard Output (create):** ``` ✓ Public consultation opened Regulation: draft-privacy-law Duration: 45 days End Date: 2024-09-15 Channels: website, email, public-forum Consultation ID: consult-g7h8i9j0k1l2 ``` **Standard Output (summary):** ``` Active Public Consultations: Cryptocurrency Framework Status: active Responses: 247 End Date: 2024-08-30 Sentiment: 68% positive Privacy Protection Law Status: active Responses: 156 End Date: 2024-09-15 Sentiment: 72% positive Data Localization Rules Status: closing Responses: 89 End Date: 2024-08-05 Sentiment: 45% negative ``` #### Examples ```bash # Open consultation pact-gov consult --regulation draft-privacy-law --duration 45d # View active consultations pact-gov consult --summary # Multi-channel consultation pact-gov consult --regulation crypto-framework --channels "website,email,public-forum" --duration 60d ``` ### status Provides comprehensive status monitoring for both individual regulations and the overall regulatory system. #### Syntax ```bash pact-gov status [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--detailed` | boolean | No | Show detailed statistics | false | | `--regulation <id>` | string | No | Status for specific regulation | - | #### Response Format **Standard Output (system status):** ``` PACT Gov System Status Regulations: Total: 47 Active: 42 Draft: 5 Financial: 18 Data: 12 Environmental: 8 General: 9 Compliance Overview: Overall Rate: 87% ↗ +3% this quarter Entities: 1,247 Audited: 892 (71%) Enforcement Activity (30 days): Warnings: 23 Fines: 8 Suspensions: 2 Total Penalties: $450,000 System Health: ✓ Operational Last Updated: 2024-08-01T17:00:00Z ``` **Regulation-Specific Status:** ``` Status for kyc-threshold-2024 Regulation Details: Type: financial Status: active Version: 2.1.0 Effective: 2024-06-01 Last Updated: 2024-07-15T10:30:00Z Compliance Metrics: Covered Entities: 234 Compliance Rate: 92% ↗ +5% this month Risk Level: LOW Recent Activity: • 3 enforcement actions (last 30 days) • 15 audits completed • 2 consultation responses processed ``` #### Examples ```bash # System overview pact-gov status # Detailed system status pact-gov status --detailed # Specific regulation status pact-gov status --regulation kyc-rules-2024 ``` ## Data Models ### Regulation Model ```typescript interface Regulation { id: string; title: string; type: 'financial' | 'data' | 'environmental' | 'general'; status: 'draft' | 'active' | 'suspended' | 'revoked'; version: string; created: string; // ISO timestamp updated: string; // ISO timestamp enforcementCount: number; content?: string; } ``` ### Publication Model ```typescript interface Publication { id: string; regulationId: string; status: 'draft' | 'published' | 'effective'; effectiveDate: string; // YYYY-MM-DD publishedDate: string; // ISO timestamp channels: string[]; notificationsSent: number; } ``` ### Enforcement Model ```typescript interface Enforcement { id: string; regulationId: string; entityId: string; action: 'warn' | 'fine' | 'suspend'; severity: 'low' | 'medium' | 'high'; penalty?: string; status: 'active' | 'resolved' | 'appealed'; created: string; // ISO timestamp deadline: string; // ISO timestamp } ``` ### Audit Model ```typescript interface Audit { id: string; period: string; regulation: string; entitiesAudited: number; complianceRate: number; findings: AuditFinding[]; summary: { highRisk: number; mediumRisk: number; lowRisk: number; }; generated: string; // ISO timestamp } interface AuditFinding { id: string; entity: string; regulation: string; severity: 'high' | 'medium' | 'low'; description: string; recommendation: string; } ``` ### Framework Model ```typescript interface Framework { id: string; name: string; status: 'draft' | 'active' | 'archived'; regulationCount: number; regulations: string[]; // regulation IDs created: string; // ISO timestamp updated: string; // ISO timestamp } ``` ### Consultation Model ```typescript interface Consultation { id: string; regulationId: string; duration: string; endDate: string; // YYYY-MM-DD channels: string[]; responses: number; sentiment: { positive: number; negative: number; neutral: number; }; status: 'active' | 'closing' | 'closed'; } ``` ### Report Model ```typescript interface Report { id: string; type: 'compliance' | 'enforcement' | 'impact'; period: string; format: 'json' | 'csv' | 'pdf' | 'html'; filePath: string; fileSize: string; generated: string; // ISO timestamp metrics: Record<string, any>; } ``` ## Response Formats ### Success Response ```json { "success": true, "data": { /* command-specific data */ }, "proof": "pact-proof-abc123def456", // if --proof option used "timestamp": "2024-08-01T12:00:00Z" } ``` ### Error Response ```json { "success": false, "error": { "code": "REGULATION_NOT_FOUND", "message": "Regulation 'kyc-rules' not found", "details": { "regulationId": "kyc-rules", "suggestion": "Use 'pact-gov regulation list' to find available regulations" } }, "timestamp": "2024-08-01T12:00:00Z" } ``` ## Error Handling ### Error Codes | Code | Description | HTTP Equivalent | |------|-------------|-----------------| | `REGULATION_NOT_FOUND` | Regulation does not exist | 404 | | `VALIDATION_ERROR` | Invalid input parameters | 400 | | `PERMISSION_DENIED` | Insufficient government authority | 403 | | `CONFIGURATION_ERROR` | Configuration problem | 500 | | `NETWORK_ERROR` | Network connectivity issue | 503 | | `PUBLICATION_FAILED` | Publication system error | 500 | | `ENFORCEMENT_ERROR` | Enforcement action failed | 500 | ### Error Handling Examples **Shell Script Error Handling:** ```bash #!/bin/bash # Error handling example if ! pact-gov regulation view --id "$REGULATION_ID" --json > regulation.json; then echo "Failed to fetch regulation: $REGULATION_ID" exit 1 fi if ! jq -e '.success' regulation.json > /dev/null; then echo "API returned error:" jq '.error.message' regulation.json exit 1 fi ``` **Python Integration:** ```python import subprocess import json def create_regulation(title, reg_type): try: result = subprocess.run([ 'pact-gov', 'regulation', 'new', '--title', title, '--type', reg_type, '--json' ], capture_output=True, text=True, check=True) return json.loads(result.stdout) except subprocess.CalledProcessError as e: error = json.loads(e.stdout) raise Exception(f"Regulation creation failed: {error['error']['message']}") ``` ## Integration Examples ### REST API Wrapper ```bash #!/bin/bash # REST API simulation for PACT Gov case "$1" in "GET") case "$2" in "/regulations") pact-gov regulation list --json ;; "/regulations/"*) reg_id=${2#/regulations/} pact-gov regulation view --id "$reg_id" --json ;; "/status") pact-gov status --json ;; "/frameworks") pact-gov framework --list --json ;; esac ;; "POST") case "$2" in "/regulations") pact-gov regulation new --title "$3" --type "$4" --json ;; "/publish") pact-gov publish --regulation "$3" --effective "$4" --json ;; "/enforce") pact-gov enforce --regulation "$3" --entity "$4" --action "$5" --json ;; esac ;; esac ``` ### Automated Compliance Monitoring ```bash #!/bin/bash # Daily compliance monitoring script LOG_FILE="/var/log/pact-gov-monitor.log" DATE=$(date +%Y-%m-%d) echo "[$DATE] Starting compliance monitoring..." >> "$LOG_FILE" # Check system status if status=$(pact-gov status --json); then compliance_rate=$(echo "$status" | jq '.overallComplianceRate') if (( $(echo "$compliance_rate < 0.8" | bc -l) )); then echo "[$DATE] WARNING: Compliance rate below 80%: $compliance_rate" >> "$LOG_FILE" # Send alert pact-gov report --type compliance --format json | \ curl -X POST -H "Content-Type: application/json" \ -d @- https://alerts.regulator.gov/compliance-alert fi else echo "[$DATE] ERROR: Failed to get system status" >> "$LOG_FILE" fi # Run daily audit pact-gov audit --regulation all --period "$(date +%Y%m%d)" --json > "/tmp/daily-audit-$DATE.json" echo "[$DATE] Monitoring complete" >> "$LOG_FILE" ``` ### Batch Regulation Processing ```bash #!/bin/bash # Batch process regulations from CSV file CSV_FILE="$1" if [ ! -f "$CSV_FILE" ]; then echo "Usage: $0 <regulations.csv>" exit 1 fi # CSV format: title,type,effective_date tail -n +2 "$CSV_FILE" | while IFS=, read -r title type effective_date; do echo "Processing: $title" # Create regulation if result=$(pact-gov regulation new --title "$title" --type "$type" --json); then reg_id=$(echo "$result" | jq -r '.regulation.id') echo "Created regulation: $reg_id" # Publish regulation if pact-gov publish --regulation "$reg_id" --effective "$effective_date" --json; then echo "Published regulation: $reg_id" else echo "Failed to publish: $reg_id" fi else echo "Failed to create regulation: $title" fi sleep 1 # Rate limiting done ``` ### Webhook Integration ```javascript // Node.js webhook handler example const express = require('express'); const { exec } = require('child_process'); const app = express(); app.use(express.json()); app.post('/webhooks/violation-detected', (req, res) => { const { entityId, regulationId, severity } = req.body; // Automatic enforcement for high severity violations if (severity === 'high') { const command = `pact-gov enforce --regulation ${regulationId} --entity ${entityId} --action fine --severity high --json`; exec(command, (error, stdout, stderr) => { if (error) { console.error('Enforcement failed:', error); res.status(500).json({ error: 'Enforcement failed' }); } else { const result = JSON.parse(stdout); console.log('Enforcement action created:', result.enforcement.id); res.json({ success: true, enforcementId: result.enforcement.id }); } }); } else { res.json({ success: true, message: 'Violation logged for review' }); } }); app.listen(3000, () => { console.log('PACT Gov webhook handler listening on port 3000'); }); ``` --- This API reference provides comprehensive documentation for integrating PACT Gov CLI into government regulatory systems and workflows. For additional support, consult the main [README](README.md) or contact the regulatory support team.</article></body></html>

# PACT Gov CLI - API Reference This document provides comprehensive API reference for PACT Gov CLI commands, including detailed parameter specifications, response formats, and integration examples for government regulatory operations. ## Table of Contents - [Command Interface](#command-interface) - [Global Options](#global-options) - [Commands](#commands) - [regulation](#regulation) - [publish](#publish) - [enforce](#enforce) - [audit](#audit) - [report](#report) - [framework](#framework) - [consult](#consult) - [status](#status) - [Data Models](#data-models) - [Response Formats](#response-formats) - [Error Handling](#error-handling) - [Integration Examples](#integration-examples) ## Command Interface All PACT Gov CLI commands follow a consistent interface pattern: ```bash pact-gov [options] [--global-options] ``` ### Exit Codes - `0`: Success - `1`: General error - `2`: Configuration error - `3`: Permission error - `4`: Validation error - `5`: Network error ## Global Options These options are available for all commands: | Option | Type | Description | Default | |--------|------|-------------|---------| | `--config ` | string | Path to configuration file | `~/.pactrc` | | `--verbose` | boolean | Enable verbose output | false | | `--no-banner` | boolean | Disable startup banner | false | | `--json` | boolean | Output results in JSON format | false | | `--proof` | boolean | Generate cryptographic proof | false | | `--debug` | boolean | Enable debug mode | false | | `--help` | boolean | Show command help | false | | `--version` | boolean | Show version information | false | ## Commands ### regulation Creates, updates, and manages regulations with full lifecycle support. #### Syntax ```bash pact-gov regulation [action] [options] ``` #### Actions | Action | Description | Required Options | |--------|-------------|------------------| | `new` | Create new regulation | `--title` | | `update` | Update existing regulation | `--id` | | `view` | View specific regulation | `--id` | | `list` | List all regulations (default) | none | #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--title ` | string | For `new` | Regulation title | - | | `--type <type>` | string | No | financial, data, environmental, general | 'general' | | `--id <id>` | string | For `update`/`view` | Regulation identifier | - | | `--content <path>` | string | No | Path to regulation content file | - | #### Response Format **Standard Output (new regulation):** ``` ✓ Regulation created successfully ID: reg-a1b2c3d4e5f6 Title: KYC Threshold Requirements Type: financial Status: draft Version: 1.0.0 Created: 2024-08-01T12:00:00Z ``` **JSON Output (`--json`):** ```json { "success": true, "regulation": { "id": "reg-a1b2c3d4e5f6", "title": "KYC Threshold Requirements", "type": "financial", "status": "draft", "version": "1.0.0", "created": "2024-08-01T12:00:00Z", "updated": "2024-08-01T12:00:00Z", "enforcementCount": 0 }, "proof": "pact-proof-a1b2c3d4e5f6g7h8" } ``` #### Examples ```bash # Create financial regulation pact-gov regulation new --title "Anti-Money Laundering Rules" --type financial # Update regulation pact-gov regulation update --id reg-a1b2c3d4 --title "Updated AML Rules" # View regulation details pact-gov regulation view --id reg-a1b2c3d4 --json # List all regulations pact-gov regulation list ``` ### publish Publishes regulations through multiple channels with scheduling and notification capabilities. #### Syntax ```bash pact-gov publish [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | Yes | Regulation ID to publish | - | | `--effective <date>` | string | No | Effective date (YYYY-MM-DD) | 30 days from now | | `--channels <list>` | string | No | Publication channels (comma-separated) | 'official-gazette,website,api' | | `--draft` | boolean | No | Publish as draft for review | false | #### Publication Channels - `official-gazette`: Official government publication - `website`: Government regulatory website - `api`: PACT Protocol API distribution - `email`: Stakeholder notification system #### Response Format **Standard Output:** ``` ✓ Regulation published successfully Regulation: kyc-threshold-2024 Status: published Effective Date: 2024-07-01 Channels: official-gazette, website, api Notifications Sent: 1,247 Publication ID: pub-x1y2z3a4b5c6 ``` **JSON Output (`--json`):** ```json { "success": true, "publication": { "id": "pub-x1y2z3a4b5c6", "regulationId": "kyc-threshold-2024", "status": "published", "effectiveDate": "2024-07-01", "publishedDate": "2024-06-01T10:00:00Z", "channels": ["official-gazette", "website", "api"], "notificationsSent": 1247 }, "proof": "pact-proof-b2c3d4e5f6g7h8i9" } ``` #### Examples ```bash # Standard publication pact-gov publish --regulation kyc-rules-2024 --effective "2024-07-01" # Draft publication pact-gov publish --regulation draft-crypto-tax --draft # Custom channels pact-gov publish --regulation privacy-law --channels "official-gazette,website,email" ``` ### enforce Creates and manages enforcement actions against entities for regulatory violations. #### Syntax ```bash pact-gov enforce [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | Yes | Regulation to enforce | - | | `--entity <id>` | string | Yes | Target entity identifier | - | | `--action <type>` | string | No | warn, fine, suspend | 'warn' | | `--severity <level>` | string | No | low, medium, high | 'medium' | #### Enforcement Actions | Action | Description | Typical Penalty | Resolution Time | |--------|-------------|-----------------|-----------------| | `warn` | Compliance warning | None | 14 days | | `fine` | Monetary penalty | $1,000 - $100,000 | 30 days | | `suspend` | Operation suspension | License suspension | 90 days | #### Response Format **Standard Output:** ``` ✓ Enforcement action created Action ID: enf-m3n4o5p6q7r8 Regulation: kyc-threshold-2024 Entity: company-alpha Action: fine Severity: high Penalty: $50,000 Deadline: 2024-08-15T23:59:59Z ``` **JSON Output (`--json`):** ```json { "success": true, "enforcement": { "id": "enf-m3n4o5p6q7r8", "regulationId": "kyc-threshold-2024", "entityId": "company-alpha", "action": "fine", "severity": "high", "penalty": "$50,000", "status": "active", "created": "2024-08-01T12:00:00Z", "deadline": "2024-08-15T23:59:59Z" }, "proof": "pact-proof-c3d4e5f6g7h8i9j0" } ``` #### Examples ```bash # Issue warning pact-gov enforce --regulation kyc-rules --entity acme-corp --action warn # Apply fine pact-gov enforce --regulation data-protection --entity tech-startup --action fine --severity high # Suspend operations pact-gov enforce --regulation aml-screening --entity suspicious-entity --action suspend ``` ### audit Performs comprehensive regulatory compliance audits with configurable depth and scope. #### Syntax ```bash pact-gov audit [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | No | Regulation to audit or "all" | 'all' | | `--period <period>` | string | No | Audit period (e.g., 2024Q1, 2024) | '2024Q1' | | `--entity <id>` | string | No | Specific entity to audit | 'all' | | `--depth <level>` | string | No | basic, standard, comprehensive | 'standard' | #### Audit Depth Levels | Level | Description | Coverage | Typical Duration | |-------|-------------|----------|------------------| | `basic` | High-level compliance check | Key metrics only | 1-2 hours | | `standard` | Standard audit procedures | Core requirements | 1-2 days | | `comprehensive` | Full regulatory audit | All requirements | 1-2 weeks | #### Response Format **Standard Output:** ``` Audit Report for 2024Q1 Summary: Entities Audited: 156 Compliance Rate: 87% Issues Found: 23 Findings by Severity: High Risk [██░░░] 3 issues Medium Risk [████░] 8 issues Low Risk [██████] 12 issues Top Violations: 1. Incomplete KYC documentation (8 entities) 2. Missing transaction monitoring (5 entities) 3. Delayed reporting requirements (4 entities) ``` **JSON Output (`--json`):** ```json { "success": true, "audit": { "id": "audit-d4e5f6g7h8i9j0k1", "period": "2024Q1", "regulation": "all", "entitiesAudited": 156, "complianceRate": 0.87, "findings": [ { "id": "finding-1", "entity": "company-alpha", "regulation": "kyc-threshold-2024", "severity": "high", "description": "Incomplete KYC documentation", "recommendation": "Complete customer verification within 30 days" } ], "summary": { "highRisk": 3, "mediumRisk": 8, "lowRisk": 12 }, "generated": "2024-08-01T14:00:00Z" }, "proof": "pact-proof-d4e5f6g7h8i9j0k1" } ``` #### Examples ```bash # System-wide audit pact-gov audit --regulation all --period 2024Q1 # Specific regulation audit pact-gov audit --regulation kyc-rules --entity acme-corp --depth comprehensive # Quick entity audit pact-gov audit --entity tech-startup --depth basic ``` ### report Generates comprehensive regulatory reports in multiple formats with detailed analytics. #### Syntax ```bash pact-gov report [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--type <type>` | string | No | compliance, enforcement, impact | 'compliance' | | `--format <format>` | string | No | json, csv, pdf, html | 'pdf' | | `--period <period>` | string | No | Report period | '2024Q1' | | `--output <path>` | string | No | Custom output file path | auto-generated | #### Report Types | Type | Description | Content | Use Case | |------|-------------|---------|----------| | `compliance` | Compliance overview | Rates, trends, violations | Regulatory oversight | | `enforcement` | Enforcement actions | Actions, penalties, outcomes | Performance tracking | | `impact` | Regulatory impact | Economic effects, costs | Policy analysis | #### Response Format **Standard Output:** ``` ✓ Report generated successfully Type: Compliance Report Period: 2024Q1 Format: PDF File: compliance-report-2024q1-20240801.pdf Size: 2.4 MB Report Highlights: • Overall compliance rate: 87% • Enforcement actions: 45 • Total penalties: $2.3M • Trend: +5% improvement from 2023Q4 ``` **JSON Output (`--json`):** ```json { "success": true, "report": { "id": "report-e5f6g7h8i9j0k1l2", "type": "compliance", "period": "2024Q1", "format": "pdf", "filePath": "./compliance-report-2024q1-20240801.pdf", "fileSize": "2.4 MB", "generated": "2024-08-01T15:00:00Z", "metrics": { "complianceRate": 0.87, "enforcementActions": 45, "totalPenalties": "$2,300,000", "trendImprovement": 0.05 } }, "proof": "pact-proof-e5f6g7h8i9j0k1l2" } ``` #### Examples ```bash # Generate compliance report pact-gov report --type compliance --format pdf --period 2024Q1 # Enforcement statistics pact-gov report --type enforcement --format csv --output enforcement.csv # Impact assessment pact-gov report --type impact --format html --period 2024 ``` ### framework Manages regulatory frameworks for organizing related regulations into coherent structures. #### Syntax ```bash pact-gov framework [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--create <name>` | string | No | Create new framework | - | | `--list` | boolean | No | List all frameworks | false | | `--add-regulation <id>` | string | No | Add regulation to framework | - | | `--framework <name>` | string | Conditional | Target framework name | - | #### Response Format **Standard Output (create):** ``` ✓ Framework created successfully ID: framework-f6g7h8i9j0k1 Name: Financial Services Framework Status: active Regulations: 0 Created: 2024-08-01T16:00:00Z ``` **Standard Output (list):** ``` Regulatory Frameworks: Financial Services Framework Status: active Regulations: 12 Created: 2024-01-15 Updated: 2024-07-20 Data Protection Framework Status: active Regulations: 8 Created: 2024-02-01 Updated: 2024-06-15 Environmental Framework Status: draft Regulations: 3 Created: 2024-07-01 Updated: 2024-07-30 ``` **JSON Output (`--json`):** ```json { "success": true, "frameworks": [ { "id": "framework-f6g7h8i9j0k1", "name": "Financial Services Framework", "status": "active", "regulationCount": 12, "created": "2024-01-15T10:00:00Z", "updated": "2024-07-20T14:30:00Z" } ], "proof": "pact-proof-f6g7h8i9j0k1l2m3" } ``` #### Examples ```bash # Create framework pact-gov framework --create "Digital Asset Framework" # List all frameworks pact-gov framework --list # Add regulation to framework pact-gov framework --add-regulation kyc-rules --framework "Financial Services Framework" ``` ### consult Manages public consultations for regulatory development with stakeholder engagement tracking. #### Syntax ```bash pact-gov consult [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--regulation <id>` | string | Conditional | Regulation ID for consultation | - | | `--duration <period>` | string | No | Consultation duration (e.g., 30d) | '30d' | | `--channels <list>` | string | No | Consultation channels | 'website,email,public-forum' | | `--summary` | boolean | No | Show consultation summary | false | #### Response Format **Standard Output (create):** ``` ✓ Public consultation opened Regulation: draft-privacy-law Duration: 45 days End Date: 2024-09-15 Channels: website, email, public-forum Consultation ID: consult-g7h8i9j0k1l2 ``` **Standard Output (summary):** ``` Active Public Consultations: Cryptocurrency Framework Status: active Responses: 247 End Date: 2024-08-30 Sentiment: 68% positive Privacy Protection Law Status: active Responses: 156 End Date: 2024-09-15 Sentiment: 72% positive Data Localization Rules Status: closing Responses: 89 End Date: 2024-08-05 Sentiment: 45% negative ``` #### Examples ```bash # Open consultation pact-gov consult --regulation draft-privacy-law --duration 45d # View active consultations pact-gov consult --summary # Multi-channel consultation pact-gov consult --regulation crypto-framework --channels "website,email,public-forum" --duration 60d ``` ### status Provides comprehensive status monitoring for both individual regulations and the overall regulatory system. #### Syntax ```bash pact-gov status [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--detailed` | boolean | No | Show detailed statistics | false | | `--regulation <id>` | string | No | Status for specific regulation | - | #### Response Format **Standard Output (system status):** ``` PACT Gov System Status Regulations: Total: 47 Active: 42 Draft: 5 Financial: 18 Data: 12 Environmental: 8 General: 9 Compliance Overview: Overall Rate: 87% ↗ +3% this quarter Entities: 1,247 Audited: 892 (71%) Enforcement Activity (30 days): Warnings: 23 Fines: 8 Suspensions: 2 Total Penalties: $450,000 System Health: ✓ Operational Last Updated: 2024-08-01T17:00:00Z ``` **Regulation-Specific Status:** ``` Status for kyc-threshold-2024 Regulation Details: Type: financial Status: active Version: 2.1.0 Effective: 2024-06-01 Last Updated: 2024-07-15T10:30:00Z Compliance Metrics: Covered Entities: 234 Compliance Rate: 92% ↗ +5% this month Risk Level: LOW Recent Activity: • 3 enforcement actions (last 30 days) • 15 audits completed • 2 consultation responses processed ``` #### Examples ```bash # System overview pact-gov status # Detailed system status pact-gov status --detailed # Specific regulation status pact-gov status --regulation kyc-rules-2024 ``` ## Data Models ### Regulation Model ```typescript interface Regulation { id: string; title: string; type: 'financial' | 'data' | 'environmental' | 'general'; status: 'draft' | 'active' | 'suspended' | 'revoked'; version: string; created: string; // ISO timestamp updated: string; // ISO timestamp enforcementCount: number; content?: string; } ``` ### Publication Model ```typescript interface Publication { id: string; regulationId: string; status: 'draft' | 'published' | 'effective'; effectiveDate: string; // YYYY-MM-DD publishedDate: string; // ISO timestamp channels: string[]; notificationsSent: number; } ``` ### Enforcement Model ```typescript interface Enforcement { id: string; regulationId: string; entityId: string; action: 'warn' | 'fine' | 'suspend'; severity: 'low' | 'medium' | 'high'; penalty?: string; status: 'active' | 'resolved' | 'appealed'; created: string; // ISO timestamp deadline: string; // ISO timestamp } ``` ### Audit Model ```typescript interface Audit { id: string; period: string; regulation: string; entitiesAudited: number; complianceRate: number; findings: AuditFinding[]; summary: { highRisk: number; mediumRisk: number; lowRisk: number; }; generated: string; // ISO timestamp } interface AuditFinding { id: string; entity: string; regulation: string; severity: 'high' | 'medium' | 'low'; description: string; recommendation: string; } ``` ### Framework Model ```typescript interface Framework { id: string; name: string; status: 'draft' | 'active' | 'archived'; regulationCount: number; regulations: string[]; // regulation IDs created: string; // ISO timestamp updated: string; // ISO timestamp } ``` ### Consultation Model ```typescript interface Consultation { id: string; regulationId: string; duration: string; endDate: string; // YYYY-MM-DD channels: string[]; responses: number; sentiment: { positive: number; negative: number; neutral: number; }; status: 'active' | 'closing' | 'closed'; } ``` ### Report Model ```typescript interface Report { id: string; type: 'compliance' | 'enforcement' | 'impact'; period: string; format: 'json' | 'csv' | 'pdf' | 'html'; filePath: string; fileSize: string; generated: string; // ISO timestamp metrics: Record<string, any>; } ``` ## Response Formats ### Success Response ```json { "success": true, "data": { /* command-specific data */ }, "proof": "pact-proof-abc123def456", // if --proof option used "timestamp": "2024-08-01T12:00:00Z" } ``` ### Error Response ```json { "success": false, "error": { "code": "REGULATION_NOT_FOUND", "message": "Regulation 'kyc-rules' not found", "details": { "regulationId": "kyc-rules", "suggestion": "Use 'pact-gov regulation list' to find available regulations" } }, "timestamp": "2024-08-01T12:00:00Z" } ``` ## Error Handling ### Error Codes | Code | Description | HTTP Equivalent | |------|-------------|-----------------| | `REGULATION_NOT_FOUND` | Regulation does not exist | 404 | | `VALIDATION_ERROR` | Invalid input parameters | 400 | | `PERMISSION_DENIED` | Insufficient government authority | 403 | | `CONFIGURATION_ERROR` | Configuration problem | 500 | | `NETWORK_ERROR` | Network connectivity issue | 503 | | `PUBLICATION_FAILED` | Publication system error | 500 | | `ENFORCEMENT_ERROR` | Enforcement action failed | 500 | ### Error Handling Examples **Shell Script Error Handling:** ```bash #!/bin/bash # Error handling example if ! pact-gov regulation view --id "$REGULATION_ID" --json > regulation.json; then echo "Failed to fetch regulation: $REGULATION_ID" exit 1 fi if ! jq -e '.success' regulation.json > /dev/null; then echo "API returned error:" jq '.error.message' regulation.json exit 1 fi ``` **Python Integration:** ```python import subprocess import json def create_regulation(title, reg_type): try: result = subprocess.run([ 'pact-gov', 'regulation', 'new', '--title', title, '--type', reg_type, '--json' ], capture_output=True, text=True, check=True) return json.loads(result.stdout) except subprocess.CalledProcessError as e: error = json.loads(e.stdout) raise Exception(f"Regulation creation failed: {error['error']['message']}") ``` ## Integration Examples ### REST API Wrapper ```bash #!/bin/bash # REST API simulation for PACT Gov case "$1" in "GET") case "$2" in "/regulations") pact-gov regulation list --json ;; "/regulations/"*) reg_id=${2#/regulations/} pact-gov regulation view --id "$reg_id" --json ;; "/status") pact-gov status --json ;; "/frameworks") pact-gov framework --list --json ;; esac ;; "POST") case "$2" in "/regulations") pact-gov regulation new --title "$3" --type "$4" --json ;; "/publish") pact-gov publish --regulation "$3" --effective "$4" --json ;; "/enforce") pact-gov enforce --regulation "$3" --entity "$4" --action "$5" --json ;; esac ;; esac ``` ### Automated Compliance Monitoring ```bash #!/bin/bash # Daily compliance monitoring script LOG_FILE="/var/log/pact-gov-monitor.log" DATE=$(date +%Y-%m-%d) echo "[$DATE] Starting compliance monitoring..." >> "$LOG_FILE" # Check system status if status=$(pact-gov status --json); then compliance_rate=$(echo "$status" | jq '.overallComplianceRate') if (( $(echo "$compliance_rate < 0.8" | bc -l) )); then echo "[$DATE] WARNING: Compliance rate below 80%: $compliance_rate" >> "$LOG_FILE" # Send alert pact-gov report --type compliance --format json | \ curl -X POST -H "Content-Type: application/json" \ -d @- https://alerts.regulator.gov/compliance-alert fi else echo "[$DATE] ERROR: Failed to get system status" >> "$LOG_FILE" fi # Run daily audit pact-gov audit --regulation all --period "$(date +%Y%m%d)" --json > "/tmp/daily-audit-$DATE.json" echo "[$DATE] Monitoring complete" >> "$LOG_FILE" ``` ### Batch Regulation Processing ```bash #!/bin/bash # Batch process regulations from CSV file CSV_FILE="$1" if [ ! -f "$CSV_FILE" ]; then echo "Usage: $0 <regulations.csv>" exit 1 fi # CSV format: title,type,effective_date tail -n +2 "$CSV_FILE" | while IFS=, read -r title type effective_date; do echo "Processing: $title" # Create regulation if result=$(pact-gov regulation new --title "$title" --type "$type" --json); then reg_id=$(echo "$result" | jq -r '.regulation.id') echo "Created regulation: $reg_id" # Publish regulation if pact-gov publish --regulation "$reg_id" --effective "$effective_date" --json; then echo "Published regulation: $reg_id" else echo "Failed to publish: $reg_id" fi else echo "Failed to create regulation: $title" fi sleep 1 # Rate limiting done ``` ### Webhook Integration ```javascript // Node.js webhook handler example const express = require('express'); const { exec } = require('child_process'); const app = express(); app.use(express.json()); app.post('/webhooks/violation-detected', (req, res) => { const { entityId, regulationId, severity } = req.body; // Automatic enforcement for high severity violations if (severity === 'high') { const command = `pact-gov enforce --regulation ${regulationId} --entity ${entityId} --action fine --severity high --json`; exec(command, (error, stdout, stderr) => { if (error) { console.error('Enforcement failed:', error); res.status(500).json({ error: 'Enforcement failed' }); } else { const result = JSON.parse(stdout); console.log('Enforcement action created:', result.enforcement.id); res.json({ success: true, enforcementId: result.enforcement.id }); } }); } else { res.json({ success: true, message: 'Violation logged for review' }); } }); app.listen(3000, () => { console.log('PACT Gov webhook handler listening on port 3000'); }); ``` --- This API reference provides comprehensive documentation for integrating PACT Gov CLI into government regulatory systems and workflows. For additional support, consult the main [README](README.md) or contact the regulatory support team.</article></body></html>