Consent and data sharing

Create a document share against an owned grant

Creates a high-risk document share anchored to an active grant the recipient holds. Requires document_shares.write. External URL: /v1/document-shares. Current Next.js implementation path: /api/platform/v1/document-shares. This mutating route requires Idempotency-Key. Shares carry manifest metadata and a short-lived handoff TTL only; raw documents, storage paths, and permanent URLs are never accepted or returned.

post/document-shares

Request

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

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

grant_idstring uuid required
document_labelstring required
data_category'loan_application_documents' | 'bank_documents' | 'law_firm_document_manifest' | 'regulated_documents' | 'payment_or_payout_status' | 'support_history' required
manifest_summaryobject required
expires_atstring date-time required
retention_untilstring date-time required
purposestring
handoff_url_ttl_secondsinteger
metadataobject

Response

Created document share.

livemodeboolean required
request_idstring required

Changes

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