Changelog

Keep track of every change to the Adatree Consent API

This changelog lists all additions and updates to the Adatree Consent APIs, in reverse chronological order.

Return 422 status code from DELETE /consents/{consentId} when revoking an inactive consent as there is no authorised consent to be deleted on the data-holder side

Add new endpoint get /consents/v2:
- Replaces get /consents with added support for pagination.
- Supports additional query parameters.
Mark get /consents as deprecated.

patch /consents/{consentId}/authorization endpoint changes:
- Updated success response to return 200 instead of 201
- Add 400 response for invalid response JWT payloads
- Mark ConsentActivatedResponse model success property as deprecated
post /consents/{consentId}/authorization endpoint changes:
- Mark ConsentAuthorization model success property as deprecated

Add new endpoint post /consents/{consentId}/authorization to
- replace get /consents/{consentId}/authorization for consent creation
- support consent extension
Add new endpoint patch /consents/{consentId}/authorization to complete consent creation or extension
- replace post /tokens for consent creation
- support consent extension
Mark post /tokens as deprecated
Mark get /consents/{consentId}/authorization as deprecated

Add new enum EXTENDED to /consents/events endpoint response. This new event type a consent was successfully extended
Add new enum WEBHOOK_SENT to /consents/events endpoint response. This new event type indicates a webhook was successfully sent
Add new enum WEBHOOK_SENDING_FAILED_CLIENT_ERROR to /consents/events endpoint response. This new event type indicates a webhook failed to send a webhook because of an error with the target API
Add new enum WEBHOOK_SENDING_FAILED to /consents/events endpoint response. This new event type indicates a webhook failed to send a webhook because of an unspecified error
Add new nullable field eventDetail to /consents/events endpoint response. This new field includes more information about the event in some situations. For example, on WEBHOOK_SENDING_FAILED_CLIENT_ERROR it will show the response message from the target API

Add new enum DATA_COLLECTION_COMPLETED to /consents/events endpoint response. This new event type indicates the completion of initial data collection (configurable)
Add new query parameter consentId to /consents/events endpoint

Add state to /tokens endpoint response. This allows clients that rely on the state parameter to access it when Data Holders encrypt the authorization response parameter.

Add support for Auth Code Flow. Now the /tokens endpoint will accept the response from Data Holder if provided instead of the combination of code, state and id_token for a Hybrid Flow. At the same time, the combination of code, state and id_token is also supported for backward-compatibility with the Hybrid Flow

Add support for the combineScopes query parameter to the /use-cases API. This combines the use case language data clusters that are combinable according to the CDS Experience Standards e.g. Account name, type and balance and Account numbers and features data clusters are combined to Account balance and details resulting in one less click for the consumer on the consent page.