Get collection point ID

GET /api/v1/external/public/collection-points

A collection point is a named location where consent is requested (e.g. “Signup Form” or “In-App Purchase Flow”). Its display_id is the bannerId you pass to the SDK.

Use the assetId you discovered in the previous step.

---

Fetch collection points for an asset

cURL

curl -X GET "https://truapi-dev.truconsent.io/api/v1/external/public/collection-points?asset_id=$ASSET_ID" \
     -H "X-API-Key: $ADMIN_API_KEY" \
     -H "X-Org-Id: $ORGANIZATION_ID"

JavaScript

const response = await fetch(
  "https://truapi-dev.truconsent.io/api/v1/external/public/collection-points?asset_id=" + ASSET_ID,
  {
    headers: {
      "X-API-Key": ADMIN_API_KEY,
      "X-Org-Id": ORGANIZATION_ID,
    },
  }
);
const { data } = await response.json();

TypeScript

interface CollectionPoint {
  id: string;
  display_id: string;
  name: string;
  status: "active" | "draft" | "archived";
  asset_id: string;
  version: string;
  purposes: string[];
}

const response = await fetch(
  "https://truapi-dev.truconsent.io/api/v1/external/public/collection-points?asset_id=" + ASSET_ID,
  {
    headers: {
      "X-API-Key": ADMIN_API_KEY,
      "X-Org-Id": ORGANIZATION_ID,
    },
  }
);
const { data }: { data: CollectionPoint[] } = await response.json();

Python

import os
import requests

asset_id = os.environ["ASSET_ID"]
url = "https://truapi-dev.truconsent.io/api/v1/external/public/collection-points"
params = {"asset_id": asset_id}
headers = {
    "X-API-Key": os.environ["ADMIN_API_KEY"],
    "X-Org-Id": os.environ["ORGANIZATION_ID"],
}
response = requests.get(url, params=params, headers=headers)
data = response.json()["data"]

PowerShell

Invoke-RestMethod -Method Get `
  -Uri "https://truapi-dev.truconsent.io/api/v1/external/public/collection-points?asset_id=$env:ASSET_ID" `
  -Headers @{
    "X-API-Key" = $env:ADMIN_API_KEY
    "X-Org-Id"  = $env:ORGANIZATION_ID
  }

---

Sample response

{
  "data": [
    {
      "asset_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "name": "Signup Form Banner",
      "display_id": "CP010",
      "description": "Consent banner shown at user signup",
      "status": "active",
      "version": "v1.0.0",
      "purposes": [
        "pppppppp-pppp-pppp-pppp-pppppppppppp",
        "qqqqqqqq-qqqq-qqqq-qqqq-qqqqqqqqqqqq"
      ]
    },
    {
      "asset_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "name": "In-App Purchase Flow",
      "display_id": "CP011",
      "description": "Consent for purchase-related data collection",
      "status": "draft",
      "version": "v1.0.1",
      "purposes": [
        "rrrrrrrr-rrrr-rrrr-rrrr-rrrrrrrrrrrr"
      ]
    }
  ],
  "count": 2
}

The display_id (e.g. CP010) is your bannerId. Use the collection point whose status is active and whose name matches the consent flow you are integrating.

---

Responses

200 OK

Returns all collection points for the specified asset.

{
  "data": [
    {
      "asset_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "name": "Signup Form Banner",
      "display_id": "CP010",
      "description": "Consent banner shown at user signup",
      "status": "active",
      "version": "v1.0.0",
      "purposes": [
        "pppppppp-pppp-pppp-pppp-pppppppppppp",
        "qqqqqqqq-qqqq-qqqq-qqqq-qqqqqqqqqqqq"
      ]
    },
    {
      "asset_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "name": "In-App Purchase Flow",
      "display_id": "CP011",
      "description": "Consent for purchase-related data collection",
      "status": "draft",
      "version": "v1.0.1",
      "purposes": [
        "rrrrrrrr-rrrr-rrrr-rrrr-rrrrrrrrrrrr"
      ]
    }
  ],
  "count": 2
}

Field	Description
id	Collection point UUID.
display_id	Short identifier used as bannerId in the SDK (e.g. CP010).
name	Human-readable name set in the dashboard.
status	active, draft, or archived. Only active collection points accept consent submissions.
version	Version string of the collection point configuration.
purposes	Array of purpose UUIDs associated with this collection point.
asset_id	UUID of the parent asset.

400 Bad Request

Missing asset_id query parameter:

{ "detail": "asset_id query parameter is required" }

401 Unauthorized

Missing or invalid X-API-Key:

{ "detail": "Invalid or inactive API key" }

403 Forbidden

API key does not have the admin scope:

{ "detail": "API key does not have the required scope" }

Only use active collection points

A collection point with status: "draft" is not yet published and will reject consent submissions at runtime. Always verify status is active before embedding a bannerId in your app.

---

Result

BANNER_ID=CP010

You now have everything required to mount the consent banner. Choose your platform:

• npm Package
• Flutter SDK
• React Native SDK
• iOS SDK
• Android SDK

---

← Get asset IDNext: npm Package →