Skip to main content
Data Agreement

Update data agreement

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

Replaces a data agreement with the body. Send the whole data agreement: a member that you leave out becomes empty. The rules of the create apply.

For a published data agreement, the server raises the major version (1.0.0 to 2.0.0) and saves a new revision. Existing consent records keep the revision that the individual consented to; they move to the new revision when the individual updates or signs them. A draft keeps its version and gets no revision. Send active: true to publish a draft.

To keep a data attribute and its ID, send its id in dataAttributes. A data attribute without a known id is new and gets a new ID; a data attribute that you leave out is removed.

A data agreement with the OID4VC profile keeps the profile: send dataExchange with its id in each update, else the answer is 400.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:data-agreements:update

Path parameters

  • dataAgreementIdstringrequired

    Data agreement ID.

    Example:"6af080eb2d6fb7b6ac6efc57"

Body

application/json
  • dataAgreementobjectrequired

    The data agreement that you create or update. The server sets the ID, the version, the controller (your organisation) and the lifecycle. When active is true, purpose, purposeDescription, policy and dataAttributes are mandatory too.

Response

application/json

The updated data agreement and its revision.

  • dataAgreementobject

    A data agreement describes one purpose for which the organisation processes personal data (ISO/IEC TS 27560). Many individuals can consent to the same data agreement: each consent is a consent record.

  • revisionobject

    One saved version of a record (a data agreement, a policy, a consent record or a data disclosure agreement). Each change makes a new revision. The revision holds the record as JSON and a SHA-1 hash of the snapshot, and it links to the hash of the revision before it, so that you can detect a changed history. Only successorId changes after the server saves a revision.