Developers

API reference

Authenticate, trigger scans and read reports from the public REST API.

The API is REST over HTTPS with JSON payloads. Create a workspace API key in the application under Settings, then send it as a bearer token.

Authentication

bash

curl https://api.checklegal.ai/v1/sites \
  -H "Authorization: Bearer $CHECKLEGAL_API_KEY"

Start a scan

bash

curl -X POST https://api.checklegal.ai/v1/scans \
  -H "Authorization: Bearer $CHECKLEGAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "site_id": "site_123", "depth": 3, "jurisdictions": ["gdpr", "ccpa"] }'

Endpoints

Method	Path	Purpose
GET	/v1/sites	List verified sites
POST	/v1/sites	Register a new site
POST	/v1/scans	Start a scan
GET	/v1/scans/:id	Scan status and progress
GET	/v1/reports/:id	Full report with findings
GET	/v1/documents	List generated documents

Keep keys server-side

API keys carry workspace-wide access. Never ship one in a browser bundle or commit it to a repository.

Was this page helpful?