Consent History API (2025-04-06)

Download OpenAPI specification:

GetHistoryForServiceUser

Retrieve history for a given service user.

path Parameters

serviceId required	string^[\w\-\.]{3,128}$ Unique identifier for a service.
userId required	string^[\w\-\.]{3,128}$ Unique identifier for a user.

Responses

Response samples

200
404
500

Content type

application/json

{"data": [{"consentId": "string",
"history": [{"consentId": "string",
"eventId": "string",
"eventTime": "2019-08-24T14:15:22Z",
"eventType": "INSERT",
"oldImage": {"consentId": "string",
"consentVersion": 0,
"userId": "string",
"serviceId": "string",
"status": "ACTIVE",
"consentType": "string",
"consentData": {"property1": "string",
"property2": "string"
},
"expiryTime": "2019-08-24T14:15:22Z"
},
"newImage": {"consentId": "string",
"consentVersion": 0,
"userId": "string",
"serviceId": "string",
"status": "ACTIVE",
"consentType": "string",
"consentData": {"property1": "string",
"property2": "string"
},
"expiryTime": "2019-08-24T14:15:22Z"
}
}
]
}
]
}

GetHistoryForServiceUserConsent

Retrieve history for a given service user consent.

path Parameters

consentId required	string^[\w\-\.]{3,128}$ Unique identifier for a Consent.
serviceId required	string^[\w\-\.]{3,128}$ Unique identifier for a service.
userId required	string^[\w\-\.]{3,128}$ Unique identifier for a user.

Responses

Response samples

200
404
500

Content type

application/json

{"data": [{"consentId": "string",
"eventId": "string",
"eventTime": "2019-08-24T14:15:22Z",
"eventType": "INSERT",
"oldImage": {"consentId": "string",
"consentVersion": 0,
"userId": "string",
"serviceId": "string",
"status": "ACTIVE",
"consentType": "string",
"consentData": {"property1": "string",
"property2": "string"
},
"expiryTime": "2019-08-24T14:15:22Z"
},
"newImage": {"consentId": "string",
"consentVersion": 0,
"userId": "string",
"serviceId": "string",
"status": "ACTIVE",
"consentType": "string",
"consentData": {"property1": "string",
"property2": "string"
},
"expiryTime": "2019-08-24T14:15:22Z"
}
}
]
}