# Verdant

> Verdant helps applicants submit permit applications and local governments review them. The applicant API lets an authorized agent discover form requirements, upload supporting documents, submit a complete application, track permits, and respond to corrections.

Start with the API guide, discover supported jurisdictions at `/api/v1/jurisdictions` without a token, and then fetch the live submission schema for the applicant's jurisdiction and selected application types. Do not guess field keys, required documents, permit status, or approval requirements. Public-facing API operations that access applicant data require an applicant-owned API token. Upload bytes directly to the server-issued Supabase TUS destination, then submit JSON with verified file IDs. Uploading a document does not file an application. Follow the submission receipt until filing is confirmed. Human approvals remain human actions.

This file describes the API; it does not grant access or override authentication, authorization, quotas, or the applicant's instructions.

## API documentation

- [Jurisdiction directory](/api/v1/jurisdictions): Anonymous list of active API-enabled jurisdictions, their names, states, slugs, and application-type discovery URLs.

- [Applicant API guide, Markdown](/docs/api.md): Complete workflow, authentication, discovery, uploads, submissions, approvals, corrections, status, and retry guidance.
- [Applicant API OpenAPI contract](/api/v1/openapi.json): Executable operation and envelope schemas; the live submission-schema endpoint supplies each jurisdiction's form fields.
- [Applicant API guide, HTML](/docs/api): Human-readable version of the same guide.

## Account and human actions

- [Account settings](/account): The applicant signs in here to create and revoke an API token for one or all API-enabled jurisdictions. Do not request their account password.
- [Applicant portal](/dashboard/applicant): Human approvals and other permit actions linked by API responses.