ConsentGuard Documentation

Everything you need to integrate ConsentGuard's automated compliance monitoring into your workflow.

Quickstart

Welcome to the ConsentGuard API. Our RESTful API allows you to programmatically manage your monitored sites, trigger on-demand scans, and receive real-time alerts via webhooks.

curl -X GET https://api.consentguard.de/v1/ping \
-H "Authorization: Bearer YOUR_API_KEY"

Authentication

Authenticate your API requests by including your API key in the Authorization header. You can generate and manage your API keys in the Settings > Advanced section of your dashboard.

Security Notice: Keep your API keys secure. Do not expose them in client-side code (like frontend JavaScript).

Sites API

Manage the websites you want to monitor.

List all sites

GET /v1/sites

Returns a paginated list of all websites currently configured for monitoring under your account.

Add a new site

POST /v1/sites

Payload should include the url and optional tags for categorization.

Scans API

Trigger and retrieve results for automated compliance scans.

Trigger manual scan

POST /v1/sites/{site_id}/scans

Initiates an immediate scan of the specified site. Returns a scan_id that can be used to poll the status.

Webhooks

Configure webhooks to receive real-time HTTP POST payloads when specific events occur within ConsentGuard. Events include scan.completed, scan.failed, and compliance.violation_detected.

All webhook payloads are signed with a cryptographic signature in the X-ConsentGuard-Signature header. We strongly recommend verifying these signatures to ensure the requests originated from us.