Consent Requests

Update Consent Request State For Current Data Producer

Updates the status of a specific consent request. Only accessible to the data producer assigned to the consent request.

put/api/agreement/v1/consent-requests/{id}/status

Path parameters

idstring uuid required

ID of the consent request

Request body

'GRANTED' | 'OPENED' | 'DECLINED' | 'LEGALLY_PERMITTED' | 'NOT_CREATED' required

Possible states of a consent request:

GRANTED: Consent has been granted
OPENED: Consent request is open and awaiting response
DECLINED: Consent has been declined
NOT_CREATED: Placeholder to indicate that no consent request exists yet for a given UID.

Response

No Content

Changes

Changed in 8 of the 57 revisions of this API.184

Jun 4, 2026d1729646b7662See the full diff
- ●
  added the new DATA_PROVIDER_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new DATA_PROVIDER_ERROR enum value to the response property for the response status
  response-property-enum-value-added
May 29, 2026a598446f80932See the full diff
- ○
  removed the DATA_PROVIDER_ERROR enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the DATA_PROVIDER_ERROR enum value from the response property for the response status
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 26, 20267cee7b14bf6f2See the full diff
- ●
  added the new DATA_PROVIDER_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new DATA_PROVIDER_ERROR enum value to the response property for the response status
  response-property-enum-value-added
May 12, 20265b038eea902d8See the full diff
- ●
  added the new OTP_EXPIRED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OTP_EXPIRED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OTP_INVALID enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OTP_INVALID enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OTP_LOCKED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OTP_LOCKED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OTP_RESEND_COOLDOWN enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OTP_RESEND_COOLDOWN enum value to the response property for the response status
  response-property-enum-value-added
Feb 9, 20260d45567e16a82See the full diff
- ●
  added the new CONSENT_NOT_GRANTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new CONSENT_NOT_GRANTED enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 27, 20253026a580bab42See the full diff
- ●
  added the new MAINTENANCE enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new MAINTENANCE enum value to the response property for the response status
  response-property-enum-value-added
Oct 6, 20251dcf6d02a6152See the full diff
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
Aug 12, 2025fc4bd0a842822See the full diff
- ●
  added the new EXTERNAL_SERVICE_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new EXTERNAL_SERVICE_ERROR enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 54 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history