Sign in

v1

latestOpenAPI 3.0.22026-07-146916.1 KB
GDPR TCF end-user consent status

Get end-user consent status

Returns end-user GDPR TCF consent status for a property. In addition to the siteId, you will also need to include <u>either</u> the end-user's consentUUID or authId.

get/consent/v3/history/{siteId}

Path parameters

siteIdinteger required

The property ID for the property in the Sourcepoint portal.

Query parameters

consentUUIDstring

Retrieved from the first-party cookie consentUUID

authIdstring

Retrieved from the first-party cookie authId

latestboolean

(Optional) Only return the latest consent record for the end-user.

Response

Success

_idstring

Unique identifier for the consent record

siteIdnumber

Sourcepoint ID for property.

dateCreatedstring

Date consent status was created

consentUUIDstring

Consent UUID for end-user

messageIdinteger

ID of the first layer message shown to end-user

vendorListIdstring

ID of the vendor list

Example response

[
  {
    "_id": "6842d825666f5a1254fd263f",
    "siteId": 39470,
    "dateCreated": "2023-05-08T15:37:18.365Z",
    "consentUUID": "1234f5a8-67c9-4a38-a7cd-6fe4f30a5678",
    "messageId": 123456,
    "vendorListId": "9876a560b8e05c06542b2a31",
    "vendors": [
      {
        "id": "5f23e826b8e05c0c0abcdef",
        "name": "IAB vendor example",
        "vendorType": "IAB"
      }
    ],
    "legIntVendors": [
      {
        "id": "5f23e826b8e05c0c0abcdef",
        "name": "IAB vendor example",
        "vendorType": "IAB"
      }
    ],
    "categories": [
      {
        "id": "5fd7e01e32bd4d27654ba1d5",
        "name": "Store and/or access information on a device",
        "iabPurposeRef": {
          "name": "Store and/or access information on a device",
          "iabId": 1
        }
      }
    ],
    "legIntCategories": [
      {
        "id": "5fd7e01e32bd4d27654ba1d5",
        "name": "Store and/or access information on a device",
        "iabPurposeRef": {
          "name": "Store and/or access information on a device",
          "iabId": 1
        }
      }
    ]
  }
]
All 6 operations