# POST /api/v1/credit/bank-analysis

> Analyze partner bank data without importing bank records

- **Tag:** credit
- **Operation ID:** `analyze_credit_bank_snapshot`

## Description

Read the configured source and return provisional cash movements.

**Prerequisites:** Server-configured lender, program/merchant binding,
and either Tie service credentials or a trusted BigQuery dataset/identity binding.

**Returns:** Safe aggregates and evidence fingerprints. `unavailable`
carries a fixed error code. Source v1 does not attest history/freshness,
so underwriting measures remain unmeasured. Cash inflows are not revenue.

**Note:** Explicit `tie_api_transient` or `bigquery_transient` mode is required. Existing
ledger-backed assessment defaults are unchanged. This endpoint neither
saves an assessment nor applies approval policy or opens loans. Replay
is not exposed. Direct BigQuery returns aggregate-only results; raw data is
never copied into query result tables or retained here.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Request body

Schema: `BankAnalysisRequest`

- `program_id` (string · required) — Your lending program UUID.
- `external_merchant_id` (string · required) — Your merchant identifier, bound server-side to its source organization or dataset.
- `source_mode` (string · required) (one of: tie_api_transient, bigquery_transient) — Explicit opt-in to temporary Tie API or direct BigQuery analysis.
- `start_date` (string · date · required) — Inclusive window start; at most 366 days.
- `end_date` (string · date · required) — Inclusive window end, no later than today UTC.

## Responses

### 200 — Successful Response

Schema: `SuccessEnvelope_BankAnalysisResponse_`

- `success` (boolean)
- `message` (string)
- `code` (string)
- `data` (BankAnalysisResponse)

### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 403 — Forbidden - Insufficient permissions

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 404 — Not Found - Resource does not exist

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 422 — Validation Error - Request body or parameters failed validation

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

## Code samples

### cURL

```bash
curl -X POST 'https://api.ondayzero.com/api/v1/credit/bank-analysis' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "program_id": "string",
  "external_merchant_id": "string",
  "source_mode": "tie_api_transient",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01"
}'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/credit/bank-analysis', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "program_id": "string",
  "external_merchant_id": "string",
  "source_mode": "tie_api_transient",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01"
}),
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {'program_id': 'string',
 'external_merchant_id': 'string',
 'source_mode': 'tie_api_transient',
 'start_date': '2026-01-01',
 'end_date': '2026-01-01'}

response = httpx.post("https://api.ondayzero.com/api/v1/credit/bank-analysis", headers=headers, json=payload)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/credit/analyze-credit-bank-snapshot
- OpenAPI slice: https://www.ondayzero.com/docs/reference/credit/analyze-credit-bank-snapshot/openapi.json
- Other endpoints in **credit**: https://www.ondayzero.com/docs/reference/credit (markdown bundle: https://www.ondayzero.com/docs/reference/credit.md, OpenAPI: https://www.ondayzero.com/docs/reference/credit/openapi.json)
- Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md