layout | title |
---|---|
schema | loan |
Loan Extended Schema
Extended loan 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 | - |
acc_fv_change_before_taxes | Accumulated change in fair value before taxes. | integer | - |
acc_fv_change_credit_risk | Accumulated changes in fair value due to credit risk. | integer | - |
accounting_treatment | The accounting treatment in accordance with IAS/IFRS9 accounting principles. | string | amortised_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_gaap, |
accrual_status | The accrual status of the loan or line of credit. | string | accrual, non_accrual, securitised, serviced_for_others, |
accrued_interest_12m | The cumulative accrued interest over the past 12 months. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
accrued_interest_balance | The accrued interest due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
administration | How the loan was administered by the lender. | string | other, principal, |
arrears_arrangement | The arrangement the lender has made with the borrower regarding the amount referenced in the arrears_balance. | string | formal, interest_grace_period, mi_claim_adv, modified_tnc, none, possessed, prin_def_rate, prin_def_rate_term, prin_def_term, principal_defer, principal_forgive, rate_prin_forgive, rate_red_frozen, rate_term, rate_term_prin_forgive, recap, refinancing, renewal, reo, temporary, term_ext, term_prin_forgive, term_recap, |
arrears_balance | The balance of the loan or capital amount that is considered to be in arrears. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
asset_liability | Is the data an asset, a liability, or equity on the firm’s balance sheet? | string | asset, equity, liability, pnl, |
balance | The balance of the loan or capital still to be repaid. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
base_rate | The base rate represents the basis of the repayment rate on the borrowed funds at the given date as agreed in the terms of the loan. | string | FDTR, UKBRBASE, ZERO, cert_dep, cofi, cofi_11th, cofi_nm, cofi_other, cosi, mta, other, prime, sofr, sofr_1m, sofr_1y, sofr_3m, sofr_6m, sofr_other, tbill, tbill_1y, tbill_3m, tbill_3y, tbill_5y, tbill_6m, tbill_other, |
behavioral_curve_id | The unique identifier for the behavioral curve used by the financial institution. | string | - |
behavioral_end_date | Behavioral end date (as opposed to contractual). YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601 | string | - |
beneficiary_id | The unique identifier for the beneficiary of the loan cashflows. | string | - |
cb_haircut | The haircut as determined by the firm’s central bank | number | - |
ccf | The credit conversion factor that indicates the proportion of the undrawn amount that would be drawn down on default. | number | - |
cost_center_code | The organizational unit or sub-unit to which costs/profits are booked. | string | - |
count | Describes the number of loans aggregated into a single row. | 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, |
cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
credit_process | Identifier for how a loan is credit assessed during the underwriting process | string | delinquency_managed, graded, rated, scored, |
cum_recoveries | The total amount recovered since the date of default of the instrument. | integer | - |
cum_write_offs | The portion of the loan which has been written off. | 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, |
customer_id | The unique identifier used by the financial institution to identify the customer. | string | - |
customers | The list of customers for this loan | array | - |
day_count_convention | The methodology for calculating the number of days between two dates. It is used to calculate the amount of accrued interest or the present value. | string | act_360, act_365, act_act, std_30_360, std_30_365, |
deal_id | Identifier used for linking this product as part of a larger deal. e.g. Two components of a single loan or matching a securitisation with it’s underlying loan. | string | - |
default_date | Date of default. | string | - |
deferred_fees | Deferred fees are deferred payments subject to prepayment risk and not included in the balance. | integer | - |
ead | The EAD field allows users to input monetary exposure-at-default values across the loan’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default. | integer | - |
ead_irb_ec | The expected gross dollar exposure for each facility upon a borrower’s default as determined by internal ratings-based approach. This value is used in economic capital calculations. | integer | - |
economic_loss | The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss | integer | - |
el_irb | The best estimate of expected loss when in default. | number | - |
encumbrance_amount | The amount of the loan that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
encumbrance_end_date | Date encumbrance amount goes to zero. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601 | string | - |
encumbrance_type | The type of the encumbrance causing the encumbrance_amount. | string | abs, cb_funding, covered_bond, |
end_date | YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601 | string | - |
facility_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, |
facility_id | The code assigned by the financial institution to identify a facility. | string | - |
fees | The fees associated with the loan. | integer | - |
first_arrears_date | The first date on which this loan was in arrears. | string | - |
first_payment_date | The first payment date for interest payments. | string | - |
forbearance_date | The date on which the first forbearance measure was granted to this product. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601 | string | - |
fraud_loss | The total value of accounting losses incurred by the Financial Institution due to fraudulent activities within the reporting segment. | integer | - |
frr_id | The internal facility risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority. | string | - |
fvh_level | Fair value hierarchy category according to IFRS 13.93 (b) | integer | - |
guarantee_amount | The amount of the loan that is guaranteed by the guarantor. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
guarantor_id | The unique identifier for the guarantor of the loan. | string | - |
impairment_amount | The impairment amount for a loan is the allowance for loan impairments set aside by the firm that accounts for the event that the loan becomes impaired in the future. | integer | - |
impairment_date | The date upon which the product became considered impaired. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601 | string | - |
impairment_status | The recognition stage for the impairment/expected credit loss of the product. | string | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
impairment_type | The loss event resulting in the impairment of the loan. | string | collective, individual, write_off, |
income_assessment | Was the loan assessed against a single or joint incomes? | string | joint, joint_not_evidenced, single, single_not_evidenced, |
interest_repayment_frequency | Repayment frequency of the loan interest, if different from principal. | string | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
issuer_id | The unique identifier for the issuer of the loan. | string | - |
last_arrears_date | The last date on which this loan was in arrears. | string | - |
last_drawdown_date | The last date on which a drawdown was made on this loan | string | - |
last_payment_date | The final payment date for interest payments, often coincides with end_date. | string | - |
last_recovery_date | Date of most recent recovery in the reporting quarter. | string | - |
last_write_off_date | Date of Financial Institution’s most recent Write Off in the reporting quarter. | string | - |
ledger_code | The internal ledger code or line item name. | string | - |
lgd_downturn | The loss given default in the event of an economic downturn. Percentage between 0 and 1. | number | - |
lgd_floored | The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations | number | - |
lgd_irb | The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations. | number | - |
lgd_irb_ec | The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations. | number | - |
lifetime_rate_cap | The lifetime interest rate cap for adjustable rate loans. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | number | - |
lifetime_rate_floor | The lifetime interest rate floor for adjustable rate loans. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | number | - |
limit_amount | The total credit limit on the loan. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
lnrf_amount | The total amount of non-recourse funding linked to the loan. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
minimum_balance | Indicates the minimum balance of each loan within the aggregate. | integer | - |
minimum_balance_eur | Indicates the minimum balance, in Euros, of each loan within the aggregate. | integer | - |
movement | The movement parameter describes how the loan arrived to the firm. | string | acquired, acquired_impaired, other, securitised, sold, syndicated, syndicated_lead, |
next_payment_date | The next date at which interest will be paid or accrued_interest balance returned to zero. | string | - |
next_repricing_date | The date on which the interest rate of the loan will be re-calculated. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. | string | - |
notional_amount | The original notional amount of the loan. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
on_balance_sheet | Is the loan reported on the balance sheet of the financial institution? | boolean | - |
orig_credit_score | The credit score of the customer at origination of the product using a commercially available credit bureau score. | integer | - |
orig_limit_amount | The original line of credit amount that was granted at the origination of the facility | integer | - |
orig_notional | The notional of the loan at origination. | integer | - |
originator_id | The unique identifier used by the financial institution to identify the originator of the loan product. | string | - |
originator_type | The type of financial institution that acted as the originator of the loan product. | string | mortgage_lender, other, spv, |
parent_facility_id | The parent code assigned by the financial institution to identify a facility. | string | - |
participation_int | For participated or syndicated credit facilities that have closed and settled, the percentage of the total loan commitment held by the reporting entity. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | number | - |
participation_type | For participated or syndicated credit facilities that have closed and settled, indicates the type of participation in the loan. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | agent_non_snc, agent_snc, none, participant_non_snc, participant_snc, |
pd_irb | The probability of default as determined by internal rating-based methods. Percentage between 0 and 1. | number | - |
pd_irb_ec | The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations. | number | - |
pd_retail_irb | The retail probability of default as determined by internal rating-based methods. Percentage between 0 and 1. | number | - |
prev_payment_date | The most recent previous date at which interest was paid or accrued_interest balance returned to zero. | string | - |
product_name | The name of the product as given by the financial institution to be used for display and reference purposes. | string | - |
provision_amount | The amount of reserves that is provisioned by the financial institution to cover the potential loss on the loan. Monetary type represented as a naturally positive integer number of cents/pence. | integer | - |
provision_type | The provision type parameter details the provisions the issuing firm has allocated to cover potential losses from issuing a loan. | string | none, other, |
purpose | The underlying reason the borrower has requested the loan. | string | agriculture, bridging_loan, buy_to_let, buy_to_let_construct, buy_to_let_further_advance, buy_to_let_house_purchase, buy_to_let_other, buy_to_let_remortgage, cash_out, commercial, commercial_property, commodities_finance, construction, consumer_buy_to_let, debt_consolidation, education, first_time_buyer, first_time_buyer_cstr, further_advance, further_advance_cstr, house_purchase, house_purchase_cstr, ips, lifetime_mortgage, medical, non_b20, object_finance, object_finance_hq, operational, operational_non_sym, operational_sym, other, project_finance, project_hq_phase, project_pre_op, promotional, rate, reference, refinance, remortgage, remortgage_construct, remortgage_other, remortgage_othr_cstr, renovation, speculative_property, term, |
rate | The full interest rate applied to the loan balance. Note that for tracker rates this includes the benchmark (ie. not the credit spread). Percentages represented as a decimal/float, so 1.5 implies 1.5%. | number | - |
rate_type | Describes the type of interest rate applied to the loan. | string | combined, fixed, tracker, variable, |
ref_income_amount | The reference income used for the customer(s) for this loan. Monetary type represented as an integer number of cents/pence. | integer | - |
regulated | Is this loan regulated or unregulated? | boolean | - |
regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_book, |
repayment_frequency | Repayment frequency of the loan. | string | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
repayment_type | Repayment type of the loan refers to whether the customer will be repaying capital + interest, just interest or a combination of the two. | string | combined, interest_only, other, repayment, |
reporting_entity_name | The name of the reporting legal entity for display purposes. | string | - |
reporting_id | The internal ID for the legal entity under which the account is being reported. | string | - |
repurchase_status | The current status of the repurchase of the loan. | string | complete_no_repurchase, complete_repurchased, in_process, initiated, |
resolution_date | Date of resolution of the defaulted facility. | string | - |
reversion_date | The timestamp that indicates the end of an initial period where the ‘rate’ is applied to a loan. After this the interest is calculated using the ‘reversion_rate’. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. | string | - |
reversion_rate | The rate to which the loan will revert after the reversion date. Percentages represented as a decimal/float, so 1.5 implies 1.5%. | number | - |
review_date | The currently scheduled review date for Counterparty exposure. This date should be set in the future. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. | string | - |
risk_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, |
risk_weight_irb | The internal risk weight represented as a decimal/float such that 1.5% is 0.015. | number | - |
risk_weight_std | The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015. | number | - |
secured | Is this loan secured or unsecured? | boolean | - |
seniority | The seniority of the security in the event of sale or bankruptcy of the issuer. | string | mezzanine, pari_passu, senior_secured, senior_unsecured, subordinated_secured, subordinated_unsecured, |
servicer_id | This is the unique id to identify the servicer of a loan. | string | - |
servicing | The method by which the loan shall be repaid | string | business, pension, rent, salary, |
servicing_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, |
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 | - |
spread | The additional rate that is added to the relevant base rate to determine the monthly interest rate of the loan. This is represented in basis points (bps). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | integer | - |
start_date | The timestamp that the trade or financial product commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. | string | - |
status | Describes if the loan is active or been cancelled. | string | actual, cancellable, cancelled, closed, committed, defaulted, frozen, revolving, |
trade_date | The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601. | string | - |
type | The form of the loan product administered by the financial institution, with regards to common regulatory classifications. | string | auto, cd, charge_card, commercial, commercial_property, corporate_card, credit_card, credit_facility, education, financial_lease, heloan, heloc, heloc_lockout, liquidity_facility, mortgage, mortgage_charter, mortgage_cra, mortgage_fha_project, mortgage_fha_res, mortgage_hud235, mortgage_no_pmi, mortgage_pmi, mortgage_va, multiccy_facility, new_auto, nostro, other, personal, q_reverse_mortgage, reverse_mortgage, trade_finance, used_auto, |
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 exposure. | number | - |
accrued_interest_after_mod | The accrued_interest 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 | - |
anchor_tenant | The name of anchor tenant(s). Anchor tenant is defined as any tenant named in a co-tenancy clause or whose rental income accounts for the majority of the gross rental income at the property level. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
arrears_arrange_comp | The arrears_arrangement that has been completed for any loan. Successful completion is defined as the closing of loss mitigation activities where the borrower has no remaining delinquent obligations to the servicer. | string | formal, interest_grace_period, mi_claim_adv, modified_tnc, none, possessed, prin_def_rate, prin_def_rate_term, prin_def_term, principal_defer, principal_forgive, rate_prin_forgive, rate_red_frozen, rate_term, rate_term_prin_forgive, recap, refinancing, renewal, reo, short_sale, temporary, term_ext, term_prin_forgive, term_recap, |
arrears_arrange_date | The date on which the loan terms were most recently modified. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
balance_after_mod | The remaining balance 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 | - |
business_line_desc | Free text describing the internal line of business. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
business_line_name | Free text indicating the internal line of business. For example: Private Banking, Corporate Banking, Asset- Based Lending, etc. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
credit_class | The credit class designation as defined by the servicer. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | alt_a, government_owned, non_prime, prime, |
credit_enhance_amt | The total amount of credit enhancement received that offset the loss. This could come from mortgage insurance proceeds, pool arrangements in deals, or other features of securities structures. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
delinquent_amount_cap | The total amount of the delinquent amount that was capitalized and added to the principal balance through loss mitigation. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
disposition_date | The disposition date for any credit facility that was disposed during the period. Also see [disposition_type]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
disposition_schedule_shift | The Y?14 report, schedule, and subschedule to which the credit facility shifted. The reported format should follow these examples: If the credit facility transferred to FR Y?14Q Schedule H.2 Commercial Real Estate, reportQ.H.2. If the credit facility transferred to FR Y?14M Schedule D.1 Domestic Credit Card Data Collection Data Dictionary, reportM.D.1. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
disposition_type | The disposition method for any credit facility that was disposed during the period. Also see [disposition_date]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | fully_participated, fully_syndicated, involuntary_payoff, liquidation, payoff, sold, |
escrow_amount | The scheduled escrow amount (including taxes and insurance) due from the borrower scheduled for the reporting month. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
final_draw_date | The date until which the borrower has the ability to make withdrawals against the credit line. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
first_principal_date | The date on which the first principal payment was/will be made based on the original loan terms. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
first_write_off_date | The date of the first write off or charge-off event for the account. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
foreclosure_ref_date | The date that the mortgage was referred to an attorney for the purpose of initiating foreclosure proceedings. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
foreclosure_sale_date | The date that the foreclosure sale occurs on the subject property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
foreclosure_status | Indication of the status of a foreclosure. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | post_sale, post_sale_susp, pre_sale, pre_sale_susp, reo, reo_susp, |
income_docs | How the borrower’s income levels were documented at the time of origination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | alt_low_borrower, alt_low_lender, alt_low_unknown, full, stated_borrower, stated_lender, stated_unknown, |
int_reset_freq | The adjustable rate periodic interest reset period. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | integer | - |
int_tax_status | The tax status of interest income for Federal or State Income Tax purposes. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | tax_exempt, taxable, |
interest_reserve | The amount of remaining Interest rate reserves. Interest reserves would represent only those funds remaining from the original construction commitment to be used to pay interest during the construction and lease-up phases. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | integer | - |
inv_term_amount | The total debt at the time of any involuntary termination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
leveraged_loan | The credit facility is defined as a leveraged loan per criteria in the reporting entity’s internal risk management framework developed pursuant to SR 13-3 (Interagency Guidance on Leveraged Lending). | boolean | - |
liq_method | The liquidation method for any loan. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | involuntary_liquidation, not_paid_in_full, servicing_transfer, voluntary_payoff, |
locked_amt_amort | The amount of credit line that has been locked and is now amortising.The amount of the outstanding principal balance that has been ‘locked’ and is now amortising under independent loan terms. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
locked_amt_io | The amount of the outstanding principal balance that has been locked as an interest only loan operating under independent terms. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
loss_mitig_amt | The total amount that was deferred through loss mitigation. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
loss_mitig_status | Identifies whether a loan is being actively handled by the servicer’s loss mitigation department. Refers to all loans where the servicer has initiated loss mitigation procedures whether or not a particular course of action or workout type has been executed. Active loss mitigation refers to instances where the loan is currently in loss mitigation, and the servicer is actively pursuing loss mitigation. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | active_non_performing, active_performing, broken, |
mod_contribution | The amount of money a borrower will contribute toward housing expenses (mortgage payment, real estate taxes, homeowner’s insurance, association dues, etc.) after modification. 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. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
mod_date | The date on which any modifications were made to renew or change contract terms of the loan and the borrower meets BHC or IHC or SLHC current credit standards (not under an arrears arrangment). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
mod_house_debt_payments | A borrower’s total monthly debt payments relating to proposed housing expenses after modification. Typically used after a borrower enters arrears or anticipates repayment difficulty. | integer | - |
mod_monthly_payments | A borrower’s total monthly debt payments (including proposed housing expenses) after modification. 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. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
mod_ref_income_amt | The borrower’s monthly income after modification. 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. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
month_payment | The scheduled principal and interest due from the borrower in the reporting month. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
neg_amort_limit | Identifies loans that as part of their contract, have or potentially can have a feature that allows the borrower to pay an amount that is less than the interest accruing on the mortgage, resulting in negative amortisation. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
net_loss | Total loss net of all recoveries. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | integer | - |
non_accrual_date | The date the credit facility was placed on non-accrual. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
noncredit_amt | For facilities that were purchased as a credit-deteriorated (PCD) asset, the noncredit discount (or premium) resulting from its acquisition (ASC 326-20-30-13). | integer | - |
occupancy | Information related to the occupancy of the property that is available on the mortgage at the time of origination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | investment, non_owner_occupied, primary, second_home, |
occupancy_date | The date on which the most recent occupancy was determined by the borrower. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
orig_base_rate | The base rate at origination. | string | FDTR, UKBRBASE, ZERO, cert_dep, cofi, cofi_11th, cofi_nm, cofi_other, cosi, mta, other, prime, sofr, sofr_1m, sofr_1y, sofr_3m, sofr_6m, sofr_other, tbill, tbill_1y, tbill_3m, tbill_3y, tbill_5y, tbill_6m, tbill_other, |
orig_credit_score_vendor | The vendor of the commercially available credit bureau score at origination. Also see [orig_credit_score] and [orig_credit_score_version]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | fico, other, vantage, |
orig_credit_score_version | The version of the commercially available credit bureau score at origination. Also see [orig_credit_score] and [orig_credit_score_vendor]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
orig_customer_id | The customer_id at origination. | string | - |
orig_end_date | The end_date at origination. | string | - |
orig_facility_id | The facility_id at origination. | string | - |
orig_house_debt_payments | A borrower’s total monthly debt payments relating to proposed housing expenses at origination. | integer | - |
orig_id | The id at origination. | string | - |
orig_imp_status | The recognition stage for the impairment/expected credit loss of the product. | string | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
orig_income | The borrower’s monthly income at origination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
orig_int_reset_freq | The adjustable rate periodic interest reset period at origination. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
orig_monthly_payments | A borrower’s total monthly debt payments (including proposed housing expenses) at origination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
orig_notional_amount | The notional_amount at origination. | integer | - |
orig_payment | The scheduled principal and interest amount at the origination of the loan. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
orig_penalty_date | The penalty_date at origination. | string | - |
orig_rate | The rate at origination. | number | - |
orig_rate_type | The rate_type at origination. | string | combined, fixed, tracker, variable, |
orig_ref_income | The amount of money a borrower will contribute toward housing expenses (mortgage payment, real estate taxes, homeowner’s insurance, association dues, etc.) at origination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
orig_repayment_type | The repayment_type at origination. | string | combined, interest_only, option_arm, other, repayment, |
orig_reversion_date | The reversion_date at origination. | string | - |
orig_source | The source by which the servicer originated or otherwise acquired the loan. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | bulk_purchase, correspondent, retail, servicing_rights_purchased, wealth_management, wholesale, |
orig_spread | The spread at origination. This is represented in basis points (bps). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
orig_type | Data schema defining the characteristics of a loan product. | object | - |
orig_valuation_type | Extended collateral schema containing all jurisdiction-specific extensions. | object | - |
pay_type_end_draw | How borrowers are required to repay any principal outstanding at the end of the allowable draw period. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | amortising, balloon, interest_only, other, |
penalty_date | The date until which a prepayment penalty applies. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
periodic_pay_cap | The cap on monthly payments for adjustable rate loans. Denominated as a percentage between 0 and 100. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | number | - |
periodic_pay_floor | The floor on monthly payments for adjustable rate loans. Denominated as a percentage between 0 and 100. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | number | - |
periodic_rate_cap | The periodic interest rate cap for adjustable rate loans. Denominated as a percentage between 0 and 100. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | number | - |
periodic_rate_floor | The periodic interest rate floor for adjustable rate loans. Denominated as a percentage between 0 and 100. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | number | - |
prev_arr_date | The arrears_arangement_date at origination. | string | - |
rate_after_mod | The rate 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. | number | - |
rate_before_mod | The rate before modification. 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. | number | - |
rate_mod_end_date | The date when the interest type modification under an arrears arrangement ended. 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. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
rate_mod_start_date | The date when the interest type was modified under an arrears arrangement. 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. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
rate_mod_step | Identifies whether a rate modification or arrears arrangement has a ‘stepped’ or gradual return to non-modified rate. If the rate drop is gradual (stepped), even to a rate that is different from the contract rate, this field should be populated with TRUE. If the rate drop is immediate, even to a rate that is different from the contract rate, this field should be populated with FALSE. Similarly, FALSE will be reported if the loan immediately returns to the contract rate at expiration of the modification. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | boolean | - |
recourse | Whether there is recourse on a loan. Recourse on a loan refers to terms in the mortgage contract that give the owner of the note the right to pursue additional claims against the borrower beyond possession of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | boolean | - |
renewal_date | The date on which the most recent renewal notification became effective. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
rep_arrears_arrangement | Identifies when a loan has been modified or undergone arrears arrangements more than once in the past 24 months. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | boolean | - |
repurchase_req_date | The date of loan repurchase requested by the counterparty. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
settlement_amount | The settlement amount (portion of the outstanding unpaid principal balance) agreed to be paid by the customer. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | integer | - |
snc_id | Where the credit facility is reported in the Shared National Credit collection and the reporting entity is the lead bank/agent, this field indicates the entities Internal Credit ID as reported in the Shared National Credit collection for this credit facility as of the most recent filing date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. | string | - |
tdr_date | The date designating when the loan was classified as a Troubled Debt Restructuring (TDR). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information. | string | - |
termination_value | Total projected market value of the lease at termination (leased vehicles only). | integer | - |