Skip to main content
Verification

List data agreements for verification

GET/v4/service/consent/verification/data-agreements

Lists the published data agreements of the organisation, as at their latest revision, one page at a time. Use it in a backend that checks consent before it processes or shares data. Give revisionId to get only the data agreement as it was at that revision.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:consent-records:read

Query parameters

  • offsetinteger

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

  • 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

One page of published data agreements.

  • dataAgreementsobject[] | null

    The data agreements of this page. null, not an empty list, when there is none.

  • paginationobject