Data Agreement

Delete data agreement

DELETE/v4/config/consent/data-agreement/{dataAgreementId}

Deletes a data agreement. Individuals can no longer consent to it, and it leaves the lists of the individual. The server keeps its revisions, and the purpose is free for a new data agreement. The answer is the latest revision of the deleted data agreement (for a draft, a revision that the server makes for the answer only).

Language of the request sample

curl -X DELETE 'https://demo-api.igrant.io/v4/config/consent/data-agreement/6af080eb2d6fb7b6ac6efc57' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "id": "6af0821c2d6fb7b6ac6efc7c",
  "schemaName": "DataAgreement",
  "objectId": "6af0821c2d6fb7b6ac6efc78",
  "signedWithoutObjectId": false,
  "timestamp": "2026-11-08T14:07:24Z",
  "authorizedByIndividualId": "",
  "authorizedByOther": "6ae2bf74a401855d2806ab5d",
  "predecessorHash": "",
  "predecessorSignature": "",
  "objectData": "{\"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\":\"\"}",
  "successorId": "",
  "serializedHash": "0c118036247654a4cf7a5ec25d94c42b20f771c5",
  "serializedSnapshot": "{\"schemaName\":\"DataAgreement\",\"objectId\":\"6af0821c2d6fb7b6ac6efc78\",\"signedWithoutObjectId\":false,\"timestamp\":\"2026-11-08T14:07:24Z\",\"authorizedByIndividualId\":\"\",\"authorizedByOther\":\"6ae2bf74a401855d2806ab5d\",\"objectData\":\"{\\\"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\\\":\\\"\\\"}\",\"organisationId\":\"\"}",
  "organisationId": "6ae2bf741c3dadfeb27982ec"
}

Authorizations

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

Path parameters

dataAgreementIdstringrequired
Data agreement ID.
Example:"6af080eb2d6fb7b6ac6efc57"

Response

application/json

The latest revision of the deleted data agreement.

idstring
Revision ID. It is empty for a draft data agreement: a draft has no saved revision, so the server builds one for the answer only.
Example:"6af080a42d6fb7b6ac6efc55"
schemaNameenum<string>
Type of the record of this revision.
Available options:DataAgreement,Policy,ConsentRecord,DataDisclosureAgreementTemplate,DataDisclosureAgreementRecord
Example:"Policy"
objectIdstring
ID of the record of this revision.
Example:"6af080a42d6fb7b6ac6efc54"
objectDatastring
The record at this revision, as a JSON string.
signedWithoutObjectIdboolean
true when the server made the hash before the record had an ID.
Example:false
serializedSnapshotstring
The JSON string that the server hashes: the revision fields (schemaName, objectId, timestamp, authorizedByIndividualId, authorizedByOther, objectData and more) without id, successorId, serializedHash and serializedSnapshot.
serializedHashstring
SHA-1 hash of serializedSnapshot, in hexadecimal.
Example:"5172776ed742c08df985f58fcbe3afd641c0f862"
timestampstring<date-time>
Time of the change, in UTC (ISO 8601).
Example:"2026-11-08T14:01:08Z"
authorizedByIndividualIdstring
Not used. Always empty.
authorizedByOtherstring
ID of who made the change: the admin (or the admin of the API key) for a data agreement or a policy, the individual for a consent record.
Example:"6ae2bf74a401855d2806ab5d"
successorIdstring
ID of the next revision of the same record. Empty for the latest revision.
predecessorHashstring
serializedHash of the revision before this one. Empty for the first revision.
predecessorSignaturestring
Not used. Always empty.
organisationIdstring
ID of the organisation that owns the record.
Example:"6ae2bf741c3dadfeb27982ec"