Create a treasury scenario

POST/reporting/treasury/scenarios

Requires verified staff with reporting:write and authentication within five minutes; service/customer/API-key callers are refused. Idempotency is bound to exact input and actor. Scenarios fix every discount/index curve month and explicit runoff/prepayment/beta/haircut assumptions. Runs require an independently approved scenario, exact tied historical ledger closing, matching modeled or explicitly excluded GL balances, and evidenced complete cash/unsupported-instrument projections. Results are immutable monthly static-runoff analytics, not a regulatory ratio, live funding action or an intramonth liquidity guarantee.

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

assumptionsarray of objectsRequired

8 child attributes

base_monthly_prepayment_bpsinteger or nullOptional

base_monthly_runoff_bpsinteger or nullOptional

deposit_beta_bpsinteger or nullOptional

evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes

referencestringRequired

sha256stringRequired

inflow_haircut_bpsinteger or nullOptional

keystringRequired

stress_monthly_prepayment_bpsinteger or nullOptional

stress_monthly_runoff_bpsinteger or nullOptional

base_curve_bpsarray of integersRequired

base_index_bpsarray of integersRequired

contingency_actionsarray of objectsRequired

5 child attributes

actionstringRequired

evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes

referencestringRequired

sha256stringRequired

idstringRequired

ownerstringRequired

trigger_below_amountintegerRequired

evidenceobjectRequired

Evidence binds externally prepared inputs and assumptions to retained documentation.

2 child attributes

referencestringRequired

sha256stringRequired

horizon_monthsintegerRequired

liquidity_floor_amountinteger or nullOptional

methodologystringRequired

namestringRequired

nii_monthsintegerRequired

stress_curve_bpsarray of integersRequired

stress_index_bpsarray of integersRequired

Returns

200 OK

The Treasury Scenario object.

Errors

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

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/reporting/treasury/scenarios' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "assumptions": [
      {
        "base_monthly_prepayment_bps": 0,
        "base_monthly_runoff_bps": 0,
        "deposit_beta_bps": 0,
        "evidence": {
          "reference": "string",
          "sha256": "string"
        },
        "inflow_haircut_bps": 0,
        "key": "string",
        "stress_monthly_prepayment_bps": 0,
        "stress_monthly_runoff_bps": 0
      }
    ],
    "base_curve_bps": [
      0
    ],
    "base_index_bps": [
      0
    ],
    "contingency_actions": [
      {
        "action": "string",
        "evidence": {
          "reference": "string",
          "sha256": "string"
        },
        "id": "string",
        "owner": "string",
        "trigger_below_amount": 10000
      }
    ],
    "evidence": {
      "reference": "string",
      "sha256": "string"
    },
    "horizon_months": 0,
    "methodology": "string",
    "name": "string",
    "nii_months": 0,
    "stress_curve_bps": [
      0
    ],
    "stress_index_bps": [
      0
    ]
  }'

Response200

{
  "capital_policy": {
    "effective_from": "2026-09-17",
    "effective_through": "2026-09-17",
    "evidence": {
      "reference": "string",
      "sha256": "string"
    },
    "methodology": "string",
    "minimum_cet1_bps": 0,
    "minimum_leverage_bps": 0,
    "minimum_tier1_bps": 0,
    "minimum_total_bps": 0,
    "name": "string",
    "risk_classes": [
      {
        "conversion_factor_bps": 0,
        "evidence": {},
        "key": "string",
        "risk_weight_bps": 0,
        "treatment": "string"
      }
    ]
  },
  "capital_run": {
    "policy": {
      "effective_from": "2026-09-17",
      "effective_through": "2026-09-17",
      "evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "methodology": "string",
      "minimum_cet1_bps": 0,
      "minimum_leverage_bps": 0,
      "minimum_tier1_bps": 0,
      "minimum_total_bps": 0,
      "name": "string",
      "risk_classes": [
        {}
      ]
    },
    "policy_sha256": "string",
    "request": {
      "as_of": "2026-09-17",
      "components": [
        {}
      ],
      "coverage_evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "deductions": [
        {}
      ],
      "denominators": {
        "additional_credit_rwa": {},
        "average_assets": {},
        "average_from": "2026-09-17",
        "average_through": "2026-09-17",
        "consolidation_adjustment": {},
        "leverage_deductions": {},
        "market_rwa": {},
        "trading_assets_and_liabilities": {}
      },
      "eligibility": {
        "advanced_approaches": false,
        "cblr_election_reported": false,
        "evidence": {},
        "supervisory_restriction": false
      },
      "exposures": [
        {}
      ],
      "measurement": "string",
      "off_balance": [
        {}
      ],
      "policy_id": "string",
      "rationale": "string"
    },
    "results": {
      "additional_tier1_amount": 10000,
      "allowance_excluded_amount": 10000,
      "allowance_included_amount": 10000,
      "cblr": {
        "consolidated_assets_amount": 10000,
        "criteria_met": false,
        "election_reported": false,
        "failed_criteria": [],
        "leverage": {},
        "off_balance_notional_amount": 10000,
        "reliance_status": "string",
        "threshold_exclusive_bps": 0,
        "trading_assets_and_liabilities_amount": 10000
      },
      "cet1_amount": 10000,
      "cet1_ratio": {
        "bps": 0,
        "denominator_amount": 10000,
        "meets_minimum": false,
        "minimum_bps": 0,
        "numerator_amount": 10000,
        "status": "string"
      },
      "credit_rwa_amount": 10000,
      "engine_version": "string",
      "exposures": [
        {}
      ],
      "leverage_ratio": {
        "bps": 0,
        "denominator_amount": 10000,
        "meets_minimum": false,
        "minimum_bps": 0,
        "numerator_amount": 10000,
        "status": "string"
      },
      "limitations": [
        "string"
      ],
      "month_end": {
        "carried": false,
        "cblr_election_reported": false,
        "closing_date": "2026-09-17",
        "tier1_amount": 10000
      },
      "tier1_amount": 10000,
      "tier1_ratio": {
        "bps": 0,
        "denominator_amount": 10000,
        "meets_minimum": false,
        "minimum_bps": 0,
        "numerator_amount": 10000,
        "status": "string"
      },
      "tier2_amount": 10000,
      "total_capital_amount": 10000,
      "total_ratio": {
        "bps": 0,
        "denominator_amount": 10000,
        "meets_minimum": false,
        "minimum_bps": 0,
        "numerator_amount": 10000,
        "status": "string"
      },
      "total_rwa_amount": 10000
    },
    "source": {
      "as_of": "2026-09-17",
      "ledger_sha256": "string",
      "positions": [
        {}
      ],
      "sha256": "string",
      "sync_id": 0
    }
  },
  "content_sha256": "string",
  "contingency_run": {
    "request": {
      "as_of": "2026-09-17",
      "contingent_flows": [
        {}
      ],
      "coverage_evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "encumbrances": [
        {}
      ],
      "rationale": "string",
      "scenario_id": "string"
    },
    "results": {
      "balances": {
        "advances_amount": 10000,
        "brokered_deposits_amount": 10000,
        "cash_amount": 10000,
        "deposits_amount": 10000,
        "encumbered_securities_amount": 10000,
        "liabilities_amount": 10000,
        "other_liabilities_amount": 10000,
        "register_capacity_amount": 10000,
        "register_lendable_amount": 10000,
        "register_outstanding_amount": 10000,
        "register_securities_pledged_amount": 10000,
        "register_shortfall_amount": 10000,
        "securities_amount": 10000
      },
      "engine_version": "string",
      "horizon_days": 0,
      "indicators": [
        {}
      ],
      "limitations": [
        "string"
      ],
      "projections": [
        {}
      ],
      "scope": "string",
      "triggered_indicators": [
        "string"
      ]
    },
    "scenario": {
      "classes": [
        {}
      ],
      "daily_days": 0,
      "event_description": "string",
      "event_kind": "string",
      "evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "indicators": [
        {}
      ],
      "intramonth_end_days": [
        0
      ],
      "lenders": [
        {}
      ],
      "methodology": "string",
      "name": "string",
      "severities": [
        {}
      ],
      "supersedes": "string"
    },
    "scenario_sha256": "string",
    "source": {
      "advances": [
        {}
      ],
      "advances_sha256": "string",
      "as_of": "2026-09-17",
      "ledger_sha256": "string",
      "lenders": [
        {}
      ],
      "positions": [
        {}
      ],
      "positions_sha256": "string",
      "register_business_date": "2026-09-17",
      "register_captured_at": "2026-09-17T14:30:00Z",
      "register_sha256": "string",
      "sha256": "string",
      "sync_id": 0
    }
  },
  "contingency_scenario": {
    "classes": [
      {
        "assumptions": [],
        "evidence": {},
        "gl_code": "string",
        "role": "string",
        "treatment": "string"
      }
    ],
    "daily_days": 0,
    "event_description": "string",
    "event_kind": "string",
    "evidence": {
      "reference": "string",
      "sha256": "string"
    },
    "indicators": [
      {
        "action": "string",
        "evidence": {},
        "key": "string",
        "metric": "string",
        "owner": "string",
        "severity": "string",
        "threshold": 0,
        "trigger": "string"
      }
    ],
    "intramonth_end_days": [
      0
    ],
    "lenders": [
      {
        "available_day": 0,
        "evidence": {},
        "lendable_haircut_bps": 0,
        "lender_kind": "string",
        "severity": "string",
        "treatment": "string"
      }
    ],
    "methodology": "string",
    "name": "string",
    "severities": [
      {
        "description": "string",
        "evidence": {},
        "key": "string"
      }
    ],
    "supersedes": "string"
  },
  "id": "string",
  "insurance_policy": {
    "bank_certificate": "string",
    "bank_insurance_confirmed": false,
    "effective_from": "2026-09-17",
    "effective_through": "2026-09-17",
    "evidence": {
      "reference": "string",
      "sha256": "string"
    },
    "legal_entity": "string",
    "methodology": "string",
    "name": "string",
    "part370_applicability": "string",
    "rule_version": "string"
  },
  "insurance_run": {
    "policy": {
      "bank_certificate": "string",
      "bank_insurance_confirmed": false,
      "effective_from": "2026-09-17",
      "effective_through": "2026-09-17",
      "evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "legal_entity": "string",
      "methodology": "string",
      "name": "string",
      "part370_applicability": "string",
      "rule_version": "string"
    },
    "policy_sha256": "string",
    "request": {
      "as_of": "2026-09-17",
      "coverage_evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "policy_id": "string",
      "rationale": "string",
      "titles": [
        {}
      ]
    },
    "results": {
      "captured_principal_amount": 10000,
      "classified_amount": 10000,
      "engine_version": "string",
      "estimated_insured_amount": 10000,
      "estimated_uninsured_amount": 10000,
      "exceptions": [
        {}
      ],
      "groups": [
        {}
      ],
      "limitations": [
        "string"
      ],
      "status": "string"
    },
    "source": {
      "accounts": [
        {}
      ],
      "captured_at": "2026-09-17T14:30:00Z",
      "expected_accrued_interest_amount": 10000,
      "expected_principal_amount": 10000,
      "gl": {
        "as_of": "2026-09-17",
        "ledger_sha256": "string",
        "positions": [],
        "sha256": "string",
        "sync_id": 0
      },
      "sha256": "string"
    }
  },
  "kind": "string",
  "proposed_at": "2026-09-17T14:30:00Z",
  "proposed_by": "string",
  "review": {
    "actor": "string",
    "content_sha256": "string",
    "decision": "string",
    "evidence": {
      "reference": "string",
      "sha256": "string"
    },
    "rationale": "string",
    "reviewed_at": "2026-09-17T14:30:00Z"
  },
  "run": {
    "request": {
      "as_of": "2026-09-17",
      "contingent_flows": [
        {}
      ],
      "coverage_evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "exclusions": [
        {}
      ],
      "positions": [
        {}
      ],
      "rationale": "string",
      "scenario_id": "string"
    },
    "results": {
      "base": {
        "buckets": [],
        "eve_amount": 10000,
        "first_shortfall_month": 0,
        "minimum_liquidity_amount": 10000,
        "nii_amount": 10000,
        "triggered_actions": []
      },
      "engine_version": "string",
      "eve_delta_amount": 10000,
      "initial_liquidity_amount": 10000,
      "limitations": [
        "string"
      ],
      "nii_delta_amount": 10000,
      "scope": "string",
      "stress": {
        "buckets": [],
        "eve_amount": 10000,
        "first_shortfall_month": 0,
        "minimum_liquidity_amount": 10000,
        "nii_amount": 10000,
        "triggered_actions": []
      }
    },
    "scenario": {
      "assumptions": [
        {}
      ],
      "base_curve_bps": [
        0
      ],
      "base_index_bps": [
        0
      ],
      "contingency_actions": [
        {}
      ],
      "evidence": {
        "reference": "string",
        "sha256": "string"
      },
      "horizon_months": 0,
      "liquidity_floor_amount": 10000,
      "methodology": "string",
      "name": "string",
      "nii_months": 0,
      "stress_curve_bps": [
        0
      ],
      "stress_index_bps": [
        0
      ]
    },
    "scenario_sha256": "string",
    "source": {
      "as_of": "2026-09-17",
      "ledger_sha256": "string",
      "positions": [
        {}
      ],
      "sha256": "string",
      "sync_id": 0
    }
  },
  "scenario": {
    "assumptions": [
      {
        "base_monthly_prepayment_bps": 0,
        "base_monthly_runoff_bps": 0,
        "deposit_beta_bps": 0,
        "evidence": {},
        "inflow_haircut_bps": 0,
        "key": "string",
        "stress_monthly_prepayment_bps": 0,
        "stress_monthly_runoff_bps": 0
      }
    ],
    "base_curve_bps": [
      0
    ],
    "base_index_bps": [
      0
    ],
    "contingency_actions": [
      {
        "action": "string",
        "evidence": {},
        "id": "string",
        "owner": "string",
        "trigger_below_amount": 10000
      }
    ],
    "evidence": {
      "reference": "string",
      "sha256": "string"
    },
    "horizon_months": 0,
    "liquidity_floor_amount": 10000,
    "methodology": "string",
    "name": "string",
    "nii_months": 0,
    "stress_curve_bps": [
      0
    ],
    "stress_index_bps": [
      0
    ]
  }
}