demo-alfa-with-fire-json-model
fire.model.collateral
Data schema to define collateral (currently can reference loans or accounts).
Local Fields
| Name | Datatype | Description |
|---|---|---|
| date | datetime | The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. |
| end_date | datetime ? | The end date for recognition of the collateral |
| street_address | string ? | 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. |
| account_ids | list< string > ? | The unique identifier/s for the account/s within the financial institution. |
| charge | int(0, *) ? | Lender charge on collateral, 1 indicates first charge, 2 second and so on. 0 indicates a combination of charge levels. |
| orig_value | int ? | 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. |
| city | string ? | The city in which the property is located. |
| encumbrance_type |  fire.model.collateral_encumbrance_type ? |
The type of the encumbrance causing the encumbrance_amount. |
| regulatory_book | fire.model.regulatory_book ? |
|
| source | string ? | 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 |
| version_id | string ? | The version identifier of the data such as the firm's internal batch identifier. |
| type | fire.model.collateral_type ? |
The collateral type defines the form of the collateral provided |
| currency_code | fire.model.currency_code ? |
|
| country_code | fire.model.country_code ? |
The country of collateral. Two-letter country code as defined according to ISO 3166-1. |
| vol_adj_fx | double ? | The volatility adjustment appropriate to currency mismatch. |
| loan_ids | list< string > ? | The unique identifiers for the loans within the financial institution. |
| id | string | The unique identifier for the record within the firm. |
| encumbrance_amount | int(0, *) ? | 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. |
| postal_code | string ? | 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. |
| vol_adj | double ? | The volatility adjustment appropriate to the collateral. |
| value | int | 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. |
| security_id | string ? | The unique identifier used by the financial institution to identify the security representing collateral. |
| start_date | datetime ? | The start date for recognition of the collateral |
| value_date | datetime ? | The timestamp that the collateral was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. |
