---
title: "List onboarding contract packages"
method: GET
path: "/onboarding/contracts/packages"
tags: ["Onboarding"]
---

# List onboarding contract packages

`GET /onboarding/contracts/packages`

## Request

- Base URL: `https://platform-api.homejourney.sg/v1`
- URL: `https://platform-api.homejourney.sg/v1/onboarding/contracts/packages`
- Auth: HTTP bearer

Returns the canonical onboarding contract package catalog used by readiness, partner-submitted contract evidence, and admin commercial approval gates. External URL: `/v1/onboarding/contracts/packages`. Current Next.js implementation path: `/api/platform/v1/onboarding/contracts/packages`. This read-only route does not require `Idempotency-Key`; it exposes package capabilities and blocked claims for humans, SDKs, CLIs, MCP servers, and AI agents without launching signing sessions or creating credentials.

## Headers

- `X-Correlation-Id` string

## Response `200`

Registered onboarding contract packages.

- PlatformContractPackageCatalogResponse
  - `packages` object[], required
    - `id` string, required
    - `version` string, required
    - `display_name` string, required
    - `status` 'active' | 'draft' | 'deprecated' | 'retired' | 'unregistered', required
    - `target_actor` 'service_provider' | 'bank_partner' | 'conveyancing_firm' | 'agent_agency' | 'advertiser' | 'landlord_owner', required
    - `allowed_environments` string[], required
    - `sandbox_terms_rail` 'clickwrap' | 'sign_with_singpass' | 'digital_signing_partner' | 'manual_review', required
    - `allowed_signing_rails` string[], required
    - `required_authority_sources` string[], required
    - `allowed_commercial_package_ids` string[], required
    - `default_commercial_package_id` 'sandbox_developer' | 'pilot_partner_api' | 'production_partner_api' | 'business_directory_advertiser_self_serve' | 'business_directory_advertiser_managed' | 'enterprise_bank_api' | 'internal_first_party', required
    - `allowed_live_scopes` string[], required
    - `requires_business_authority` boolean, required
    - `countersignature_required` boolean, required
    - `signing_session_available` boolean, required
    - `blocks_live_credentials_without_commercial_approval` true, required
    - `ai_agent_summary` string, required
    - `blocked_claims` string[], required
    - `source_spec` 'docs/features/platform/PLATFORM_CONTRACT_SIGNING_AND_COMMERCIAL_TERMS_SPEC.md', required
  - `default_package` object, required
    - `id` 'platform_service_provider_terms', required
    - `version` '2026.06', required
  - `livemode` false, required
  - `request_id` string, required

## Other responses

- `400`: Request validation failed.
- `401`: Missing or invalid platform API key.
- `403`: Credential, environment, or scope is not allowed.
- `404`: Platform API feature or resource is not available.
- `429`: Rate limit exceeded.
- `500`: Unexpected platform API failure.

---

[API](https://skmtc.dev/homejourney/apis/homejourney-platform-api.md) · [All operations](https://skmtc.dev/homejourney/apis/homejourney-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/homejourney/apis/homejourney-platform-api/revisions/a2c6fe063db1?raw)