Agreement records

Delete data disclosure agreement record

DELETE

/v4/config/consent/data-disclosure-agreement/{dataDisclosureAgreementTemplateRevisionId}/record/{dataDisclosureAgreementRecordId}

Deletes the copy of a data disclosure agreement record in your organisation. The record is then not in the record lists and reads, a pull data request and an access token check under it fail, and its revisions stay readable with GET .../record/{dataDisclosureAgreementRecordId}/revision/{dataDisclosureAgreementRecordRevisionId}. The copy of the other party does not change, and the service tells nobody about the delete.

The record id alone selects the record: the service does not check the template revision ID in the path.

Errors: 404 when the record does not exist or is already deleted.

Delete data disclosure agreement record

Language of the request sample

curl -X DELETE 'https://demo-api.igrant.io/v4/config/consent/data-disclosure-agreement/{dataDisclosureAgreementTemplateRevisionId}/record/{dataDisclosureAgreementRecordId}' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "revision": {
    "id": "6af1c0ab2d6fb7b6ac6efd27",
    "schemaName": "DataDisclosureAgreementRecord",
    "objectId": "6af1c0a12d6fb7b6ac6efd20",
    "signedWithoutObjectId": false,
    "timestamp": "2026-11-08T14:20:11Z",
    "authorizedByIndividualId": "",
    "authorizedByOther": "6ae2bf741c3dadfeb27982ec",
    "predecessorHash": "a8138b18a0a66de72ddaa42be8a88bb45a22754d",
    "predecessorSignature": "",
    "objectData": "{\"id\":\"6af1c0a12d6fb7b6ac6efd20\",\"canonicalId\":\"6af1c0a12d6fb7b6ac6efd20\",\"optIn\":true,\"timestamp\":\"2026-11-08T14:20:11Z\",\"organisationRole\":\"data_source\",...}",
    "successorId": "",
    "serializedHash": "d36253add1431c9588aa4d38b9fd774e1cfcbdfb",
    "serializedSnapshot": "{\"schemaName\":\"DataDisclosureAgreementRecord\",\"objectId\":\"6af1c0a12d6fb7b6ac6efd20\",\"timestamp\":\"2026-11-08T14:20:11Z\",...}",
    "organisationId": "6ae2bf741c3dadfeb27982ec"
  }
}

Authorizations

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

Path parameters

dataDisclosureAgreementTemplateRevisionIdstringrequired
ID of the template revision of the record (dataDisclosureAgreementTemplateRevision.id). The service does not check it.
dataDisclosureAgreementRecordIdstringrequired
ID of the data disclosure agreement record (id).

Response

application/json

The latest revision of the deleted record. The delete makes no new revision.

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.