Consent Artifact v1

This page details about Consent Artifact, a structured record of user consent for data processing, with examples in XML , JSON, YAML, and TOML formats.

A Consent Artifact is a structured data object that encapsulates the detailed information about user consent for data processing activities. It is designed to provide a comprehensive and verifiable record of consent agreements, ensuring transparency, compliance, and accountability. You can find data fields definitions at Artifact Glossary Below is an example of a Consent Artifact in JSON format:

XML Data Format

<artifact>
    <context>https://consent.foundation/artifact/v1</context>
    <cp_name>Customer Onboarding Form</cp_name>
    <agreement_hash_id>1ca35897540ec7ae7294a8cacd11caf2c09f95f026c925c6ce4e4c29b20e3c41</agreement_hash_id>
    <agreement_version>1.0</agreement_version>
    <linked_agreement_hash>d4828c7252da8b626a40ffdbbec74c36b74d8f80c78df86e43d53fb5f3f366f4</linked_agreement_hash>
    <data_principal>
        <dp_df_id>d74bed43-6ee3-4cdc-a5cb-2b6b8f1732c4</dp_df_id>
        <dp_public_key></dp_public_key>
        <dp_residency>india</dp_residency>
        <dp_e>30ac654fe2a70f1a7a1b1b5b92b0238c2b2366ffab8bdde09de8030705b76b67</dp_e>
        <dp_verification>false</dp_verification>
        <dp_child>false</dp_child>
        <dp_attorney>
            <dp_df_id></dp_df_id>
            <dp_public_key></dp_public_key>
            <dp_e></dp_e>
        </dp_attorney>
    </data_principal>
    <data_fiduciary>
        <df_id>flipbasket</df_id>
        <agreement_date></agreement_date>
        <date_of_consent>2024-02-23T00:00:00Z</date_of_consent>
        <consent_status>active</consent_status>
        <revocation_date>2024-05-23</revocation_date>
    </data_fiduciary>
    <data_principal_rights>
        <right_to_access>true</right_to_access>
        <right_to_rectify>true</right_to_rectify>
        <right_to_erase>true</right_to_erase>
        <right_to_restrict_processing>true</right_to_restrict_processing>
        <right_to_data_portability>true</right_to_data_portability>
    </data_principal_rights>
    <consent_scope>
        <data_element>
            <data_element>home_address</data_element>
            <consents>
                <consent>
                    <purpose_id>bb4f25e5fd9b5b2b</purpose_id>
                    <consent_status>approved</consent_status>
                    <shared>false</shared>
                    <data_processors>
                        <data_processor_id>123abc</data_processor_id>
                        <data_processor_id>234ghi</data_processor_id>
                        <data_processor_id>345jik</data_processor_id>
                    </data_processors>
                    <cross_border>true</cross_border>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
                <consent>
                    <purpose_id>kl4f25e5fd875b2b</purpose_id>
                    <consent_status>approved</consent_status>
                    <shared>false</shared>
                    <data_processors></data_processors>
                    <cross_border>false</cross_border>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
            </consents>
        </data_element>
        <data_element>
            <data_element>mobile_number</data_element>
            <consents>
                <consent>
                    <purpose_id>hj1f25e5fd9b5b2b</purpose_id>
                    <consent_status>approved</consent_status>
                    <shared>true</shared>
                    <data_processors>
                        <data_processor_id>123abc</data_processor_id>
                        <data_processor_id>234ghi</data_processor_id>
                        <data_processor_id>345jik</data_processor_id>
                    </data_processors>
                    <cross_border>true</cross_border>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
                <consent>
                    <purpose_id>rgyu625e5fd9b5b2b</purpose_id>
                    <consent_status>rejected</consent_status>
                    <shared>false</shared>
                    <data_processors></data_processors>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
            </consents>
        </data_element>
    </consent_scope>
</artifact>

Other Data Formats

Below are the examples of Consent Artifact with other data formats:

XML

<artifact>
    <context>https://consent.foundation/artifact/v1</context>
    <cp_name>Customer Onboarding Form</cp_name>
    <agreement_hash_id>1ca35897540ec7ae7294a8cacd11caf2c09f95f026c925c6ce4e4c29b20e3c41</agreement_hash_id>
    <agreement_version>1.0</agreement_version>
    <linked_agreement_hash>d4828c7252da8b626a40ffdbbec74c36b74d8f80c78df86e43d53fb5f3f366f4</linked_agreement_hash>
    <data_principal>
        <dp_df_id>d74bed43-6ee3-4cdc-a5cb-2b6b8f1732c4</dp_df_id>
        <dp_public_key></dp_public_key>
        <dp_residency>india</dp_residency>
        <dp_e>30ac654fe2a70f1a7a1b1b5b92b0238c2b2366ffab8bdde09de8030705b76b67</dp_e>
        <dp_verification>false</dp_verification>
        <dp_child>false</dp_child>
        <dp_attorney>
            <dp_df_id></dp_df_id>
            <dp_public_key></dp_public_key>
            <dp_e></dp_e>
        </dp_attorney>
    </data_principal>
    <data_fiduciary>
        <df_id>flipbasket</df_id>
        <agreement_date></agreement_date>
        <date_of_consent>2024-02-23T00:00:00Z</date_of_consent>
        <consent_status>active</consent_status>
        <revocation_date>2024-05-23</revocation_date>
    </data_fiduciary>
    <data_principal_rights>
        <right_to_access>true</right_to_access>
        <right_to_rectify>true</right_to_rectify>
        <right_to_erase>true</right_to_erase>
        <right_to_restrict_processing>true</right_to_restrict_processing>
        <right_to_data_portability>true</right_to_data_portability>
    </data_principal_rights>
    <consent_scope>
        <data_element>
            <data_element>home_address</data_element>
            <consents>
                <consent>
                    <purpose_id>bb4f25e5fd9b5b2b</purpose_id>
                    <consent_status>approved</consent_status>
                    <shared>false</shared>
                    <data_processors>
                        <data_processor_id>123abc</data_processor_id>
                        <data_processor_id>234ghi</data_processor_id>
                        <data_processor_id>345jik</data_processor_id>
                    </data_processors>
                    <cross_border>true</cross_border>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
                <consent>
                    <purpose_id>kl4f25e5fd875b2b</purpose_id>
                    <consent_status>approved</consent_status>
                    <shared>false</shared>
                    <data_processors></data_processors>
                    <cross_border>false</cross_border>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
            </consents>
        </data_element>
        <data_element>
            <data_element>mobile_number</data_element>
            <consents>
                <consent>
                    <purpose_id>hj1f25e5fd9b5b2b</purpose_id>
                    <consent_status>approved</consent_status>
                    <shared>true</shared>
                    <data_processors>
                        <data_processor_id>123abc</data_processor_id>
                        <data_processor_id>234ghi</data_processor_id>
                        <data_processor_id>345jik</data_processor_id>
                    </data_processors>
                    <cross_border>true</cross_border>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
                <consent>
                    <purpose_id>rgyu625e5fd9b5b2b</purpose_id>
                    <consent_status>rejected</consent_status>
                    <shared>false</shared>
                    <data_processors></data_processors>
                    <consent_timestamp>2024-02-23T00:00:00Z</consent_timestamp>
                    <expiry_date>2024-05-23T00:00:00Z</expiry_date>
                    <retention_date>2024-08-23T00:00:00Z</retention_date>
                </consent>
            </consents>
        </data_element>
    </consent_scope>
</artifact>

JSON

{
    "artifact": {
      "context": "https://consent.foundation/artifact/v1",
      "cp_name": "Customer Onboarding Form",
      "agreement_hash_id": "1ca35897540ec7ae7294a8cacd11caf2c09f95f026c925c6ce4e4c29b20e3c41",
      "agreement_version": "1.0",
      "linked_agreement_hash": "d4828c7252da8b626a40ffdbbec74c36b74d8f80c78df86e43d53fb5f3f366f4",
      "data_principal": {
        "dp_df_id": "d74bed43-6ee3-4cdc-a5cb-2b6b8f1732c4",
        "dp_public_key": "",
        "dp_residency": "india",
        "dp_e": "30ac654fe2a70f1a7a1b1b5b92b0238c2b2366ffab8bdde09de8030705b76b67",
        "dp_verification": false,
        "dp_child": false,
        "dp_attorney": {
          "dp_df_id": "",
          "dp_public_key": "",
          "dp_e": ""
        }
      },
      "data_fiduciary": {
        "df_id": "flipbasket",
        "agreement_date": "",
        "date_of_consent": "2024-02-23T00:00:00Z",
        "consent_status": "active",
        "revocation_date": "2024-05-23"
      },
      "data_principal_rights": {
        "right_to_access": true,
        "right_to_rectify": true,
        "right_to_erase": true,
        "right_to_restrict_processing": true,
        "right_to_data_portability": true
      },
      "consent_scope": {
        "data_element": [
          {
            "data_element": "home_address",
            "consents": [
              {
                "purpose_id": "bb4f25e5fd9b5b2b",
                "consent_status": "approved",
                "shared": false,
                "data_processors": [
                  "123abc",
                  "234ghi",
                  "345jik"
                ],
                "cross_border": true,
                "consent_timestamp": "2024-02-23T00:00:00Z",
                "expiry_date": "2024-05-23T00:00:00Z",
                "retention_date": "2024-08-23T00:00:00Z"
              },
              {
                "purpose_id": "kl4f25e5fd875b2b",
                "consent_status": "approved",
                "shared": false,
                "data_processors": [],
                "cross_border": false,
                "consent_timestamp": "2024-02-23T00:00:00Z",
                "expiry_date": "2024-05-23T00:00:00Z",
                "retention_date": "2024-08-23T00:00:00Z"
              }
            ]
          },
          {
            "data_element": "mobile_number",
            "consents": [
              {
                "purpose_id": "hj1f25e5fd9b5b2b",
                "consent_status": "approved",
                "shared": true,
                "data_processors": [
                  "123abc",
                  "234ghi",
                  "345jik"
                ],
                "cross_border": true,
                "consent_timestamp": "2024-02-23T00:00:00Z",
                "expiry_date": "2024-05-23T00:00:00Z",
                "retention_date": "2024-08-23T00:00:00Z"
              },
              {
                "purpose_id": "rgyu625e5fd9b5b2b",
                "consent_status": "rejected",
                "shared": false,
                "data_processors": [],
                "consent_timestamp": "2024-02-23T00:00:00Z",
                "expiry_date": "2024-05-23T00:00:00Z",
                "retention_date": "2024-08-23T00:00:00Z"
              }
            ]
          }
        ]
      }
    }
  }

TOML

[artifact]
context = "https://consent.foundation/artifact/v1"
cp_name = "Customer Onboarding Form"
agreement_hash_id = "1ca35897540ec7ae7294a8cacd11caf2c09f95f026c925c6ce4e4c29b20e3c41"
agreement_version = "1.0"
linked_agreement_hash = "d4828c7252da8b626a40ffdbbec74c36b74d8f80c78df86e43d53fb5f3f366f4"

[artifact.data_principal]
dp_df_id = "d74bed43-6ee3-4cdc-a5cb-2b6b8f1732c4"
dp_public_key = ""
dp_residency = "india"
dp_e = "30ac654fe2a70f1a7a1b1b5b92b0238c2b2366ffab8bdde09de8030705b76b67"
dp_verification = false
dp_child = false

[artifact.data_principal.dp_attorney]
dp_df_id = ""
dp_public_key = ""
dp_e = ""

[artifact.data_fiduciary]
df_id = "flipbasket"
agreement_date = ""
date_of_consent = "2024-02-23T00:00:00Z"
consent_status = "active"
revocation_date = "2024-05-23"

[artifact.data_principal_rights]
right_to_access = true
right_to_rectify = true
right_to_erase = true
right_to_restrict_processing = true
right_to_data_portability = true

[[artifact.consent_scope.data_element]]
data_element = "home_address"

  [[artifact.consent_scope.data_element.consents]]
  purpose_id = "bb4f25e5fd9b5b2b"
  consent_status = "approved"
  shared = false
  data_processors = ["123abc", "234ghi", "345jik"]
  cross_border = true
  consent_timestamp = "2024-02-23T00:00:00Z"
  expiry_date = "2024-05-23T00:00:00Z"
  retention_date = "2024-08-23T00:00:00Z"

  [[artifact.consent_scope.data_element.consents]]
  purpose_id = "kl4f25e5fd875b2b"
  consent_status = "approved"
  shared = false
  data_processors = []
  cross_border = false
  consent_timestamp = "2024-02-23T00:00:00Z"
  expiry_date = "2024-05-23T00:00:00Z"
  retention_date = "2024-08-23T00:00:00Z"

[[artifact.consent_scope.data_element]]
data_element = "mobile_number"

  [[artifact.consent_scope.data_element.consents]]
  purpose_id = "hj1f25e5fd9b5b2b"
  consent_status = "approved"
  shared = true
  data_processors = ["123abc", "234ghi", "345jik"]
  cross_border = true
  consent_timestamp = "2024-02-23T00:00:00Z"
  expiry_date = "2024-05-23T00:00:00Z"
  retention_date = "2024-08-23T00:00:00Z"

  [[artifact.consent_scope.data_element.consents]]
  purpose_id = "rgyu625e5fd9b5b2b"
  consent_status = "rejected"
  shared = false
  data_processors = []
  consent_timestamp = "2024-02-23T00:00:00Z"
  expiry_date = "2024-05-23T00:00:00Z"
  retention_date = "2024-08-23T00:00:00Z"

YAML

artifact:
  context: "https://consent.foundation/artifact/v1"
  cp_name: "Customer Onboarding Form"
  agreement_hash_id: "1ca35897540ec7ae7294a8cacd11caf2c09f95f026c925c6ce4e4c29b20e3c41"
  agreement_version: "1.0"
  linked_agreement_hash: "d4828c7252da8b626a40ffdbbec74c36b74d8f80c78df86e43d53fb5f3f366f4"
  data_principal:
    dp_df_id: "d74bed43-6ee3-4cdc-a5cb-2b6b8f1732c4"
    dp_public_key: ""
    dp_residency: "india"
    dp_e: "30ac654fe2a70f1a7a1b1b5b92b0238c2b2366ffab8bdde09de8030705b76b67"
    dp_verification: false
    dp_child: false
    dp_attorney:
      dp_df_id: ""
      dp_public_key: ""
      dp_e: ""
  data_fiduciary:
    df_id: "flipbasket"
    agreement_date: ""
    date_of_consent: "2024-02-23T00:00:00Z"
    consent_status: "active"
    revocation_date: "2024-05-23"
  data_principal_rights:
    right_to_access: true
    right_to_rectify: true
    right_to_erase: true
    right_to_restrict_processing: true
    right_to_data_portability: true
  consent_scope:
    data_element:
      - data_element: "home_address"
        consents:
          - purpose_id: "bb4f25e5fd9b5b2b"
            consent_status: "approved"
            shared: false
            data_processors:
              - "123abc"
              - "234ghi"
              - "345jik"
            cross_border: true
            consent_timestamp: "2024-02-23T00:00:00Z"
            expiry_date: "2024-05-23T00:00:00Z"
            retention_date: "2024-08-23T00:00:00Z"
          - purpose_id: "kl4f25e5fd875b2b"
            consent_status: "approved"
            shared: false
            data_processors: []
            cross_border: false
            consent_timestamp: "2024-02-23T00:00:00Z"
            expiry_date: "2024-05-23T00:00:00Z"
            retention_date: "2024-08-23T00:00:00Z"
      - data_element: "mobile_number"
        consents:
          - purpose_id: "hj1f25e5fd9b5b2b"
            consent_status: "approved"
            shared: true
            data_processors:
              - "123abc"
              - "234ghi"
              - "345jik"
            cross_border: true
            consent_timestamp: "2024-02-23T00:00:00Z"
            expiry_date: "2024-05-23T00:00:00Z"
            retention_date: "2024-08-23T00:00:00Z"
          - purpose_id: "rgyu625e5fd9b5b2b"
            consent_status: "rejected"
            shared: false
            data_processors: []
            consent_timestamp: "2024-02-23T00:00:00Z"
            expiry_date: "2024-05-23T00:00:00Z"
            retention_date: "2024-08-23T00:00:00Z"