Help & Reference

Everything you need to use the CheQ platform — features, field definitions, and troubleshooting.

  1. 1

    Log in with your credentials. The Dashboard is your home screen — it shows aggregate metrics for both compliance checks and policy verifications.

  2. 2

    Go to Documents and upload at least one Regulation PDF (e.g. an IRDAI guideline) and one BRD (Business Requirements Document). Wait for each file to finish processing before continuing.

  3. 3

    Go to Compliance and run a check: select your BRD, choose which regulations to compare it against, then click "Run Check". The system will extract, compare, and score the document.

  4. 4

    Open the resulting Report to see the compliance score, per-regulation findings, and the Policy Reasoning Trace.

  5. 5

    To verify a policy document (e.g. a customer-facing policy PDF), go to Policy Verification, upload the PDF, and wait for the scorecard to appear.

  6. 6

    Use Rule Studio to manage the rules that drive policy verification. Activate, suspend, or create new rules without re-uploading any documents.

Field & Status Reference

RegulationA regulatory guideline uploaded as a PDF that defines rules for compliance.
BRDBusiness Requirements Document — the internal document being checked for compliance.
  1. 1

    The top KPI row shows Total Checks, Average Score, Regulations Loaded, and Non-Compliant count for the compliance workflow.

  2. 2

    The "Compliance Score Trend" area chart plots the overall score of each completed check in chronological order.

  3. 3

    The "Status Distribution" donut shows the ratio of compliant, non-compliant, and insufficient-info results.

  4. 4

    The "Recent Activity" table lists the last 5 compliance reports. Click any row to open the full report.

  5. 5

    The "Policy Verification" section below shows the same type of metrics for uploaded policy PDFs: total verified, average pass rate, failed count, and grade distribution.

  6. 6

    All data refreshes automatically every 30 seconds. To force a refresh, reload the page.

Field & Status Reference

Avg. ScoreAverage overall_score across all completed compliance checks (0–100).
Avg. Pass RateAverage scorecard.score × 100 across all validated policy verifications.
Grade A / B / C / FLetter grade derived from pass rate: A ≥ 90%, B ≥ 75%, C ≥ 60%, F < 60%.
  1. 1

    Click "Upload Document" and select a PDF file. Choose the document type: "Regulation" for regulatory guidelines, "BRD" for internal business documents.

  2. 2

    After upload, the document enters the processing pipeline: text is extracted, chunked, embedded, and indexed into the vector and graph databases.

  3. 3

    Wait for the status to show "ready" before using the document in a compliance check. Large PDFs may take 30–120 seconds.

  4. 4

    Documents in "failed" status could not be processed — check that the file is a valid, non-corrupted PDF with extractable text (not a scanned image).

  5. 5

    To delete a document, use the delete button on the document card. This also removes its entries from the knowledge base.

Field & Status Reference

processingDocument is being chunked, embedded, and indexed. Wait for this to complete.
readyDocument is fully indexed and available for compliance checks and queries.
failedIngestion failed — most commonly a scanned PDF with no extractable text layer.
RegulationA regulatory guideline. Multiple regulations can be checked against one BRD.
BRDBusiness Requirements Document. The target document for a compliance check.
  1. 1

    Step 1 — Select BRD: Choose the BRD you want to check. Only documents with status "ready" are listed.

  2. 2

    Step 2 — Select Regulations: Choose one or more regulatory documents to compare against. You can select multiple.

  3. 3

    Step 3 — Run Check: Click "Run Compliance Check". The system sends both documents to the multi-agent pipeline (Builder → Legislator → Judge) and scores each regulatory requirement.

  4. 4

    When complete, you are redirected to the Report. A compliance check typically takes 30–90 seconds depending on document length.

  5. 5

    Scores range from 0–100. A score above 70 is generally considered compliant, though this threshold depends on your organisation's standards.

Field & Status Reference

compliantThe BRD satisfies the requirements of the selected regulations.
non_compliantOne or more regulatory requirements are clearly not met.
partialSome requirements are met; others are not. Review the per-regulation breakdown.
insufficient_infoThe BRD does not contain enough information to make a determination.
Overall ScoreWeighted average of per-requirement scores across all checked regulations (0–100).
  1. 1

    The Reports list shows all completed checks with the BRD name, overall score, status, and date. Click any row to open the full report.

  2. 2

    Inside a report, the header shows the overall score and status. Below it, each regulation's findings are listed in a collapsible panel.

  3. 3

    Each finding includes an extracted clause, the applicable regulation reference, and the Judge's reasoning.

  4. 4

    The "Policy Reasoning Trace" (PRT) section shows the full chain of reasoning the AI used — every step from extraction to verdict. This is the audit trail.

  5. 5

    To export, click "Print / Save PDF" in the header. The page uses print-optimised CSS with the CheQ header and branding.

Field & Status Reference

PRTPolicy Reasoning Trace — the full audit trail of every reasoning step performed by the AI pipeline.
FindingA single regulatory requirement that was evaluated, with its extracted evidence and verdict.
compliant / non_compliant / partial / insufficient_infoPer-finding status (same definitions as the overall check status).
  1. 1

    Type a question in plain English in the query box and press Enter or click Send. Example: "What are the capital adequacy requirements under IRDAI?"

  2. 2

    The system retrieves the most relevant chunks from indexed regulations using hybrid vector + graph search, then synthesises an answer.

  3. 3

    Citations appear below the answer — each citation links to the source document and the specific passage used.

  4. 4

    For best results, ask specific questions about requirements, definitions, or thresholds. Vague questions ("tell me about IRDAI") produce broad summaries.

  5. 5

    The query interface searches only documents that have been successfully ingested. If a document is missing from results, verify it has status "ready" in Documents.

Field & Status Reference

CitationA direct reference to a source document passage used to construct the answer.
Hybrid searchCombines dense vector similarity (semantic meaning) with sparse BM25 keyword matching for higher recall.
  1. 1

    Go to Policy Verification and click "Upload Policy PDF". Select one PDF (or up to 10 for batch mode). Only PDF files are accepted.

  2. 2

    Pass the X-Org-Id header (or select the org in the upload form) to use the correct extraction schema. Supported: hdfc-ergo, prudent, aditya-birla.

  3. 3

    The system runs a two-layer pipeline: (1) extract text → extract structured fields using the org's Schema Studio schema → evaluate business rules (Document QC layer); (2) evaluate regulatory ACU rules with MiniPRT reasoning (Regulatory Compliance layer).

  4. 4

    Once status is "validated", click the document row to open the detail view. Two tabs are available: "Document QC" and "Regulatory Compliance".

  5. 5

    "Document QC" tab shows extracted fields, standard rule results, and the business scorecard. Each rule result shows PASS / FAIL / WARN / SKIP with evidence.

  6. 6

    "Regulatory Compliance" tab shows IRDAI regulation-derived rule results, each with a MiniPRT: evidence found in the document, page reference, reasoning chain, and COMPLIANT / NON-COMPLIANT / UNABLE_TO_DETERMINE verdict with confidence score.

  7. 7

    If you change rules in Rule Studio, use the "Re-validate" button to re-run rule evaluation without re-uploading the PDF (~5 seconds).

  8. 8

    Export a branded PDF report using the "Export PDF Report" button in the detail view header.

Field & Status Reference

processingText is being extracted from the PDF.
extractedText and fields have been extracted; rule evaluation is running.
validatedAll pipeline stages complete. Both Document QC and Regulatory Compliance results are available.
failedOne or more pipeline stages failed. Check that the PDF has extractable text.
PASS / COMPLIANTRule or regulatory condition was met.
FAIL / NON-COMPLIANTRule or regulatory condition was not met.
WARN / UNABLE_TO_DETERMINECondition partially met or insufficient evidence to make a determination.
SKIPRule was not applicable to this document (e.g. the field it checks was not present).
MiniPRTMini Policy Reasoning Trace — a lightweight audit record for each regulatory rule evaluation, including evidence, page reference, reasoning, verdict, and confidence.
scorepassed ÷ (total − skipped), expressed as a percentage. Shown separately for Document QC and Regulatory Compliance.
Grade APass rate ≥ 90%.
Grade BPass rate ≥ 75%.
Grade CPass rate ≥ 60%.
Grade FPass rate < 60%.
  1. 1

    The Rules Library tab lists all rules. Use the status filter to view "active", "draft", or "suspended" rules.

  2. 2

    Each rule card shows the rule name, type (deterministic or semantic), severity, and current status. Use the toggle to activate or suspend a rule without deleting it.

  3. 3

    To create a new rule, go to the "Create Rule" tab and type a plain-English description of what you want the rule to check. Example: "The sum insured must be at least ₹5 lakh."

  4. 4

    The AI analyses your intent, asks clarifying questions if needed, then compiles the rule. Review the compiled rule before saving.

  5. 5

    Use "Sandbox Test" on any rule to run it against recent verified documents and see how it would perform before activating it.

  6. 6

    The "Rule Packs" tab lists pre-built YAML rule collections (e.g. IRDAI Life Basics, Premium Arithmetic, HDFC Ergo Custom). Click "Install" to add all rules in a pack.

  7. 7

    After installing a pack or changing rule status, use "Re-validate" on existing policy verifications to see the updated results immediately.

Field & Status Reference

deterministicRule uses an exact formula or comparison against an extracted field value (fast, no LLM).
semanticRule uses an LLM to evaluate a natural language condition against extracted text.
activeRule is included in all new policy verifications.
draftRule exists but is not yet included in verifications.
suspendedRule is temporarily excluded from verifications without being deleted.
severitycritical / high / medium / low — determines how heavily a FAIL impacts the overall score.
Rule PackA YAML file containing a named collection of rules that can be installed as a unit.
Regulation badgeRules with a purple "Regulation" badge are auto-synced from compliance ACUs and used in the Regulatory Compliance layer of Policy Verification.
  1. 1

    Go to Schema Studio. The Schemas tab lists all extraction schemas in the system, filterable by organisation (HDFC Ergo, Prudent, Aditya Birla) and status (active / draft / deprecated).

  2. 2

    Each schema card shows the schema ID, organisation, version, field count, and status. Expand a card to see all fields grouped by category (identity, financial, dates, terms, etc.).

  3. 3

    To activate a schema so it is used for new uploads, expand the card and click "Activate". Only one schema per org can be active at a time.

  4. 4

    To create a new schema with AI, click the "Create with AI" tab. Select the organisation, describe what you want to extract in plain English, and click "Generate with AI".

  5. 5

    If the AI needs more information, it will ask clarifying questions. Answer them and click "Generate Schema". Review the generated fields and click "Save Schema" to store it as a draft.

  6. 6

    Activate the new draft schema from the Schemas list. Future uploads for that org will use the new schema immediately.

  7. 7

    To deprecate an old schema, expand the card and click "Deprecate". Deprecated schemas are retained for audit purposes but not used for new extractions.

Field & Status Reference

schema_idUnique identifier for the schema, e.g. hdfc_ergo_life_v1. Used in extraction logs and audit records.
org_idOrganisation the schema belongs to (hdfc-ergo, prudent, aditya-birla). The upload API uses X-Org-Id to select the schema.
activeThis schema is used for all new uploads for the matching org.
draftSchema exists but is not yet used for extractions.
deprecatedSchema is retired and no longer used, but retained for audit.
field_idUnique snake_case identifier for an extracted field, e.g. sum_assured or nominee_name.
data_typestring / number / boolean / date / array — determines how the extracted value is typed and validated.
extraction_hintOptional natural language hint to the LLM about where or how to find a specific field in the document.
  1. 1

    The Knowledge Graph page shows live node and edge counts from the graph database (FalkorDB).

  2. 2

    Every regulatory document that is ingested is parsed for entities (sections, clauses, definitions, requirements) and the relationships between them.

  3. 3

    These relationships enhance the Query feature — when you ask a question, the system uses both vector similarity and graph traversal to find relevant passages.

  4. 4

    Entity Search lets you look up specific concepts (e.g. "premium", "exclusion", "sum insured") and see which regulations reference them.

  5. 5

    The graph is populated automatically during document ingestion. No manual action is required.

Field & Status Reference

NodeAn entity in the graph — could be a regulation, a section, a clause, a definition, or a requirement.
EdgeA relationship between two nodes — e.g. "Section 3 contains Clause 3.1" or "Clause 3.1 defines Premium".
HierFinRAGThe hierarchical retrieval schema used to model financial regulatory documents in the graph.
  1. 1

    Connector Hub is for PAS API integrations only — Duck Creek, Oracle OIPA, TCS BaNCS, or any custom REST API that exposes product or policy data.

  2. 2

    Click "+ Add Connector", choose a pre-built template (Duck Creek, Oracle OIPA, TCS BaNCS) or start from scratch.

  3. 3

    Fill in the Endpoint URL, Organisation ID, and authentication credentials (API Key or Bearer token).

  4. 4

    Use "Test Connection" on the connector card to verify the endpoint is reachable and returns a valid response.

  5. 5

    To extract fields and rules from a policy or product filing PDF, use Pack Studio → "From Document" tab instead — that is the correct ingestion path for document-based content.

Field & Status Reference

PASPolicy Administration System — the core platform insurers use to manage products, policies, and premiums.
TemplateA pre-configured connector definition for a known PAS vendor (Duck Creek, Oracle OIPA, TCS BaNCS).
From DocumentThe Pack Studio tab for uploading a product filing PDF and extracting fields and rules using AI. Not part of Connector Hub.
  1. 1

    Every ACU (Atomic Compliance Unit) has an intrinsic severity — CRITICAL, HIGH, MEDIUM, or LOW — assigned by the AI during extraction, aligned with IRDAI's weighted risk formula.

  2. 2

    When a compliance check or policy verification runs, each finding's severity is computed from a deterministic matrix: a CRITICAL ACU that is NON-COMPLIANT becomes a CRITICAL finding; a CRITICAL ACU that has INSUFFICIENT_INFO becomes a HIGH finding; any COMPLIANT finding is INFO.

  3. 3

    The Risk Breakdown summary (e.g., "2 CRITICAL · 1 HIGH") appears at the top of every compliance report and policy verification result. Use this to triage the most important issues first.

  4. 4

    Use the severity filter bar on report detail pages to focus on CRITICAL or HIGH findings only — this is the fastest path to the highest-risk gaps.

  5. 5

    Dashboard → Risk Distribution card shows your aggregate severity profile across all recent checks.

  6. 6

    You can manually override an ACU's intrinsic severity in the ACU Explorer (Compliance → ACU Explorer tab → edit severity field). Changes take effect on future checks.

Field & Status Reference

CRITICALMandatory IRDAI provisions — free-look, grievance redressal, exclusion disclosure. Must be resolved before filing.
HIGHKey disclosure requirements with regulatory penalty exposure.
MEDIUMProcedural or format requirements with moderate compliance risk.
LOWInformational obligations with minimal penalty risk.
INFOCompliant finding — no action required.
  1. 1

    When you upload a new or updated regulation PDF, CheQ automatically compares the extracted ACUs against existing ones using SHA-256 content hashing and semantic similarity.

  2. 2

    Changes are classified by the MURCIA taxonomy: ADDED (new obligation), MODIFIED (rewording detected — cosine similarity > 0.75 but content differs), SUPERSEDED (same rule code, new version replaces old), or UNCHANGED (identical).

  3. 3

    The Dashboard shows an amber "Regulation Updates" card when pending changes exist, listing how many BRDs were checked against now-stale regulation versions.

  4. 4

    Navigate to Compliance → Regulation Updates tab to review all detected changes. Each event shows the change type, similarity score, affected BRD count, and a summary.

  5. 5

    Click "Acknowledge" to mark a change as reviewed, or "Resolve" once you have re-run the relevant compliance checks against the updated regulation.

  6. 6

    Filter events by status (Pending / Acknowledged / Resolved) to manage your regulatory change backlog.

Field & Status Reference

ADDEDA new ACU with no predecessor. Compliance checks run before this regulation was uploaded may have missed this obligation.
MODIFIEDAn ACU was reworded. Semantic similarity detected a near-match, but the content hash changed — the obligation's requirements may have shifted.
SUPERSEDEDAn existing ACU with the same rule code was replaced. The old version is marked superseded; re-run affected BRDs against the new version.
pendingChange detected but not yet reviewed by a compliance officer.
acknowledgedChange reviewed and noted. BRDs may still need re-running.
resolvedAll affected BRDs have been re-checked against the updated regulation.
  1. 1

    Verification stuck in "processing": The pipeline may have timed out. Wait 2 minutes, then reload the page. If still stuck, check that the backend is running (GET /health should return 200). The PDF may also be a scanned image with no text layer — try a different file.

  2. 2

    Extraction returning empty fields: The LLM could not find the expected data in the document. Check that the PDF contains actual text (not images of text). Try a cleaner, digitally-generated PDF.

  3. 3

    Rule not matching despite correct data: The extracted field value may be formatted differently than the rule expects. Use the Sandbox Test in Rule Studio to inspect what value was extracted and adjust the rule formula.

  4. 4

    Report export failing: The PDF export uses WeasyPrint on the backend. If the download does not start, check the backend logs. The browser's native print dialog is a fallback for compliance reports.

  5. 5

    Query returning irrelevant results: Ensure the relevant documents have status "ready" in Documents. Try rephrasing the question to include specific terms from the regulation.

  6. 6

    Backend not responding (500 errors): Run `docker-compose ps` to check all services are healthy. Run `docker-compose logs backend --tail=50` for error details. Restart with `docker-compose restart backend` if needed.