Consent and data sharing

Revoke a recipient-held document share

Revokes a document share the recipient holds, blocking future handoff URL issuance. Requires document_shares.write. External URL: /v1/document-shares/{shareId}/revoke. Current Next.js implementation path: /api/platform/v1/document-shares/[shareId]/revoke. This mutating route requires Idempotency-Key. Share-level revocation does not revoke the parent grant.

post/document-shares/{shareId}/revoke

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/document-shares/{shareId}/revoke
  • Auth: HTTP bearer

Path parameters

shareIdstring uuid required

Document share 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 revoked document share.

livemodeboolean required
request_idstring required

Changes

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