Skip to main content
Verification

Read consent record for verification

GET/v4/service/consent/verification/consent-record/{consentRecordId}

Reads a consent record of any individual of the organisation, with its latest revision. Use it in a backend to check the current consent before you process the data: optIn says if the individual allows it, and state says if the record is signed.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:consent-records:read

Path parameters

  • consentRecordIdstringrequired

    Consent record ID.

    Example:"6af081ea2d6fb7b6ac6efc71"

Response

application/json

The consent record and its latest revision.

  • consentRecordobject

    The consent of one individual to one data agreement. An individual has at most one consent record for each data agreement. Each change makes a new revision of the 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.