Getting Started

Version: 1.0

Last Updated: July 14, 2026

Overview

The TrustArc Cookie Consent Manager (CCM) External API provides programmatic access to core CCM capabilities including website management and cookie scan initiation. This RESTful API enables third-party systems to integrate CCM workflows directly into their own pipelines, portals, and automation tooling.

Use cases include:

•  Programmatically adding or removing domains managed under a CCM account
•  Triggering automated cookie scans for compliance auditing
•  Integrating CCM operations into CI/CD pipelines or DevOps workflows
•  Building multi-tenant management dashboards for agencies managing multiple clients
Prerequisites

Before making your first API call, ensure you have the following:

A valid TrustArc CCM account with API access enabled
A user role of SUPER_ADMIN, ADMIN, or DESIGNER assigned to your account
An API key or valid session token issued by TrustArc support
HTTPS-capable HTTP client (curl, Postman, or any SDK)
Base URL

All API requests are made to:

https://<your-ccm-domain>/external/v1

Replace <your-ccm-domain> with the host provided in your onboarding welcome email.

Authentication

The CCM External API uses Bearer Token authentication. All requests must include a valid JWT in the Authorization header.

Bearer Token
Authorization: Bearer <your_access_token>
Content-Type: application/json
📋 NOTE
Tokens are short-lived. Refresh your token before it expires to avoid 401 Unauthorized errors. Contact TrustArc support to configure token expiry settings for your account.
Role Requirements

Every endpoint requires one of the following roles to be associated with the authenticated user:

Role Description
SUPER_ADMIN Full access to all API operations and account management.
ADMIN Access to website and scan management operations.
DESIGNER Access to website and scan management operations.
Quickstart: Your First API Call

The following steps walk you through adding your first website via the API.

1
Obtain your Bearer token from the TrustArc portal or your onboarding contact.
2
Confirm your account's Consent Manager UUID (cmUuid). This is visible in the CCM portal URL or provided during onboarding.
3
Make the following HTTP request:
POST /external/v1/websites HTTP/1.1
Host: <your-ccm-domain>
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...
Content-Type: application/json

{
  "cmUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "websites": [
    "https://example.com",
    "https://shop.example.com"
  ]
}
4
A 201 Created response confirms success. Review the response body for per-URL status details.
Response Format

All API responses return JSON. Timestamps are in ISO 8601 format. HTTP status codes follow standard semantics with CCM-specific multi-status behavior on partial failures.

⚠ IMPORTANT
Some endpoints return HTTP 207 Multi-Status when a batch request partially succeeds. Always inspect the status field of each item in the response array.
TrustArc  ·  CCM External API Guide  ·  https://trustarc.com/