Consent and data sharing

List recipient-scoped document shares

Returns the document shares where the authenticated organization is the recipient. Requires document_shares.read. External URL: /v1/document-shares. Current Next.js implementation path: /api/platform/v1/document-shares. This read-only route does not require Idempotency-Key; manifest metadata only, never raw documents or storage paths.

get/document-shares

Request

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

Query parameters

grant_idstring uuid

Optional grant filter (must be recipient-owned).

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Recipient-scoped document shares.

livemodeboolean required
request_idstring required

Changes

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