| layout | title |
|---|---|
| schema | collateral |
Collateral Schema
Data schema to define collateral (currently can reference loans or accounts).
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| id | The unique identifier for the record within the firm. | string | - |
| date | The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. | string | - |
| account_ids | The unique identifier/s for the account/s within the financial institution. | array | - |
| charge | Lender charge on collateral, 1 indicates first charge, 2 second and so on. 0 indicates a combination of charge levels. | integer | - |
| currency_code | Currency in accordance with ISO 4217 standards plus CNH for practical considerations. | string | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, |
| encumbrance_amount | The amount of the collateral that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
| encumbrance_type | The type of the encumbrance causing the encumbrance_amount. | string | covered_bond, derivative, none, other, real_estate, repo, |
| end_date | The end date for recognition of the collateral | string | - |
| loan_ids | The unique identifiers for the loans within the financial institution. | array | - |
| regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_book, |
| security_id | The unique identifier used by the financial institution to identify the security representing collateral. | string | - |
| source | The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2 | string | - |
| start_date | The start date for recognition of the collateral | string | - |
| type | The collateral type defines the form of the collateral provided | string | cash, commercial_property, commercial_property_hr, debenture, farm, guarantee, immovable_property, life_policy, multifamily, other, residential_property, security, |
| value | The valuation as used by the bank for the collateral on the value_date. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
| value_date | The timestamp that the collateral was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. | string | - |
| version_id | The version identifier of the data such as the firm’s internal batch identifier. | string | - |
| vol_adj | The volatility adjustment appropriate to the collateral. | number | - |
| vol_adj_fx | The volatility adjustment appropriate to currency mismatch. | number | - |