Data Agreement

List data agreements

GET/v4/config/consent/data-agreements

Lists the data agreements of the organisation, one page at a time. Without filters the list has the current state of every data agreement, published or draft.

Filters: lifecycle (complete or draft), methodOfUse and dexProfile. With revisionId the list has only the data agreement as it was at that revision. With includeRevisions=true each data agreement also has its revisions.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/consent/data-agreements' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "dataAgreements": [
    {
      "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": ""
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 3,
    "totalPages": 3,
    "limit": 1,
    "hasPrevious": false,
    "hasNext": true
  }
}

Authorizations

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

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.
offsetinteger
Number of records to skip for pagination. A negative or unreadable value falls back to 0.
At least 0.
Default:0
limitinteger
Maximum number of records to return per page.
Default:10
lifecycleenum<string>
complete lists the data agreements that have a published revision, as at their latest revision. draft lists only the drafts. Without it, the list has both, in their current state. When complete matches no data agreement and includeRevisions is not true, dataAgreements is null.
Available options:complete,draft
methodOfUseenum<string>
Lists only the data agreements with this method of use.
Available options:null,data_source,data_using_service
dexProfilestring
Lists only the data agreements with this data exchange profile, for example OID4VC.
includeRevisionsboolean
true adds the revisions of each data agreement to the list.
Default:false

Response

application/json

One page of data agreements.

dataAgreementsobject[] | null
null when lifecycle=complete matches no data agreement and includeRevisions is not true.
paginationobject