Onboarding

Inspect onboarding readiness

Returns the headless service-provider sandbox onboarding readiness contract for the authenticated platform organization. External URL: /v1/onboarding/readiness. Current Next.js implementation path: /api/platform/v1/onboarding/readiness. This read-only route does not require Idempotency-Key; mutating credential, signing, live-access, mortgage, conveyancing, and marketplace actions remain blocked or manual-reviewed.

get/onboarding/readiness

Request

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

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Current onboarding readiness and action contract.

livemodeboolean required
request_idstring required

Changes

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