Analyze partner bank data without importing bank records

POST/api/v1/credit/bank-analysis

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.

Operation ID: analyze_credit_bank_snapshot·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: BankAnalysisRequest

program_idstringrequired

Your lending program UUID.

external_merchant_idstringrequired

Your merchant identifier, bound server-side to its source organization or dataset.

source_modestringrequired

Explicit opt-in to temporary Tie API or direct BigQuery analysis.

One of: tie_api_transient, bigquery_transient

start_datestring · daterequired

Inclusive window start; at most 366 days.

end_datestring · daterequired

Inclusive window end, no later than today UTC.

Responses

200Successful Response

Schema: SuccessEnvelope_BankAnalysisResponse_

successboolean
messagestring
codestring
dataBankAnalysisResponse

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

Schema: ErrorResponse

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

403Forbidden - Insufficient permissions

Schema: ErrorResponse

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

404Not Found - Resource does not exist

Schema: ErrorResponse

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

422Validation Error - Request body or parameters failed validation

Schema: ErrorResponse

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

Code samples

POST/api/v1/credit/bank-analysis

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"
}'