Collection points

A collection point is a named location in your application where you present a consent prompt to a user. It might be a sign-up form, a checkout page, a cookie banner, or any other screen where you need to capture a user’s consent decision. Each collection point groups together the specific purposes for which you are requesting consent, so users can make informed, granular decisions.

You create and manage collection points in the truConsent dashboard. In your API calls, you reference them by their UUID or human-readable display_id.

Note

Collection points are created and managed in the truConsent dashboard — you cannot create or update them through the API.

Collection point fields

Field	Type	Description
id	string (UUID)	Unique identifier for the collection point
display_id	string	Human-readable slug you can use in API calls instead of the UUID (for example, checkout-form)
name	string	Display name shown in the dashboard
description	string	Optional description of where or how consent is collected
consent_type	string	The type of consent interaction for this collection point
asset_id	string (UUID)	Optional reference to the asset (web page, app screen) this collection point belongs to
status	string	Whether the collection point is active or inactive

Consent types

The consent_type field indicates what kind of consent interaction the collection point represents. You can retrieve the consent_type from the GET /banners/{banner_id} endpoint response.

Referencing a collection point in API calls

Most API endpoints that record or retrieve consent use the collection point as a path parameter. You can pass either the UUID or the display_id — the API resolves both:

GET  /consent/{collection_point_id}/consents?userId=user_123
POST /consent/{collection_point_id}/consent
GET  /consent/{collection_point_id}/previous-consent?userId=user_123

For example, if your collection point has display_id: "checkout-form", both of these are equivalent:

POST /consent/checkout-form/consent
POST /consent/3fa85f64-5717-4562-b3fc-2c963f66afa6/consent

Tip

Use display_id values in your integration code rather than UUIDs. They are stable, readable, and make your API calls easier to understand at a glance.

Purposes attached to a collection point

Each collection point has a list of purpose IDs. When you fetch a banner for a collection point, the API returns the full details of each attached purpose so you can render the appropriate consent choices to the user.

A user’s consent decision at a collection point is recorded against all of its attached purposes, with per-purpose outcomes stored in the purpose_consents field of the consent log.

Assets

A collection point can be associated with an asset — a web page, mobile screen, or other resource where the consent prompt appears. When an asset is linked, it is returned alongside the collection point in banner API responses, giving you additional context about where consent was collected.

Example: a collection point object

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "display_id": "checkout-form",
  "name": "Checkout Form",
  "description": "Consent prompt shown at the final step of the checkout flow",
  "consent_type": "explicit",
  "status": "active",
  "asset": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "name": "Checkout Page",
    "description": "The final checkout page at /checkout",
    "asset_type": "web_page"
  },
  "purposes": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "c3d4e5f6-a7b8-9012-cdef-123456789012"
  ]
}

In this example, checkout-form has three purposes attached — perhaps “Order Fulfillment”, “Analytics”, and “Marketing Emails”. When a user submits consent at this collection point, truConsent records an individual decision for each of those three purposes.