Agreements

Read data disclosure agreement

GET/v4/config/consent/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}

Reads a data disclosure agreement template in its current state, draft or published, with its latest revision. For a template that was never published, the revision has an empty id.

Errors: 404 when the template does not exist or is deleted.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/consent/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "dataDisclosureAgreementTemplate": {
    "@context": [
      "https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/interface-specs/jsonld/contexts/dexa-context.jsonld",
      "https://w3id.org/security/v2"
    ],
    "@id": "6af081832d6fb7b6ac6efc65",
    "@type": [
      "DataDisclosureAgreement"
    ],
    "language": "en",
    "version": "3.0.0",
    "templateId": "6af081832d6fb7b6ac6efc65",
    "templateVersion": "3.0.0",
    "dataController": {
      "publicKey": "urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs",
      "name": "Example Data Source",
      "legalId": "SE556677889901",
      "url": "https://www.example.com",
      "industrySector": "Retail"
    },
    "agreementPeriod": 730,
    "dataSharingRestrictions": {
      "policyUrl": "https://www.example.com/privacy-policy",
      "jurisdiction": "Sweden",
      "dataRetentionPeriod": 90,
      "geographicRestriction": "European Union",
      "storageLocation": "Sweden"
    },
    "purpose": "Loyalty points",
    "purposeDescription": "Share the loyalty points of customers with partner services that give rewards.",
    "lawfulBasis": "contract",
    "dataAttributes": [
      {
        "id": "6af081612d6fb7b6ac6efc60",
        "name": "Loyalty points",
        "description": "Points balance of the loyalty account",
        "sensitivity": false,
        "category": "Loyalty",
        "restrictions": null
      },
      {
        "id": "6af081612d6fb7b6ac6efc61",
        "name": "Membership level",
        "description": "Level of the loyalty membership",
        "sensitivity": false,
        "category": "Loyalty",
        "restrictions": null
      }
    ],
    "codeOfConduct": "",
    "dataAgreementId": "6af081612d6fb7b6ac6efc5d",
    "dataAgreementRevisionId": "6af081612d6fb7b6ac6efc62",
    "dataAgreementRevisionHash": "2d05813a1efa898498645ec1a63fd299a3a30338",
    "active": true,
    "presentationDefinitionId": "93f40fc0-c946-4966-8544-8172d9ff8dba",
    "openApiSpecification": {
      "info": {
        "title": "Loyalty API",
        "version": "1.0.0"
      },
      "openapi": "3.0.0",
      "paths": {
        "/loyalty/{customerId}/points": {
          "get": {
            "responses": {
              "200": {
                "description": "OK"
              }
            },
            "summary": "Read the loyalty points"
          }
        }
      }
    }
  },
  "revision": {
    "id": "6af082302d6fb7b6ac6efc87",
    "schemaName": "DataDisclosureAgreementTemplate",
    "objectId": "6af081832d6fb7b6ac6efc65",
    "signedWithoutObjectId": false,
    "timestamp": "2026-11-08T14:07:44Z",
    "authorizedByIndividualId": "",
    "authorizedByOther": "6ae2bf74a401855d2806ab5d",
    "predecessorHash": "410686e4d61421db7581ed170c9b569510b910d0",
    "predecessorSignature": "",
    "objectData": "{\"@context\":[\"https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/interface-specs/jsonld/contexts/dexa-context.jsonld\",\"https://w3id.org/security/v2\"],\"@id\":\"6af081832d6fb7b6ac6efc65\",\"@type\":[\"DataDisclosureAgreement\"],\"language\":\"en\",\"version\":\"3.0.0\",\"templateId\":\"6af081832d6fb7b6ac6efc65\",\"templateVersion\":\"3.0.0\",\"dataController\":{\"publicKey\":\"urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs\",\"name\":\"Example Data Source\",\"legalId\":\"SE556677889901\",\"url\":\"https://www.example.com\",\"industrySector\":\"Retail\"},\"agreementPeriod\":730,\"dataSharingRestrictions\":{\"policyUrl\":\"https://www.example.com/privacy-policy\",\"jurisdiction\":\"Sweden\",\"dataRetentionPeriod\":90,\"geographicRestriction\":\"European Union\",\"storageLocation\":\"Sweden\"},\"purpose\":\"Loyalty points\",\"purposeDescription\":\"Share the loyalty points of customers with partner services that give rewards.\",\"lawfulBasis\":\"contract\",\"dataAttributes\":[{\"id\":\"6af081612d6fb7b6ac6efc60\",\"name\":\"Loyalty points\",\"description\":\"Points balance of the loyalty account\",\"sensitivity\":false,\"category\":\"Loyalty\",\"restrictions\":null},{\"id\":\"6af081612d6fb7b6ac6efc61\",\"name\":\"Membership level\",\"description\":\"Level of the loyalty membership\",\"sensitivity\":false,\"category\":\"Loyalty\",\"restrictions\":null}],\"codeOfConduct\":\"\",\"dataAgreementId\":\"6af081612d6fb7b6ac6efc5d\",\"dataAgreementRevisionId\":\"6af081612d6fb7b6ac6efc62\",\"dataAgreementRevisionHash\":\"2d05813a1efa898498645ec1a63fd299a3a30338\",\"active\":true,\"presentationDefinitionId\":\"93f40fc0-c946-4966-8544-8172d9ff8dba\",\"openApiSpecification\":{\"info\":{\"title\":\"Loyalty API\",\"version\":\"1.0.0\"},\"openapi\":\"3.0.0\",\"paths\":{\"/loyalty/{customerId}/points\":{\"get\":{\"responses\":{\"200\":{\"description\":\"OK\"}},\"summary\":\"Read the loyalty points\"}}}}}",
    "successorId": "",
    "serializedHash": "d613d4c83b5b5b9569cff6d8a8de3c27be628d14",
    "serializedSnapshot": "{\"schemaName\":\"DataDisclosureAgreementTemplate\",\"objectId\":\"6af081832d6fb7b6ac6efc65\",\"signedWithoutObjectId\":false,\"timestamp\":\"2026-11-08T14:07:44Z\",\"authorizedByIndividualId\":\"\",\"authorizedByOther\":\"6ae2bf74a401855d2806ab5d\",\"objectData\":\"{\\\"@context\\\":[\\\"https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/interface-specs/jsonld/contexts/dexa-context.jsonld\\\",\\\"https://w3id.org/security/v2\\\"],\\\"@id\\\":\\\"6af081832d6fb7b6ac6efc65\\\",\\\"@type\\\":[\\\"DataDisclosureAgreement\\\"],\\\"language\\\":\\\"en\\\",\\\"version\\\":\\\"3.0.0\\\",\\\"templateId\\\":\\\"6af081832d6fb7b6ac6efc65\\\",\\\"templateVersion\\\":\\\"3.0.0\\\",\\\"dataController\\\":{\\\"publicKey\\\":\\\"urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs\\\",\\\"name\\\":\\\"Example Data Source\\\",\\\"legalId\\\":\\\"SE556677889901\\\",\\\"url\\\":\\\"https://www.example.com\\\",\\\"industrySector\\\":\\\"Retail\\\"},\\\"agreementPeriod\\\":730,\\\"dataSharingRestrictions\\\":{\\\"policyUrl\\\":\\\"https://www.example.com/privacy-policy\\\",\\\"jurisdiction\\\":\\\"Sweden\\\",\\\"dataRetentionPeriod\\\":90,\\\"geographicRestriction\\\":\\\"European Union\\\",\\\"storageLocation\\\":\\\"Sweden\\\"},\\\"purpose\\\":\\\"Loyalty points\\\",\\\"purposeDescription\\\":\\\"Share the loyalty points of customers with partner services that give rewards.\\\",\\\"lawfulBasis\\\":\\\"contract\\\",\\\"dataAttributes\\\":[{\\\"id\\\":\\\"6af081612d6fb7b6ac6efc60\\\",\\\"name\\\":\\\"Loyalty points\\\",\\\"description\\\":\\\"Points balance of the loyalty account\\\",\\\"sensitivity\\\":false,\\\"category\\\":\\\"Loyalty\\\",\\\"restrictions\\\":null},{\\\"id\\\":\\\"6af081612d6fb7b6ac6efc61\\\",\\\"name\\\":\\\"Membership level\\\",\\\"description\\\":\\\"Level of the loyalty membership\\\",\\\"sensitivity\\\":false,\\\"category\\\":\\\"Loyalty\\\",\\\"restrictions\\\":null}],\\\"codeOfConduct\\\":\\\"\\\",\\\"dataAgreementId\\\":\\\"6af081612d6fb7b6ac6efc5d\\\",\\\"dataAgreementRevisionId\\\":\\\"6af081612d6fb7b6ac6efc62\\\",\\\"dataAgreementRevisionHash\\\":\\\"2d05813a1efa898498645ec1a63fd299a3a30338\\\",\\\"active\\\":true,\\\"presentationDefinitionId\\\":\\\"93f40fc0-c946-4966-8544-8172d9ff8dba\\\",\\\"openApiSpecification\\\":{\\\"info\\\":{\\\"title\\\":\\\"Loyalty API\\\",\\\"version\\\":\\\"1.0.0\\\"},\\\"openapi\\\":\\\"3.0.0\\\",\\\"paths\\\":{\\\"/loyalty/{customerId}/points\\\":{\\\"get\\\":{\\\"responses\\\":{\\\"200\\\":{\\\"description\\\":\\\"OK\\\"}},\\\"summary\\\":\\\"Read the loyalty points\\\"}}}}}\",\"organisationId\":\"\"}",
    "organisationId": "6ae2bf741c3dadfeb27982ec"
  }
}

Authorizations

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

Path parameters

dataDisclosureAgreementTemplateIdstringrequired
ID of the data disclosure agreement template (@id), 24 hexadecimal characters.

Response

application/json

The template and its latest revision.

dataDisclosureAgreementTemplateobject
The terms under which your organisation, as a data source, offers data to data using services. A data using service signs a data disclosure agreement record against a published template. The data attributes and the OpenAPI specification come from the revision of the data agreement that the template names.
revisionobject
A locked snapshot of a data disclosure agreement template or record. The service makes a revision each time it publishes a template or changes a record. A new revision links to the one before it through predecessorHash, and the one before it gets the successorId of the new revision.