Corgi BankDocumentation
OpenAPI

Create a contingency funding scenario

POST/reporting/contingency-funding/scenarios

Requires verified staff reporting:write with fresh step-up; exact-input and actor-bound idempotency. A scenario version fixes the stress event, 1–30 daily and 1–10 intramonth buckets ending no later than day 31, 1–5 severities, a role for each GL (cash, marketable_security, deposit, advance, other_liability or excluded) with an explicit haircut and available day or a nondecreasing cumulative runoff per bucket and severity, a lendable-value haircut and available day per register lender kind and severity, and 1–50 early-warning indicators with reviewed thresholds, owners and actions. A version that supersedes another names an independently approved version of the same name that no approved version already supersedes, so the versions of a scenario form one chain (conflict otherwise). No regulatory threshold is supplied by the service.

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

classesarray of objectsRequired
5 child attributes
assumptionsarray of objectsRequired
5 child attributes
available_dayinteger or nullOptional
cumulative_runoff_bpsarray of integersOptional
evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes
referencestringRequired
sha256stringRequired
haircut_bpsinteger or nullOptional
severitystringRequired
evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes
referencestringRequired
sha256stringRequired
gl_codestringRequired
rolestringRequired
treatmentstringRequired
daily_daysintegerRequired

One bucket for each calendar day 1..daily_days

event_descriptionstringRequired
event_kindstringRequired

Institution_specific, market_wide or combined

evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes
referencestringRequired
sha256stringRequired
indicatorsarray of objectsRequired
8 child attributes
actionstringRequired
evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes
referencestringRequired
sha256stringRequired
keystringRequired
metricstringRequired
ownerstringRequired
severitystringOptional
thresholdinteger or nullOptional
triggerstringRequired

Below or above

intramonth_end_daysarray of integersRequired

Then buckets ending on these days, the last no later than day 31

lendersarray of objectsRequired
6 child attributes
available_dayinteger or nullOptional
evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes
referencestringRequired
sha256stringRequired
lendable_haircut_bpsinteger or nullOptional
lender_kindstringRequired
severitystringRequired
treatmentstringRequired
methodologystringRequired
namestringRequired
severitiesarray of objectsRequired
3 child attributes
descriptionstringRequired
evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes
referencestringRequired
sha256stringRequired
keystringRequired
supersedesstringOptional

Returns

200 OK

The Contingency Funding Scenario object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close