Consent and data sharing

Inspect one recipient-scoped grant

Returns one data-sharing grant where the authenticated platform organization is the recipient. Requires consents.read. External URL: /v1/consents/{consentId}. Current Next.js implementation path: /api/platform/v1/consents/[consentId]. This read-only route does not require Idempotency-Key; grants owned by other organizations return 404.

get/consents/{consentId}

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/consents/{consentId}
  • 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.

Response

One recipient-scoped grant.

livemodeboolean required
request_idstring required

Changes

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