Consent and data sharing

Relinquish a recipient-held grant

Lets the recipient organization relinquish a data-sharing grant it holds, failing closed across all access paths. Requires consents.write. External URL: /v1/consents/{consentId}/revoke. Current Next.js implementation path: /api/platform/v1/consents/[consentId]/revoke. This mutating route requires Idempotency-Key. Partner API keys can never create or extend user consent; revocation here is recorded with a partner_api source.

post/consents/{consentId}/revoke

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/consents/{consentId}/revoke
  • Auth: HTTP bearer

Path parameters

consentIdstring uuid required

Data-sharing grant identifier.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

reasonstring

Response

The relinquished grant.

livemodeboolean required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.