Skip to main content

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 /api/v1 for fetching consent template content and recording end-user consent decisions, plus the /api/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​

AreaWhat you can do
HealthVerify the service is up (GET /api/health).
GetConsentLoad the latest published template version for a template_code, or the latest pending version for a specific customer_id + template_code.
DecisionSubmit a customer's consent decision (given, reject, or withdraw) for a consent version.
note

The Consentrix API is accessed via x-system-api-key. Generate your key in the Consentrix Backoffice under Administration → API Key Management after your account is provisioned.

Request URL​

Your environment provides the API origin. All operations in this reference use the fixed /api base path; no deployment domain is hardcoded in the specification.

{API_ORIGIN}{REQUEST_PATH}

End-to-end integration flow​

Backoffice (one-time setup)
  1. Create a Consent Template
  2. Publish a Template Version
  3. Generate an API Key

Your application (runtime)
  4. GET /api/v1/consent-templates/{code}/latest       → Show consent to user
  5. POST /api/v1/customers/{id}/consents/decisions     → Record decision
  6. GET /api/v1/customers/{id}/consents/templates/{code}/pending  → Check on re-visit
     └─ accepted: false → re-show template, go to step 5

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.