navigator.consent

JSON Schema

InterfaceRegistration

Declaration payload submitted via navigator.consent.registerInterface().

Properties

vendorstringrequired
minLength: 1
promptstring
regulationstring
jurisdictionstring
cmpobjectrequired
cmp.idstring
minLength: 1
cmp.versionstring
minLength: 1
cmp.sdkVersionstring
minLength: 1
cmp.configVersionstring
minLength: 1
cmp.languagestring
minLength: 1
cmp.displayNamestring
minLength: 1
cmp.frameworksstring[]
item minLength: 1
catalogChecksumstring
minLength: 1

Raw Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://navigator-consent.spec/schemas/cmp.schema.json",
  "title": "InterfaceRegistration",
  "description": "Declaration payload submitted via navigator.consent.registerInterface().",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "vendor",
    "cmp"
  ],
  "properties": {
    "vendor": {
      "type": "string",
      "minLength": 1
    },
    "prompt": {
      "type": "string"
    },
    "regulation": {
      "type": "string"
    },
    "jurisdiction": {
      "type": "string"
    },
    "cmp": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "version"
      ],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "version": {
          "type": "string",
          "minLength": 1
        },
        "sdkVersion": {
          "type": "string",
          "minLength": 1
        },
        "configVersion": {
          "type": "string",
          "minLength": 1
        },
        "language": {
          "type": "string",
          "minLength": 1
        },
        "displayName": {
          "type": "string",
          "minLength": 1
        },
        "frameworks": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        }
      }
    },
    "catalogChecksum": {
      "type": "string",
      "minLength": 1
    }
  }
}