layouttitle
schemacollateral

Collateral Schema


Data schema to define collateral (currently can reference loans or accounts).

Properties

NameDescriptionTypeEnum
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-
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
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVESVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMW
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_bondderivativenoneotherreal_estaterepo
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_booktrading_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
autocashco_opcommercial_propertycommercial_property_hrcondodebenturefarmfour_unitsguaranteeimmovable_propertylife_policymanufactured_housemultifamilyone_unitotherplanned_unit_devres_property_hrresi_mixed_useresidential_propertysecuritysingle_familythree_unitstownhousetwo_units
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-