welcome

Welcome to the Sourcepoint API Hub

Sourcepoint GDPR TCF API

GDPR TCF end-user consent status
GDPR TCF vendor list
IAB GDPR TCF API
Sourcepoint commands
- addEventListener

Sourcepoint GDPR Standard API

GDPR Standard end-user consent status
- Get end-user consent statusget
- Delete end-user consent statusdelete
GDPR Standard vendor list
- Map vendors and purposesget
- Vendor URL mappingpost
Sourcepoint commands

Sourcepoint GDPR Reporting API

Introduction
GDPR reporting API
- GDPR pageview datapost
- GDPR message datapost

Sourcepoint U.S. Multi-State Privacy API

U.S. Multi-State Privacy end-user consent status
- Get end-user consent historyget
- Delete end-user consent statusdelete
IAB GPP framework
Standard framework
- Sourcepoint commands

Sourcepoint Reporting U.S. Multi-State Privacy API

Introduction
U.S. Multi-State Privacy reporting API
- U.S. Multi-State Privacy pageview datapost
- U.S. Multi-State Privacy message datapost

Sourcepoint U.S. Privacy (Legacy) API

U.S. Privacy (Legacy) end-user consent status
IAB U.S. Privacy API

welcome

Welcome to the Sourcepoint API Hub

Sourcepoint GDPR TCF API

GDPR TCF end-user consent status
GDPR TCF vendor list
IAB GDPR TCF API
Sourcepoint commands
- addEventListener

Sourcepoint GDPR Standard API

GDPR Standard end-user consent status
- Get end-user consent statusget
- Delete end-user consent statusdelete
GDPR Standard vendor list
- Map vendors and purposesget
- Vendor URL mappingpost
Sourcepoint commands

Sourcepoint GDPR Reporting API

Introduction
GDPR reporting API
- GDPR pageview datapost
- GDPR message datapost

Sourcepoint U.S. Multi-State Privacy API

U.S. Multi-State Privacy end-user consent status
- Get end-user consent historyget
- Delete end-user consent statusdelete
IAB GPP framework
Standard framework
- Sourcepoint commands

Sourcepoint Reporting U.S. Multi-State Privacy API

Introduction
U.S. Multi-State Privacy reporting API
- U.S. Multi-State Privacy pageview datapost
- U.S. Multi-State Privacy message datapost

Sourcepoint U.S. Privacy (Legacy) API

U.S. Privacy (Legacy) end-user consent status
IAB U.S. Privacy API

Get end-user consent status

get https://cdn.privacy-mgmt.com/ccpa/ccpa/consent/{siteId}/consent-status

Returns end-user U.S. Privacy- CCPA consent status for a property. In addition to the siteId, you will also need to include either the end-user's ccpaUUID or authId.

URL Expired

The URL for this request expired after 30 days.

Path Params

siteId

integer

required

The property ID for the property in the Sourcepoint portal.

Query Params

ccpaUUID

string

Retrieved from the first-party cookie ccpaUUID

authId

string

Retrieved from the first-party cookie authId

Response

Response body

object

userConsent

object

ccpaUUID

string

User's unique id for which a consent profile is stored against

consentedAll

boolean

Is consent profile consented to all vendors and purposes on the vendor list?

rejectedAll

boolean

Is consent profile opted-out of all vendors and purposes on the vendor list?

rejectedVendors

array of strings

Specific vendors (by ID) to which an end-user has opted-out. Only returns a response when an end-user has partial consent (i.e. end-user has opted-out of some but not all vendors).

rejectedVendors

rejectedCategories

array of strings

Specific purposes (by ID) to which an end-user has opted-out. Only returns a response when an end-user has partial consent (i.e. end-user has opted-out of some but not all purposes).

rejectedCategories

status

string

Consent status for the end-user's consent profile.

dateCreated

string

The date the consent status was created/last updated.

newUser

boolean

Is the end-user a new user to the property?

ccpaApplies

boolean

Does CCPA apply in this situation?

signedLspa

boolean

Are any vendors a part of LSPA?

dnsDisplayed

boolean

Whether Do Not Sell has been displayed to user.

array

Cookies created/updated.

expirationDate

string

When the end-user's consent profile expires

actions

array of objects

Consent and/or reject actions configured for vendors and/or purposes that triggered

actions

object

string

type

string

url

string

tagManager

object

Updated 11 months ago

U.S. Multi-State Privacy message data

Get end-user consent history

Did this page help you?

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://cdn.privacy-mgmt.com/ccpa/ccpa/consent/siteId/consent-status \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 11 months ago

U.S. Multi-State Privacy message data

Get end-user consent history

Did this page help you?

welcome
Welcome to the Sourcepoint API Hub

Sourcepoint GDPR TCF API
GDPR TCF end-user consent status
Delete end-user consent statusdelete
Merge end-user consent status with identity providerpost
Get end-user consent statusget
GDPR TCF vendor list
Retrieve vendors on vendor listget
Vendor URL mappingpost
Map vendors and purposesget
IAB GDPR TCF API
euconsentWithDisclosedVendors
tcData object
postCustomConsent
postRejectAll
getVendorPurposeMapping
getCustomVendorConsents
removeEventListener
addEventListener
getTCData (Deprecated TCF 2.2)
ping
Sourcepoint commands
addEventListener

Sourcepoint GDPR Standard API
GDPR Standard end-user consent status
Delete end-user consent statusdelete
Get end-user consent statusget
GDPR Standard vendor list
Vendor URL mappingpost
Map vendors and purposesget
Sourcepoint commands
addEventListener
postCustomConsent
postRejectAll
getVendorPurposeMapping
getCustomVendorConsents

Sourcepoint GDPR Reporting API
Introduction
GDPR reporting API
GDPR message datapost
GDPR pageview datapost

Sourcepoint U.S. Multi-State Privacy API
U.S. Multi-State Privacy end-user consent status
Delete end-user consent statusdelete
Get end-user consent historyget
IAB GPP framework
U.S. State Sections
Virginia Privacy Section
Utah Privacy Section
Texas Privacy Section
Oregon Privacy Section
Montana Privacy Section
Florida Privacy Section
Connecticut Privacy Section
Colorado Privacy Section
California Privacy Section
U.S. National Section
U.S. National Privacy Section
Sourcepoint commands
postRejectAllUsnat
getUserConsentsUsnat
addEventListener
Reference: systemId for IAB privacy choices
postRejectAll
getUserConsents
IAB GPP API
getField
getSection
hasSection
removeEventListener
addEventListener
ping
Standard framework
Sourcepoint commands
Reference: systemId for Standard privacy choices
postRejectAll
getUserConsents

Sourcepoint Reporting U.S. Multi-State Privacy API
Introduction
U.S. Multi-State Privacy reporting API
U.S. Multi-State Privacy message datapost
U.S. Multi-State Privacy pageview datapost

Sourcepoint U.S. Privacy (Legacy) API
U.S. Privacy (Legacy) end-user consent status
Delete end-user consent statusdelete
Opt-out all purposes and vendorspost
Get end-user consent historyget
Get end-user consent statusget
IAB U.S. Privacy API
postRejectAll
getCustomVendorRejects
getUSPData

welcome
Welcome to the Sourcepoint API Hub

Sourcepoint GDPR TCF API
GDPR TCF end-user consent status
Delete end-user consent statusdelete
Merge end-user consent status with identity providerpost
Get end-user consent statusget
GDPR TCF vendor list
Retrieve vendors on vendor listget
Vendor URL mappingpost
Map vendors and purposesget
IAB GDPR TCF API
euconsentWithDisclosedVendors
tcData object
postCustomConsent
postRejectAll
getVendorPurposeMapping
getCustomVendorConsents
removeEventListener
addEventListener
getTCData (Deprecated TCF 2.2)
ping
Sourcepoint commands
addEventListener

Sourcepoint GDPR Standard API
GDPR Standard end-user consent status
Delete end-user consent statusdelete
Get end-user consent statusget
GDPR Standard vendor list
Vendor URL mappingpost
Map vendors and purposesget
Sourcepoint commands
addEventListener
postCustomConsent
postRejectAll
getVendorPurposeMapping
getCustomVendorConsents

Sourcepoint GDPR Reporting API
Introduction
GDPR reporting API
GDPR message datapost
GDPR pageview datapost

Sourcepoint U.S. Multi-State Privacy API
U.S. Multi-State Privacy end-user consent status
Delete end-user consent statusdelete
Get end-user consent historyget
IAB GPP framework
U.S. State Sections
Virginia Privacy Section
Utah Privacy Section
Texas Privacy Section
Oregon Privacy Section
Montana Privacy Section
Florida Privacy Section
Connecticut Privacy Section
Colorado Privacy Section
California Privacy Section
U.S. National Section
U.S. National Privacy Section
Sourcepoint commands
postRejectAllUsnat
getUserConsentsUsnat
addEventListener
Reference: systemId for IAB privacy choices
postRejectAll
getUserConsents
IAB GPP API
getField
getSection
hasSection
removeEventListener
addEventListener
ping
Standard framework
Sourcepoint commands
Reference: systemId for Standard privacy choices
postRejectAll
getUserConsents

Sourcepoint Reporting U.S. Multi-State Privacy API
Introduction
U.S. Multi-State Privacy reporting API
U.S. Multi-State Privacy message datapost
U.S. Multi-State Privacy pageview datapost

Sourcepoint U.S. Privacy (Legacy) API
U.S. Privacy (Legacy) end-user consent status
Delete end-user consent statusdelete
Opt-out all purposes and vendorspost
Get end-user consent historyget
Get end-user consent statusget
IAB U.S. Privacy API
postRejectAll
getCustomVendorRejects
getUSPData

200Success