Skip to content

Authentication

truConsent uses two authentication methods depending on the type of endpoint you are calling. Most endpoints use an API key passed in a request header. Endpoints that manage consent links on behalf of a logged-in user require a Bearer token instead.

API key authentication

An API key identifies your organization and authorizes server-to-server requests. Include it in the X-API-Key header on every request to protected endpoints.

Where to get your API key: Log in to your truConsent dashboard and go to Settings → API Keys. Generate a new key and copy it immediately — the dashboard will not show the plaintext value again.

Which endpoints require it: All consent, banner, and user rights endpoints use API key authentication.

Terminal window
curl -X POST https://api.truConsent.io/consent/your-collection-point-id/consent \
-H "X-API-Key: your-api-key" \
-H "Content-Type: application/json" \
-d '{ ... }'

Bearer token authentication

Consent link management endpoints require a Bearer token tied to an authenticated user in your organization. Pass the token in the Authorization header.

Affected endpoints:

  • POST /api/outside-app/consent-link/create
  • POST /api/outside-app/consent-link/regenerate/{request_id}
  • GET /api/outside-app/consent-link/history
Terminal window
curl -X POST https://api.truConsent.io/api/outside-app/consent-link/create \
-H "Authorization: Bearer your-bearer-token" \
-H "Content-Type: application/json" \
-d '{ ... }'

Tenant routing

Every truConsent organization has its own subdomain (for example, acme.api.truConsent.io). All requests must be sent to your organization’s subdomain so the API can route them to the correct data store. Sending a valid API key to the wrong subdomain will result in an authentication error.

Error responses

HTTP statusResponse bodyCause
401{"error": "API key required (X-API-Key header)"}The X-API-Key header is missing
401{"error": "Invalid API key"}The key was provided but does not match any active key for your tenant
403{"error": "User not a member of this tenant"}The Bearer token is valid but the user does not belong to the target organization

Quick reference

HeaderValueUsed for
X-API-KeyYour API key from the dashboardConsent, banners, user rights endpoints
AuthorizationBearer <token>Consent link management endpoints