Read consent record

GET 
/service/individual/record/data-agreement/:dataAgreementId

This endpoint is used to read a consent record for an individial for a chosen data agreement. There should be one unambiguous consent record for an individual.

Request

Path Parameters

dataAgreementId stringrequired

Unique ID of an object

Header Parameters

X-ConsentBB-IndividualId stringrequired

Individual Id

Responses

200

Response Headers

application/json

Schema

Schema

consentRecord object
A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)
id stringrequired
Objects may be passed back by some API endpoints without an id (PK), denoting that they are a "draft", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated.
dataAgreementId string
The DataAgreement to which consent has been given
dataAgreementRevisionId string
The Revision of the data agreement which consent has been given to
dataAgreementRevisionHash string
Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement.
individualId string
The Individual who has signed this consent record
optIn boolean
True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent).
state stringrequired
Possible values: [unsigned, signed]
The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed
signatureId string
A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?
sectorPreferences object[]
Array [
sector stringrequired
Name of the sector
optIn boolean
Defines sector is opted in or not
isLastUpdated boolean
Defines consent record for this sector is last updated
]

Example (from schema)

{
  "consentRecord": {
    "id": "",
    "dataAgreementId": "string",
    "dataAgreementRevisionId": "string",
    "dataAgreementRevisionHash": "",
    "individualId": "string",
    "optIn": "",
    "state": "",
    "signatureId": "string",
    "sectorPreferences": [
      {
        "sector": "",
        "optIn": true,
        "isLastUpdated": true
      }
    ]
  }
}

400

bad input parameter

Response Headers

Loading...