Skip to main content

API Overview

The ConsentForge API is a REST API with JSON request and response bodies.

Base URL​

https://api.consentforge.com/api/v1/

Versioning​

The API is versioned via URL path. The current version is v1. Breaking changes will be released under a new version with advance notice.

Format​

  • All requests and responses use JSON (Content-Type: application/json)
  • All strings are UTF-8
  • Timestamps are ISO 8601 in UTC (e.g. 2026-03-09T12:00:00Z)
  • IDs are UUIDs

Authentication​

Two token types:

  • API Token — for management operations (your backend only, never expose in browsers)
  • Embed Token — for runtime operations (safe to use publicly in <script> tags)

See Authentication for details.