Agreements

Create data disclosure agreement

POST/v4/config/consent/data-disclosure-agreement

Creates a data disclosure agreement (DDA) template. The template states the terms under which your organisation, as a data source, shares data with data using services through a data marketplace.

Base the template on a revision of a data agreement: give dataAgreementId, dataAgreementRevisionId and dataAgreementRevisionHash (the serializedHash of that revision). The data agreement must have the method of use data_source, and its policy must allow third-party data sharing. The service copies the data attributes and the OpenAPI specification of that revision into the template.

With active: false the template is a draft: the answer has a revision with an empty id, because a draft has no stored revision. With active: true the service publishes the template, makes a revision and tells your data marketplace about it (see the base configuration). To publish, purpose and purposeDescription are mandatory.

Errors:

400: a field is missing or not valid (the message names it), the revision does not belong to the data agreement, the hash does not match, or the data agreement does not allow data sharing as a data source.
404: the data agreement, its revision or the presentation definition does not exist.

Create data disclosure agreement

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/config/consent/data-disclosure-agreement' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "dataDisclosureAgreementTemplate": {
    "language": "en",
    "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": 365,
    "dataSharingRestrictions": {
      "policyUrl": "https://www.example.com/privacy-policy",
      "jurisdiction": "Sweden",
      "dataRetentionPeriod": 180,
      "geographicRestriction": "European Union",
      "storageLocation": "Sweden"
    },
    "purpose": "Loyalty points",
    "purposeDescription": "Share the loyalty points of customers with partner services that give rewards.",
    "lawfulBasis": "contract",
    "codeOfConduct": "https://www.example.com/code-of-conduct",
    "dataAgreementId": "6af081612d6fb7b6ac6efc5d",
    "dataAgreementRevisionId": "6af081612d6fb7b6ac6efc62",
    "dataAgreementRevisionHash": "2d05813a1efa898498645ec1a63fd299a3a30338",
    "presentationDefinitionId": "93f40fc0-c946-4966-8544-8172d9ff8dba",
    "active": false
  }
}'

{
  "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": "1.0.0",
    "templateId": "6af081832d6fb7b6ac6efc65",
    "templateVersion": "1.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": 365,
    "dataSharingRestrictions": {
      "policyUrl": "https://www.example.com/privacy-policy",
      "jurisdiction": "Sweden",
      "dataRetentionPeriod": 180,
      "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": "https://www.example.com/code-of-conduct",
    "dataAgreementId": "6af081612d6fb7b6ac6efc5d",
    "dataAgreementRevisionId": "6af081612d6fb7b6ac6efc62",
    "dataAgreementRevisionHash": "2d05813a1efa898498645ec1a63fd299a3a30338",
    "active": false,
    "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": "",
    "schemaName": "DataDisclosureAgreementTemplate",
    "objectId": "6af081832d6fb7b6ac6efc65",
    "signedWithoutObjectId": false,
    "timestamp": "2026-11-08T14:04:51Z",
    "authorizedByIndividualId": "",
    "authorizedByOther": "6ae2bf74a401855d2806ab5d",
    "predecessorHash": "",
    "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\":\"1.0.0\",\"templateId\":\"6af081832d6fb7b6ac6efc65\",\"templateVersion\":\"1.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\":365,\"dataSharingRestrictions\":{\"policyUrl\":\"https://www.example.com/privacy-policy\",\"jurisdiction\":\"Sweden\",\"dataRetentionPeriod\":180,\"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\":\"https://www.example.com/code-of-conduct\",\"dataAgreementId\":\"6af081612d6fb7b6ac6efc5d\",\"dataAgreementRevisionId\":\"6af081612d6fb7b6ac6efc62\",\"dataAgreementRevisionHash\":\"2d05813a1efa898498645ec1a63fd299a3a30338\",\"active\":false,\"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": "31406d214f826ad716d78369e8842c7d528de16d",
    "serializedSnapshot": "{\"schemaName\":\"DataDisclosureAgreementTemplate\",\"objectId\":\"6af081832d6fb7b6ac6efc65\",\"signedWithoutObjectId\":false,\"timestamp\":\"2026-11-08T14:04:51Z\",\"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\\\":\\\"1.0.0\\\",\\\"templateId\\\":\\\"6af081832d6fb7b6ac6efc65\\\",\\\"templateVersion\\\":\\\"1.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\\\":365,\\\"dataSharingRestrictions\\\":{\\\"policyUrl\\\":\\\"https://www.example.com/privacy-policy\\\",\\\"jurisdiction\\\":\\\"Sweden\\\",\\\"dataRetentionPeriod\\\":180,\\\"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\\\":\\\"https://www.example.com/code-of-conduct\\\",\\\"dataAgreementId\\\":\\\"6af081612d6fb7b6ac6efc5d\\\",\\\"dataAgreementRevisionId\\\":\\\"6af081612d6fb7b6ac6efc62\\\",\\\"dataAgreementRevisionHash\\\":\\\"2d05813a1efa898498645ec1a63fd299a3a30338\\\",\\\"active\\\":false,\\\"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:create

Body

application/json

dataDisclosureAgreementTemplateobjectrequired
The fields of a new data disclosure agreement template.

Response

application/json

The template and its revision. The Location header has the path of the new template.

Headers

Locationstring
Path of the new template.

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.