---
title: "Get sandbox bank document manifest"
method: GET
path: "/banks/current/applications/{id}/document-manifest"
tags: ["Banks"]
---

# Get sandbox bank document manifest

`GET /banks/current/applications/{id}/document-manifest`

## Request

- Base URL: `https://platform-api.homejourney.sg/v1`
- URL: `https://platform-api.homejourney.sg/v1/banks/current/applications/{id}/document-manifest`
- Auth: HTTP bearer

Returns deterministic sandbox document-manifest metadata for a bank application when the authenticated automation client has `banks.documents.read`. External URL: `/v1/banks/current/applications/{id}/document-manifest`. Current Next.js implementation path: `/api/platform/v1/banks/current/applications/[id]/document-manifest`. This read-only route does not require `Idempotency-Key`; it returns document requirement, upload, review, consent-category, and redaction metadata 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, signed storage URLs, permanent storage paths, callback signing secrets, provider calls, or enterprise ingress claims. Live bank document manifests remain unavailable until promotion gates have REST, consent, audit, signed handoff, 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.

## Path parameters

- `id` string, required

## Headers

- `X-Correlation-Id` string

## Response `200`

Sandbox bank document manifest.

- PlatformBankDocumentManifestResponse
  - `application` PlatformBankApplicationSummary, required
    - `id` string, required
    - `sandbox_fixture_id` string, required
    - `application_state` 'missing_document' | 'approved' | 'rejected', required
    - `bank_display_name` string, required
    - `borrower_reference` string, required
    - `consent_text_version` string, required
    - `document_manifest_required` true, required
    - `raw_application_data_exposed` false, required
    - `livemode` false, required
    - `updated_at` string, date-time, required
  - `documents` PlatformBankDocumentRequirement[], required
    - `id` string, required
    - `document_type` 'identity_summary' | 'income_notice_summary' | 'property_option_summary' | 'bank_statement_summary', required
    - `requirement_state` 'required' | 'received', required
    - `upload_status` 'missing' | 'received', required
    - `review_status` 'not_started' | 'pending_review' | 'accepted' | 'rejected', required
    - `safe_display_label` string, required
    - `consent_category` 'document_manifest_metadata', required
    - `signed_upload_handoff` PlatformBankDocumentHandoffState, required
      - `available` false, required
      - `reason` 'deferred_until_signed_storage_handoff', required
    - `signed_download_handoff` PlatformBankDocumentHandoffState, required
      - `available` false, required
      - `reason` 'deferred_until_signed_storage_handoff', required
    - `raw_document_contents_exposed` false, required
    - `permanent_storage_path_exposed` false, required
    - `nric_fin_exposed` false, required
    - `income_proof_contents_exposed` false, required
    - `bank_statement_contents_exposed` false, required
    - `livemode` false, required
  - `document_boundary` PlatformBankDocumentManifestReadBoundary, required
    - `sandbox_only` true, required
    - `manifest_metadata_only` true, required
    - `bank_secrets_redacted` true, required
    - `raw_document_contents_redacted` true, required
    - `raw_myinfo_redacted` true, required
    - `credit_bureau_data_redacted` true, required
    - `nric_fin_redacted` true, required
    - `income_proof_contents_redacted` true, required
    - `bank_statement_contents_redacted` true, required
    - `signed_handoff_urls_deferred` true, required
    - `application_write_deferred` true, required
    - `callback_delivery_deferred` true, required
  - `manifest_fixture_id` string, required
  - `document_count` integer, 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)