Skip to main content
Agreement records

Read data disclosure agreement record

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

Reads a data disclosure agreement record of your organisation in its current state, with its latest revision. The current state can have only one signature while the parties sign.

Give the template revision that the record is based on (dataDisclosureAgreementTemplateRevision.id of the record) and the record id.

Errors: 404 when the template revision or the record does not exist, or when the record is not based on that template revision.

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 a revision of the template.

  • dataDisclosureAgreementRecordIdstringrequired

    ID of the data disclosure agreement record (id).

Response

application/json

The record and its latest 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.