Data Agreement

Read data agreement

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

Reads a data agreement and its latest revision. Give revisionId to get the data agreement as it was at that revision. For a draft, the revision in the answer is one that the server makes for the answer only (its id is empty).

Read data agreement

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/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": ""
  },
  "revision": {
    "id": "6af0821c2d6fb7b6ac6efc7c",
    "schemaName": "DataAgreement",
    "objectId": "6af0821c2d6fb7b6ac6efc78",
    "signedWithoutObjectId": false,
    "timestamp": "2026-11-08T14:07:24Z",
    "authorizedByIndividualId": "",
    "authorizedByOther": "6ae2bf74a401855d2806ab5d",
    "predecessorHash": "",
    "predecessorSignature": "",
    "objectData": "{\"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\":\"\"}",
    "successorId": "",
    "serializedHash": "0c118036247654a4cf7a5ec25d94c42b20f771c5",
    "serializedSnapshot": "{\"schemaName\":\"DataAgreement\",\"objectId\":\"6af0821c2d6fb7b6ac6efc78\",\"signedWithoutObjectId\":false,\"timestamp\":\"2026-11-08T14:07:24Z\",\"authorizedByIndividualId\":\"\",\"authorizedByOther\":\"6ae2bf74a401855d2806ab5d\",\"objectData\":\"{\\\"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\\\":\\\"\\\"}\",\"organisationId\":\"\"}",
    "organisationId": "6ae2bf741c3dadfeb27982ec"
  }
}

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"

Query parameters

revisionIdstring
Revision ID. Give it to get the record as it was at that revision. Without it, the server uses the latest revision.

Response

application/json

The data agreement and the revision.

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.
revisionobject
One saved version of a record (a data agreement, a policy, a consent record or a data disclosure agreement). Each change makes a new revision. The revision holds the record as JSON and a SHA-1 hash of the snapshot, and it links to the hash of the revision before it, so that you can detect a changed history. Only successorId changes after the server saves a revision.