Audit

Read data agreement

GET/v4/audit/consent/data-agreement/{dataAgreementId}

Reads the current state of a data agreement, published or draft. For the earlier versions, use "List data agreement revisions". An API key needs the scope data-agreements:read (a key with the old scope values needs audit).

Read data agreement

Language of the request sample

curl 'https://demo-api.igrant.io/v4/audit/consent/data-agreement/6af080eb2d6fb7b6ac6efc57' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "dataAgreement": {
    "id": "6af0821c2d6fb7b6ac6efc78",
    "version": "1.0.0",
    "controllerId": "6ae2bf741c3dadfeb27982ec",
    "controllerUrl": "https://org1.example.com/policy",
    "controllerName": "Organization 1",
    "policy": {
      "id": "6af0821c2d6fb7b6ac6efc79",
      "name": "Privacy policy",
      "version": "",
      "url": "https://www.example.com/privacy-policy",
      "jurisdiction": "Sweden",
      "industrySector": "Retail",
      "dataRetentionPeriodDays": 365,
      "geographicRestriction": "European Union",
      "storageLocation": "Sweden",
      "thirdPartyDataSharing": true
    },
    "purpose": "Loyalty data sharing",
    "purposeDescription": "Share the purchase history with partners that give loyalty offers.",
    "lawfulBasis": "consent",
    "methodOfUse": "data_source",
    "dpiaDate": "",
    "dpiaSummaryUrl": "",
    "signature": {
      "id": "6af0821c2d6fb7b6ac6efc7a",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": false,
      "objectType": "",
      "objectReference": ""
    },
    "active": true,
    "forgettable": false,
    "compatibleWithVersionId": "",
    "lifecycle": "complete",
    "dataAttributes": [
      {
        "id": "6af0821c2d6fb7b6ac6efc7b",
        "name": "Purchase history",
        "description": "Products bought in the last 12 months",
        "sensitivity": false,
        "category": "Purchases",
        "restrictions": null
      }
    ],
    "dataUse": "data_source",
    "dpia": "",
    "compatibleWithVersion": "",
    "controller": {
      "id": "6ae2bf741c3dadfeb27982ec",
      "name": "Organization 1",
      "url": "https://org1.example.com/policy"
    },
    "dataExchange": {
      "dataExchangeProfile": "",
      "id": ""
    },
    "dataSources": [],
    "dataUsingServices": [
      {
        "name": "Example Bank",
        "sector": "Finance",
        "location": "Sweden",
        "privacyDashboardUrl": "https://bank.example.com/privacy"
      },
      {
        "name": "Example Airline",
        "sector": "Travel",
        "location": "Sweden",
        "privacyDashboardUrl": "https://airline.example.com/privacy"
      }
    ],
    "openApiSpecification": null,
    "nats": {
      "subjects": null,
      "url": ""
    },
    "dataExchangeMethod": ""
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:data-agreements:read

Path parameters

dataAgreementIdstringrequired
Data agreement ID.
Example:"6af080eb2d6fb7b6ac6efc57"

Response

application/json

The data agreement.

dataAgreementobject
A data agreement describes one purpose for which the organisation processes personal data (ISO/IEC TS 27560). Many individuals can consent to the same data agreement: each consent is a consent record.