Onboarding

Accept current sandbox onboarding terms

Records sandbox clickwrap-style acceptance for the current service-provider platform terms package and returns the refreshed onboarding readiness contract. External URL: /v1/onboarding/terms/acceptance. Current Next.js implementation path: /api/platform/v1/onboarding/terms/acceptance. This sandbox-only mutating route requires Idempotency-Key and does not create API credentials, launch contract signing, or request live access; live terms promotion remains blocked.

post/onboarding/terms/acceptance

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/onboarding/terms/acceptance
  • 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

accepted_termstrue required

Explicit acknowledgement that the caller accepts the named terms package.

terms_package_id'platform_service_provider_terms' required
terms_version'2026.06' required

Response

Terms acceptance evidence and refreshed readiness contract.

idempotency_key_hashstring required
livemodefalse required
request_idstring required

Changes

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