QiXCite: Getting Started Guide
Citation governance for legal AI. Prevent hallucinated citations, verify case law, detect retractions, and produce verifiable evidence bundles.
What is QiXCite?
QiXCite is a citation governance engine for legal AI. It prevents hallucinated citations, verifies authority existence, labels treatment coverage by source type, and produces verifiable evidence bundles for every verification.
QiXCite is part of the Quorum Integrity eXchange (QIX) framework by OrchIntel, purpose-built for law firms, legal departments, and compliance teams that use AI in their workflows.
Core Capabilities
| Capability | Description |
|---|---|
| Citation Extraction | Automatically extracts legal citations from documents using regex + NLP |
| Existence Check | Verifies citations against jurisdiction-aware providers (policy and license gated) |
| Treatment Status | Distinguishes licensed treatment checks vs OCG estimated signals vs existence-only |
| Semantic Support | Dual-signal embedding analysis to verify the citation supports the claim |
| Quote-Lock | SHA-256 hash of quoted material to prevent AI fabrication |
| Evidence Bundle | Cryptographically signed JSON bundle for audit trails |
| Auto-Correction | Suggests alternative citations when issues are detected |
| Document Scan | Full-document analysis with per-citation verification |
| Batch Processing | High-volume API for processing multiple documents |
| Continuous Monitoring | Register citations for periodic re-checking with webhook alerts on status changes |
| Risk Assessment | Executive summary and risk score (low/medium/high/critical) for document scans |
Deployment Options
QiXCite runs in two modes. Choose the one that fits your organization's needs.
IOA Cloud
Zero infrastructure. QiXCite runs as a managed service. Start in Word immediately, then sign in when you want saved history and higher limits.
Requirements
- Microsoft Word with the QiXCite Add-in
- Optional free IOA Cloud account for saved usage and evidence continuity
- No provider key required for standard cloud trial scans
Setup
- Install the Word Add-in (see below)
- Open the sidebar and click Scan This Document
- If you hit preview limits or need cloud-only features, continue with a free account
- Manage plan and quota at Usage and billing pages
Local / On-Premise
Run QiXCite on your own infrastructure. Evidence stays on your network.
Requirements
- Docker and Docker Compose
- Python 3.11+ (if running without Docker)
- Network access to CourtListener API (for citation verification)
Option A: Docker (recommended)
cd qixcite/
docker compose -f docker-compose.local.yml up -d This starts QiXCite on http://localhost:8000 in local mode.
Option B: Direct Python
cd qixcite/
pip install -e .
./scripts/run_local.sh Or manually:
export QIXCITE_MODE=local
export EVIDENCE_LOCAL_PATH=~/.qixcite/evidence
uvicorn qixcite.api:app --host 0.0.0.0 --port 8000 Verify It's Running
curl http://localhost:8000/healthz
# {"status":"healthy","mode":"local","version":"1.0.0"} Microsoft Word Add-in
The QiXCite Word Add-in puts citation validation directly inside Microsoft Word. No command line, no extra software, no technical setup required.
Installation
- Open Microsoft Word
- Go to Insert > Get Add-ins (or Home > Add-ins depending on version)
- Install via Microsoft AppSource if listed for your tenant, or use your organization's sideloaded
manifest.xml - Open QiXCite from the Home ribbon after install
manifest.xml.
First Launch
When you open the QiXCite sidebar for the first time:
- Click Scan This Document to start immediately
- If signed out, you can run a limited preview without technical setup
- When preview checks are used, or when cloud-only features are requested, sign in or create a free account
- Use Advanced connection options only if you need local server mode, optional licensed/BYO connectors, or custom endpoints
Using the Add-in
Scan This Document
Click "Scan This Document" to validate every citation in the current document. QiXCite extracts and verifies each one.
Quick Verify
Select a specific citation and click "Quick Verify" for single-citation checks.
Results Panel
Each citation shows a status badge:
- Verified — citation was found and passed verification checks
- Warning — citation was found, but still needs legal review
- Failed — citation could not be verified and should be checked before filing
Evidence
Download the evidence bundle for any verification. Click any result to see full details, confidence scores, and treatment notes.
Switching Modes
Cloud is the default path. Local mode and provider configuration remain available under Advanced connection options in the sidebar.
Privacy and Data Flow
QiXCite applies defensibility-first privacy controls across add-in, gateway, and evidence workflows.
- Citation verification does not require full document persistence in gateway fallback evidence bundles.
- Authority Alignment requires explicit consent for redacted excerpt processing.
- No external processing mode hard-blocks outbound alignment processing.
- Internal evidence APIs require service-to-service token authentication.
For the field-level outbound data matrix used in legal/procurement reviews, see QiXCite Privacy and Data Flow.
API Reference (Quick Start)
All endpoints are available at http://localhost:8000 (local) or https://api.orchintel.com/api/qixcite (cloud).
Verify a Single Citation
curl -X POST http://localhost:8000/verify \
-H "Content-Type: application/json" \
-d '{"citation": "Miranda v. Arizona, 384 U.S. 436 (1966)"}' Scan a Document
curl -X POST http://localhost:8000/v1/documents/scan \
-H "Content-Type: application/json" \
-d '{"content": "As established in Miranda v. Arizona, 384 U.S. 436 (1966), the Court held that..."}' Quote-Lock
curl -X POST http://localhost:8000/v1/cite/quote-lock \
-H "Content-Type: application/json" \
-d '{
"citation": "Miranda v. Arizona, 384 U.S. 436 (1966)",
"quote": "the prosecution may not use statements..."
}' Batch Processing
# Submit a batch
curl -X POST http://localhost:8000/v1/batch \
-H "Content-Type: application/json" \
-d '{
"citations": [
"Miranda v. Arizona, 384 U.S. 436 (1966)",
"Roe v. Wade, 410 U.S. 113 (1973)",
"Brown v. Board of Education, 347 U.S. 483 (1954)"
]
}'
# Check batch status
curl http://localhost:8000/v1/batch/{batch_id} View a Sample Evidence Bundle
curl http://localhost:8000/v1/evidence/sample Returns a realistic sample evidence bundle showing exactly what auditors and regulators will see -- including compliance summary, risk assessment, and cryptographic signature.
E-Filing Precheck
curl -X POST http://localhost:8000/v1/efiling/precheck \
-H "Content-Type: application/json" \
-d '{
"content": "Your brief text here...",
"jurisdiction": "US-FED",
"court": "SCOTUS"
}' Cloud Mode Authentication
For IOA Cloud, add the Authorization header:
curl -X POST https://api.orchintel.com/api/qixcite/v1/documents/scan \
-H "Authorization: Bearer ioa_usr_sk_live_..." \
-H "Content-Type: application/json" \
-d '{"content": "..."}' Configuration
QiXCite is configured via environment variables.
Core Settings
| Variable | Default | Description |
|---|---|---|
QIXCITE_MODE | local | Deployment mode: local or cloud |
EVIDENCE_LOCAL_PATH | ~/.qixcite/evidence | Local evidence storage path |
EVIDENCE_SINK_URL | — | Cloud evidence sink URL (cloud mode) |
CONSOLE_API_URL | — | IOA Console URL for auth validation (cloud mode) |
LOG_LEVEL | INFO | Logging level |
QIXCITE_CANLII_LICENCE_OBTAINED | false | Set to true to enable CanLII in cloud mode (requires formal licence) |
Citator Providers
Provider availability is policy-gated by jurisdiction, licensing, and deployment mode. Cloud starts with managed defaults; local/BYO mode can add optional licensed provider keys where permitted.
Cloud Coverage Matrix
| Jurisdiction | Default Cloud Source | Treatment Coverage | Notes |
|---|---|---|---|
| US | CourtListener | Existence checks by default; licensed treatment optional | Managed cloud path available |
| EU | EUR-Lex | Source-dependent treatment coverage | Attribution and reuse conditions apply |
| AU | Official legislation sources | Existence-only in default cloud mode | Treatment requires licensed/private source strategy |
| NZ | Official legislation sources | Existence-only in default cloud mode | Treatment requires licensed/private source strategy |
| UK / CA / restricted datasets | Policy-gated or BYO licensed provider | Conditional by contract and deployment | Enterprise enablement path |
| Academic | DOI, PubMed, arXiv, Retraction Watch | Retraction and existence checks available | Same governance/evidence flow as legal checks |
Licensed Treatment (licensed/provider-verified), Treatment Insight (Estimated • Beta) (first-party estimate with mandatory review), and Treatment Not Available (no treatment verdict available).
Optional BYO Provider Keys (Advanced / Local)
Most cloud users do not need provider keys to start. Advanced users and local deployments can configure optional BYO provider keys as needed.
| Variable | Provider | Purpose |
|---|---|---|
QIXCITE_COURTLISTENER_API_KEY | CourtListener | US case-law existence checks for local/BYO deployments |
QIXCITE_KEYCITE_API_KEY | Thomson Reuters KeyCite | Licensed treatment history integration (contract required) |
QIXCITE_SHEPARDS_API_KEY | LexisNexis Shepard's | Licensed treatment history integration (contract required) |
QIXCITE_CANLII_API_KEY | Regional adapters | Use only where your legal/license posture explicitly permits |
Validation Response Fields
Every citation validation returns these fields:
| Field | Type | Description |
|---|---|---|
is_valid | boolean | Whether the citation was verified as real |
status | string | valid, questioned, negative, overruled, superseded, or unknown |
authority_level | string | primary (binding), secondary, persuasive, or unknown |
hallucination_score | float | 0.0 (definitely real) to 1.0 (likely hallucinated) |
treatment_notes | list | Details from the citator (case name, court, date filed, source URL) |
requires_human_review | boolean | True if the citation has concerning treatment |
warnings | list | Actionable warnings (e.g., "Citation has negative treatment") |
evidence_ref | object | Reference to the evidence bundle (bundle_id, audit_id) |
Status Meanings
| Status | Meaning | Hallucination Score | Risk Level |
|---|---|---|---|
| valid | Citation exists and passed configured checks for this source path | 0.05 | Low |
| questioned | Citation exists but has been questioned | 0.45 | Medium |
| negative | Citation has received negative treatment | 0.75 | High |
| overruled | Citation has been overruled | 0.95 | Critical |
| superseded | Citation has been superseded by newer authority | 0.85 | High |
| unknown | Citation could not be verified | 0.50 | Medium |
Evidence Bundles
Every verification produces an evidence bundle containing:
Provenance
Source provider, timestamps, audit ID
Input
Citation text, jurisdiction, quote (if provided)
Output
Status, authority level, hallucination score, treatment notes
User Context
User ID and tenant ID (cloud mode)
Metadata
Validator version, mode (real/mock), provider details
Signature
Cryptographic signature for tamper detection
In local mode, bundles are saved as JSON files to EVIDENCE_LOCAL_PATH.
In cloud mode, bundles are sent to the IOA Evidence Sink for centralized storage and retrieval.
Continuous Monitoring
Register citations for ongoing surveillance. QiXCite periodically re-checks them and notifies you when treatment status changes -- for example, if a cited case is overruled after your brief was filed.
Register Citations for Monitoring
curl -X POST http://localhost:8000/v1/monitor \
-H "Content-Type: application/json" \
-d '{
"citations": ["384 U.S. 436", "347 U.S. 483"],
"jurisdiction": "US-FED",
"webhook_url": "https://your-firm.com/hooks/qixcite",
"check_interval_hours": 24
}' List Active Monitors
curl http://localhost:8000/v1/monitor Trigger an Immediate Re-check
curl -X POST http://localhost:8000/v1/monitor/{monitor_id}/check Delete a Monitor
curl -X DELETE http://localhost:8000/v1/monitor/{monitor_id} text field instead of explicit citations. QiXCite will extract citations from the text automatically.
IOA Cloud Console Playground
If you're using IOA Cloud, the QiXCite Playground at console.orchintel.com/qixcite provides a web interface for testing citation validation without writing code.
How to Use the Playground
- Log in at console.orchintel.com
- Navigate to the QiXCite page
- Use the Validate tab:
- Enter a citation in the text field (e.g.,
384 U.S. 436) - Select a jurisdiction from the dropdown
- Click Validate
- Enter a citation in the text field (e.g.,
- Results show:
- Status badge (Valid, Questioned, Negative, Overruled, Unknown)
- Authority level (Primary, Secondary, Persuasive)
- Treatment lane labels (Licensed Treatment, Treatment Insight (Estimated • Beta), or Treatment Not Available)
- Hallucination risk percentage
- Evidence bundle reference
Sample Citations to Try
| Citation | Expected Result |
|---|---|
384 U.S. 436 | Valid — Miranda v. Arizona (1966) |
347 U.S. 483 | Valid — Brown v. Board of Education (1954) |
576 U.S. 644 | Valid — Obergefell v. Hodges (2015) |
163 U.S. 537 | Valid — Plessy v. Ferguson (1896) |
999 U.S. 999 | Unknown — Citation not found |
1 Umbrella 100 | Unknown — Invalid reporter |
Support & Resources
Product Page
IOA Console
Sales Inquiries
Trademark Notice: QiXCite is an independent framework by OrchIntel. KeyCite is a registered trademark of Thomson Reuters. Shepard's is a registered trademark of LexisNexis. Availability of those services depends on deployment mode, contracts, and licensing.