Audit

List consent record revisions

GET/v4/audit/consent/consent-records

Lists every revision of the consent records of the organisation, newest first, one page at a time: each consent, withdrawal, sector change and signature is one item, with its time and the purpose, lawful basis and version of its data agreement. Use it as the audit trail of consent, for example to answer a regulator. The revisions of the consent records that "Delete all consent records of the individual" removed are not in the list.

Filter with id (a consent record, a data agreement, an individual or its external ID), lawfulBasis and sector. An API key needs the scope consent-records:read (a key with the old scope values needs audit).

Language of the request sample

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

{
  "consentRecords": [
    {
      "id": "6af081ea2d6fb7b6ac6efc71",
      "dataAgreementId": "6af080eb2d6fb7b6ac6efc57",
      "dataAgreementRevisionId": "6af081a62d6fb7b6ac6efc6f",
      "dataAgreementRevisionHash": "d6eb1a0ed9f96941d40b61969b2c79912252ce3f",
      "individualId": "6af081b138e8f33dcf799628",
      "optIn": false,
      "state": "unsigned",
      "signatureId": "",
      "timestamp": "2026-11-08T14:07:17Z",
      "dataAgreement": {
        "purpose": "Newsletter",
        "lawfulBasis": "consent",
        "version": "4.0.0"
      }
    },
    {
      "id": "6af081ea2d6fb7b6ac6efc71",
      "dataAgreementId": "6af080eb2d6fb7b6ac6efc57",
      "dataAgreementRevisionId": "6af081a62d6fb7b6ac6efc6f",
      "dataAgreementRevisionHash": "d6eb1a0ed9f96941d40b61969b2c79912252ce3f",
      "individualId": "6af081b138e8f33dcf799628",
      "optIn": true,
      "state": "signed",
      "signatureId": "",
      "timestamp": "2026-11-08T14:07:11Z",
      "dataAgreement": {
        "purpose": "Newsletter",
        "lawfulBasis": "consent",
        "version": "4.0.0"
      }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 3,
    "totalPages": 2,
    "limit": 2,
    "hasPrevious": false,
    "hasNext": true
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:consent-records: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
lawfulBasisenum<string>
Lists only the consent records of data agreements with this lawful basis.
Available options:consent,legal_obligation,contract,vital_interest,public_task,legitimate_interest
idstring
Lists only the revisions that match this ID: a consent record ID, a data agreement ID, an individual ID, or the externalId of an individual.
sectorstring
Lists only the revisions that concern this industry sector: a change of this sector, or a change of the whole consent record when the record has this sector.

Response

application/json

One page of consent record revisions.

consentRecordsobject[]
paginationobject