Input Tool - Response

Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.

ElementAttributes
🟥 <outINPUT_TOOL>
|- 🟥 <CalcResult>
|- 🟦 <XMLDetail>[]
|- 🟥 <LoanSetup>
|- |- 🟥 <DefaultDays>
|- |- 🟥 <MinDays>
|- |- 🟥 <MaxDays>
|- |- 🟥 <MaxDaysSinglePays>
|- |- 🟥 <DefAmount>
|- |- 🟥 <MinAmount>
|- |- 🟥 <MaxAmount>
|- |- 🟥 <ShowRate>
|- |- 🟥 <DefRate>
|- |- 🟥 <MinRate>
|- |- 🟥 <MaxRate>
|- |- 🟥 <ShowPPY>
|- |- 🟥 <PPY>
|- |- 🟥 <DefTerm>
|- |- 🟥 <MinTerm>
|- |- 🟥 <MaxTerm>
|- |- 🟥 <PromptFinIns>
|- |- 🟥 <AllowPast28>
|- |- 🟥 <AllowAutoLoans>
|- |- 🟥 <True360>
|- |- 🟥 <DebtProtection>
|- |- 🟥 <DebtTitle>
|- |- 🟥 <ShowHOEPALoanType>
|- |- 🟥 <PremiumType>
|- |- 🟥 <PromptOpenEnd>
|- |- 🟥 <DiscloseHOEPA>
|- |- 🟥 <AcceleratedBiWeekly>
|- |- 🟥 <DefaultBirthday>
|- |- 🟥 <Construction>
|- 🟥 <ARM>
|- |- 🟥 <FirstRateIncrease>
|- |- 🟥 <RoundRate>
|- |- 🟥 <TeaserTermDef>
|- |- 🟥 <TermInc>
|- |- 🟥 <TeaserRateDef>
|- |- 🟥 <MaxAnnualInc>
|- |- 🟥 <MaxLoanInc>
|- |- 🟥 <MinLifeRate>
|- |- 🟥 <MaxLifeRate>
|- 🟥 <PMI>
|- |- 🟥 <AllowPMI>
|- |- 🟥 <AssumePMI>
|- |- 🟥 <UpFront>
|- |- 🟥 <PercentToWarn>
|- |- 🟥 <PercentToRemove>
|- |- 🟥 <AddToPrin>
|- |- 🟥 <AddToFinChg>
|- |- 🟥 <PutPMIinAmort>
|- |- 🟥 <PromptFrequency>
|- |- 🟥 <PromptUpFront>
|- |- 🟥 <PromptAddToPrin>
|- |- 🟥 <PromptAddToFinChg>
|- 🟥 <CreditLife>
|- |- 🟥 <CLTitle>
|- |- 🟥 <CLAbbrev>
|- |- 🟥 <CLAllow>
|- |- 🟥 <CLSingleOnCoBorrower>
|- |- 🟥 <CLDefault>
|- |- 🟥 <CLDefaultMethod>
|- |- 🟥 <CLPromptMethod>
|- |- 🟥 <CLPromptTermGross>
|- |- 🟥 <CLPromptTermNet>
|- |- 🟥 <CLPromptTermMOB>
|- |- 🟥 <CLPromptDismemberment>
|- |- 🟥 <CLPromptUseLevelRates>
|- |- 🟥 <CLPromptBirthdaysGross>
|- |- 🟥 <CLPromptBirthdaysNet>
|- |- 🟥 <CLPromptBirthdaysMOB>
|- |- 🟥 <CLPromptCov>
|- |- 🟥 <CLMinLoanTerm>
|- |- 🟥 <CLMinTruncTerm>
|- |- 🟥 <CLAllowNonMonthlyGross>
|- |- 🟥 <CLAllowWeeklyGross>
|- |- 🟥 <CLAllowNonMonthlyNet>
|- |- 🟥 <CLAllowWeeklyNet>
|- |- 🟥 <CLAllowNonMonthlyMOB>
|- |- 🟥 <CLAllowWeeklyMOB>
|- |- 🟥 <CLMult>
|- |- 🟥 <CLNBCManditory>
|- |- 🟥 <LLTitle>
|- |- 🟥 <LLAbbrev>
|- 🟥 <AccidentHealth>
|- |- 🟥 <AHTitle>
|- |- 🟥 <AHAbbrev>
|- |- 🟥 <AHAllow>
|- |- 🟥 <AHSingleOnCoBorrower>
|- |- 🟥 <AHMethod>
|- |- 🟥 <AHAllowBalloonGross>
|- |- 🟥 <AHAllowBalloonNet>
|- |- 🟥 <AHDefault>
|- |- 🟥 <AHPromptBenefit>
|- |- 🟥 <AHPromptTermGross>
|- |- 🟥 <AHPromptTermNet>
|- |- 🟥 <AHMinTruncTerm>
|- |- 🟥 <AHPromptBirthdays>
|- |- 🟥 <AHMult>
|- |- 🟥 <AHOnly>
|- |- 🟥 <AHJointWOJointCL>
|- |- 🟥 <AHNonMonthly>
|- |- 🟥 <AHSetCount>
|- |- 🟥 <AHSetTitle>[]
|- |- 🟥 <AHTermEqualsCL>
|- 🟥 <InvoluntaryUnemployment>
|- |- 🟥 <IUTitle>
|- |- 🟥 <IUAbbrev>
|- |- 🟥 <IUAllow>
|- |- 🟥 <IUDefault>
|- |- 🟥 <IUSingleOnCoBorrower>
|- |- 🟥 <IUOnly>
|- |- 🟥 <IUJointWOJointCL>
|- |- 🟥 <IUwoAH>
|- |- 🟥 <IUJointWOJointAH>
|- |- 🟥 <IUPromptBenefit>
|- |- 🟥 <IUPromptTerm>
|- |- 🟥 <IUMult>
|- |- 🟥 <IUPromptBirthdays>
|- |- 🟥 <IUTermEqualsCLTerm>
|- |- 🟥 <IUNonMonthly>
|- 🟥 <PersonalProperty>
|- |- 🟥 <PPTitle>
|- |- 🟥 <PPAbbrev>
|- |- 🟥 <PPAllow>
|- |- 🟥 <PPDefault>
|- |- 🟥 <PPPromptCoverage>

🟥 <outINPUT_TOOL>

Element TypeData Type
Parent-

This is the root element of the XML response, and is required. This element simply acts as a container for all of the result child elements.

🟥 <CalcResult>

Element TypeData Type
DataText

If the calculation was completed successfully, then this element will contain the value Valid Calculation. Otherwise, this element will contain a description of the problem encountered during the attempted computation.

🟦 <XMLDetail>[]

Element TypeData TypeDefault
DataTextNULL

The <XMLDetail> elements are messages passed back to the calling application which detail the status of the request. If the SCEX issues any warnings regarding unrecognized elements or attributes, then each warning message will be displayed in an <XMLDetail> element.

In our sample output above, no warnings are returned by the SCEX, and hence there are no <XMLDetail> elements returned.


🟥 <LoanSetup>

Element TypeData Type
Parent-

This element contains child elements describing general loan user interface issues, such as miscellaneous minimum, maximum, and default values, allowed payment frequencies, etc.

🟥 <LoanSetup><DefaultDays>

Element TypeData Type
DataInteger

Contains the default number of days between the loan date and the date of first payment.

🟥 <LoanSetup><MinDays>

Element TypeData Type
DataInteger

Defines the minimum number of days allowed between the loan date and the first payment date for monthly loans only. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><MaxDays>

Element TypeData Type
DataInteger

Defines the maximum number of days allowed between the loan date and the first payment date for monthly loans only. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><MaxDaysSinglePays>

Element TypeData Type
DataInteger

Defines the maximum number of days allowed between the loan date and the single payment date for single payment loans. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><DefAmount>

Element TypeData Type
DataCurrency

Contains the default proceeds amount.

🟥 <LoanSetup><MinAmount>

Element TypeData Type
DataCurrency

Holds the minimum proceeds amount allowed. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><MaxAmount>

Element TypeData Type
DataCurrency

Holds the maximum proceeds amount allowed. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><ShowRate>

Data TypeValues
Booleantrue, false, 1, 0

Not all accrual methods require a prompt to be visible for the note rate (e.g. split rate loans which have their rates defined in the setup files). A value of 1 means that the note rate prompt should be displayed, whereas a value of 0 indicates that it need not be displayed.

🟥 <LoanSetup><DefRate>

Element TypeData Type
DataDecimal

Contains the default note rate amount.

🟥 <LoanSetup><MinRate>

Element TypeData Type
DataDecimal

Holds the minimum note rate allowed. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><MaxRate>

Element TypeData Type
DataDecimal

Holds the maximum note rate allowed. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><ShowPPY>

Data TypeValues
Booleantrue, false, 1, 0

Should an entry prompting for the payment frequency be displayed? 1 = yes, 0 = no.

🟥 <LoanSetup><PPY>

Element TypeData TypeValues
DataInteger[See Table Below]

If the payment frequency needs to be prompted (see <ShowPPY>), then this element informs the user interface which payment frequencies are allowed. The content of this element is eight characters in length, and each character will be either a one (1) or a zero (0). A value of 1 indicates that the payment frequency associated with the position should be allowed, whereas a value of 0 indicates that the frequency should not be offered.

PositionPayment Frequency
1Monthly
2Annual
3Semiannual
4Quarterly
5Bimonthly
6Semimonthly
7Biweekly
8Weekly

🟥 <LoanSetup><DefTerm>

Element TypeData Type
DataInteger

Defines the default loan term, expressed as a number of months.

🟥 <LoanSetup><MinTerm>

Element TypeData Type
DataInteger

Holds the minimum loan term (expressed in months) allowed. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><MaxTerm>

Element TypeData Type
DataInteger

Holds the maximum loan term (expressed in months) allowed. This value is not enforced within the SCE as it is a user interface issue.

🟥 <LoanSetup><PromptFinIns>

Element TypeData Type
DataInteger

Some institutions and insurance types allow the borrower to pay for the insurance premium up front, instead of financing it. If financing the insurance is an option which should be available, then this element will be set to 1, for yes. Otherwise, a value of 0 will signify that this is not an option, and no prompt should appear.

🟥 <LoanSetup><AllowPast28>

Data TypeValues
Booleantrue, false, 1, 0

If the first payment date is allowed to fall on a day number greater than 28, then this element will be set to 1, for yes. Otherwise, a value of 0 will signify that payment dates beyond the 28th day of a month are not allowed.

🟥 <LoanSetup><AllowAutoLoans>

Data TypeValues
Booleantrue, false, 1, 0

If this account has been set up to auto prompts, then this element will be set to 1. Otherwise, a value of 0 indicates that no auto prompts are necessary. This is primarily for the Winloan32, as the SCE itself has no auto prompts defined. Instead, the calling application would need to take into account price, down payment, etc. and then feed the resulting actual loan amount to the SCE.

🟥 <LoanSetup><True360>

Data TypeValues
Booleantrue, false, 1, 0

If this account has been set up to use a True 360 day calendar (e.g. all months have 30 days, regardless of the actual number of days between payments), then this element will contain the value 1. Otherwise, a value of 0 will be present.

🟥 <LoanSetup><DebtProtection>

Element TypeData Type
DataText

If this account has been set up to offer debt protection coverage instead of insurance, then this element will hold the value 1. Otherwise, a value of 0 will be present. This setting is useful to distinguish debt protection verbiage from insurance verbiage, such as "fee" instead of "premium".

🟥 <LoanSetup><DebtTitle>

Element TypeData Type
DataText

Different lending institutions may use different terminology when offering debt protection. The value of this element contains the title of this product for the account.

🟥 <LoanSetup><ShowHOEPALoanType>

Data TypeValues
Booleantrue, false, 1, 0

HOEPA calculations have been deprecated in the SCE, so you may ignore this element.

🟥 <LoanSetup><PremiumType>

Element TypeData TypeValues
DataInteger[0..3]

The type of premium which has been set up for the account may be useful knowledge for your user interface. The numeric values possible and their associated meanings are as follows: 0 = standard single premium, 1 = standard monthly outstanding balance, 2 = True monthly outstanding balance, 3 = TruStage single premium.

🟥 <LoanSetup><PromptOpenEnd>

Data TypeValues
Booleantrue, false, 1, 0

If this element holds a value of 1, then this account has been set up to prompt the user if this is a TruStage open ended loan. A TruStage open ended loan causes all age and term related truncation caps to be ignored.

If this element holds a value other than 1, then the open ended prompt need not be displayed (and the corresponding LineOfCredit attribute of the <Protection> element should be set to false.

🟥 <LoanSetup><DiscloseHOEPA>

Data TypeValues
Booleantrue, false, 1, 0

HOEPA calculations have been deprecated in the SCE, so you may ignore this element.

🟥 <LoanSetup><AcceleratedBiWeekly>

Data TypeValues
Booleantrue, false, 1, 0

Accounts that have set up accelerated biweekly payment schedules will report a value of 1 in this element. If normal biweekly payments are set up, then a value of 0 will be returned.

If accelerated biweekly payment schedules are in effect, it is very important to understand that the value of the <Term> element sent to the SCEX will be interpreted as a number of monthly payments, not biweekly payments. The SCE will then compute a monthly loan based upon that term, divide the resulting payment in half, and then compute a biweekly loan term using the computed payment. This computed biweekly term is then returned with the response, along with all of the other standard result information.

🟥 <LoanSetup><DefaultBirthday>

Element TypeData Type
DataInteger

The default birthday to be used with protection products is entered here as an integer. e.g. January 17, 1996 would be returned as 19960117.

🟥 <LoanSetup><Construction>

Element TypeData TypeValues
DataInteger1, 2

Accounts that do not have construction loans configured will return a value of 0. If construction loans have been configured for this account, then a value greater than zero will be returned in this element, identifying the construction loan method in use:

  • 1 = simple method where construction interest is treated as a prepaid fee when a permanent loan is attached
  • 2 = LaserPro method which prepends interest only payments to the amortization schedule when a permanent loan is attached.

🟥 <ARM>

Element TypeData Type
Parent-

This element contains child elements describing how adjustable rate mortgages have been configured in the setup files. When computing ARMs, you can use these values as is, as defaults, or ignore them completely.

🟥 <ARM><FirstRateIncrease>

Element TypeData Type
DataDecimal

The default UI value for the <FirstRateIncrease> element of an <inARM> request.

🟥 <ARM><RoundRate>

Element TypeData Type
DataDecimal

The default UI value for the <RoundRate> element of an <inARM> request.

🟥 <ARM><TeaserTermDef>

Element TypeData Type
DataInteger

The default UI value for the <TeaserTerm> element of an <inARM> request.

🟥 <ARM><TermInc>

Element TypeData Type
DataInteger

The default UI value for the <TermSteps> element of an <inARM> request.

🟥 <ARM><TeaserRateDef>

Element TypeData Type
DataDecimal

The default UI value for the <TeaserRate> element of an <inARM> request.

🟥 <ARM><MaxAnnualInc>

Element TypeData Type
DataDecimal

The default UI value for the <AnnualRateIncrease> element of an <inARM> request.

🟥 <ARM><MaxLoanInc>

Element TypeData Type
DataDecimal

The default UI value for the <MaxRateIncrease> element of an <inARM> request.

🟥 <ARM><MinLifeRate>

Element TypeData Type
DataDecimal

The default UI value for the <MinRate> element of an <inARM> request.

🟥 <ARM><MaxLifeRate>

Element TypeData Type
DataDecimal

The default UI value for the <MaxRate> element of an <inARM> request.


🟥 <PMI>

Element TypeData Type
Parent-

This element contains child elements describing user interface issues dealing with PMI.

🟥 <PMI><AllowPMI>

Data TypeValues
Booleantrue, false, 1, 0

If PMI coverage is allowed, and hence if the prompts associated with it should appear, then the value of this element is 1. Otherwise, a value of 0 is returned and all further child elements of PMI may be ignored.

🟥 <PMI><AssumePMI>

Data TypeValues
Booleantrue, false, 1, 0

The value of this element indicates whether or not PMI coverage should be provided as a default with a new loan. A value of 1 indicates that PMI coverage should be defaulted to true, whereas a zero value indicates a default PMI coverage of false.

🟥 <PMI><UpFront>

Element TypeData Type
DataInteger

This element contains the number of periodic PMI premiums to be made up front, as reported in the setup files. When calling the SCE and requesting PMI coverage, you may either use this value or select a different value.

🟥 <PMI><PercentToWarn>

Element TypeData Type
DataInteger

This element contains the loan to value ratio at which a warning should be issued, as reported in the setup files. When calling the SCE and requesting PMI coverage, you may either use this value or select a different value.

🟥 <PMI><PercentToRemove>

Element TypeData Type
DataInteger

This element contains the loan to value ratio at which PMI coverage should be removed, as reported in the setup files. When calling the SCE and requesting PMI coverage, you may either use this value or select a different value.

🟥 <PMI><AddToPrin>

Data TypeValues
Booleantrue, false, 1, 0

The <AddToPrin> element determines if the up front PMI fee should be added to the principal balance, as reported in the setup files. A value of 1 means that the PMI fee should be added to the principal balance, whereas a value of 0 indicates that the PMI fee will be paid out of pocket. When calling the SCE and requesting PMI coverage, you may either use this value or select a different value.

🟥 <PMI><AddToFinChg>

Data TypeValues
Booleantrue, false, 1, 0

The <AddToFinChg> element determines if the up front PMI fee should be included in the Reg. Z Finance Charge (and hence, affect the APR), as reported in the setup files. A value of 1 means that the PMI fee should be added to the finance charge, whereas a value of 0 indicates that the PMI fee will not affect the finance charge nor APR. When calling the SCE and requesting PMI coverage, you may either use this value or select a different value.

🟥 <PMI><PutPMIinAmort>

Data TypeValues
Booleantrue, false, 1, 0

This element determines if the periodic PMI premiums should be included in the returned amortization schedule, as reported in the setup files. A value of 1 means that the PMI premiums should be included with the amortization table, whereas a value of 0 indicates that PMI will not show up in the amortization table. When calling the SCE and requesting PMI coverage, you may either use this value or select a different value.

🟥 <PMI><PromptFrequency>

Data TypeValues
Booleantrue, false, 1, 0

If the value of this element is 1, then the setup files indicate that the application should allow the user to select a PMI frequency different than the payment frequency of the loan. The application would then use this prompt's value to fill the Freq attribute of the PMI element for a loan requesting PMI coverage. A value of 0 indicates that the PMI frequency need not be prompted, and no Freq attribute need be specified (it will default to the payment frequency of the loan).

🟥 <PMI><PromptUpFront>

Data TypeValues
Booleantrue, false, 1, 0

If the value of this element is 1, then the setup files indicate that the application should allow the user to specify a number of periodic premiums to be paid up front (with the default value specified in the UpFront element discussed above). The application would then use this prompt's value to fill the UpFront attribute of the PMI element for a loan requesting PMI coverage. A value of 0 indicates that the UpFront PMI premium need not be prompted, and the UpFront attribute should be set to the value of the UpFront element.

🟥 <PMI><PromptAddToPrin>

Data TypeValues
Booleantrue, false, 1, 0

If the value of this element is 1, then the setup files indicate that the application should allow the user to specify whether or not the up front periodic PMI premiums should be added to the principal balance or not (with the default value specified in the <AddToPrin> element discussed above). The application would then use this prompt's value to fill the AddToPrin attribute of the PMI element for a loan requesting PMI coverage. A value of 0 indicates that this option need not be prompted, and the AddToPrin attribute should be set to the value of the AddToPrin element.

🟥 <PMI><PromptAddToFinChg>

Data TypeValues
Booleantrue, false, 1, 0

If the value of this element is 1, then the setup files indicate that the application should allow the user to specify whether or not the up front periodic PMI premiums should be added to the finance charge or not (with the default value specified in the AddToFinChg element discussed above). The application would then use this prompt's value to fill the AddToFinChg attribute of the PMI element for a loan requesting PMI coverage. A value of 0 indicates that this option need not be prompted, and the AddToFinChg attribute should be set to the value of the <AddToFinChg> element.


🟥 <CreditLife>

Element TypeData Type
Parent-

This element contains child elements describing user interface issues dealing with credit life.

🟥 <CreditLife><CLTitle>

Element TypeData Type
DataText

This element holds the product title associated with the SCE's credit life calculation option. This title defaults to Credit Life, although customers who wish to customize the name of this offering may do so. For example, it could simply be called Life, or Death. Customers who offer debt cancellation instead of insurance will also usually wish to change the name of their life product for regulatory reasons (e.g. DCL for debt cancellation life). The title may be used for inputs (e.g. "Credit Life Option") and outputs (e.g. "Credit Life Premium").

🟥 <CreditLife><CLAbbrev>

Element TypeData Type
DataText

Like the <CLTitle> element above, this element provides an abbreviation to be used for the product associated with the SCE's credit life calculation option. The value of this element defaults to CL, although customers who wish to customize this abbreviation may do so. Customers who offer debt cancellation instead of insurance will also usually wish to change the abbreviations of their life product for regulatory reasons (e.g. DCL for debt cancellation life). The title may be used for inputs (e.g. "CL Option") and outputs (e.g. "CL Coverage Term").

🟥 <CreditLife><CLAllow>

Data TypeValues
Booleantrue, false, 1, 0

If credit life coverage is allowed, and hence if the prompts associated with it should appear, then the value of this element is 1. Otherwise, a value of 0 is returned.

🟥 <CreditLife><CLSingleOnCoBorrower>

Data TypeValues
Booleantrue, false, 1, 0

If single coverage is allowed on the co-borrower, then this element will hold a value of 1. If it holds a value of 0, then single life is only allowed on the primary borrower.

🟥 <CreditLife><CLDefault>

Element TypeData TypeValues
DataInteger[0..3]

Specifies the default credit life option: 0 = None, 1 = Single, 2 = Joint, 3 = Single on Co-borrower.

🟥 <CreditLife><CLDefaultMethod>

Element TypeData TypeValues
DataInteger[0..2]

The default credit life method as specified in the setup files: 0 = Gross, 1 = Net, 2 = MOB.

🟥 <CreditLife><CLPromptMethod>

Data TypeValues
Booleantrue, false, 1, 0

Some accounts using single premium insurance may support both net and gross credit life. If this is the case, this element will hold a value of 1 to signal the UI that the user should be prompted for the credit life method. A value of 0 indicates that prompting for the credit life method is not required, as only one method is allowed.

🟥 <CreditLife><CLPromptTermGross>

Data TypeValues
Booleantrue, false, 1, 0

If this element holds a value of 1, then the user may be prompted for a desired term of coverage for single premium gross credit life. A value of 0 indicates that user specified truncation is not allowed and should not be prompted.

🟥 <CreditLife><CLPromptTermNet>

Data TypeValues
Booleantrue, false, 1, 0

If this element holds a value of 1, then the user may be prompted for a desired term of coverage for single premium net credit life. A value of 0 indicates that user specified truncation is not allowed and should not be prompted.

🟥 <CreditLife><CLPromptTermMOB>

Data TypeValues
Booleantrue, false, 1, 0

If this element holds a value of 1, then the user may be prompted for a desired term of coverage for MOB credit life. A value of 0 indicates that user specified truncation is not allowed and should not be prompted.

🟥 <CreditLife><CLPromptDismemberment>

Data TypeValues
Booleantrue, false, 1, 0

Some accounts allow for an additional dismemberment option to be written with the credit life policy (with an associated rate increase). If dismemberment is an option for this account, then the element will hold a value of 1. Otherwise, a value of 0 indicates that no dismemberment is offered.

🟥 <CreditLife><CLPromptUseLevelRates>

Data TypeValues
Booleantrue, false, 1, 0

In some states, it is legal to compute decreasing credit life using level rates. If that is an option for the account specified, then this value will contain a value of 1 indicating that the UI should prompt for the option to use level rates. A value of 0 indicates that this option is not allowed, and hence the prompt for using level rates should not be presented to the user.

🟥 <CreditLife><CLPromptBirthdaysGross>

Data TypeValues
Booleantrue, false, 1, 0

If age caps are in effect for single premium gross life coverage, and the UI needs to prompt for birthdays, then this value will be set to 1. If age truncation is not set up, then this element will hold a value of 0.

🟥 <CreditLife><CLPromptBirthdaysNet>

Data TypeValues
Booleantrue, false, 1, 0

If age caps are in effect for single premium net life coverage, and the UI needs to prompt for birthdays, then this value will be set to 1. If age truncation is not set up, then this element will hold a value of 0.

🟥 <CreditLife><CLPromptBirthdaysMOB>

Data TypeValues
Booleantrue, false, 1, 0

If age caps are in effect for MOB life coverage, and the UI needs to prompt for birthdays, then this value will be set to 1. If age truncation is not set up, then this element will hold a value of 0.

🟥 <CreditLife><CLPromptCov>

Data TypeValues
Booleantrue, false, 1, 0

If the account has been set up to allow for a coverage amount to be specified by the user, then this value will be set to 1 to indicate that the UI should prompt the user for a life coverage amount. A value of 0 indicates that only the default coverage amount will be considered, and hence there is no need to prompt for a user specified coverage.

🟥 <CreditLife><CLMinLoanTerm>

Data TypeValues
Booleantrue, false, 1, 0

This element contains the minimum loan term (in months) for which credit life coverage is allowed. A value of 0 indicates that no minimum loan term is in effect.

🟥 <CreditLife><CLMinTruncTerm>

Data TypeValues
Booleantrue, false, 1, 0

This element holds the minimum term (in months) that credit life may be truncated. If the coverage term is truncated to a value less than this amount, then coverage will be dropped. A value of 0 indicates that there is no credit life minimum truncation term.

🟥 <CreditLife><CLAllowNonMonthlyGross>

Data TypeValues
Booleantrue, false, 1, 0

If single premium gross credit life is allowed on loans with payment frequencies of 1, 2, 4, or 6 payments per year, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on these payment frequencies, and hence the UI need not display credit life prompts.

🟥 <CreditLife><CLAllowWeeklyGross>

Data TypeValues
Booleantrue, false, 1, 0

If single premium gross credit life is allowed on loans with payment frequencies of 24, 26, or 52 payments per year, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on these payment frequencies, and hence the UI need not display credit life prompts.

🟥 <CreditLife><CLAllowNonMonthlyNet>

Data TypeValues
Booleantrue, false, 1, 0

If single premium net credit life is allowed on loans with payment frequencies of 1, 2, 4, or 6 payments per year, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on these payment frequencies, and hence the UI need not display credit life prompts.

🟥 <CreditLife><CLAllowWeeklyNet>

Data TypeValues
Booleantrue, false, 1, 0

If single premium net credit life is allowed on loans with payment frequencies of 24, 26, or 52 payments per year, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on these payment frequencies, and hence the UI need not display credit life prompts.

🟥 <CreditLife><CLAllowNonMonthlyMOB>

Data TypeValues
Booleantrue, false, 1, 0

If MOB credit life is allowed on loans with payment frequencies of 1, 2, 4, or 6 payments per year, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on these payment frequencies, and hence the UI need not display credit life prompts.

🟥 <CreditLife><CLAllowWeeklyMOB>

Data TypeValues
Booleantrue, false, 1, 0

If MOB credit life is allowed on loans with payment frequencies of 24, 26, or 52 payments per year, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on these payment frequencies, and hence the UI need not display credit life prompts.

🟥 <CreditLife><CLMult>

Element TypeData TypeValues
DataInteger1, 3, 6, 12

If the user is allowed to specify a truncated term of coverage for credit life (see <CLPromptTermGross>, <CLPromptTermNet> and <CLPromptTermMOB> above), then this value defines the multiple which the entered term of coverage must with. Possible values are: 1 (any), 3, 6 and 12.

🟥 <CreditLife><CLNBCManditory>

Data TypeValues
Booleantrue, false, 1, 0

This was a custom modification made for a specific client, and can safely be ignored by all others.

🟥 <CreditLife><LLTitle>

Element TypeData Type
DataText

This element holds the product title associated with the SCE's level credit life calculation. This title defaults to Level Life, although customers who wish to customize the name of this offering may do so.

The title may be used for inputs (e.g. "Level Life Option") and outputs (e.g. "Level Life Premium").

🟥 <CreditLife><LLAbbrev>

Element TypeData Type
DataText

Like the <LLTitle> element above, this element provides an abbreviation to be used for the product associated with the SCE’s level credit life calculation option. The value of this element defaults to LL, although customers who wish to customize this abbreviation may do so. The title is primarily useful when producing outputs (e.g. "LL Coverage Term").


🟥 <AccidentHealth>

Element TypeData Type
Parent-

This element contains child elements describing user interface issues dealing with accident and health coverage (A&H).

🟥 <AccidentHealth><AHTitle>

Element TypeData Type
DataText

This element holds the product title associated with the SCE's accident and health calculation option. This title defaults to Accident & Health, although customers who wish to customize the name of this offering may do so. For example, it could simply be called Disability.

🟥 <AccidentHealth><AHAbbrev>

Element TypeData Type
DataText

Like the <AHTitle> element above, this element provides an abbreviation to be used for the product associated with the SCE’s accident and health calculation option. The value of this element defaults to AH, although customers who wish to customize this abbreviation may do so. Customers who offer debt cancellation instead of insurance will also usually wish to change the abbreviations of their life product for regulatory reasons (e.g., DCD for debt cancellation disability).

The title may be used for inputs (e.g., "AH Option") and outputs (e.g., "AH Coverage Term").

🟥 <AccidentHealth><AHAllow>

Element TypeData TypeValues
DataInteger[0..2]

If A&H coverage is allowed by the account settings, then this element will contain a value of either 1 (single A&H only) or 2 (both single and joint A&H offered). A value of 0 indicates that A&H coverage is not allowed for this account.

🟥 <AccidentHealth><AHSingleOnCoBorrower>

Data TypeValues
Booleantrue, false, 1, 0

If single coverage is allowed on the co-borrower, then this element will hold a value of 1. If it holds a value of 0, then single life is only allowed on the primary borrower.

🟥 <AccidentHealth><AHMethod>

Element TypeData TypeValues
DataInteger[0..2]

This element describes the method used to compute the A&H premium: 0 = Single Premium, 1 = MOB Net, 2 = MOB Gross.

🟥 <AccidentHealth><AHAllowBalloonGross>

Data TypeValues
Booleantrue, false, 1, 0

If A&H coverage is allowed on balloon loans covered with single premium gross credit life insurance, then this element will hold a value of 1. Otherwise, a value of 0 will be present.

🟥 <AccidentHealth><AHAllowBalloonNet>

Data TypeValues
Booleantrue, false, 1, 0

If A&H coverage is allowed on balloon loans covered with single premium net credit life insurance, then this element will hold a value of 1. Otherwise, a value of 0 will be present.

🟥 <AccidentHealth><AHDefault>

Element TypeData TypeValues
DataInteger[0..3]

Specifies the default A&H option: 0 = None, 1 = Single, 2 = Joint, 3 = Single on Co-borrower.

🟥 <AccidentHealth><AHPromptBenefit>

Data TypeValues
Booleantrue, false, 1, 0

If the account has been set up to allow for a benefit amount to be specified by the user, then this value will be set to 1 to indicate that the UI should prompt the user for the desired A&H benefit amount. A value of 0 indicates that only the default benefit amount will be considered, and hence there is no need to prompt for a user specified benefit.

🟥 <AccidentHealth><AHPromptTermGross>

Data TypeValues
Booleantrue, false, 1, 0

If this element holds a value of 1, then the user may be prompted for a desired term of coverage for A&H coverage with single premium gross credit life. A value of 0 indicates that user specified truncation is not allowed and should not be prompted.

🟥 <AccidentHealth><AHPromptTermNet>

Data TypeValues
Booleantrue, false, 1, 0

If this element holds a value of 1, then the user may be prompted for a desired term of coverage for A&H coverage with single premium net credit life. A value of 0 indicates that user specified truncation is not allowed and should not be prompted.

🟥 <AccidentHealth><AHMinTruncTerm>

Element TypeData Type
DataInteger

This element holds the minimum term (in months) that A&H may be truncated. If the coverage term is truncated to a value less than this amount, then coverage will be dropped. A value of 0 indicates that there is no minimum truncation term.

🟥 <AccidentHealth><AHPromptBirthdays>

Data TypeValues
Booleantrue, false, 1, 0

If age caps are in effect for A&H, and the UI needs to prompt for birthdays, then this value will be set to 1. If age truncation is not set up, then this element will hold a value of 0.

🟥 <AccidentHealth><AHMult>

Element TypeData TypeValues
DataInteger1, 3, 6, 12

If the user is allowed to specify a truncated term of coverage for A&H (see <AHPromptTermGross> and <AHPromptTermNet> above), then this value defines the number of which the entered term of coverage must be a multiple. Possible values are: 1 (any), 3, 6 and 12.

🟥 <AccidentHealth><AHOnly>

Data TypeValues
Booleantrue, false, 1, 0

If A&H is allowed without credit life, then this element will hold the value 1. A value of 0 indicates that A&H may not be written without life coverage.

🟥 <AccidentHealth><AHJointWOJointCL>

Data TypeValues
Booleantrue, false, 1, 0

If Joint A&H is allowed without joint credit life, then this element will hold the value 1. A value of 0 indicates that joint A&H may not be written without joint life coverage. Note that if the value of <AHOnly> is 0, then this setting should be ignored.

🟥 <AccidentHealth><AHNonMonthly>

Data TypeValues
Booleantrue, false, 1, 0

If A&H is allowed on loans with payment frequencies other than monthly, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on non-monthly loans, and hence the UI need not display A&H prompts.

🟥 <AccidentHealth><AHSetCount>

Element TypeData Type
DataInteger

The number of A&H rate sets available is specified by this element.

🟥 <AccidentHealth><AHSetTitle>[]

Element TypeData Type
DataText

For each A&H rate set available (see above for the number available), there will be one <AHSetTitle> element holding the name of the set. The order of these elements corresponds to the Table numbers used to specify the sets. Thus, the first <AHSetTitle> element holds the name of the first A&H rate set, and corresponds to Table="0".

🟥 <AccidentHealth><AHTermEqualsCL>

Data TypeValues
Booleantrue, false, 1, 0

Some accounts are set up such that specified terms of coverage are allowed for credit life and disability, however they must be the same. If this is the case, then this element will hold a value of 1.

On the other hand, if different specified terms of coverage are allowed, then this element will contain a value of 0.


🟥 <InvoluntaryUnemployment>

Element TypeData Type
Parent-

This element contains child elements describing user interface issues dealing with involuntary unemployment coverage (IUI).

🟥 <InvoluntaryUnemployment><IUITitle>

Element TypeData Type
DataText

This element holds the product title associated with the SCE’s involuntary unemployment calculation option. This title defaults to Involuntary Unemployment, although customers who wish to customize the name of this offering may do so. For example, it could simply be called Unemployment, or Job Loss. Customers who offer debt cancellation instead of insurance will also usually wish to change the name of their disability product for regulatory reasons.

The title may be used for inputs (e.g., "Involuntary Unemployment Option") and outputs (e.g., "Involuntary Unemployment Premium").

🟥 <InvoluntaryUnemployment><IUIAbbrev>

Element TypeData Type
DataText

Like the <IUITitle> element above, this element provides an abbreviation to be used for the product associated with the SCE’s involuntary unemployment calculation option. The value of this element defaults to IU, although customers who wish to customize this abbreviation may do so. Customers who offer debt cancellation instead of insurance will also usually wish to change the abbreviations of their life product for regulatory reasons (e.g., DCU for debt cancellation unemployment).

The title may be used for inputs (e.g., "IU Option") and outputs (e.g., "IU Coverage Term").

🟥 <InvoluntaryUnemployment><IUAllow>

Element TypeData TypeValues
DataInteger[0..2]

If IUI coverage is allowed by the account settings, then this element will contain a value of either 1 (single IUI only) or 2 (both single and joint IUI offered). A value of 0 indicates that IUI coverage is not allowed for this account.

🟥 <InvoluntaryUnemployment><IUIDefault>

Element TypeData TypeValues
DataInteger[0..2]

Specifies the default IUI option. 0 = None, 1 = Single, 2 = Joint, 3 = Single on Co-borrower.

🟥 <InvoluntaryUnemployment><IUSingleOnCoBorrower>

Data TypeValues
Booleantrue, false, 1, 0

If single coverage is allowed on the co-borrower, then this element will hold a value of 1. If it holds a value of 0, then single life is only allowed on the primary borrower.

🟥 <InvoluntaryUnemployment><IUOnly>

Data TypeValues
Booleantrue, false, 1, 0

If IUI is allowed without A&H, then this element will hold the value 1. A value of 0 indicates that IUI may not be written without A&H coverage.

🟥 <InvoluntaryUnemployment><IUJointWOJointCL>

Data TypeValues
Booleantrue, false, 1, 0

If Joint IUI is allowed without joint credit life, then this element will hold the value 1. A value of 0 indicates that joint IUI may not be written without joint life coverage. Note that if the value of <IUOnly> is 0, then this setting should be ignored.

🟥 <InvoluntaryUnemployment><IUwoAH>

Data TypeValues
Booleantrue, false, 1, 0

If IUI is allowed without A&H, then this element will hold the value 1. A value of 0 indicates that IUI may not be written without A&H coverage.

🟥 <InvoluntaryUnemployment><IUJointWOJointAH>

Data TypeValues
Booleantrue, false, 1, 0

If joint IUI is allowed without joint A&H, then this element will hold the value 1. A value of 0 indicates that joint IUI may not be written without joint A&H.

🟥 <InvoluntaryUnemployment><IUPromptBenefit>

Data TypeValues
Booleantrue, false, 1, 0

If the account has been set up to allow for a benefit amount to be specified by the user, then this value will be set to 1 to indicate that the UI should prompt the user for a the desired IUI benefit amount. A value of 0 indicates that only the default benefit amount will be considered, and hence there is no need to prompt for a user specified benefit.

🟥 <InvoluntaryUnemployment><IUPromptTerm>

Data TypeValues
Booleantrue, false, 1, 0

If this element holds a value of 1, then the user may be prompted for a desired term of coverage for IUI coverage. A value of 0 indicates that user specified truncation is not allowed and should not be prompted.

🟥 <InvoluntaryUnemployment><IUMult>

Element TypeData TypeValues
DataInteger1, 3, 6, 12

If the user is allowed to specify a truncated term of coverage for IUI (see <IUPromptTerm> above), then this value defines the number of which the entered term of coverage must be a multiple. Possible values are: 1 (any), 3, 6 and 12.

🟥 <InvoluntaryUnemployment><IUPromptBirthdays>

Data TypeValues
Booleantrue, false, 1, 0

If age caps are in effect for IUI, and the UI needs to prompt for birthdays, then this value will be set to 1. If age truncation is not set up, then this element will hold a value of 0.

🟥 <InvoluntaryUnemployment><IUTermEqualsCLTerm>

Data TypeValues
Booleantrue, false, 1, 0

Some accounts are set up such that specified terms of coverage are allowed for credit life and IUI, however they must be the same. If this is the case, then this element will hold a value of 1.

On the other hand, if different specified terms of coverage are allowed, then this element will contain a value of 0.

🟥 <InvoluntaryUnemployment><IUNonMonthly>

Data TypeValues
Booleantrue, false, 1, 0

If IUI is allowed on loans with payment frequencies other than monthly, then this element will hold a value of 1. A value of 0 indicates that coverage is not allowed on non-monthly loans, and hence the UI need not display IUI prompts.


🟥 <PersonalProperty>

Element TypeData Type
Parent-

This element contains child elements describing user interface issues dealing with personal property coverage (PP).

🟥 <PersonalProperty><PPTitle>

Element TypeData Type
DataText

This element holds the product title associated with the SCE’s personal property calculation option. This title defaults to Personal Property, although customers who wish to customize the name of this offering may do so. For example, it could simply be called Property. Customers who offer debt cancellation instead of insurance will also usually wish to change the name of their personal property product for regulatory reasons.

The title may be used for inputs (e.g. "Personal Property Option") and outputs (e.g. "Personal Property Premium").

🟥 <PersonalProperty><PPAbbrev>

Element TypeData Type
DataText

Like the <PPTitle> element above, this element provides an abbreviation to be used for the product associated with the SCE’s personal property calculation option. The value of this element defaults to PP, although customers who wish to customize this abbreviation may do so. Customers who offer debt cancellation instead of insurance will also usually wish to change the abbreviations of their life product for regulatory reasons (e.g. DCP for debt cancellation property).

The title may be used for inputs (e.g. "PP Option") and outputs (e.g. "PP Coverage Term").

🟥 <PersonalProperty><PPAllow>

Element TypeData TypeValues
DataInteger[0..2]

If PP coverage is allowed by the account settings, then this element will contain a value of either 1 (single PP only) or 2 (both single and joint PP offered). A value of 0 indicates that PP coverage is not allowed for this account.

🟥 <PersonalProperty><PPDefault>

Element TypeData TypeValues
DataInteger[0..2]

Specifies the default PP option: 0 = None, 1 = Single, 2 = Joint.

🟥 <PersonalProperty><PPPromptCoverage>

Data TypeValues
Booleantrue, false, 1, 0

If the account has been set up with a personal property type which allows the user to specify a coverage amount, then this element will hold the value of 1. Otherwise, a value of 0 indicates that no coverage prompt need be displayed for PP.