---
title: "Get sandbox bank frontend config"
method: GET
path: "/banks/current/frontend-config"
tags: ["Banks"]
---

# Get sandbox bank frontend config

`GET /banks/current/frontend-config`

## Request

- Base URL: `https://platform-api.homejourney.sg/v1`
- URL: `https://platform-api.homejourney.sg/v1/banks/current/frontend-config`
- Auth: HTTP bearer

Returns the deterministic sandbox bank frontend configuration when the authenticated automation client has `banks.frontends.read`. External URL: `/v1/banks/current/frontend-config`. Current Next.js implementation path: `/api/platform/v1/banks/current/frontend-config`. This read-only route does not require `Idempotency-Key`; it returns public browser-safe frontend metadata only and never exposes bank secrets, raw MyInfo, credit bureau data, bank statements, raw document contents, NRIC/FIN, income-proof documents, full financial profile data, callback signing secrets, staff write controls, provider calls, or enterprise ingress claims. Live bank frontend config remains unavailable until promotion gates have REST, consent, audit, sandbox, callback, and operations evidence. Bank pilot posture remains information/referral and pre-approval only, recommendation and live bank-decision claims remain deferred, and partner-status publication remains private-first.

## Headers

- `X-Correlation-Id` string

## Response `200`

Sandbox bank frontend configuration.

- PlatformBankFrontendConfigResponse
  - `frontend_config` PlatformBankFrontendConfig, required
    - `id` string, required
    - `sandbox_fixture_id` string, required
    - `display_name` string, required
    - `environment` 'sandbox', required
    - `supported_deployment_modes` PlatformBankFrontendDeployment[], required
      - `mode` 'bank_hosted_frontend' | 'homejourney_hosted_white_label', required
      - `sandbox_fixture_id` string, required
      - `enabled` true, required
      - `status` 'sandbox_ready', required
      - `public_config_only` true, required
      - `route_prefix` string, required
    - `widget_security` PlatformBankWidgetSecurity, required
      - `signed_widget_id_required` true, required
      - `allowed_origins_required` true, required
      - `scoped_cors_required` true, required
      - `allowed_origins` string[], required
      - `bank_secrets_in_browser_config` false, required
    - `consent` PlatformBankFrontendConsentBoundary, required
      - `consent_text_version` string, required
      - `data_categories` PlatformBankFrontendDataCategory[], required
      - `purpose` 'mortgage_application_or_refinance_assessment', required
      - `expiry_required` true, required
      - `revocation_supported` true, required
      - `raw_myinfo_exposed` false, required
      - `full_financial_profile_exposed` false, required
    - `staff_boundary` PlatformBankFrontendStaffBoundary, required
      - `borrower_token_staff_actions_allowed` false, required
      - `partner_identity_required` true, required
      - `supported_roles` PlatformBankFrontendStaffRole[], required
    - `document_manifest_boundary` PlatformBankDocumentManifestBoundary, required
      - `signed_handoff_url_required` true, required
      - `raw_document_contents_exposed` false, required
      - `income_proof_exposed` false, required
      - `bank_statement_exposed` false, required
      - `credit_bureau_data_exposed` false, required
      - `nric_fin_exposed` false, required
    - `callback_contract` PlatformBankCallbackContract, required
      - `signed_payload_required` true, required
      - `replay_protection_required` true, required
      - `idempotency_keys_required` true, required
      - `callback_delivery_enabled` false, required
      - `supported_events` string[], required
    - `enterprise_ingress` PlatformBankEnterpriseIngress, required
      - `mtls` 'deferred', required
      - `ip_allowlist` 'deferred', required
      - `private_ingress` 'deferred', required
      - `api_gateway_custom_domain` 'deferred', required
      - `tofu_required` true, required
    - `data_minimization` PlatformBankDataMinimizationBoundary, required
      - `raw_myinfo_exposed` false, required
      - `credit_bureau_data_exposed` false, required
      - `bank_statement_exposed` false, required
      - `raw_document_contents_exposed` false, required
      - `nric_fin_exposed` false, required
      - `income_proof_exposed` false, required
      - `bank_secrets_exposed` false, required
    - `side_effects` PlatformBankSandboxSideEffects, required
      - `live_callback_sent` false, required
      - `email_sent` false, required
      - `sms_sent` false, required
      - `whatsapp_sent` false, required
      - `document_link_sent` false, required
      - `bank_system_write_performed` false, required
      - `payment_event_created` false, required
      - `production_webhook_sent` false, required
    - `livemode` false, required
    - `updated_at` string, date-time, required
  - `frontend_boundary` PlatformBankFrontendBoundary, required
    - `sandbox_only` true, required
    - `live_promotion_required` true, required
    - `financial_conduct_boundary_enforced` true, required
    - `advice_like_recommendations_deferred` true, required
    - `live_bank_decisioning_deferred` true, required
    - `bank_secrets_redacted` true, required
    - `raw_borrower_data_redacted` true, required
    - `staff_actions_deferred` true, required
    - `callback_delivery_deferred` true, required
    - `document_handoff_deferred` true, required
    - `enterprise_ingress_deferred` true, required
    - `private_pilot_status_posture` 'private_first', 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)