Create a capital run
/reporting/capital/runsRequires verified staff reporting:write with fresh step-up. Exact-input and actor-bound idempotency. Runs require an independently approved effective policy and the exact tied closing of a calendar quarter end or, with measurement month_end, of a quarter's first or second calendar month-end (a month-end that is not a Federal Reserve banking day is measured on the closing of the last banking day before it, recorded in the result as closing_date with carried true, as 12 CFR 327.5(a)(1) uses the previous business day's amounts for a closed day); a month-end run carries no quarter average, leverage deduction, consolidation or trading input and reports tier 1 capital and risk-based ratios without a leverage ratio or CBLR screen, for Schedule RC-O item 5. Every core asset/contra-asset and equity/income/expense balance must reconcile to explicitly classified or excluded allocations. Risk weights, conversion factors, capital eligibility adjustments, off-balance inclusion, whole-quarter average assets and consolidation are evidenced, never inferred from product labels. Undefined denominators are not reported as zero or a passing ratio. Outputs are a reviewed standardized capital workpaper and current CBLR criteria screen, not a filing or regulatory/PCA compliance decision; CBLR election and grace history remain in the governed Call Report workflow.
Headers
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
as_ofstring · dateRequiredA business date, YYYY-MM-DD
componentsarray of objectsRequired7 child attributes
book_amountintegerRequiredbucketstringRequiredCet1, additional_tier1, tier2, allowance, excluded
evidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredgl_codestringOptionalidstringRequiredregulatory_amountintegerRequiredtreatmentstringRequiredcoverage_evidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequireddeductionsarray of objectsRequired5 child attributes
amountintegerRequiredbucketstringRequiredCet1, additional_tier1, tier2
evidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredidstringRequiredtreatmentstringRequireddenominatorsobjectRequiredAverageAssets is an evidenced whole-calendar-quarter average prepared under the applicable Call Report instructions. A closing balance is never substituted.
8 child attributes
additional_credit_rwaobjectRequired3 child attributes
amountinteger or nullOptionalevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredtreatmentstringRequiredaverage_assetsobjectRequired3 child attributes
amountinteger or nullOptionalevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredtreatmentstringRequiredaverage_fromstring · dateRequiredA business date, YYYY-MM-DD
average_throughstring · dateRequiredA business date, YYYY-MM-DD
consolidation_adjustmentobjectRequired3 child attributes
amountinteger or nullOptionalevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredtreatmentstringRequiredleverage_deductionsobjectRequired3 child attributes
amountinteger or nullOptionalevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredtreatmentstringRequiredmarket_rwaobjectRequired3 child attributes
amountinteger or nullOptionalevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredtreatmentstringRequiredtrading_assets_and_liabilitiesobjectRequired3 child attributes
amountinteger or nullOptionalevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredtreatmentstringRequiredeligibilityobjectRequired4 child attributes
advanced_approachesboolean or nullOptionalcblr_election_reportedboolean or nullOptionalevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredsupervisory_restrictionboolean or nullOptionalexposuresarray of objectsRequired8 child attributes
book_amountintegerRequiredevidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredexcludedbooleanRequiredgl_codestringOptionalidstringRequiredregulatory_exposure_amountintegerRequiredrisk_classstringOptionaltreatmentstringRequiredmeasurementstringOptionalOmitted for a quarter-end run; month_end at a quarter's first or second month-end
off_balancearray of objectsRequired6 child attributes
cblr_includedboolean or nullOptionalNotional inclusion under 3.12, distinct from risk-based CCF
evidenceobjectRequiredEvidence binds externally prepared inputs and assumptions to retained documentation.
2 child attributes
referencestringRequiredsha256stringRequiredidstringRequirednotional_amountintegerRequiredrisk_classstringRequiredtreatmentstringRequiredpolicy_idstringRequiredrationalestringRequiredReturns
200 OK
The Capital Run object.
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503