PermitOS Docs

Product documentation for permit readiness, document intake, and human-led review workflows.

Explore PermitOS concepts, data models, workflow guides, configuration notes, and integration readiness. Public APIs and webhooks should be documented only when implemented.

15 pages15 sections

Section 01

Core concepts

Projects, packets, prechecks, issues, reviewer notes.

Core conceptsAvailable

PermitOS concepts

Glossary of the entities PermitOS works with: projects, packets, documents, prechecks, issues, scores, corrections, zoning checks, and activity.

Section 02

Data model

Tables that back PermitOS workflows.

Data modelAvailable

Data model

The Supabase tables that back PermitOS and how they relate.

Section 03

Authentication & orgs

Sign-in, organizations, roles, RLS.

Authentication & orgsAvailable

Organization and permissions

How sign-in, organizations, roles, and Row-Level Security combine to keep workspaces isolated.

Section 04

Permit projects

How a project ties packets, docs, and reports together.

Permit projectsAvailable

Projects and permit packets

Project setup fields and how a project ties documents, reports, issues, corrections, zoning checks, and activity together.

Section 05

Document intake

Upload, categorize, store. Extraction state.

Document intakeAvailable

Document intake

How files reach PermitOS, what metadata is stored, and what happens when document extraction is not configured.

Section 06

Rules-only precheck

Deterministic readiness check without AI.

Rules-only precheckAvailable

Rules-only Permit Precheck

Deterministic readiness check that runs against project fields and uploaded document categories. No AI required.

Section 07

Readiness reports

Score bands, confidence, analysis_mode.

Readiness reportsAvailable

Readiness Score

How the 0–100 readiness score is banded and how confidence is reported.

Section 08

Issues & reviewer review

Confirm, dismiss, request more info.

Issues & reviewer reviewAvailable

Reviewer confirmation

How reviewers confirm, dismiss, or request more information on flagged issues — and what reviewer confirmation does not mean.

Section 09

Correction tasks

Turn comments into tracked fixes.

Correction tasksAvailable

Correction tasks

Convert correction comments into trackable task records linked back to projects and issues.

Section 10

Zoning checks

Decision-support records, not determinations.

Zoning checksAvailable

Zoning checks

Record zoning questions, parcel context, and source notes. Decision-support only.

Section 11

Activity logs

Audit trail of workspace actions.

Activity logsAvailable

Activity logs

Audit trail of who did what across the workspace.

Section 12

Email & consent

Transactional vs marketing, suppression, unsubscribe.

Email & consentAvailable

Email preferences and consent

Transactional vs marketing email, unsubscribe, suppression list, and consent logging.

Section 13

Integrations

Planned categories. Configure before claiming live.

IntegrationsPlanned

Integrations

Categories of integrations PermitOS can support. Each requires explicit configuration before claiming it is live.

Section 14

API & webhooks (planned)

Public API and webhook surface are not implemented.

API & webhooks (planned)Planned

API and webhooks

Public API and webhook surface are planned, not implemented.

Section 15

Production readiness

What to verify before going live.

Production readinessAvailable

Production readiness

Checklist of legal, email, consent, and integration steps to verify before going live.

Notice

AI catches issues. Humans make decisions.

PermitOS does not file permits, issue determinations, or replace qualified professionals. Planned capabilities are clearly labeled as planned in the docs. See Production readiness