---
title: "Check sandbox bank eligibility"
method: POST
path: "/banks/current/eligibility"
tags: ["Banks"]
---

# Check sandbox bank eligibility

`POST /banks/current/eligibility`

## Request

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

Returns deterministic sandbox eligibility-summary metadata when the authenticated automation client has `banks.eligibility.read`. External URL: `/v1/banks/current/eligibility`. Current Next.js implementation path: `/api/platform/v1/banks/current/eligibility`. This deterministic sandbox check does not require `Idempotency-Key` because it performs no writes, provider calls, live quote generation, application creation, callback delivery, or document handoff. It returns eligibility summary, consent metadata, redaction boundaries, and blocked side effects only and never exposes bank secrets, raw MyInfo, credit bureau data, bank statements, raw document contents, NRIC/FIN, income-proof contents, full financial profile data, borrower-specific pricing, signed storage URLs, callback signing secrets, provider calls, or enterprise ingress claims. Live bank eligibility 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

## Request body

- PlatformBankEligibilityRequest: Sandbox-only eligibility check selector. Omit borrower_fixture_id to use the eligible sandbox borrower fixture.
  - `borrower_fixture_id` 'eligible_borrower' | 'ineligible_borrower'

## Response `200`

Sandbox bank eligibility summary.

- PlatformBankEligibilityResponse
  - `eligibility` PlatformBankEligibilitySummary, required
    - `id` string, required
    - `sandbox_fixture_id` 'eligible_borrower' | 'ineligible_borrower', required
    - `result` 'eligible' | 'ineligible', required
    - `safe_display_label` string, required
    - `eligible_product_codes` string[], required
    - `maximum_loan_amount_sgd` integer, required
    - `minimum_cash_downpayment_percent` number, required
    - `next_action` 'continue_application' | 'review_financing_options', required
    - `consent_text_version` string, required
    - `raw_borrower_data_exposed` false, required
    - `livemode` false, required
    - `updated_at` string, date-time, required
  - `eligibility_boundary` PlatformBankEligibilityBoundary, required
    - `sandbox_only` true, required
    - `eligibility_summary_only` 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_myinfo_redacted` true, required
    - `full_financial_profile_redacted` true, required
    - `credit_bureau_data_redacted` true, required
    - `bank_statement_contents_redacted` true, required
    - `raw_document_contents_redacted` true, required
    - `borrower_personal_identifiers_redacted` true, required
    - `borrower_specific_pricing_deferred` true, required
    - `live_quote_generation_deferred` true, required
    - `application_create_deferred` true, required
    - `callback_delivery_deferred` true, required
  - `consent` PlatformBankEligibilityConsent, required
    - `consent_text_version` string, required
    - `data_category` 'eligibility_summary', required
    - `purpose` 'mortgage_application_or_refinance_assessment', required
    - `consent_text_version_required` true, required
    - `raw_myinfo_exposed` false, required
    - `full_financial_profile_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
  - `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)