Skip to main content
GET
/
api
/
rulepacks
Rule Packs
curl --request GET \
  --url https://api.example.com/api/rulepacks/
[
  {
    "id": "scenario_retail_investor_letter",
    "name": "Retail Investor Letter",
    "description": "Compliance checks for retail investor communications"
  },
  {
    "id": "scenario_retail_fact_sheet_registered_fund",
    "name": "Retail Fact Sheet - Registered Fund",
    "description": "Compliance checks for mutual fund fact sheets"
  },
  {
    "id": "scenario_pitch_book_registered_fund",
    "name": "Pitch Book - Registered Fund",
    "description": "Compliance checks for institutional pitch books"
  }
]
List all available scenarios or get details for a specific scenario including compliance checks and definitions.

​
Query Parameters

​
id
string
Scenario ID to retrieve specific scenario details

​
Response - List All Scenarios

When called without id parameter, returns a list of all available scenarios. 
[
  {
    "id": "scenario_retail_investor_letter",
    "name": "Retail Investor Letter",
    "description": "Compliance checks for retail investor communications"
  },
  {
    "id": "scenario_retail_fact_sheet_registered_fund",
    "name": "Retail Fact Sheet - Registered Fund",
    "description": "Compliance checks for mutual fund fact sheets"
  },
  {
    "id": "scenario_pitch_book_registered_fund",
    "name": "Pitch Book - Registered Fund",
    "description": "Compliance checks for institutional pitch books"
  }
]

​
Response - Specific Scenario

When called with id parameter, returns detailed scenario information including checks and definitions.
​
id
string
Unique scenario identifier
​
name
string
Human-readable scenario name
​
description
string
Scenario description
​
requirements
object
Audience and product requirements for this scenario
​
checks
array
List of compliance checks performed
​
compliance_attestation_checklist
array
Checklist items for compliance attestation
​
definitions
array
Rule definitions (some fields may be masked)
[
  {
    "id": "scenario_retail_investor_letter",
    "name": "Retail Investor Letter",
    "description": "Compliance checks for retail investor communications",
    "requirements": {
      "audience_hint": ["retail_US", "retail_nonUS"],
      "product_class": ["registered_fund", "non_registered"]
    },
    "checks": [
      {
        "id": "perf_claim_no_disclosure",
        "name": "Performance Disclosure Check",
        "severity": "high"
      },
      {
        "id": "risk_disclosure_missing",
        "name": "Risk Disclosure Check",
        "severity": "high"
      }
    ],
    "compliance_attestation_checklist": [
      "All performance claims have required disclosures",
      "Risk factors are prominently disclosed",
      "No promissory language present"
    ],
    "definitions": [
      {
        "id": "perf_claim_no_disclosure",
        "type": "rule",
        "name": "Performance Disclosure Check",
        "keywords": "***MASKED***",
        "prompt": "***MASKED***"
      }
    ]
  }
]

​
Example

curl -X GET "https://zhshgjat2b.execute-api.us-east-1.amazonaws.com/dev/v1/api/rulepacks/" \
  -H "x-api-key: YOUR_API_KEY"