Enterprise Solutions

Loan Account Add

Enterprise SOAP API > API by Reference > Core Services > Loan Account Add
Loan Account Addition

Loan Account Addition

Loan Account Addition (LnAcctAdd) is a jXchange service designed to add loan accounts for a consumer on a service provider by a third-party consumer.

Message Flow

In jXchange, the Loan Account Addition service uses a typical exchange of MType messages to add loan accounts for a consumer on a service provider by a third-party consumer.

Primary Request

The third-party consumer forwards the LnAcctAddRq_MType message to the service provider.

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • LnAdd_CType
  • MsgRqHdr_CType

The message contains the following array:

  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the LnAcctAddRs_MType message to the third-party consumer.

The message contains the following simple element:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

LnAcctAddRq_MType

LnAcctAddRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • LnAdd_CType
  • MsgRqHdr_CType

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType

ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

LnAdd_CType

LnAdd_CType is a complex CType element.

Contains:

  • ACHPmtInfo_CType
  • Custom_CType
  • LnAcctInfo_CType
  • LnBalDtInfo_CType
  • LnDlrInfo_CType
  • LnInfoRec_CType
  • LnMtgInfo_CType
  • LnPastDueInfo_CType
  • LnPmtInfo_CType
  • LnProtInfo_CType
  • LnRateInfo_CType
  • LnRealEstateInfo_CType
  • LnRegRptInfo_CType
  • LnRenExtInfo_CType
  • LnStopInfo_CType
  • PromoInfo_CType

LnMtgInfo_CType

LnMtgInfo_CType is a complex CType element. This element is optional.

Contains:

  • FHLBSICInfoArray_AType
  • HousingInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

AgencyCaseId
The ID assigned to an FHA or VA loan for tracking purposes by HUD or the VA.
ApprDocId
The appraisal document identifier for electronic delivery of the appraisal.
AvlSecdMktgCode
The code that references the availability of a loan for sale on the secondary market.
FHAVACode
The code that describes the type of FHA or VA loan.
FHLBApprCode
The code that describes the appraisal form or inspection type used to compile the FHLB Appraisal report.
FHLBDocCode
The code that references the level of documentation used to qualify a borrower on a loan.
FHLBProdCode
The code that designates the FHLB product for the loan.
FHLBPurpCode
The code that designates the FHLB purpose that the loan proceeds are to be used.
FirstHomePur
Answers the question: Is the borrower a first-time home buyer?
HighPriceMtg
Answers the question: Does the mortgage loan qualify as a high priced mortgage (HMPL)? Canonical values are:
  • false
  • true
HighPriceMtgRateVar
The rate variance between the borrowers APR and the index published by the Federal Reserve Board (APOR).
HOEPAStat
The status of the Home Ownership and Equity Protection Act loan. Canonical values are:
  • HighCostMtg
  • NA
  • NotHighCostMtg
LnFeatureCode
The code that describes features associated with the loan.
LnOrignCompId
The Loan Originator's company unique identifier as assigned by the Nationwide Mortgage Licensing System and Registry (NMLSR).
LnOrignId
The Loan Originator's unique identifier as assigned by the Nationwide Mortgage Licensing System and Registry (NMLSR).
LnOrigSrcCode
The code that describes the business source that wholly or partially originated the mortgage loan.
LnProspectId
The ID assigned by Loan Prospector for the loan processed through Loan Prospector.
MERSId
The identification that is used for the Mortgage Electronic Registration System (MERS).
MHNumUnit
The number of sections or units that make up the manufactured home.
MHOccupCode
The code that designates the occupancy of the manufactured home, prior to transfer of ownership of the borrowers.
MHPriceToOrigPct
The ratio of the original loan amount and the manufactured home dealer's invoice price of the manufactured housing unit.
MHYrBuilt
The year the manufactured home was built.
MoHouseAmt
The borrower's monthly household debt expense.
MPFCommId
The commitment ID assigned to the institution under the mortgage partnership finance program.
MtgInsurCertifId
The certificate ID for the mortgage insurance.
MtgInsurCode
The code that defines the mortgage insurance company.
MtgInsurPct
The percentage of the loan insured for mortgage insurance.
NumUnit
The number of units in the mortgaged property.
PledgeLnCode
The code that references the institution the loan is pledged to.
PredatoryLnCode
The code that designates the type of loan for Anti-Predatory lending in accord with Freddie Mac® guidelines.
QualMtgCode
The code that describes the type of qualified mortgage as mandated by Dodd-Frank Act.
QualResMtgCode
The code that describes the type of residential qualified mortgage as mandated by Dodd-Frank Act.
RedDocCode
The code that indicates whether a loan was underwritten using reduced documentation.
SecdMtgCode
The code that represents the type of secondary mortgage activity. Canonical values are:
  • AflInst
  • CommBank
  • FAMC
  • FHLMC
  • FNMA
  • GNMA
  • InsFi
  • Oth
  • PrivSec
ShareNatCrLn
Does the loan participate as part of the Shared National Credit Program.
StateApprLicId
The field appraiser's state license number or state certification number issued by the state of the related property.
StateSupvApprLicId
The supervisory appraiser's or appraisal firm state license number of the related property.
SubDebtCode
The code that describes if a mortgaged property has a lower priority than that of the first mortgage.
SynAgentId
The ID of the syndicated agent responsible for the servicing of the loan.
SynMemberId
The ID of the syndicated member responsible for the servicing of the loan.
FHLBSICInfoArray_AType

FHLBSICInfoArray_AType is an array AType element. This is an array of FHLBSICInfo simple elements used to define information for FHLB special feature codes. This element is optional.

Contains:

  • FHLBSICInfo_CType
FHLBSICInfo_CType

FHLBSICInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

FHLBSIC
The FHLB special feature codes related to mortgage characteristics as required by the master commitment.
FHLBSICTxt
The text that describes the FHLB special feature codes related to mortgage characteristics as required by the master commitment.
HousingInfoArray_AType

HousingInfoArray_AType is an array AType element. This is an array of simple elements used to define information pertinent to the units for mortgage property.

Contains:

  • HousingInfo_CType
HousingInfo_CType

HousingInfo_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

HousingInfoTxt
The text description of the housing unit referenced for the array.
NumBdrm
The number of bedrooms in a housing unit.
NumRentalUnit
The number of rental units for each property.
RentUtlAmt
The unit's rent plus utilities.
UnitOwnerCode
The code that references the borrower's position for the mortgage property. For example, owner occupied.
UnitOwnerDesc
The description of the code that references the borrower's position for the mortgage property. For example, owner occupied.

LnPastDueInfo_CType

LnPastDueInfo_CType is a complex CType element. This element is optional.

Contains:

  • PastDueArray_AType
Simple Elements

The following simple elements are contained within this complex.

DlqConDt
The date a customer was contacted about a delinquent situation.
PastDue10LastYr
The number of times past due 10–29 days during the previous year.
PastDue10LTD
The number of times past due 10–29 days life-to-date.
PastDue10YTD
The number of times past due 10–29 days year-to-date.
PastDue120LastYr
The number of times past due 120–149 days last year.
PastDue120LTD
The number of times past due 120–149 days life-to-date.
PastDue120YTD
The number of times past due 120–149 days year-to-date.
PastDue150LastYr
The number of times past due 150–179 days last year.
PastDue150LTD
The number of times past due 150–179 days life-to-date.
PastDue150YTD
The number of times past due 150–179 days year-to-date.
PastDue180LastYr
The number of times past due 180+ days last year.
PastDue180LTD
The number of times past due 180+ days life-to-date.
PastDue180YTD
The number of times past due 180+ days year-to-date.
PastDue30LastYr
The number of times past due 30–59 days last year.
PastDue30LTD
The number of times past due 30–59 days life-to-date.
PastDue30YTD
The number of times past due 30–59 days year-to-date.
PastDue60LastYr
The number of times past due 60–89 days last year.
PastDue60LTD
The number of times past due 60–89 days life-to-date.
PastDue60YTD
The number of times past due 60–89 days year-to-date.
PastDue90LastYr
The number of times past due 90–119 days last year.
PastDue90LTD
The number of times past due 90–119 days life-to-date.
PastDue90YTD
The number of times past due 90–119 days year-to-date.
PastDueArray_AType

PastDueArray_AType is an array AType element. This is an array of past due counters and their respective time periods.

Contains:

  • PastDueInfo_CType
PastDueInfo_CType

PastDueInfo_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

PastDueCntLTD
The number of times a loan was past due life-to-date.
PastDueTerm
The integer length of the term.
PastDueTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years

LnPmtInfo_CType

LnPmtInfo_CType is a complex CType element. This element is optional.

Contains:

  • LnFeeArray_AType
  • OthInsurArray_AType
Simple Elements

The following simple elements are contained within this complex.

AHInsurAccrBase
The AH insurance accrual base.
AHInsurAccrRate
The AH insurance accrual rate.
AHInsurCompCode
The code that references the AH insurance company.
AHInsurIdxNum
The AH insurance index number.
AHInsurPerDiem
The AH insurance per diem.
AHInsurStartDt
The date the accident and health insurance begins to accrue.
AHInsurTerm
The integer length of the term.
AHInsurTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
AmrtzInt
The amortized interest.
AmrtzPmtSusp
The amortized payment suspense.
AnnDebtPmt
The amount of money on a total yearly basis required for the payment of interest and principal on a long-term debt.
BallPmtAmt
The balloon payment amount.
BilAHAmt
The billed credit life insurance amount.
BilCrLifeAmt
The billed credit life insurance amount.
BilEscrwAmt
The billed escrow amount.
BilIntAmt
The billed interest amount.
BilLateChgAmt
The billed late charge.
BilLeadDays
The number of days before due date to print bills.
BilOtherChgAmt
The billed other charge amount.
BilPrincAmt
The billed principal.
ChgYrFeeCode
The code that describes the behavior of how a yearly fee should be charged. For example, skip the first year.
CrLifeCompCode
The code that references the credit life insurance company.
CrLifeInsurAccrBase
The credit life insurance accrual base.
CrLifeInsurAccrRate
The credit life insurance accrual rate.
CrLifeInsurIdxNum
The credit life insurance index number.
CrLifeInsurPerDiem
The credit life insurance per diem.
CrLifeInsurStartDt
The date the credit life insurance begins to accrue.
CrLifeInsurTerm
The integer length of the term.
CrLifeInsurTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
CrtBilDOM
The specific day of the month to create a loan bill/statement (rather than number of days before due date to print bills - BilLeadDays).
DefrIntPaidTo
The deferred interest paid to. This field must be 0 filled.
DefrInt
The deferred interest. This field must be 0 filled.
FundPct
The percentage of a loan advance that should be split to the sold portion of a loan.
FundSeqId
The order in which advances on LOC are passed to participation sold loans.
GradPmtCode
The code that references the graduated/ascending payment option.
IgnrLateChgMulti
The late charge sequence on multiple bills should be ignored. Canonical values are:
  • LateChg
  • LateChgAndOther
  • Neither
  • Other
IntPmtPostCode
The code that describes the behavior for the posting of the interest portion of a regular payment.
LastIntPmtDt
The date of the last interest payment.
LastPmtAmt
The last payment amount.
MinChkAdva
The minimum check advance.
MinChkTolr
The minimum check tolerance for charging an NSF fee. This field must be zero filled if not used.
NegAmrtzCapPct
The negative amortization cap percentage. Must be 0 or greater than 100.
NegAmrtzOrignBal
The highest principal balance due to negative amortization as the Original Balance for loans.
NewPmtAmt
The new payment amount.
NewPrinIntPmtEffDt
The new principal interest payment effective date.
NewPrinIntPmt
The new principal interest payment.
NonPenIncmAmt
Income derived from the customer not as a result of a loan penalty.
NSFFeeAmt
The NSF fee amount.
OthChgAmt
Other charges.
OvrLineFeeAddNxtBil
Add over line amount to next bill.
OvrLineFeeAmt
The over line fee amount.
PctBalReAmrtz
The percentage of balance to reamortize.
PenIncmAmt
Income derived from the customer as a result of a loan penalty.
PmtGraceDays
The number of grace days a payment is due from the time they are billed for the payment amount.
PmtReAmrtzCap
The payment reamortization cap.
PmtReAmrtzDayOfMonth
The day of month for payment reamortization. This code is required only if the payment reamortization date is the 29th of the month.
PmtReAmrtzDt
The payment reamortization date. For loans whose payments reamortize on a different schedule than their rates change. Date the loan payment is supposed to be reamortized.
PmtReAmrtzFreqCode
The code used to determine the frequency of reamortizing a loan payment over time.
PmtReAmrtzFreq
The day of month for payment reamortization. This code is required only if the payment reamortization date is the 29th of the month.
PmtReAmrtzPeriodCode
The payment reamortization period code. Canonical values are:
  • Days
  • Months
  • SemiMonthly
  • Years
PmtReAmrtzPeriod
The payment reamortization period.
PmtSuspPostCode
The code that references how to post payment suspense.
PmtTotAmt
The total number of payments.
PostPmtPastDueCode
The code that describes the action to be taken for payments on past due loans.
PostPmtPastDueDay
The number of days a loan can be past due before payments will not post.
PostPmtPrePaidCode
The code that describes the action to be taken for payments on loans that are pre-paid.
PostPrincCurtCode
The code that describes the action to be taken when an excess amount above the regular payment is received.
PostSeq1Code
The regular payment posting sequence #1 code.
PostSeq2Code
The regular payment posting sequence #2 code.
PostSeq3Code
The regular payment posting sequence #3 code.
PostSeq4Code
The regular payment posting sequence #4 code.
PostSeq5Code
The regular payment posting sequence #5 code.
PostShortPmts
Indicates if short payments should be posted. Canonical values are:
  • false
  • true
PrePaidAmtCode
The code that describes the action to be taken for pre-paid loans.
PrePaidAmt
The permissible amount that a loan can be pre-paid per payment.
PrePaidNum
The permissible number of payments that a loan can be pre-paid.
PrePaidPct
The permissible percent that a loan can be pre-paid per payment.
PrePmtPenLTD
The pre-payment penalty life-to-date.
PrePmtPenPYTD
The pre-payment penalty previous year-to-date.
PrePmtPenYTD
The pre-payment penalty year-to-date.
PrevPmtAmt
The previous payment amount.
PrtcpFirstPmtCode
The code that describes the action to be taken when the first payment is received on a sold loan.
PrtcpIntPmtPct
The percentage of the interest payment that should be split to the sold portion of the loan.
PrtcpPmtSplitCode
The code that describes the action to be taken when extracting payments to the sold portion of a loan.
PrtcpPrincPmtPct
The percentage of the principal payment that should be split to the sold portion of the loan.
PrtcpSeqId
The ID assigned to sold loans that control the order of splitting payments for the sold portion.
ReAmrtzPmt
Determines if the system is to re-amortize the payment amount automatically. Canonical values are:
  • false
  • true
  • OnDemand
  • Info
RstrAutoPmt
Indicates whether automatic payments should be restricted. Canonical values are:
  • false
  • true
SecdAccr
The secondary accrual.
SplitPmtAsBil

Indicates if payments should be split as billed. Canonical values are:

  • false
  • true
UEInsurAccrBase
The unemployment insurance accrual base.
UEInsurAccrRate
The unemployment insurance accrual rate.
UEInsurCompCode
The code that references the unemployment insurance company.
UEInsurIdxRate
The unemployment insurance index rate.
UEInsurPerDiem
The unemployment insurance per diem.
UnpaidChgs
The unpaid charges.
UnusedCrAccrIdxNum
The unused credit accrual index number.
UnusedCrAccrRate
The unused credit accrual rate.
UnusedCrIntBase
The unused credit interest base.
UnusedCrPerDiem
The unused credit per diem.
UsePmtSusp
Indicates if payment suspense should be used. Canonical values are:
  • false
  • true
YrFeeAmt
The yearly fee amount.
YrPmtIncrPct
The yearly payment increase for graduated payment loans.
LnFeeArray_AType

LnFeeArray_AType is an array AType element.

Contains:

  • LnFeeInfoRec_CType
LnFeeInfoRec_CType

LnFeeInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

LnFeeAmt
The amount of specific loan fees collected.
LnFeeAssmntDt
The date the loan fee assessment should occur.
LnFeeCaplze
Answers the question: Are the loan fees being capitalized? Canonical values are:
  • false
  • true
LnFeeChgCode
The code that describes the behavior for charging a fee. Canonical values are:
  • Chg
  • NA
  • Wav
LnFeeCode
The code that describes the details of charging a loan fee.
LnFeeDayOfMonth
The day of month for loan fee assessment. This day is only required if the loan fee assessment date is the 29th of the month.
LnFeeFreq
The frequency of the loan fee assessment.
LnFeeFreqUnits
The units of frequency for the loan fee assessment. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
LnFeeId
A unique identifier given to a loan fee.
LnFeeLastPmtDt
The last payment date.
LnFeeNxtPayDt
The next payment date.
LnFeeRemAmt
The remaining amount of the loan fee that needs to be collected.
LnFeeStat
The status of the loan fee. Canonical values are:
  • Act
  • Canc
  • Exp
  • Susp
LnFeeText
The text that describes the loan fee element that precedes it in the LnFeeArray.
OthInsurArray_AType

OthInsurArray_AType is an array AType element. This is an array of insurance classifications not addressed as an individual element. For example: Credit life, A and H, Unemployment.

Contains:

  • OthInsurInfoRec_CType
OthInsurInfoRec_CType

OthInsurInfoRec_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

OthInsurAccrBase
The other insurance accrual base.
OthInsurCompCode
The code that references insurance companies.
OthInsurCompDesc
The description of the code that references insurance companies.
OthInsurIdxNum
The other insurance index number.
OthInsurStartDt
The date that some other type of insurance begins to accrue.
OthInsurTerm
The integer length of the term.
OthInsurTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
OthInsurText
The text that describes other insurance classifications that precede it in the OthInsurArray.

ACHPmtInfo_CType

ACHPmtInfo_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

ACHCompDiscrData
The ACH company discretionary data, as governed by Nacha® rules.
ACHCompEntryDesc
The ACH company entry description, as governed by Nacha® rules.
ACHCompId
The ACH company ID.
ACHCompName
The ACH company name, as governed by Nacha® rules.
ACHCrAcctId
The account ID of the credit account for the ACH item.
ACHCrName
The account holder's name of the credit account for the ACH item.
ACHCrRtNum
The routing and transit number of the credit account's bank for the ACH item.
ACHDrAcctId
The account ID of the debit account for the ACH item.
ACHDrName
The account holder's name of the debit account for the ACH item.
ACHDrRtNum
The routing and transit number of the debit account's bank for the ACH item.
ACHSendPreNoteCode
The code that determines if an ACH prenotification should be generated, as governed by Nacha® rules.
ACHStdEntryClass
The ACH standard entry class.
ACHTrnCode
The transaction code to be used for the ACH item, as governed by Nacha® rules.

LnStopInfo_CType

LnStopInfo_CType is a complex CType element. This element is optional.

Contains:

  • LnStopInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

LnStopCode
The code that references the loan stop functions.
LnStopInfoArray_AType

LnStopInfoArray_AType is an array AType element.

Contains:

  • LnStopFuncInfo_CType
LnStopFuncInfo_CType

LnStopFuncInfo_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

LnStopFuncCode
The code that references the loan stop function. Canonical values are:
  • Accr
  • Adva
  • BilNot
  • Corr
  • CrRpt
  • EscrwAnlys
  • EscrwDistr
  • HazDistr
  • IRSRpt
  • LnSale
  • Not
  • OptInsurDistr
  • PastDueRpt
  • Pmt
  • PrePmt
  • Stmt
  • TaxDistr
LnStopFuncDesc
The description of the code that references the loan stop function.
LnStopFuncExpDt
The expiration date for a specific loan stop function.
LnStopFuncStat
The status of the loan stop function that controls the behavior for a specific function. Canonical values are:
  • NoAction
  • Stop
  • Warn

LnRealEstateInfo_CType

LnRealEstateInfo_CType is a complex CType element. It contains the loan real estate information. This element is optional.

Contains:

  • TaxRptPropDescArray_AType
Simple Elements

The following simple elements are contained within this complex.

ApprDt
The last appraisal date of the account.
ApprVal
Used for bank informational purposes in tracking appraised value of collateral.
AvgLeaseRate
The average rate received for the lease account.
CollatSrcValCode
The code that references the source used to obtain the value of the collateral item.
CommOccupPct
The commercial real estate occupancy percent.
CommPropSqFt
The square footage of the commercial property land.
CondoPUDInfo
The condominium project name.
ConstLnCode
The code that describes the type of construction loan.
CorrBankCode
The code that references the correspondent bank for the loan.
DefrConDt
The deferral contact date.
FirstDefrComingDueNotDt
The deferral coming due notice date.
FloodInsurCode
Indicates if flood insurance is required.
FloodInsurExpDt
The date that a flood insurance policy expires.
NetOperIncm
The borrower's net operating income.
OccupCode
The code that references the occupancy of the property. Canonical values are:
  • NA
  • NotOwnOcc
  • OwnOcc
ProjectCode
The code that describes the type of project for the loan funding.
PropCity
The city where the property is located.
PropCondRmk
Application or user remarks free-form text.
PropCounty
The name of the county in which the property is located.
PropListAmt
The amount the property was listed for sale.
PropListDt
The date the property was listed for sale.
PropMultiListId
The property's multiple listing identification.
PropPostalCode
The ZIP code where the property is located.
PropPurchaseAmt
The purchase price of the property.
PropRelDt
The date of the property's last real estate release.
PropRentSqFt
The property's available square footage available for rent.
PropSqFt
The square footage of the residential property.
PropState
The state where the property is located.
PropStreet
The property street.
PropSubDivName
The name of the subdivision where the property is located.
PropVacRate
The vacancy percentage of the property available for rent.
RemNumUnit
The remaining number of units available for rent.
RemUnitVal
The value of the remaining number of units available for rent.
REOType
The type of real estate owned included on a loan application. Canonical values are:
  • COM - commercial
  • RES - residential
  • SEC - secondary residence
  • VAC - vacation
SecdDefrComingDueNotDt
The deferral coming due notice date.
YrBuilt
The year the property was built.
TaxRptPropDescArray_AType

TaxRptPropDescArray_AType is an array AType element. This is an array of tax reporting property descriptions.

Contains:

  • TaxRptPropDescRec_CType
TaxRptPropDescRec_CType

TaxRptPropDescRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PrioritySeq
The assignment of a priority sequence for an array of items.
TaxRptPropDesc
Application or user remarks free-form text.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnAcctInfo_CType

LnAcctInfo_CType is a complex CType element. It contains one or more optional complex elements used to define the loan account identified in the account inquiry request.

Contains:

  • AllowTrnActArray_AType
  • BorwInfoArray_AType
  • CrRatingInfoArray_AType
  • EstbPersonName references PersonName_CType
  • LnClsInfoArray_AType
  • LnGuarArray_AType
  • PrePmtPenInfoRec_CType
  • UserDefInfoArray_AType
  • Ver_15_CType
Simple Elements

The following simple elements are contained within this complex.

CAUTION:
The TotDebtPct element will deprecate on January 1, 2021. The element was defined incorrectly. Use the TotDebtPctV2 element instead.
CAUTION:
The LnPmtToIncmPct element will deprecate on January 1, 2023. The element was defined incorrectly. Use the LnPmtToIncmPctV2 element instead.
AcctClsfCode
The allowed account classification values that are bank defined.
AnnIncmAmt
The annual income amount. This field is used for reporting purposes for the bank.
ATMCard
The ATM card canonical values of:
  • false
  • true
BadChkRecv
The number of bad checks received.
BorwDebtIncmPct
The ratio of the borrower's debt to income.
BorwLiqAssetAmt
The borrower's liquid asset amount.
CalcPartPct
The calculated participation percentage.
ClsOnZeroBal
Indicates if the account should be closed automatically when the balance is at zero for the required number of days. Canonical values are:
  • false
  • true
CoBorwDebtIncmPct
The ratio of the co-borrower's debt to income.
CollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
CombLTV
The combined LTV ratio. This might include second mortgages.
CouponBookTerm
Shows the term of the coupon book or how many coupons should be ordered.
CrBureauRptCode
The code that identifies the behavior for credit bureau reporting.
CrRatingCode
Determines the credit rating reported for this account.
CrScoreCode
The code that identifies the borrower's credit code used to score the credit rating.
CrScoreId
Identifies the borrower's credit score.
CurApprLTVRatio
The current lone-to-value ratio used derived from the appraisal.
CurDebtSvcRatio
The current ratio of the amount subject to debt service.
CurLnToValRatio
The current lone-to-value ratio.
CurrencyCode
The code that references the type of currency used for the loan.
DeptCode
The department code is provided for bank use in assigning department responsibility for the loan.
EndorNum
The number of endorsers that exist for a loan.
EstbPersonTitle
The title an employee holds in a corporation or business.
ExclAutoNonAccr
Exclude from auto nonaccrual controls whether this loan can automatically change to nonaccrual status. Canonical values are:
  • false
  • true
ExcLndPlcyCode
The code that references that the loan was made as an exception to the institutions normal lending policy.
ExmnrClsfCode
An examiner's classification code. Any entry is valid.
FirstStmtDt
The date the first statement should be created.
FirstStmtFeeCode
The code that describes the behavior for charging a fee on the first statement.
ForcedPlaceInsur
The forced place insurance.
HighRiskCust
High risk customer. Canonical values are:
  • false
  • true
HldAcctId
Hold account deposit or CD account to automatically hold for this account.
HldAcctType
The hold account type.
  • Enter D to place holds on a deposit account.
  • Enter S to place holds on a savings account.
  • Enter T to place holds on a CD account.
HldMailCode
Includes the mailing instructions. Valid values are 1–9 or blank.
IncCombStmt
Include on combined statement. Indicates if this account is to be included in combined statement information. Canonical values are:
  • false
  • true
InvrInsurCode
The code that references the investors who have vested interest in the loan.
InvrPropType
The code that references the investor's property type associated to the loan.
InvrPurpCode
The code that references the investor's interest purpose in the loan.
LangType
The language as defined by ISO 639-2 Language code list, available at http://www.loc.gov/standards/iso639-2/php/code_list.php. Canonical values are:
  • chi
  • eng
  • fre
  • ger
  • ita
  • jpn
  • kor
  • pol
  • por
  • spa
  • swe
  • zho
LateChgCode
Late charge code types that are bank-defined.
LnPmtToIncmPct
The loan payment to household income ratio.
LnPmtToIncmPctV2
The loan payment to household income ratio. Percentages are expressed as a decimal where 100% would be expressed as 1.00 and 3.25% would be expressed as .0325. To convert to a percent, this number is multiplied by 100. Version 2 was added because certain providers handled the earlier version incorrectly.
LOCAcctId
The account identification that is charged for fees from line of credit services.
LOCCustId
The customer identification for lines of credit.
MinBilAmt
The minimum amount due on a loan before a billing notice is created.
MoDebtAmt
The borrower's monthly debt expense.
MoIncmAmt
The monthly income of all borrowers.
NetWorthAmt
The net worth of an entity.
NetWorth
Represents the net worth.

This element is scheduled for deprecation. Effective date: 2018-01-01. The NetWorthAmt element should be used due to size limitations of the NetWorth element.

NumBorw
The number of borrowers.
NumProp
The number of properties securing a mortgage.
OffCode
The code that designates the financial institution officer.
OrigBorwDebtIncmPct
The ratio of the borrower's debt to income.
OrigCoBorwDebtIncmPct
The ratio of the co-borrower's debt to income.
OrigDebtSvcRatio
The original ratio of the amount subject to debt service.
OrigLnToValRatio
The original lone-to-value ratio.
OrigPartPct
The original participation percentage.
PartIdNum
The participation identification number.
PayoffPend
Payoff pending canonical values are:
  • false
  • true
PrePmtPenBillDt
The date that the prepayment penalty bill is created.
PrePmtPenCode
Pre-payment penalty code. If the loan is to assess a prepayment penalty on payoff, then enter the corresponding prepayment penalty parameter code.
PrePmtPenDueDt
The date that the prepayment penalty is due.
PrevStat
The previous status.
PrtBilNotCode
Print billing notice indicates if the loan is to receive a billing notice.
PrtCouponBook
Determines if a coupon book should be generated for the account. Canonical values are:
  • false
  • true
PrtcpAcctId
The account ID of the master loan linked to the referenced loan.
PrtcpAcctType
The account type of the master loan linked to the referenced loan.
PrtcpCode
The code that references the participation position of the loan.
PrtPastDueNotCode
Print past due notice.
PrtRcpt
Print receipt. Canonical values are:
  • false
  • FirstRcptOnly
  • FromAcct
  • ToAcct
  • true
PtPaid
The points paid. The number of points paid on the loan.
PurpCode
Bank-defined and is used to define the purpose of the loan. Canonical values are:
  • CashOutRefi
  • HomeImprov
  • HomePurch
  • Oth
  • Refi
RelAcctId
The related account ID or number.
RelAcctType
The related account type.
RestructuredDr
Restructured debt valid indicates that this loan is for restructuring of debt. Canonical values are:
  • false
  • true
RestructuredDt
The date the loan was restructured.
RewriteToLnAcctId
Rewrite to loan account number.
RstrAdvaOvrLmt
Restrict advances over limit. Canonical values are:
  • false
  • true
RstrAdva
Restrict advances. Canonical values are:
  • Auto
  • AutoAndManual
  • NA
SecdCrScoreId
Identifies the borrower's secondary credit score.
State
Corresponding abbreviation for the state.
StressRateCode
A stress rating given to loans to determine the loan's exposure to interest rate changes.
StressRateDt
A date a stress rating code was given to a loan.
StudentLnCode
Designates if the loan is a demand type loan or a student loan.
SubPrimeLnCode
The subprime lending code.
TitleNeeded
Answers the question: Is the title still needed? This code is provided for bank use in tracking those loans for which a title to the collateral used for security is still needed. Canonical values are:
  • false
  • true
TotDebtPct
The ratio of the total monthly housing expenses plus the total of other debts to the borrower's monthly income.
TotDebtPctV2
The ratio of the total monthly housing expenses plus the total of other debts to the borrower's monthly income.

Express percentages as a decimal where 100% would be expressed as 1.00, and 3.25% would be expressed as .0325. To convert to a percent, multiply this number by 100.

Version 2 was added to TotDebtPct because certain providers handled the earlier version incorrectly.

TotDownPmtAmt
The total down payment amount used for the loan.
TotOtherDebtAmt
The total amount of other debts excluding housing expense.
VehicleId
The Vehicle Identification Number.
WatchListCode
Watch list code indicates if the loan is placed on a watch list.
AllowTrnActArray_AType

AllowTrnActArray_AType is an array AType element. This is an array of permissible transaction activity for an account.

Contains:

  • AllowTrnActInfo_CType
AllowTrnActInfo_CType

AllowTrnActInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AllowTrnAct
Allowable account transaction activity permitted for a specific account. Canonical values are:
  • All
  • Dep
  • Distr
  • None
  • Pmt
  • Wthdwl
  • XferFrom
  • XferTo
BorwInfoArray_AType

BorwInfoArray_AType is an array AType element.

Contains:

  • BorwInfo_CType
BorwInfo_CType

BorwInfo_CType is a complex CType element.

Contains:

  • AddlBorwRaceArray references BorwRaceArray_AType.
Simple Elements

The following simple elements are contained within this complex.

BorwAdviceCode
The code that represents the type of counseling/advice given to the borrower.
BorwAdviceDesc
The description of the code that represents the type of counseling/advice given to the borrower.
BorwAdviceFormatCode
The code that represents the format used for counseling/advice for the borrower.
BorwAdviceFormatDesc
The description of the code that represents the format used for counseling/advice for the borrower.
BorwAge
The borrower's age.
BorwBirthDt
The borrower's birth date.
BorwCrScoreCode
The code that identifies the borrower's credit code used to score the credit rating.
BorwCrScoreDesc
The description of the code that identifies the borrower's credit code used to score the credit rating.
BorwCrScoreId
Identifies the borrower's credit score.
BorwEthnicCode
The code that references the borrower's ethnicity.
BorwEthnicDesc
The description of the code that references the borrower's ethnicity.
BorwFICOId
The borrower's Fair Isaac credit rating identification.
BorwGender
The borrower's gender. Canonical values are:
  • Female
  • Male
  • NotPrvd
BorwIncmAmt
The borrower's income.
BorwInfoTxt
The text description of the borrower referenced for the array.
BorwRaceCode
The code that references the borrower's race. Canonical values are:
  • AfroAm
  • Asia
  • AsiaInd
  • Cau
  • CHN
  • GUM
  • HI
  • HIPacIslnd
  • JPN
  • KOR
  • OthAsia
  • OthPacIslnd
  • PHL
  • USIndAk
  • VNM
  • WSM
BorwRaceDesc
The description of the code that references the borrower's race.
BorwSelfEmpl
Answers the question: Is the borrower self-employed? Values are:
  • false
  • true
CrRatingInfoArray_AType

CrRatingInfoArray_AType is an array AType element. This is an array of credit rating information.

Contains:

  • CrRatingInfo_CType
CrRatingInfo_CType

CrRatingInfo_CType is a complex CType element. This is a package of data related to credit scores.

Simple Elements

The following simple elements are contained within this complex.

CrRatingCapDt
The date information was captured, created, or updated.
CrRatingCode
Determines the credit rating reported for this account.
EstbPersonName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

EstbPersonName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
LnClsInfoArray_AType

LnClsInfoArray_AType is an array AType element.

Contains:

  • LnClsInfo_CType
LnClsInfo_CType

LnClsInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ClsCostSrcCode
The code that represents the source of funds used for the closing of a loan.
ClsCostSrcDesc
The description of the code that represents the source of funds used for the closing of a loan.
ClsCost
The costs associated with the closing of a loan.
DownPmtAmt
The amount of the borrower's down payment attributable to the DownPmtSrcCode.
DownPmtSrcCode
The code that represents the source of the borrower's down payment.
DownPmtSrcDesc
The description of the code that represents the source of the borrower's down payment.
LnClsInfoTxt
The text description of elements associated with a loan closing for the array.
LnClsPmtAmt
The amount of payment collected at the loan closing.
SecdLnAmt
The amount of the secondary financing attributable to the SecdLnCode.
SecdLnCode
The code that represents the source of the borrower's secondary financing.
SecdLnDesc
The description of the code that represents the source of the borrower's secondary financing.
LnGuarArray_AType

LnGuarArray_AType is an array AType element. This is an array of guarantors for a loan.

Contains:

  • LnGuarInfoRec_CType
LnGuarInfoRec_CType

LnGuarInfoRec_CType is a complex CType element.

Contains:

  • LnGuarName references PersonName_CType
Simple Elements

The following simple elements are contained within this complex.

LnGuarId
An ID that relates to a guarantor for a loan.
LnGuarText
The text that describes the guarantor element detail that proceeds it in the LnGuarArray.
LnGuarName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

LnGuarName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
PrePmtPenInfoRec_CType

PrePmtPenInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CurtPenAffPrtcp
Answers the question: Should the curtailment penalty affect the sold portion of a loan? Canonical Values are:
  • false
  • true
CurtPenCode
The code used to determine the behavior for curtailment penalty.
CurtPenDesc
The description of the code used to determine the behavior for curtailment penalty.
PayoffPrePmtPenExpDt
The date that the prepayment penalty policy expires.
PayoffPrePmtPenStartDt
The date that the prepayment penalty policy becomes effective.
PrePmtPenBillCode
The code that describes the behavior for billing for prepayment penalties.
PrePmtPenBillDesc
The description of the code that describes the behavior for billing for prepayment penalties.
PrePmtPenBillTerm
The integer length of the term.
PrePmtPenBillTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
PrePmtPenExpDt
The date that the prepayment penalty policy expires.
PrePmtPenRenDt
The prepayment penalty renewal date.
PrePmtPenRenTerm
The integer length of the term.
PrePmtPenRenTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
PrePmtPenStartDt
The date that the prepayment penalty policy becomes effective.
RecoupPenAffPrtcp
Answers the question: Should the recoupment penalty affect the sold portion of a loan? Canonical values are:
  • false
  • true
RecoupPenAffPrtcpPct
The percentage of the recoupment penalty that should affect the sold portion of a loan.
UserDefInfoArray_AType

UserDefInfoArray_AType is an array AType element. This is an array of UserDefInfo simple elements used to describe user-defined information.

Contains:

  • UserDefInfo_CType
UserDefInfo_CType

UserDefInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

OvrrdInstRtId
Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
UserDefCode
The code that represents the answer to the UserDefTxt.
UserDefDesc
The description of what the UserDefCode represents.
UserDefDt
A date field that has a relationship with the UserDefTxt or UserDefCode.
UserDefInfo1
Additional information that may accompany any of the user supplied codes.
UserDefInfo2
Additional information that may accompany any of the user supplied codes.
UserDefInfo3
Additional information that may accompany any of the user supplied codes.
UserDefTxt
User Defined Text is part of a matched pair array that describes the proceeding elements.
Ver_15_CType

Ver_15_CType is a complex CType element. This element is the object tag that represents the 15th iteration of the object.

LnBalDtInfo_CType

LnBalDtInfo_CType is a complex CType element. It contains loan account balance information. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

AdvaMTDAmt
The monthly amount advanced for a loan.
AdvaYTDAmt
The yearly amount advanced for a loan.
AHInsurMatDt
The AH insurance maturity date.
BalDueAtMat
The balance due at maturity. Canonical values are:
  • false
  • true
BallCallDt
The date the balloon note is due.
ChgdOffAmt
The amount charged off.
ChgdOffDt
The charge-off date.
ClsDt
The closing date.
CollatInsurExpDt
The collateral insurance expiration date.
CouponReOrderDt
The date a coupon book is to be reordered.
CouponReOrderTerm
The integer length of the term.
CouponReOrderTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
CouponStartDt
The beginning date for loan coupons.
CrLifeMatDt
The credit life insurance maturity date.
EstClsDt
The estimated closing date of the loan.
ExmnrClsfDt
The classification date. The date of examiner classification.
FeeChgdPYTD
The fees charged previous year-to-date.
FeeChgdYTD
The fees charged year-to-date.
FeePaidLTD
The fees paid life-to-date.
FeePaidMTD
The fees paid month-to-date.
FeePaidPYTD
The fees paid prior year-to-date.
FeePaidYTD
The fees paid year-to-date.
FirstPmtDt
The first payment date.
ForeClosureDt
The date a lender foreclosed on a property.
FundLmt
The funding limit of a loan. The maximum amount that can be advanced on a loan.
IntChgdPYTD
The interest charged previous year-to-date.
IntChgdYTD
The interest charged year-to-date.
IntOnlyExpDt
The date that the loan expires for interest only payments.
IntPaidAtAssumLastYr
The interest paid at assumption last year.
IntPaidAtAssumYTD
The interest paid at assumption year-to-date.
IntPaidLTD
The interest paid life-to-date.
IntPaidPYTD
The interest paid previous year-to-date.
IntPaidToDt
The interest paid to date.
IntPaidYTD
The interest paid year-to-date.
IntResrvBal
The interest reserve balance.
LastCouponReOrderDt
The last coupon reorder date.
LastMainDt
The last maintenance date.
LateChgPaidLTD
The late charges paid life-to-date.
LateChgPaidMTD
The late charges were paid month-to-date.
LateChgPaidPrevYTD
The late charges paid previous year-to-date.
LateChgPaidYTD
The late charges paid year-to-date.
LnApprvDt
The date a loan was approved which differs from the date the loan closed.
LnConvDt
The date the loan was converted from one loan product to another loan product.
LnSetupDt
The date of loan setup.
MinInt
The minimum interest.
MTDAccrInt
The amount of interest that has accrued for an account.
NetMemoPostAmt
The sum of the current memo-posted items against this account.
NewLnFundAmt
The amount of any new money added to or borrowed along with the original amount of the Senior Lien Loan.
NonAccrDt
The nonaccrual date.
NxtRvwDt
The next review date.
OrigFeesLTD
The origination fees life-to-date.
OrigFeesPYTD
The origination fees previous year-to-date.
OrigFeesYTD
The origination fees year-to-date.
OrigMatDt
The original maturity date.
PrincPaidPYTD
The principal paid prior year-to-date.
PrincPaidYTD
The principal paid year-to-date.
ProceedAmt
The first advance amount for the new loan.
PtPaidByOwner
The points paid by owner. Canonical values are:
  • false
  • true
ReAmrtzDOM
The day of the month the payment re-amortizes.
ReAmrtzPmtDt
The date the payment re-amortizes.
ReAmrtzThruDt
The re-amortize through date.
RightToCureDt
The right-to-cure date.
SoldBal
The sold balance.
TotIntAmt
The total amount of interest anticipated to be paid over the life of the loan.
UCCExpDt
The UCC expiration date.
UEInsurMatDt
The unemployment insurance maturity date.
WatchListDt
The watch list date.
YrFeeChgDt
The date the yearly fee should be charged to an account.

LnProtInfo_CType

LnProtInfo_CType is a complex CType element. It contains loan protection information. This element is optional.

Contains:

  • ProtAcctArray_AType
Simple Elements

The following simple elements are contained within this complex.

AdvaCnt
The number of advances.
AdvaTot
The total number of advances.
DDAMinBalAdv
The DDA minimum balance for advance.
DrAcctExpDt
The debit account expiration date.
DrAcctHldDt
The debit account hold date.
DrAcctId
The debit account number.
DrAcctType
The debit account type.
ExclHldXferCode
The code that conveys if account holds should be considered for transfer requests.
FrzPmtPastDue
Freeze if payment is past due. Canonical values are:
  • false
  • true
LastAdvaDt
The last advance date
LastStmtBal
The last statement balance.
LastStmtDt
The last statement date.
LOCAvg
The credit line average usage.
LOCCycleAcctId
The account ID that is used to cycle the credit line whenever that account ID is cycled.
LOCCycleAcctType
The account type that is used to cycle the credit line whenever that account ID is cycled.
LOCDaysAtZero
The credit line number of days at balance zero.
LOCExpDt
The line of credit expiration date.
LOCHighAmtPrevYTD
The credit line's high usage previous year-to-date.
LOCHighAmt
The credit line high usage.
LOCHighAmtYTD
The high balance of the credit line year-to-date.
LOCLmt
The line of credit limit.
LOCLowAmt
The line of credit low usage.
LOCTaxRefId
The credit line tax reference number. Tax reference number for credit line. For informational purposes.
LOCTotAdvaAmt
The credit line total advances.
MaxPmtAmt
The maximum payment amount.
MinPmtAmt
The minimum payment amount.
ODProtPmtCode
The code for the payment calculation method.
PmtCnt
The number of payments.
PmtDDANSFCode
The code for take payment if DDA is NSF.
PmtPct
The payment percentage.
ProtAcctId
The protection account number.
ProtAcctType
The protection account type.
ProtBalZero
Keep protection balance at zero. Canonical values are:
  • false
  • true
StmtCycle
The statement cycle.

LnRateInfo_CType

LnRateInfo_CType is a complex CType element. It contains loan interest rate information.

Contains:

  • LnTierRateArray_AType
Simple Elements

The following simple elements are contained within this complex.

BackdateRateChngType
Does this loan backdate based on the rate change? Canonical values are:
  • true
  • false
BegFactorIdxDt
The beginning date of the factor index.
BegFactorIdx
The factor index.
BusCalDayType
Designates whether business or calendar days. Canonical values are:
  • Bus
  • Cal
BusDayRateRevType
Business or calendar days to look at for rate review changes. Canonical values are:
  • Prev - Previous business day
  • Nxt - Next business day
  • Cur - Current calendar day
ConvARMCode
A convertible ARM indicator.
ConvARMExpDt
The convertible ARM expiration date.
ConvFixRateExpDt
The expiration date for a loan to convert from a fixed rate loan to an adjustable-rate loan.
ConvIdxNum
The convertible index number. This code must match a valid index set up by the bank if not zero.
ConvVarCode
The convertible variance code.
ConvVar
The convertible variance.
CurCarryOvrSign
The rate carryover sign.
CurCarryOvr
The current carryover.
CurIdx
The current index.
DaysBeforeRateChg
The number of days before rate change.
DaysInitARMNot
The number of days before the initial adjustable-rate mortgage rate change notice should be sent.
DlqRateDays
The delinquent rate number of days. The number of days delinquent that the loan must become before it begins to accrue at the delinquent rate.
DlqRateIdxNum
The delinquent rate index number. Master rate index number that the loan accrues at if delinquent.
DlqRateMarginSign
The delinquent rate margin sign.
DlqRateMargin
The delinquent rate margin.
DlqRate
The delinquent flat rate that the loan accrues at if delinquent.
InitARMFixPeriodCnt
The integer length of the term.
InitARMFixPeriodUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
InitARMNotType
The status of the initial adjustable rate mortgage notice. Canonical values are:
  • NA
  • NotSent
  • Sent

The default is NA.

LastRePriceDt
The date that the loan rate was reviewed or changed.
LnCapRate
The life time cap for a loan's rate.
MatGraceDays
The maturity grace days. The number of grace days allowed after the loan maturity before the maturity rate is used, if it is entered.
MatRate
The maturity rate. The rate of the loan at maturity.
NewCarryOvrSign
The rate carryover sign.
NewCarryOvr
The new carryover.
NewIdxVal
The future (new) index value.
NewPrevRateChgDt
The new previous rate change date.
NewPrevRate
The new previous rate.
NonBusDayRateRevType
Used when the rate review date falls on a non-processing day. Canonical values are:
  • Prev - Previous business day
  • Nxt - Next business day
  • NxtCurMonth - Next current month, which functions like next business day unless the non-processing day occurs at month-end, in which case the previous business day is used.
OrigIdxVal
The original index value. This index is used to calculate the original rate for ARM.
OrigRate
The original rate.
PenAnnPctIdxNum
The Rate Index Number for penalty APR.
PenAnnPctRate
The penalty APR interest rate.
PenEffDays
The number of effective days after the notice is generated to apply the penalty APR.
PenNotDays
The number of days a loan is past due to trigger a penalty notice.
PenRevTerm
The penalty APR Review Term. The amount of time lapse to review a loan for continued penalty APR application.
PenRevTermUnits
The Penalty APR Review Term Code. This code determines when to review the loan for continued penalty APR application based in days or months. Canonical values are:
  • Day
  • Month
  • NA
PermRateCapUp
The rate cap that is permanent for the life of the loan.
PrevCarryOvrSign
The rate carryover sign.
PrevCarryOvr
The previous carryover.
PrevIdxVal
The previous index value.
PrtRateChgNotCode
The code that designates the behavior for print rate change notices.
RateBeforeDlq
The rate before delinquency.
RateBegCapPeriod
The rate at beginning of cap period.
RateCapDown
The rate cap downward. The maximum downward change in the rate allowed during any rate cap term.
RateCapRevDt
The rate cap review date.
RateCapRevTerm
The rate cap review term. The system checks the prime rate for change at the interval specified in this field. Entries may be in number of days or number of months.
RateCapRevTermUnits
The rate cap review term code. This field determines if the rate cap period is to be figured in months or days.

Canonical values are:

  • Days
  • Months
  • NA
  • SemiMonthly
  • Years
RateCapUp
The rate cap upward. The maximum upward change in the rate allowed during any rate cap term.
RateCeil
The rate ceiling entry that sets a top rate above which the rate never rises.
RateFlr
The rate floor entry that sets a base rate below which the rate of the loan never falls.
RateIdxNum
The rate index number to which the loan is tied.
RateIdxType
Will the rate or index type be used? Canonical values are:
  • Rate - default value
  • Idx
RateLookbackDays
The number of days to look back at the index for the rate.
RateRevDayOfMonth
The day of month for rate reviews. This code is only required if the rate review date is the 29th of the month.
RateRevDt
The date used to determine if a rate should be changed.
RateRevTerm
The rate review term. The system checks the prime rate for change at the interval specified in this field. Entries may be in number of days or number of months.
RateRevTermUnits
The rate review term code. This code determines whether the prime review term is in months or days. Canonical values are:
  • Days
  • Month
  • NA
RateRoundMthd
Rate rounding method. Method to round newly calculated rates.
RateRoundToPct
The rate rounded to percentage. Increment to round newly calculated rates.
RateSpread
The spread between the APR on the mortgage and the rate on Treasury securities.
RateVarCode
The rate variance code. This code tells the system if the variance from prime is above, below, or is of a percentage. Canonical values are:
  • NA
  • Negative
  • Pct
  • Positive
RateVar
The rate variance. The amount of variance from the prime rate allowed for the account.
TeaserRateCode
The code that indicates the type of teaser rate.
UseRateCarryOvrs
Use rate carryovers. Canonical values are:
  • false
  • true
LnTierRateArray_AType

LnTierRateArray_AType is an array AType element. This is an array of loan tiered rates.

Contains:

  • LnTierRateInfoRec_CType
LnTierRateInfoRec_CType

LnTierRateInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AccrMeth
The accrual method.
LnTierRate
The loan tier rate.
LnTierRateBal
The threshold balance used to initiate a tiered rate.
LnTierRateIdxNum
The loan tier rate index number that references a rate.
LnTierRateText
The text used to describe the proceeding elements in the LnTierRateArray.

LnRegRptInfo_CType

LnRegRptInfo_CType is a complex CType element. It contains loan regulatory reporting information. This element is optional.

Contains:

  • CRARec_CType
  • LnRiskRateArray_AType
Simple Elements

The following simple elements are contained within this complex.

ARGOProdCode
The code used to interface to the ArgoKeys product.
CallRptCode
The call report code.
ExclRealEstateRptCode
The code that references that a loan is excluded from supervisory LTV limits.
FraudSusType
Answers the question: Is the entity subject a possible fraud suspect? Canonical values are:
  • false
  • true
GLCostCtr
The GL cost center provided for bank use in reporting the account to a specific GL cost center.
GLProdCode
The GL product code provided for bank use in reporting the account to a specific GL product code.
GroupCode
Used to group loans of different types for general ledger reporting purposes. It may also be used to group customer accounts together.
HMDARpt
Does the loan qualify for HMDA reporting?
LienPositCode
The lien position for a loan. For example, first lien position, second lien position, etc.
LnAppId
An identification given to a loan application.
LnUnvId
The loan universal identifier. The ULI must begin with the institution's legal entity identifier described in 1003.5(a)(3), followed by up to 25 additional characters to identify the loan or application. These characters must be letters, numbers, symbols, or a combination.
MltryApp
Military applicant. Canonical values are:
  • false
  • true
MltryLnActType
Specifies if the loan qualifies under Military Lending Act Regulation. Canonical values are:
  • false
  • true
NAICSCode
A valid NAICS (Northern American Industry Classification System) code. Value is passed from the service of record during the pilot phase.
RegLTVCode
The code that describes the regulatory supervisory loan to value category.
RegRiskId
The ID that weighs the risk of an institution's assets.
RegRptConvARMCode
The code used to report to regulatory agencies for convertible adjustable rate mortgages.
RegSeniorLienCode
The code that references the regulatory reporting for senior liens on a loan.
Req1098
Requires 1098 determines whether this loan needs a form 1098 generated at end-of-year. Canonical values are:
  • 1098
  • 1098E
  • NotReq
RightToCureNotCnt
The number of Right to Cure notices that have been sent.
RiskRateCalcAmt
The risk rating calculated amount based on the risk rating codes, percents, and amounts.
RiskRateDt
Date risk rating is assigned.
SBAApprvDt
The date a loan was approved by SBA.
SBABasisPts
The basis points used on SBA loans to calculate the SBA administration fee on the guaranteed portion of the loan.
SBACycleStat
The code that designates the SBA status for current cycle. Canonical values are:
  • Defr
  • FullyUnDisb
  • InLiq
  • PdInFull
  • PurchBySBA
  • Xfer
SBAGuarId
The ID provided by SBA for SBA guaranteed loans.
SBAGuarPct
The percentage of the loan guaranteed by SBA.
SBAPrevStat
The code that designates the SBA status for previous cycle. Canonical values are:
  • Defr
  • FullyUnDisb
  • InLiq
  • PdInFull
  • PurchBySBA
  • Xfer
SCRABegDt
The beginning date that an individual should be considered for Service Members Civil Service Relief.
SCRAEndDt
The ending date that an individual should be considered for Service Members Civil Service Relief.
SCRANotCode
The code that describes the behavior for HUD notices for qualified members of active military service.
SrLienAmt
The amount of the loan that is held by another institution as required for Federal Reserve reporting for thrift institutions.
SrLienOrigAmt
The original amount held by the senior lien holder.
StdIndustCode
The standard industry code.
CRARec_CType

CRARec_CType is a complex CType element. This complex contains CRA information. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

CRAAnnIncmAboveMil
Is the borrower's income above $1,000,000?
CRAAnnIncmAmt
The annual income of the borrower.
CRACenTract
Census tract information for Community Reinvestment Act reporting.
CRACode
The code that designates the type of loan predetermined by CRA.
CRACountyCode
County code for Community Reinvestment Act reporting.
CRACountyDesc
County for Community Reinvestment Act reporting.
CRADesc
The description of the code that designates the type of loan predetermined by CRA.
CRAId
An ID for the CRA account record.
CRAIncmLvl
Income level for Community Reinvestment Act reporting.
CRALoc
Location information for Community Reinvestment Act reporting.
CRAMilitaryCode
Military code for Community Reinvestment Act reporting.
CRAMilitaryDesc
Military description for Community Reinvestment Act reporting.
CRAOrigBal
The original or renewal amount to be reported under the rules of CRA.
CRAOrigLocCode
Designates where the loan was originated.
CRAOrigLocDesc
The description of the code that designates where the loan was originated.
CRAOrigRenDt
The original or renewal date, in accord with CRA reporting.
CRAPurchaseLn
Determines if the loan was purchased or originated by the bank.
CRASMSACode
Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
CRASMSADesc
Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
CRAStateCode
The state code for Community Reinvestment Act reporting.
CRAStateDesc
The state for Community Reinvestment Act reporting.
LnRiskRateArray_AType

LnRiskRateArray_AType is an array AType element. This is an array of loan risk ratings.

Contains:

  • LnRiskRateInfoRec_CType
LnRiskRateInfoRec_CType

LnRiskRateInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

RiskRateAmt
The risk rating amount applied to the loan.
RiskRateCode
Risk rating code assigned by bank.
RiskRateDesc
Describe risk rating code assigned by bank.
RiskRatePct
The risk rating percent applied to the loan.
RiskRateText
The textual data that describes the risk rating codes in the array.

LnDlrInfo_CType

LnDlrInfo_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BankDisc
Bank discount is the amount of unearned interest on the loan. This field is only active on add-on type loans.
BankIncmFrft
The bank income forfeited.
DaysToFrftOnChgoff
The number of days to forfeit discount/rebate if charged off.
DaysToFrft
The number of days to forfeit discount/rebate.
DlrAccr
The dealer accrual.
DlrCode
The dealer code.
DlrDisc
The amount of dealer discount.
DlrEarnings
The dealer earnings.
DlrId
The dealer identification.
DlrLocId
The dealer location identification.
DlrName
The dealer name.
DlrRate
The current dealer rate.
DlrRebate
The dealer rebate.
DlrResrvAmt
The dealer reserve amount.
DlrUpfrntEarned
The dealer up front earned.
FrftDiscAtPayoff
The forfeit discount/rebate at payoff forfeit dealer discount or rebate if early payoff within specified number of days or payments. Canonical values are:
  • Disc
  • NA
  • Rebate
FrftRebateAfterChgoff
Forfeit dealer rebate after charge-off. Canonical values are:
  • Bank
  • Dlr
  • NA
FrftRebateIfChgoff
Forfeit dealer rebate/discount if charged off.
FrftRebateOnPayoff
Forfeit discount/rebate at payoff. Canonical values are:
  • Bank
  • Dlr
  • NA
IntRebate
The interest rebate.
PctRebateToChgoff
The percent of discount/rebate to charge off.
PmtsToFrft
Number of payments to forfeit rebate/discount.
PmtsToFrftOnChgoff
Number of payments to forfeit discount/rebate if charge-off.
RebateToBankDlr
Up front remaining rebate goes to bank or dealer. Canonical values are:
  • Bank
  • Dlr
  • NA
RecourseCode
The code that describes the recourse action to be taken with a dealer when a loan is past due.
RecoursePct
The percent of the dealer's liability for each loan.
RecourseTerm
The recourse term the dealer's liability expires.
RecourseTermUnit
The recourse frequency units the dealer's liability expires. Canonical values are:
  • Days
  • Months
  • NA
  • SemiMonthly
  • Years
RemResrvAmt
The remaining reserve amount.
RemResrvEarn
The remaining reserve earned.
RemResrvPct
The remaining reserve percentage.
UpfrntPct
Up front percent dealer's upfront reserve percentage.

LnRenExtInfo_CType

LnRenExtInfo_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

ExtFeesLTD
The extension fees life-to-date.
ExtFeesMTD
The extension fees month-to-date.
ExtFeesYTD
The extension fees year-to-date.
ExtMonthsLTD
The number of months extended life-to-date.
LastExtDt
The last extension date.
LastRenBal
The last renewal balance.
LastRenDt
The date of last renewal.
LastRenExtDt
The last renewed/extended date.
NumPmtsExtLastYr
The number of payments extended last year.
NumPmtsExtLTD
The number of payments extended life-to-date.
NumPmtsExtYTD
The number of payments extended year-to-date.
PrevExtDt
The date of previous extension.
PrevRenDt
The date of previous renewal.
RenCntLTD
The number of times renewed life-to-date.
TimesExtLTD
The number of extensions life-to-date.
TimesRenPrevYr
The number of times renewed last year.
TimesRenYTD
The number of times renewed this year.

LnInfoRec_CType

LnInfoRec_CType is a complex CType element.

Contains:

  • AcctTitleArray_AType
  • AliasCustName references PersonName_CType
  • OffInfoArray_AType
  • Term_CType
  • TINInfo_CType
Simple Elements

The following simple elements are contained within this complex.

AccrBilMthd

The accrual billing method. Canonical values are:

  • ActualSchedDueDt - Accruals billed as of the actual scheduled due date.
  • BilDt - Accruals billed as of the billing date.
  • DueDt - Accruals billed as of the due date.
  • ThruActualSchedDueDt - Accruals billed through the actual scheduled due date.
  • ThruDueDt - Accruals billed through the due date.
AccrBal
The accrual balance.
AcctLvlSecCode
The code that references the special handling security processes/accesses at the account level.
AcctStat
The account status.
AHInsurAccr
The AH insurance accrual.
AliasAcctName
An alias name provided to an account that is often used for GUI representation that is understandable to an end consumer.
AvailCr
The available credit.
BatchNum
The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
BrandCode
The code that defines the brandings.
BrCode
The branch code.
CrLifeInsurAccr
The credit life insurance accrual.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
IntBasis
The interest base method used for the loan. Canonical values are:
  • AddOn
  • Amrtz
  • Act/360
  • Act/365
  • 30/360
  • 360/360
IntRate
The interest rate.
LastPmtDt
The last payment date.
LateChgAmt
The late charge amount.
LnUnitDesc
The description of an identification assigned to a unit of a loan.
LnUnitRptMthd
The method of reporting for unit loans. Canonical values are:
  • Dlr
  • MstrPln
  • UnitPrice
MatDt
The maturity date.
MICRAcctId
The magnetic ink character recognition account identification that could differ from the account identification.
NxtPayDt
The next payment date.
NxtSchedPmtDt
The next scheduled payment date.
OddDaysIntBasis
The interest base to be used at the account's origination if it differs from the IntBasis.
OffCode
The code that designates the financial institution officer.
OpenDt
The date opened.
OrigBal
The original balance.
PartPmtAmt
The partial payment amount.
PastDueAmt
The past due amount.
PayoffGoodThruDt
The payoff good through date.
PIAmt
The principal and interest payment amount.
PmtAmtDue
The payment amount due.
PmtAmt
The payment amount.
PmtCode
The payment code. The payment code determines how the payment is applied to the loan.
PmtDayOfMonth
The day of month for payment. This code is only required if the payment due date is the 29th of the month.
PmtTerm
The payment frequency.
PmtTermUnits
The payment frequency units: months, days. Canonical values are:
  • AtMat
  • Days
  • Months
  • NA
  • SemiMonthly
  • Years
ProdCode

The code that identifies a product type of account within an application. Canonical values are:

  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

RemPmtCnt
The number of payments remaining.
SalesPerson
The code value that represents the sales person. This element was changed from a string to an open enumerated type in 4/2011. This element resides as an exception and is not to be suffixed with code rather than deprecate the element. The element does have a description.
SemiDay1
The day of month for first semi-monthly payment.
SemiDay2
The day of month for second semi-monthly payment.
ShortPmtCode
The code that defines the behavior for advancing due dates when less than a full payment is accepted.
SpecLndType

Indicates if this is a specialty lending loan. Canonical values are:

  • false
  • true
Term
The term of the loan.
UEInsurAccr
The unemployment insurance accrual.
UnusedCrAccr
The unused credit accrued.
LnInfoRec_CType Deprecation Details
OffCode
This element has been moved to the OffInfoArray located within this complex. Effective date: 2011-01-01.
AcctTitleArray_AType

AcctTitleArray_AType is an array AType element. This is an array of account titles used to define the customer and additional names. This element is optional.

Contains:

  • AcctTitleInfo_CType
AcctTitleInfo_CType

AcctTitleInfo_CType is a complex CType element.

Contains:

  • AddlName references PersonName_CType
  • AddlPhoneArray references PhoneArray_AType
  • AddlTIN references TINInfo_CType
Simple Elements

The following simple elements are contained within this complex.

AcctTitle
The account title including customer name and additional names.
Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
AddlBirthDt
The date of birth.
AddlNameStat
The additional person status. Canonical values are:
  • Act - active
  • NotAct - not active

The ComName element is contained by the AddlName complex and replaces the AcctTitle element. The depreciation effective date for AcctTitle is 2012-01-01.

AddlName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

AddlName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
AddlPhoneArray

PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.

AddlPhoneArray references PhoneArray_AType.

Contains:

  • PhoneInfo_CType
PhoneInfo_CType

PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.

Contains:
  • MobPhoneInfo_CType
Simple Elements

The following simple elements are contained within this complex.

ConEndTime
The Greenwich Mean time when contact availability ends.
ConStartTime
The Greenwich Mean time when contact availability starts.
PhoneExt
The phone extension.
PhoneNumDsp
Phone Number Display, based on format codes which may include special formatting. Examples include:
  • (XXX)XXX-XXXX
  • XXX-XXX-XXXX
  • XXX/XXX/XXXX
  • XXX.XXX.XXXX
  • XXX-XXX-XXXXXX
  • XXXXX-XXX-XXX-XXXX
PhoneNum
The phone number.
PhoneTime
Best phone usage time, day, or evening.
PhoneType

Phone type examples are: home, work, fax, cell. Canonical values are:

  • Home
  • SecdHome
  • Bus
  • SecdBus
  • HomeCell
  • BusCell
  • PersonalCell
  • HomeFax
  • BusFax
  • SecdBusCell

PhoneType is a hybrid open enumeration.

AddlTIN

TINInfo_CType is a complex CType element. This element contains tax information number codes and descriptions. This element is optional.

AddlTIN references TINInfo_CType.

Contains:

  • TaxIdOwnerName references PersonName_CType
Simple Elements

The following simple elements are contained within this complex.

BNotIRSDt
The last IRS notification.
BNotStat
The B notice flag.
CertCodeDesc
The description of the code that represents the certification behavior for a tax ID.
CertCodeDt
The certification code date.
CertCode
The code that represents the certification behavior for a tax ID.
TaxIdMod
A tax ID modifier assigned by the SSA to some individuals.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
TINCode
The code that designates the type of tax identification number. Canonical values are:
  • SSN
  • EIN
  • Forn

TINCode is a hybrid open enumeration.

TINDesc
The description of the code that designates the type of tax identification number.
TaxIdOwnerName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

TaxIdOwnerName references PersonName_CType.

The TaxIdOwnerName is optional and is only required when the customer level tax ID is different than the account level.

Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
AliasCustName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

AliasCustName
references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
OffInfoArray_AType

OffInfoArray_AType is an array AType element. This is an array of officers.

Contains:

  • OffInfoRec_CType
OffInfoRec_CType

OffInfoRec_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

OffCode
The code that designates the financial institution officer.
OffCodeText
The text that describes the preceding elements for the OffInfoArry.
OffDesc
The officer short name.
OffRmk
Application or user remarks free-form text.
Term_CType

Term_CType is a complex CType element. This complex contains loan account term information. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

DaysCall
The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
Desc
The generic description.
TermCnt
The integer length of the term.
TermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
TINInfo_CType

TINInfo_CType is a complex CType element. This element contains tax information number codes and descriptions. This element is optional.

Contains:

  • TaxIdOwnerName references PersonName_CType
Simple Elements

The following simple elements are contained within this complex.

BNotIRSDt
The last IRS notification.
BNotStat
The B notice flag.
CertCodeDesc
The description of the code that represents the certification behavior for a tax ID.
CertCodeDt
The certification code date.
CertCode
The code that represents the certification behavior for a tax ID.
TaxIdMod
A tax ID modifier assigned by the SSA to some individuals.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
TINCode
The code that designates the type of tax identification number. Canonical values are:
  • SSN
  • EIN
  • Forn

TINCode is a hybrid open enumeration.

TINDesc
The description of the code that designates the type of tax identification number.
TaxIdOwnerName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

TaxIdOwnerName references PersonName_CType.

The TaxIdOwnerName is optional and is only required when the customer level tax ID is different than the account level.

Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.

PromoInfo_CType

PromoInfo_CType is a complex CType element.

Simple Dictionary

This complex element contains the following simple elements.

PromoCode
The code that identifies a promotion.
PromoOrigBal
The original balance.
PromoCurBal
The current balance.
PromoCrYTD
The year-to-date interest.
PromoCrPrevYTD
The previous year-to-date interest paid.
PromoCrLTD
The interest paid life-to-date.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

LnAcctAddRs_MType

LnAcctAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

RsStat

The status of the response. Canonical values are:

  • fail
  • success

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Thu Feb 8 2024