Onboarding

Inspect the current onboarding contract envelope

Returns the redacted current contract-envelope state for the authenticated platform organization. External URL: /v1/onboarding/contracts/envelopes/current. Current Next.js implementation path: /api/platform/v1/onboarding/contracts/envelopes/current. This read-only route does not require Idempotency-Key; it exposes provider-neutral contract state, commercial gate readiness, and evidence-presence booleans without raw documents, signer private details, signing-provider payloads, or credential creation.

get/onboarding/contracts/envelopes/current

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/onboarding/contracts/envelopes/current
  • Auth: HTTP bearer

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Current onboarding contract-envelope state.

livemodeboolean required
request_idstring required

Changes

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