consentstring.schema.json

{
    "meta:license": [
        "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/context/consentstring",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Consent String",
    "type": "object",
    "meta:extensible": true,
    "description": "Consent String as presented by user along with standard information to help consent enforcer to parse the String.",
    "definitions": {
        "consentstring": {
            "properties": {
                "xdm:consentStandard": {
                    "title": "Standard for the consent",
                    "type": "string",
                    "description": "This helps determine the format of the consent string as set by consent management services."
                },
                "xdm:consentStandardVersion": {
                    "title": "Standards Version",
                    "type": "string",
                    "description": "Standards version to accurately define the format of the consent string as set by consent management services."
                },
                "xdm:consentStringValue": {
                    "title": "Consent String",
                    "type": "string",
                    "description": "Full consent string as provided by consent management services. Standard and Version help define how to parse this string."
                },
                "xdm:gdprApplies": {
                    "title": "GDPR Applies",
                    "type": "boolean",
                    "default": false,
                    "description": "If this is true, it means this consent string needs to be processed for consent enforcement."
                },
                "xdm:containsPersonalData": {
                    "title": "Contains personal data",
                    "type": "boolean",
                    "description": "If this is true, it means consent is coming with personal data."
                }
            },
            "required": [
                "xdm:gdprApplies"
            ]
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/consentstring"
        }
    ],
    "meta:status": "stable",
    "examples": [
        {
            "xdm:consentStandard": "IAB TCF",
            "xdm:consentStandardVersion": "2.0",
            "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA",
            "xdm:gdprApplies": true,
            "xdm:containsPersonalData": false
        }
    ]
}