Skip to main content

Quick Start

1. Register for Access​

To start using the Consent Management API, you must first register for access:

  1. Fill out the registration form: https://forms.office.com/r/0nFLVmS5U4
  2. Wait for credentials: Our team will generate and provide you with:
    • Alias
    • Email
    • Password for login

2. Obtain API Key​

After registration, you can generate your x-api-key yourself via the Consentrix Backoffice.

3. Verify connectivity​

curl -sS "https://consent-service-uat.odd.works/api/v1/health"

A successful response is a JSON object with status and success fields.

Try Health check API ↩

4. Fetch a published template version​

Replace YOUR_KEY with your actual API key:

curl -sS \
  -H "x-system-api-key: YOUR_KEY" \
  "https://consent-service-uat.odd.works/api/v1/consent-templates/YOUR_TEMPLATE_CODE/latest"

Expected success response:

{
  "data": {
    "consent_version_id": "123e4567-e89b-12d3-a456-426614174010",
    "version": 1,
    "tag": "1.0.0",
    "content_html": "<html>...</html>",
    "file_url": "https://example.com/content.html",
    "allow_reconsent": true
  }
}

Try Get latest consent template version API ↩

curl -sS -X POST \
  -H "Content-Type: application/json" \
  -H "x-system-api-key: YOUR_KEY" \
  "https://consent-service-uat.odd.works/api/v1/customers/CUSTOMER_ID/consents/decisions" \
  -d '{
    "consent_version_id": "123e4567-e89b-12d3-a456-426614174010",
    "decision": "given"
  }'

View Decision Values.

Try Submit consent decision API ↩

6. Errors​

Error response format:

{
  "code": "1002",
  "message": "Unauthorized."
}

See API conventions for full error codes.

Base URL​

UAT: https://consent-service-uat.odd.works/

API Endpoints​

MethodPathPurpose
GET/healthHealth check
GET/v1/consent-templates/{template_code}/latestLatest published template
POST/v1/customers/{customer_id}/consents/decisionsSubmit decision

Next​