layout | title |
---|---|
schema | collateral |
Collateral Extended Schema
Extended collateral schema containing all jurisdiction-specific extensions.
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 | - |
city | The city in which the property is located. | string | - |
claims | The total amount of 3rd party claims on the collateral. | integer | - |
country_code | Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ). | string | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
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 | - |
orig_value | The valuation as used by the bank for the collateral at the origination of the related loan or line of credit. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
postal_code | The zip code in which the property is located. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
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 | - |
street_address | The street address associated with the property. Must include street direction prefixes, direction suffixes, and unit number for condos and co-ops. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
type | The collateral type defines the form of the collateral provided | string | auto, auto_other, car, cash, co_op, commercial_property, commercial_property_hr, condo, convertible, debenture, farm, four_units, guarantee, immovable_property, life_policy, luxury, manufactured_house, multifamily, one_unit, other, planned_unit_dev, res_property_hr, resi_mixed_use, residential_property, security, single_family, sport, suv, three_units, townhouse, truck, two_units, van, |
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 | - |
census_tract | Census tracts are identified by an up to four digit integer number and may have an optional two?digit suffix. The census tract codes consist of six digits with an implied decimal between the fourth and fifth digit corresponding to the basic census tract number but with leading zeroes and trailing zeroes for census tracts without a suffix. For additional details refer to the Census Bureau website: https://www.census.gov/data/academy/data-gems/2018/tract.html | string | - |
orig_charge | The lender charge on collateral at origination. See: charge. | integer | - |
orig_valuation_type | Extended collateral schema containing all jurisdiction-specific extensions. | object | - |
property_size | The size of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | integer | - |
sale_price | The final sales price at which the property was disposed by the reporting entity in the case of involuntary termination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
valuation_type | Methodology used in the determination of the collateral value. Refer to https://www.ecfr.gov/current/title-12/chapter-VI/subchapter-B/part-614/subpart-F/section-614.4265 and https://www.federalreserve.gov/boarddocs/srletters/2010/sr1016a1.pdf | string | auto_val_model, broker_price, desktop, full, limited, purchase_price, tav, |
value_after_mod | The collateral value after the loan has been modified. A loan arrears arrangement or modification refers to a situation where a lender and borrower agree to adjust the terms of an existing loan due to the borrower’s difficulty in making scheduled repayments. This typically occurs after the borrower falls behind, enters arrears, or anticipates they soon will. | integer | - |