Overview
Consentrix is a consent management platform. This documentation site describes the Consent Management Service integration API as published in the bundled OpenAPI specification: routes under /v1 for fetching consent template content and recording end-user consent decisions, plus a health check.
Who should use this API
- System integrators embedding consent capture in apps or services (mobile, web, backend-for-frontend).
- Partners connecting their systems to Consentrix using server-to-server calls.
- Internal teams building or operating integrations against a shared consent service.
Capabilities in this reference
| Area | What you can do |
|---|---|
| Health | Verify the service is up (GET /health). |
| GetConsent | Load the latest published template version for a template_code, or the latest pending version for a specific customer_id + template_code. |
| Decision | Submit a customer's consent decision (given, reject, or withdraw) for a consent version. |
Scope of this documentation
Everything on this site describes the Consent Management Service API published in swagger/openapi.yaml—the operations listed in the sidebar under Health, GetConsent, and Decision.
How to read this site
Use the sidebar API Reference groups (Health, GetConsent, Decision) for interactive operation details. Complete the Get Started topics first if you need base URLs, authentication, response shapes, and domain terminology.