Audit

List data agreements

GET/v4/audit/consent/data-agreements

Lists all data agreements of the organisation, published and draft, in their current state, one page at a time. Give revisionId to get only the data agreement as it was at that revision. An API key needs the scope data-agreements:read (a key with the old scope values needs audit).

Language of the request sample

curl 'https://demo-api.igrant.io/v4/audit/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

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
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

One page of data agreements.

dataAgreementsobject[]
paginationobject