Skip to main content
Agreement records

Read data disclosure agreement record revision

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

Reads one revision of a data disclosure agreement record: the record as it was at that revision. The service makes a revision each time a party signs, opts in or opts out. Use it to prove which terms and signatures were valid at a given time.

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

Errors: 404 when the revision does not exist.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:data-space:read

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

  • dataDisclosureAgreementRecordRevisionIdstringrequired

    ID of a revision of the record.

Response

application/json

The record as it was at the revision, and the revision.

  • dataDisclosureAgreementRecordobject

    A data disclosure agreement between a data source and a data using service, based on one revision of a published template. Both organisations keep a copy with the same canonicalId. The record comes into being in an OpenID4VP exchange between the two organisation wallets: the data source sends the record as transaction data, and each party signs it with a key binding JWT. Data can flow only when both signatures are there and optIn is true.

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