netID API

The European netID Foundation established by Mediengruppe RTL Deutschland, ProSiebenSat.1 and United Internet AG pursues the goal of establishing netID as a European alternative to US single sign-on providers. With netID, users can organize their consents for internet services transparently and in compliance with data protection regulations.

Sourcepoint offers API access that allows an end-user's netID consent data to be retrieved.

netID API endpoint

The API endpoint to retrieve an end-user's consent information requires the siteID and consentUUID values.

The API endpoint is the following:

https://preprod-cdn.privacy-mgmt.com/consent/tcfv2/consent/v3/{__SITE_ID__}?consentUUID={__CONSENT_UUID__}

This API endpoint has two placeholders that need to be replaced with the correct values:

  • A property's site id {__SITE_ID__}

  • The cookie consent UUID {__CONSENT_UUID__}

The site id value can be found by selecting a property from the Dialogue dashboard and navigating to the browser address bar. The site id value will be shown in the browser address bar.

The consentUUID value can be retrieved from the first-party cookie consentUUID.

Retrieve consent status

Your organization can call the API endpoint using a server-side script or a third-party service like Postman.

Server-side script (PHP example
Using Postman
Server-side script (PHP example

Your organization could use a server side script using code similar to the following PHP example to retrieve an end-user's consent status. You will need to provide the correct values for site id and consentUUID in the script.

$site_id = YYYY;
$consent_uuid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX";
$api_endpoint = "https://preprod-cdn.privacy-mgmt.com/consent/tcfv2/consent/v3/".$site_id."/tcstring?consentUUID=".$consent_uuid;
$handle = curl_init($api_endpoint);
$fileHandle = fopen("netID_consent.json", "w");
/* If you encounter an 'SSL certificate problem: unable to get local issuer certificate' then enable the following two lines */
/* This is NOT recommended as a solution and should only be used as a quick and temporary fix */
//curl_setopt($handle, CURLOPT_SSL_VERIFYHOST, 0);
//curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($handle, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
curl_setopt($handle, CURLOPT_FILE, $fileHandle);
curl_exec($handle);
curl_close($handle);
fclose($fileHandle);
Using Postman

Your organization can use a third party service like Postman to retrieve an end-user's consent status.

Use the POST method and provide the correct API endpoint url and values for site id and consentUUID to retrieve an end-user's consent status.

API JSON response

The API will return the following response if the request to retrieve an end-user's consent status history has been successful.

//Example JSON response
{
"categories": [
"5e8b11c3ebdb0627ecca27ab",
"5e8b11c3ebdb0627ecca279c",
"5e8b11c3ebdb0627ecca279f",
"5e8b11c3ebdb0627ecca27a0",
"5e8b11c3ebdb0627ecca279d",
"5e8b11c3ebdb0627ecca279b",
"5e8b11c3ebdb0627ecca279e",
"5e8b11c3ebdb0627ecca27a1",
"5e8b11c3ebdb0627ecca27a2",
"5e8b11c3ebdb0627ecca27a3"
],
"legIntCategories": [
"5e8b11c3ebdb0627ecca279e"
],
"vendors": [],
"legIntVendors": [
"5e7792c8d8d48d7950873ff3",
"5e7f6927b8e05c48537f6074",
"5e7786abf443bb795772efee",
"5e77890cd8d48d7950873ef7",
"5e7793636fbbc471e4b62573",
"5f21834b4e23d23c6c4ce0f3",
"5f2a2b392b87b72624a333f2",
"5f1b2fbeb8e05c306f2a1ed5"
],
"_id": "61263285702648036d7d2d8c",
"consentUUID": "d0640748-7cae-4d3e-8f72-494a15815923",
"siteId": 6804,
"vendorListId": "5e7790deb8e05c48537f6052",
"rejectedAny": true,
"fromNetId": true,
"dateCreated": "2021-08-25T12:07:33.691Z",
"__v": 0
}

Parameter

Description

categories, legIntCategories

Purpose ids granted consent by the end-user or which are legitimate interest

vendors, legIntVendors

Vendor ids granted consent by the end-user or which are legitimate interest

_id

The netID request id

consentUUID

The consentUUID value

siteId

The site id value

vendorListId

The active Sourcepoint vendor list id

rejectedAny

Set to true if user has rejected any purpose

dateCreated

The timestamp for the netID request