GEgetaxonflow
US Banking Compliance

US banking examination readiness

Answers "if I generate the US banking examination package now, what will be in it and what will it have to disclose?" WITHOUT creating a report job.

It returns COUNTS, PRESENCE and DISCLOSURES, never evidence rows. The rows come from the compliance report facade (POST /api/v1/compliance/reports with regulator=usbanking) and only from there, so this is not a second export path.

It exists because the facade cannot answer this question: asking it means creating a job, spending one of an Evaluation tier's three daily reports, and waiting on an async render, purely to learn whether the package is worth generating.

SCOPE: the summary covers the requesting TENANCY. Every source it reads is tenancy-keyed, and audit_logs.org_id is nullable, so an organization-wide count would silently omit records (ADR-063 section 4). The unattributed_records source reports exactly the population an organization-wide report would have dropped.

AUTHORITY: gated on tenant-wide read authority, the same gate as the evidence and compliance exports. It returns aggregates rather than rows, but an aggregate over audit_logs still describes whole-tenant activity.

Enterprise Feature. Community builds register no route (404).

get/api/v1/usbanking/exam-readiness

Request

Response

Examination readiness summary

tenant_idstring

The tenancy this summary covers.

window_daysinteger

The lookback the counts are taken over. One quarter, because that is the shortest cadence any instrument in scope sets (12 CFR Part 609 quarterly board reporting), so the window always covers at least one full cycle for the tighter profile.

period_startstring date-time
period_endstring date-time
scopestring

One sentence stating the report's tenancy boundary. Every count is meaningless without it.

disclosuresstring[]

The sentences every generated artifact carries. Returned here so nothing in a package is a surprise at the point it reaches an examiner, and served from the same source the artifact renders from, so the two cannot say different things.

generated_atstring date-time

Example response

{
  "window_days": 90
}

Changes

No recorded changes to this operation across all 1 revision of this API.