Skip to main content
Data Policy

Read data policy

GET/v4/service/consent/policy/{policyId}

Reads a data policy of the organisation and its latest revision. Give revisionId to get that revision instead. The policy member is always the current policy.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:data-agreements:read

Path parameters

  • policyIdstringrequired

    Policy ID.

    Example:"6af080a42d6fb7b6ac6efc54"

Query parameters

  • 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

The data policy and the revision.

  • policyobject

    A data policy: the privacy policy and the processing rules under which the organisation processes the data. Each update makes a new revision and raises the major version.

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