User Interface Module - Response

The Data object for a response from the Ui module is defined below, in the order the fields are returned:

🟥 Data

The Data object for a response from the Cd module is defined below, in the order the fields and objects are returned:

Fields: None

Objects: 🟥Errors[], 🟥Warnings[], 🟥Ls, 🟥Cl, 🟥Ah, 🟥Iu, 🟥Pp

The Data object for a response from the User Interface module is defined below:

🟥 Data.Errors[]

The Errors[] field contains an array of Strings which describe any errors encountered while handling the request. If the length of the Errors[] Array is zero (0), then the module processed the request successfully, and the Data object can be further processed by the calling application for the returned data.

On the other hand, if the length of the Errors[] Array is greater than zero (0), then this indicates that an error condition has been detected, and the calling application should not process the respons Data object further. In this case, the contents of the Errors[] array will describe the error(s) encountered.

Typical errors include the omission of 🟥 required fields, invalid field values, etc.

🟥 Data.Warnings[]

The Warnings[] field contains an array of Strings which describe any warnings generated by the module handling the request. The most common warnings returned by modules inform the calling application that the module does not recognize a specified field (which may help to isolate a field name spelling error in the calling application's code). Note that field names which start with "//" will bre treated as comment fields by the SCE, and no warnings will be generated for these unrecognized fields.

Example - Request and response illustrating warnings when passing unrecognized fields:

{
  "Module" : "Ui",
  "Data" : {
    "//" : "This is a comment.",
    "Hello" : "Friend!",
    "How" : "are you?"
  }
}

{
  "Result" : 200,
  "Module" : "Ui",
  "Data" : {
    "Errors" : [
    ],
    "Warnings" : [
      "Request field Data.Hello (String) not recognized.",
      "Request field Data.How (String) not recognized."
    ],
    ...
  }
}   

🟥 Data.Ls

The Ls object returns information on general loan configuration setup file data.

Fields: 🔸Status

Objects: 🟥LoanTypes 🟥Accrual

🔸 Data.Ls.Status

If the loan setup fil was successfully loaded and parsed, the value of this field will be Loaded. Any other return value indicates an error has occurred while trying to loan the loan setup file for the account number requested.

🟥 Data.Ls.LoanTypes

The LoanTypes object returns fields which indicate if a loan of a given repayment schedule is allowed, according to the loan setup file associated with the account.

Fields: 🔹ARM, 🔹Balloon, 🔹Construction, 🔹Equal, 🔹IntOnly, 🔹PrinPlus, 🔹SinglePay, 🔹SkipsIrregs, 🔹SkipsPickups

Objects: None

🔹 Data.Ls.LoanTypes.ARM

Returns a value of true if adjustable rate loans available for this account.

🔹 Data.Ls.LoanTypes.Balloon

Returns a value of true if balloon loans available for this account?

🔹 Data.Ls.LoanTypes.Construction

Returns a value of true if construction loans available for this account.

🔹 Data.Ls.LoanTypes.Equal

Returns a value of true if equal payment loans available for this account.

🔹 Data.Ls.LoanTypes.IntOnly

Returns a value of true if interest only loans available for this account.

🔹 Data.Ls.LoanTypes.PrinPlus

Returns a value of true if fixed principal plus interest loans available for this account.

🔹 Data.Ls.LoanTypes.SinglePay

Returns a value of true if single payment notes available for this account.

🔹 Data.Ls.LoanTypes.SkipsIrregs

Returns a value of true if loans with skipped and specified irregular payments available for this account.

🔹 Data.Ls.LoanTypes.SkipsPickups

Returns a value of true if loans with skipped and pickup payments available for this account.

🟥 Data.Ls.Accrual

The Accrual object returns information regarding how various interest accrual settings have been configured in the loan setup file associated with the account.

Fields: 🔸Code, 🔹LastDay, 🔹InterestRound, 🔹PaymentRound, 🔸SinglePayDivisor

Objects: None

🔸 Data.Ls.Accrual.Code

The method of interest accrual configured for the account is returned in this field. All valid accrual codes are described in the table below.

🔹 Data.Ls.Accrual.LastDay

This setting only applies to loans computed with an actual day accrual calendar where the first payment date falls at the end of a month with fewer than 31 days. As an example, if the first payment date is on April 30, should the following payment dates be made on the 30th of each month, or on the last day of the month?

A value of true means that when conditions triggering a last day situation are active, this will result in payments which fall at the end of the month. A value of false indicates that when dictated, subsequent payment dates will not be moved to the last day of the month.

🔹 Data.Ls.Accrual.InterestRound

When amortizing interest in the amortization schedule, the value of this field dictates how the SCE rounds off interest with fractional currency units.

🔹 Data.Ls.Accrual.PaymentRound

When the SCE computes the payment which best amortizes the loan to zero, the value of this field dictates how the payment is rounded.

A value of Best means to choose the payment that returns a minimal ending balance at the end of amortization. If two payments result in the same minimal error magnitude, the smaller payment is chosen.

🔸 Data.Ls.Accrual.SinglePayDivisor

When computing a single payment note, the value of this field determines the number of days in the interest accrual factor's divisor.

🟥 Data.Cl

The Cl object returns information on life protection configuration setup file data.

Fields: 🔸Active, 🔹IsDP, 🔸Method

Objects: 🟥AllowOn, 🟦CUNASP, 🟦SinglePremium, 🟦StandardMob, 🟦TrueMob

🔸 Data.Cl.Active

If life coverage is configured and allowed on one or more loan types, then the value of this field will be true and the rest of the object should be parsed for further details.

A value of false indicates that life coverage is not confiured nor allowed for this account. Furthermore, no other fields of the Cl object will be returned to the calling application.

🔹 Data.Cl.IsDP

If the life product has been configured as a debt protection product, then the value of this field will be true. A value of false indicates that the life product is considered insurance.

🔸 Data.Cl.Method

The Method field returns the general method used to compute the life products premiums/fees. SinglePremium indicates that a single premium or fee is computed and (usually) financed. The StandardMob method computes a premium/fee with each payment. The TrueMOB method computes a premium/fee on a specified day number every month. Finally, CUNASP is a single premium method implemented specifically for TruStage.

The value of this field also corresponds to the name of the Cl object field which will return further information useful for this general method.

As an example, if Cl.Method is SinglePremium, then there will be a Cl.SinglePremium object which should be parsed (detailed below) for additional information realted to this method.

🟥 Data.Cl.AllowOn

The AllowOn object contains fields which inform the calling application the loan types which allow for the inclusion of this life product.

Fields: 🔹ARM, 🔹Balloon, 🔹Equal, 🔹IntOnly, 🔹Irregs, 🔹PrinPlus, 🔹SinglePay

Objects: None

🔹 Data.Cl.AllowOn.ARM

A value of true indicates that life coverage is allowed on Adjustable Rate Mortgages.

🔹 Data.Cl.AllowOn.Balloon

A value of true indicates that life coverage is allowed on Balloon Payment Loans.

🔹 Data.Cl.AllowOn.Equal

A value of true indicates that life coverage is allowed on Equal Payment Loans.

🔹 Data.Cl.AllowOn.IntOnly

A value of true indicates that life coverage is allowed on Interest Only Loans.

🔹 Data.Cl.AllowOn.Irregs

A value of true indicates that life coverage is allowed on Skip, Pickup and Irregular Payment Loans.

🔹 Data.Cl.AllowOn.PrinPlus

A value of true indicates that life coverage is allowed on Fixed Principal Plus Interest Loans.

🔹 Data.Cl.AllowOn.SinglePay

A value of true indicates that life coverage is allowed on Single Payment Notes.

🟦 Data.Cl.CUNASP

The CUNASP object will only be returned when Cl.Method is CUNASP. It contains additional information which should be parsed related to this general method.

Fields: 🔸Abbrev 🔸Title

Objects: None

🔸 Data.Cl.CUNASP.Abbrev

Like the Title field below, this field provides an abbreviation to be used for the product associated with the SCE's configured 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).

🔸 Data.Cl.CUNASP.Title

The value of this field holds the product title associated with the SCE's configured life product. 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.

The title may be used for inputs (e.g. Credit Life Option) and outputs (e.g. Credit Life Premium/Fee).

🟦 Data.Cl.SinglePremium

Fields: 🔸DlAbbrev, 🔸DlTitle, 🔸LlAbbrev, 🔸LlTitle, 🔹Gross, 🔹Level, 🔹Net, 🔹OrdinaryLife

Objects: 🟥Prompts

The SinglePremium object will only be returned when Cl.Method is SinglePremium. It contains additional information which should be parsed related to this general method.

🔸 Data.Cl.SinglePremium.DlAbbrev

Like the Title field below, this field provides an abbreviation to be used for the product associated with the SCE's configured decreasing 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).

🔸 Data.Cl.SinglePremium.DlTitle

The value of this field holds the product title associated with the SCE's configured decreasing life product. 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.

The title may be used for inputs (e.g. Credit Life Option) and outputs (e.g. Credit Life Premium/Fee).

🔸 Data.Cl.SinglePremium.LlAbbrev

Similar to SinglePremium.DlAbbrev, except this abbreviation is for the configured level life product.

🔸 Data.Cl.SinglePremium.LlTitle

Similar to SinglePremium.DlTitle, except this abbreviation is for the configured level life product.

🔹 Data.Cl.SinglePremium.Gross

If gross coverage is allowed for the configured life product, then the value of this field will be true. A value of false indicates that gross coverage is not supported.

🔹 Data.Cl.SinglePremium.Level

If level coverage is allowed for the configured life product, then the value of this field will be true. A value of false indicates that level coverage is not supported.

🔹 Data.Cl.SinglePremium.Net

If net coverage is allowed for the configured life product, then the value of this field will be true. A value of false indicates that net coverage is not supported.

🔹 Data.Cl.SinglePremium.OrdinaryLife

If an ordinary life product has been configured for the life product, then the value of this field will be true. A value of false indicates that no odinary life product is supported.

🟥 Data.Cl.SinglePremium.Prompts

The Prompts object returns information to the calling application about optional prompts/inputs that may be allowed for this life product.

Fields: 🔹CoverageAmount, 🔹CoverageTermGross, 🔹CoverageTermNet, 🔹Dismemberment, 🔹GrossNet, 🔹SingleOnCoborrower, 🔹UseLevelRatesGross, 🔹UseLevelRatesNet

Objects: None

🔹 Data.Cl.SinglePremium.Prompts.CoverageAmount

If the account has been configured to allow for a coverage amount to be specified by the user, then the value of this field will be true, which indicates that the user interface should prompt the user for a life coverage amount. A value of false indicates that only the default coverage amount will be considered, and hence there is no need to prompt for a user specified coverage.

🔹 Data.Cl.SinglePremium.Prompts.CoverageTermGross

A value of true implies that the user may be prompted for a desired term of coverage for single premium gross life. A value of false indicates that user specified coverage term truncation is not allowed and should not be prompted.

🔹 Data.Cl.SinglePremium.Prompts.CoverageTermNet

A value of true implies that the user may be prompted for a desired term of coverage for single premium net life. A value of false indicates that user specified coverage term truncation is not allowed and should not be prompted.

🔹 Data.Cl.SinglePremium.Prompts.Dismemberment

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

🔹 Data.Cl.SinglePremium.Prompts.GrossNet

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

🔹 Data.Cl.SinglePremium.Prompts.SingleOnCoborrower

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

🔹 Data.Cl.SinglePremium.Prompts.UseLevelRatesGross

In some states, it is legal to compute gross decreasing life using level rates. If that is an option for this account, then this value of this field will be true, which indicates that the user interface should prompt for the option to use level rates with gross life. A value of false indicates that this option is not allowed, and hence the prompt for using level rates should not be presented to the user.

🔹 Data.Cl.SinglePremium.Prompts.UseLevelRatesNet

In some states, it is legal to compute net decreasing life using level rates. If that is an option for this account, then this value of this field will be true, which indicates that the user interface should prompt for the option to use level rates with net life. A value of false indicates that this option is not allowed, and hence the prompt for using level rates should not be presented to the user.

🟦 Data.Cl.StandardMob

The StandardMob object will only be returned when Cl.Method is StandardMob. It contains additional information which should be parsed related to this general method.

Fields: 🔸Abbrev, 🔸Title

Objects: 🟥Prompts

🔸 Data.Cl.StandardMob.Abbrev

Like the Title field below, this field provides an abbreviation to be used for the product associated with the SCE's configured 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).

🔸 Data.Cl.StandardMob.Title

The value of this field holds the product title associated with the SCE's configured life product. 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.

The title may be used for inputs (e.g. Credit Life Option) and outputs (e.g. Credit Life Premium/Fee).

🟥 Data.Cl.StandardMob.Prompts

The Prompts object returns information to the calling application about optional prompts/inputs that may be allowed for this life product.

Fields: 🔹CoverageAmount, 🔹CoverageTerm, 🔹Dismemberment, 🔹SingleOnCoborrower

Objects: None

🔹 Data.Cl.StandardMob.Prompts.CoverageAmount

If the account has been configured to allow for a coverage amount to be specified by the user, then the value of this field will be true, which indicates that the user interface should prompt the user for a life coverage amount. A value of false indicates that only the default coverage amount will be considered, and hence there is no need to prompt for a user specified coverage.

🔹 Data.Cl.StandardMob.Prompts.CoverageTerm

A value of true implies that the user may be prompted for a desired term of coverage for life. A value of false indicates that user specified coverage term truncation is not allowed and should not be prompted.

🔹 Data.Cl.StandardMob.Prompts.Dismemberment

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

🔹 Data.Cl.StandardMob.Prompts.SingleOnCoborrower

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

🟦 Data.Cl.TrueMob

The TrueMob object will only be returned when Cl.Method is TrueMob. It contains additional information which should be parsed related to this general method.

Fields: 🔸Abbrev, 🔸Title

Objects: 🟥Prompts

🔸 Data.Cl.TrueMob.Abbrev

Like the Title field below, this field provides an abbreviation to be used for the product associated with the SCE's configured 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).

🔸 Data.Cl.TrueMob.Title

The value of this field holds the product title associated with the SCE's configured life product. 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.

The title may be used for inputs (e.g. Credit Life Option) and outputs (e.g. Credit Life Premium/Fee).

🟥 Data.Cl.TrueMob.Prompts

The Prompts object returns information to the calling application about optional prompts/inputs that may be allowed for this life product.

Fields: 🔹SingleOnCoborrower

Objects: None

🔹 Data.Cl.TrueMob.Prompts.SingleOnCoborrower

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

🟥 Data.Ah

The Ah object returns information on accident and health protection (A&H) configuration setup file data. Note that packaged debt protection products use the Ah product for implementation (see Ah.IsPackagedDP).

Fields: 🔸Active, 🔸Abbrev, 🔸Title, 🔹IsDP, 🔹IsPackagedDP, 🔸Method

Objects: 🟥AllowOn, 🟥Prompts, 🟥Rules, 🟥Tables

🔸 Data.Ah.Active

If A&H coverage is configured and allowed on one or more loan types, then the value of this field will be true and the rest of the object should be parsed for further details.

A value of false indicates that A&H coverage is not confiured nor allowed for this account. Furthermore, no other fields of the Ah object will be returned to the calling application.

🔸 Data.Ah.Abbrev

Like the Title field below, this field provides an abbreviation to be used for the product associated with the SCE's configured A&H 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 A&H product for regulatory reasons.

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

🔸 Data.Ah.Title

The value of this field holds the product title associated with the SCE's configured disability product. This title defaults to Accident & Health, although customers who wish to customize the name of this offering may do so. 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. Accident & Health Option) and outputs (e.g. Accident & Health Premium/Fee).

🔹 Data.Ah.IsDP

If the A&H product has been configured as a debt protection product, then the value of this field will be true. A value of false indicates that the A&H product is considered insurance.

🔹 Data.Ah.IsPackagedDP

If the A&H product has been configured as a packaged debt protection product, then the value of this field will be true. A value of false indicates that the A&H product is not configured as packaged debt protection.

When A&H is configured as packaged debt protection, the debt protection plans offered are all enumerated under Ah.Tables[]. As an example, if there are four packaged debt protection plans configured, then the Ah.Tables[] array will return the name of each plan, in order. Thus, if Ah.Tables is equal to ["Life", "Life and Disability", "Life, Disability, and Unemployment"] then Table #1 corresponds to Life, etc.

🔸 Data.Ah.Method

The Method field returns the general method used to compute the A&H product premiums/fees. SinglePremium indicates that a single premium or fee is computed and (usually) financed. The StandardMob method computes a premium/fee with each payment. The TrueMOB method computes a premium/fee on a specified day number every month. Finally, CUNASP is a single premium method implemented specifically for TruStage.

🟥 Data.Ah.AllowOn

The AllowOn object contains fields which inform the calling application the loan types which allow for the inclusion of this product.

Fields: 🔹ARM, 🔹BalloonGross, 🔹BalloonMobNet, 🔹Equal, 🔹IntOnly, 🔹Irregs, 🔹PrinPlus, 🔹SinglePay

Objects: None

🔹 Data.Ah.AllowOn.ARM

A value of true indicates that coverage for this product is allowed on Adjustable Rate Mortgages.

🔹 Data.Ah.AllowOn.BalloonGross

A value of true indicates that coverage for this product is allowed on Balloon Payment Loans covered with single premium gross life.

🔹 Data.Ah.AllowOn.BalloonMobNet

A value of true indicates that coverage for this product is allowed on Balloon Payment Loans covered with single premium net or monthly outstanding balance life.

🔹 Data.Ah.AllowOn.Equal

A value of true indicates that coverage for this product is allowed on Equal Payment Loans.

🔹 Data.Ah.AllowOn.IntOnly

A value of true indicates that coverage for this product is allowed on Interest Only Loans.

🔹 Data.Ah.AllowOn.Irregs

A value of true indicates that coverage for this product is allowed on Skip, Pickup and Irregular Payment Loans.

🔹 Data.Ah.AllowOn.PrinPlus

A value of true indicates that coverage for this product is allowed on Fixed Principal Plus Interest Loans.

🔹 Data.Ah.AllowOn.SinglePay

A value of true indicates that coverage for this product is allowed on Single Payment Notes.

🟥 Data.Ah.Prompts

The Prompts object returns information to the calling application about optional prompts/inputs that may be allowed for this A&H product.

Fields: 🔹CoverageBenefit, 🔹CoverageTermGross, 🔹CoverageTermMobNet, 🔹Joint, 🔹SingleOnCoborrower

Objects: None

🔹 Data.Ah.Prompts.CoverageBenefit

If the account has been configured to allow for a benefit amount to be specified by the user, then the value of this field will be true, which indicates that the user interface should prompt the user for an A&H benefit amount. A value of false indicates that only the default benefit amount will be considered, and hence there is no need to prompt for a user specified benefit.

🔹 Data.Ah.Prompts.CoverageTermGross

A value of true implies that the user may be prompted for a desired term of coverage for A&H when the loan is covered with single premium gross life. A value of false indicates that user specified coverage term truncation is not allowed with this life coverage type and should not be prompted.

🔹 Data.Ah.Prompts.CoverageTermMobNet

A value of true implies that the user may be prompted for a desired term of coverage for life when the loan is covered with single premium net or monthly outstanding balance life. A value of false indicates that user specified coverage term truncation is not allowed with this life coverage type and should not be prompted.

🔹 Data.Ah.Prompts.Joint

If joint coverage A&H is allowed, then the value of this field will be true. Otherwise, a value of false indicates that no joint coverage option is offered.

🔹 Data.Ah.Prompts.SingleOnCoborrower

If single coverage is allowed on the co-borrower, then this field will hold a value of true. If it holds a value of false, then single coverage is only allowed on the primary borrower.

🟥 Data.Ah.Rules

The Rules object returns information to the calling application about coverage rules that may be in effect for this A&H product.

Fields: 🔹MustHaveLife, 🔹PPYLessThan12, 🔹PPYGreaterThan12

Objects: None

🔹 Data.Ah.Rules.MustHaveLife

If A&H may only be offered on loans that include life coverage, then the value of this field will be true. A value of false means that A&H may be offered independently of any life product.

🔹 Data.Ah.Rules.PPYLessThan12

If A&H is allowed on loans with annual, semiannual, quarterly, or bimonthly payment frequencies, then the value of this field will be true.

🔹 Data.Ah.Rules.PPYGreaterThan12

If A&H is allowed on loans with semimonthly, biweekly, or weekly payment frequencies, then the value of this field will be true.

🟥 Data.Ah.Tables

The Tables[] array holds the name of each allowed set of A&H rates. If A&H has been configured for packaged debt protection (see Ah.IsPackagedDP), then this array holds the name of each allowed packaged debt protection plan.

🟥 Data.Iu

The Iu object returns information on involuntary unemployment protection (IU) configuration setup file data.

Fields: 🔸Active, 🔸Abbrev, 🔸Title, 🔹IsDP, 🔸Method

Objects: 🟥AllowOn, 🟥Prompts, 🟥Rules

🔸 Data.Iu.Active

If IU coverage is configured and allowed on one or more loan types, then the value of this field will be true and the rest of the object should be parsed for further details.

A value of false indicates that IU coverage is not confiured nor allowed for this account. Furthermore, no other fields of the Iu object will be returned to the calling application.

🔸 Data.Iu.Abbrev

Like the Title field below, this field provides an abbreviation to be used for the product associated with the SCE's configured IU 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 IU product for regulatory reasons.

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

🔸 Data.Iu.Title

The value of this field holds the product title associated with the SCE's configured unemployment product. This title defaults to Involuntary Unemployment, although customers who wish to customize the name of this offering may do so. Customers who offer debt cancellation instead of insurance will also usually wish to change the name of their unemployment product for regulatory reasons.

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

🔹 Data.Iu.IsDP

If the IU product has been configured as a debt protection product, then the value of this field will be true. A value of false indicates that the IU product is considered insurance.

🔸 Data.Iu.Method

The Method field returns the general method used to compute the IU product premiums/fees. SinglePremium indicates that a single premium or fee is computed and (usually) financed. The StandardMob method computes a premium/fee with each payment. The TrueMOB method computes a premium/fee on a specified day number every month. Finally, CUNASP is a single premium method implemented specifically for TruStage.

🟥 Data.Iu.AllowOn

The AllowOn object contains fields which inform the calling application the loan types which allow for the inclusion of this product.

Fields: 🔹ARM, 🔹BalloonGross, 🔹BalloonMobNet, 🔹Equal, 🔹IntOnly, 🔹Irregs, 🔹PrinPlus, 🔹SinglePay

Objects: None

🔹 Data.Iu.AllowOn.ARM

A value of true indicates that coverage for this product is allowed on Adjustable Rate Mortgages.

🔹 Data.Iu.AllowOn.BalloonGross

A value of true indicates that coverage for this product is allowed on Balloon Payment Loans covered with single premium gross life.

🔹 Data.Iu.AllowOn.BalloonMobNet

A value of true indicates that coverage for this product is allowed on Balloon Payment Loans covered with single premium net or monthly outstanding balance life.

🔹 Data.Iu.AllowOn.Equal

A value of true indicates that coverage for this product is allowed on Equal Payment Loans.

🔹 Data.Iu.AllowOn.IntOnly

A value of true indicates that coverage for this product is allowed on Interest Only Loans.

🔹 Data.Iu.AllowOn.Irregs

A value of true indicates that coverage for this product is allowed on Skip, Pickup and Irregular Payment Loans.

🔹 Data.Iu.AllowOn.PrinPlus

A value of true indicates that coverage for this product is allowed on Fixed Principal Plus Interest Loans.

🔹 Data.Iu.AllowOn.SinglePay

A value of true indicates that coverage for this product is allowed on Single Payment Notes.

🟥 Data.Iu.Prompts

The Prompts object returns information to the calling application about optional prompts/inputs that may be allowed for this IU product.

Fields: 🔹CoverageBenefit, 🔹CoverageTerm, 🔹Joint, 🔹SingleOnCoborrower

Objects: None

🔹 Data.Iu.Prompts.CoverageBenefit

If the account has been configured to allow for a benefit amount to be specified by the user, then the value of this field will be true, which indicates that the user interface should prompt the user for an IU benefit amount. A value of false indicates that only the default benefit amount will be considered, and hence there is no need to prompt for a user specified benefit.

🔹 Data.Iu.Prompts.CoverageTerm

A value of true implies that the user may be prompted for a desired term of coverage for IU. A value of false indicates that user specified coverage term truncation is not allowed and should not be prompted.

🔹 Data.Iu.Prompts.Joint

If joint coverage IU is allowed, then the value of this field will be true. Otherwise, a value of false indicates that no joint coverage option is offered.

🔹 Data.Iu.Prompts.SingleOnCoborrower

If single coverage is allowed on the co-borrower, then this field will hold a value of true. If it holds a value of false, then single coverage is only allowed on the primary borrower.

🟥 Data.Iu.Rules

The Rules object returns information to the calling application about coverage rules that may be in effect for this IU product.

Fields: 🔹JointMustHaveJointDis, 🔹JointMustHaveJointLife, 🔹MustHaveDis, 🔹MustHaveLife

Objects: None

🔹 Data.Iu.Rules.JointMustHaveJointDis

If joint IU may only be offered on loans that include joint A&H coverage, then the value of this field will be true. A value of false means that joint IU may be offered with single A&H.

🔹 Data.Iu.Rules.JointMustHaveJointLife

If joint IU may only be offered on loans that include joint life coverage, then the value of this field will be true. A value of false means that joint IU may be offered with single life.

🔹 Data.Iu.Rules.MustHaveDis

If IU may only be offered on loans that include A&H coverage, then the value of this field will be true. A value of false means that IU may be offered independently of any disability product.

🔹 Data.Iu.Rules.MustHaveLife

If IU may only be offered on loans that include life coverage, then the value of this field will be true. A value of false means that IU may be offered independently of any life product.

🟥 Data.Pp

The Pp object returns information on personal property protection (PP) configuration setup file data.

Fields: 🔸Active, 🔸Abbrev, 🔸Title, 🔹IsDP, 🔸Method

Objects: 🟥AllowOn, 🟥Prompts

🔸 Data.Pp.Active

If PP coverage is configured and allowed on one or more loan types, then the value of this field will be true and the rest of the object should be parsed for further details.

A value of false indicates that PP coverage is not confiured nor allowed for this account. Furthermore, no other fields of the Pp object will be returned to the calling application.

🔸 Data.Pp.Abbrev

Like the Title field below, this field provides an abbreviation to be used for the product associated with the SCE's configured PP 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 PP product for regulatory reasons.

The title may be used for inputs (e.g. PP Option) and outputs (e.g. PP Premium/Fee).

🔸 Data.Pp.Title

The value of this field holds the product title associated with the SCE's configured personal property product. This title defaults to Personal Property, although customers who wish to customize the name of this offering may do so. Customers who offer debt cancellation instead of insurance may wish to change the name of their unemployment product for regulatory reasons.

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

🔹 Data.Pp.IsDP

If the PP product has been configured as a debt protection product, then the value of this field will be true. A value of false indicates that the PP product is considered insurance.

🔸 Data.Pp.Method

The Method field returns the general method used to compute the PP product premiums/fees. SinglePremium indicates that a single premium or fee is computed and (usually) financed. The StandardMob method computes a premium/fee with each payment. The TrueMOB method computes a premium/fee on a specified day number every month. Finally, CUNASP is a single premium method implemented specifically for TruStage.

🟥 Data.Pp.AllowOn

The AllowOn object contains fields which inform the calling application the loan types which allow for the inclusion of this product.

Fields: 🔹ARM, 🔹BalloonGross, 🔹BalloonMobNet, 🔹Equal, 🔹IntOnly, 🔹Irregs, 🔹PrinPlus, 🔹SinglePay

Objects: None

🔹 Data.Pp.AllowOn.ARM

A value of true indicates that coverage for this product is allowed on Adjustable Rate Mortgages.

🔹 Data.Pp.AllowOn.BalloonGross

A value of true indicates that coverage for this product is allowed on Balloon Payment Loans covered with single premium gross life.

🔹 Data.Pp.AllowOn.BalloonMobNet

A value of true indicates that coverage for this product is allowed on Balloon Payment Loans covered with single premium net or monthly outstanding balance life.

🔹 Data.Pp.AllowOn.Equal

A value of true indicates that coverage for this product is allowed on Equal Payment Loans.

🔹 Data.Pp.AllowOn.IntOnly

A value of true indicates that coverage for this product is allowed on Interest Only Loans.

🔹 Data.Pp.AllowOn.Irregs

A value of true indicates that coverage for this product is allowed on Skip, Pickup and Irregular Payment Loans.

🔹 Data.Pp.AllowOn.PrinPlus

A value of true indicates that coverage for this product is allowed on Fixed Principal Plus Interest Loans.

🔹 Data.Pp.AllowOn.SinglePay

A value of true indicates that coverage for this product is allowed on Single Payment Notes.

🟥 Data.Pp.Prompts

The Prompts object returns information to the calling application about optional prompts/inputs that may be allowed for this PP product.

Fields: 🔸Coverage, 🔹Joint

Objects: None

🔸 Data.Pp.Prompts.Coverage

The value of the Coverage field informs the calling application how the personal property coverage amount is determined. A value of Principal means that the property product covers the loan's principal balance. TotalOfPayments means that the coverage amount is the loan's total of payments.

A value of Entered means that the coverage amount is specified by the user, and must be prompted and sent in with the loan request.

🔹 Data.Pp.Prompts.Joint

If joint coverage PP is allowed, then the value of this field will be true. Otherwise, a value of false indicates that no joint coverage option is offered.