Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Loan Application Register Search

Enterprise SOAP API > API by Reference > Core Services > Loan Application Register Search

Loan Application Register Search

Loan Application Register Search is a jXchange messaging service designed to search the lending data of the loan applications in the register used for reporting purposes.

Message Flow

Message flow involves the exchange of MType complexes between the Third Party Consumer and the Service Provider.

Primary Request

In the initial request, the Third Party Consumer forwards the LnAppRgtrSrchRq_MType complex to the Service Provider containing:

  • AppStatCode_Type
  • LnAppId_Type
  • StartDt_Type
  • EndDt_Type

Primary Response

In the initial response, the Service Provider returns the LnAppRgtrSrchRs_MType message containing:

  • LnAppRgtrSrchRecArray_AType

LnAppRgtrSrch Behavior

Overview

The search request allows for a documented key statement for the AppStatCode. For example, this would allow a consumer to request all of the open applications, if the Service Provider utilizes a status for open applications.

The search request allows for a documented key statement for the LnAppId. This would provide the consumer with a means to retrieve elements for a specific element.

The search request allows for a documented filter statement for a date range. The StartDt and EndDt elements are re-used for this purpose.

The complexes used in the Addition service are re-used in this service.

The search response includes the description elements that correlate with the code elements. The loan application identification is included to allow for use in the modification service.

LnAppRgtrSrchRq_MType

LnAppRgtrSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElemArray_AType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

AppStatCode
The status or disposition of an application.
EndDt
The date that designates the ending point for date selections.
InclNaAppDtType
Whether to include not applicable (NA) application dates. Canonical values are:
  • True
  • False
LnAppId
An identification given to a loan application.
StartDt
The date that designates the starting point for date selections.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element.

Contains:

  • IncXtendElemInfo_CType

IncXtendElemInfo_CType

IncXtendElemInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XtendElem
Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message 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.
Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MaxRec
The maximum number of records when multiple records are returned.

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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.

LnAppRgtrSrchRs_MType

LnAppRgtrSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • LnAppRgtrSrchRecArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

AppStatCode
The status or disposition of an application.
EndDt
The date that designates the ending point for date selections.
InclNaAppDtType
Whether to include not applicable (NA) application dates. Canonical values are:
  • True
  • False
LnAppId
An identification given to a loan application.
StartDt
The date that designates the starting point for date selections.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnAppRgtrSrchRecArray_AType

LnAppRgtrSrchRecArray_AType is an array AType element. This is an array of responses for a loan application register search.

Contains:

  • LnAppRgtrSrchRec_CType

LnAppRgtrSrchRec_CType

LnAppRgtrSrchRec_CType is a complex CType element.

Contains:

  • CustomLnAppRgtrSrchRec references Custom_CType
  • LnAppBorwInfo_CType
  • LnAppCoBorwArray_AType
  • ResLnAppRgtrInfo_CType
Simple Elements

The following simple elements are contained within this complex.

AppStatDesc
The description of the status or disposition of an application.
CRACountyDesc
County for Community Reinvestment Act reporting.
CRADelinDesc
The description of the code that references the property's location within the delineated community in the lending association's CRA statement.
CrAppDesc
The description of the code that further defines the type of loan credit application.
CRASMSADesc
Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
FHLBPropDesc
The description of the code that references the type of property in accord with FHLB reporting requirements.
HOEPAStatDesc
The description of the status of the Home Ownership and Equity Protection Act loan.
LienStatDesc
The description of the code that references the status of the lien for a loan application.
LnAppId
An identification given to a loan application.
LnPurpDesc
The purpose code description.
MHLandPropIntDesc
The description of the code that describes the manufactured home land property interest. Examples are:
  • Direct Ownership
  • Indirect Ownership
  • Paid Leasehold
MHSecuredPropDesc
The description of the code that describes the manufactured home secured property. Examples are:
  • Manufactured Home and Land
  • Manufactured Home Only
OccupDesc
The description of the code that references the occupancy of the property.
PreApprvAppDesc
The description of the code that references the pre-approval process for a loan application.
PropDesc
A description of the property.
PurpDesc
The purpose code description.
SecdMtgDesc
The description of the code that represents the type of secondary mortgage activity.
CustomLnAppRgtrSrchRec

Custom_CType is a complex CType element.

CustomLnAppRgtrSrchRec references Custom_CType.

This element is optional.

LnAppBorwInfo_CType

LnAppBorwInfo_CType is a complex CType element.

Contains:

  • BorwCrScoreArray_AType
  • BorwEthnicArray_AType
  • BorwName references PersonName_CType
  • BorwPhoneArray references PhoneArray_AType
  • BorwRaceArray_AType
Simple Elements

The following simple elements are contained within this complex.

BorwAge
The borrower's age.
BorwEthnicColType
Ethnicity of an individual collected through visual observation or surname.
BorwEthnicType
The ethnicity of an individual. Canonical values are:
  • Latino
  • OptOut
  • Oth
BorwEthnicVal
Individuals' Other Hispanic or Latino ethnicities free form text value.
BorwGenderColType
Individual's gender, collected by visual observation or surname. Canonical values are:
  • Visual
  • NonVisual
  • NA
BorwGender
The borrower's gender. Valid options are:
  • Female
  • Male
  • Other
BorwIncmAmt
The borrower's income.
BorwMaritalStatType
The marital status of a person. Canonical values are:
  • Divorce
  • Married
  • Separated
  • Single
  • Widow
BorwTaxId
The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
BorwCrScoreArray_AType

BorwCrScoreArray_AType is an array AType element.

Contains:

  • BorwCrScoreRec_CType
BorwCrScoreRec_CType

BorwCrScoreRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

BorwCrScoreId
Identifies the borrower's credit score.
BorwCrScoreModelCode
The code that identifies the name and version of a credit scoring model.
BorwCrScoreModelDesc
The description of the code that identifies the name and version of a credit scoring model.
BorwCrScoreModelVal
The credit score model name free form text value.
BorwEthnicArray_AType

BorwEthnicArray_AType is an array AType element.

Contains:

  • CoBorwEthnicRec_CType
BorwEthnicRec_CType

BorwEthnicRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

BorwEthnicColType
Ethnicity of an individual collected through visual observation or surname.
BorwEthnicType
The ethnicity of an individual. Canonical values are:
  • Latino
  • OptOut
  • Oth
BorwEthnicVal
Individuals' Other Hispanic or Latino ethnicities free form text value.
PrioritySeq
The assignment of a priority sequence for an array of items.
BorwName

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

BorwName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This 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.
BorwPhoneArray

BorwPhoneArray is an array AType element.

BorwPhoneArray 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.
PhoneNum
The phone number.
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
PhoneTime
Best phone usage time, day, or evening.
PhoneType
Phone type examples are: home, work, fax, cell.
BorwRaceArray_AType

BorwRaceArray_AType is an array AType element. This is an array of race codes for a borrower.

Contains:

  • BorwRaceInfo_CType
BorwRaceInfo_CType

BorwRaceInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

BorwRaceCode
The code that references the borrower's race.
BorwRaceColType
Race collected through visual observation or surname. Canonical values are:
  • Visual
  • NonVisual
  • NA
BorwRaceDesc
The description of the code that references the borrower's race.
BorwRaceType
A description of the race that correlates with the race array.
BorwRaceVal
Race of borrower free form text value.
LnAppCoBorwArray_AType

LnAppCoBorwArray_AType is an array AType element. This is an array of elements that describe the co-borrower for the application register.

Contains:

  • LnAppCoBorwInfo_CType
LnAppCoBorwInfo_CType

LnAppCoBorwInfo_CType is a complex CType element.

Contains:

  • CoBorwCrScoreArray_AType
  • CoBorwEthnicArray_AType
  • CoBorwName references PersonName_CType
  • CoBorwPhoneArray references PhoneArray_AType
  • CoBorwRaceArray references BorwRaceArray_AType
Simple Elements

The following simple elements are contained within this complex.

CoBorwAge
The co-borrower's age.
CoBorwEthnicColType
Ethnicity of an individual collected through visual observation or surname.
CoBorwEthnicType
The ethnicity of an individual. Canonical values are:
  • Latino
  • OptOut
  • Oth
CoBorwEthnicVal
Individuals' Other Hispanic or Latino ethnicities free form text value.
CoBorwGenderColType
Individual's gender, collected by visual observation or surname. Canonical values are:
  • Visual
  • NonVisual
  • NA
CoBorwGender
The co-borrower's gender. Valid options are:
  • Female
  • Male
  • Other
CoBorwMaritalStatType
The marital status of a person. Canonical values are:
  • Divorce
  • Married
  • Separated
  • Single
  • Widow
CoBorwTaxId
The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
CoBorwCrScoreArray_AType

CoBorwCrScoreArray_AType is an array AType element.

Contains:

  • CoBorwCrScoreRec_CType
CoBorwCrScoreRec_CType

CoBorwCrScoreRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CoBorwCrScoreId
Identifies the borrower's credit score.
CoBorwCrScoreModelCode
The code that identifies the name and version of a credit scoring model.
CoBorwCrScoreModelDesc
The description of the code that identifies the name and version of a credit scoring model.
CoBorwCrScoreModelVal
The credit score model name free form text value.
CoBorwEthnicArray_AType

CoBorwEthnicArray_AType is an array AType element.

Contains:

  • CoBorwEthnicRec_CType
CoBorwEthnicRec_CType

CoBorwEthnicRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CoBorwEthnicColType
Ethnicity of an individual collected through visual observation or surname.
CoBorwEthnicType
The ethnicity of an individual. Canonical values are:
  • Latino
  • OptOut
  • Oth
CoBorwEthnicVal
Individuals' Other Hispanic or Latino ethnicities free form text value.
PrioritySeq
The assignment of a priority sequence for an array of items.
CoBorwName

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

CoBorwName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This 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.
CoBorwPhoneArray

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.

CoBorwPhoneArray 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.
PhoneNum
The phone number.
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
PhoneTime
Best phone usage time, day, or evening.
PhoneType
Phone type examples are: home, work, fax, cell.
CoBorwRaceArray

CoBorwRaceArray is an array AType element. This is an array of race codes for a co-borrower.

CoBorwRaceArray references BorwRaceArray_AType.

Contains:

  • BorwRaceInfo_CType
BorwRaceInfo_CType

BorwRaceInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

BorwRaceCode
The code that references the borrower's race.
BorwRaceColType
Race collected through visual observation or surname. Canonical values are:
  • Visual
  • NonVisual
  • NA
BorwRaceDesc
The description of the code that references the borrower's race.
BorwRaceType
A description of the race that correlates with the race array.
BorwRaceVal
Race of borrower free form text value.
ResLnAppRgtrInfo_CType

ResLnAppRgtrInfo_CType is a complex CType element.

Contains:

  • AutoUndrwrtArray_AType
  • DenialRsnArray_AType
  • LnFeeArray_AType
  • LnTerm references Term_CType
  • OffInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

AnnPctRate
The annual percentage rate (APR).
AppDecDt
The date the application status or disposition was made.
AppDt
The date the application was accepted.
AppEffDt
The effective date of the application. The date can be a future or past date.
ApprDt
The last appraisal date of the account.
ApprVal
Used for bank informational purposes in tracking appraised value of collateral.
AppStatCode
The status or disposition of an application.
BallPmtType
Whether the mortgage applied for requires a balloon payment. Canonical values are:
  • True
  • False
BusCommType
If the mortgage applied for is primarily for a business or commercial purpose. Canonical values are:
  • false
  • true
City
The city name.
ClsCost
The costs associated with the closing of a loan.
CombLTV
The combined LTV ratio. This might include second mortgages.
CRACenTract
Census tract information for Community Reinvestment Act reporting.
CRACountyCode
County code for Community Reinvestment Act reporting.
CRADelinCode
The code that references the property's location within the delineated community in the lending association's CRA statement.
CrAppCode
The code that further defines the type of loan credit application.
CRASMSACode
Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
CurLnToValRatio
The current loan to value ratio.
DecOffc
The office/center where an application was processed.
EstClsDt
The estimated closing date of the loan.
FHLBPropCode
The code that references the type of property in accord with FHLB reporting requirements.
HMDANoRptRsn
The reason a loan applicant is not to be included in HMDA regulatory reporting.
HMDARpt
Does the loan qualify for HMDA reporting?
HOEPAStat
The status of the Home Ownership and Equity Protection Act loan.
InitialPayInstType
Identifies that initial payments are made to your institution. Canonical values are:
  • Inst - initially payable to your institution
  • NotInst - not initially payable to your institution
  • NA - not applicable
IntOnlyType
If the mortgage applied for requires interest only. Canonical values are:
  • True
  • False
IntRate
The interest rate.
LienStatCode
The code that references the status of the lien for a loan application.
LnAcctId
The numbers or characters that identify a loan account record.
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).
LnPurpCode
Bank-defined and is used to define the purpose of the loan.
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.
MHLandPropIntCode
The code that describes the manufactured home land property interest.
MHSecuredPropCode
The code that describes the manufactured home secured property.
MultiAffrdUnit
The number of units in the mortgaged property.
NegAmrtzType
If the mortgage applied for allows for negative amortization. Canonical values are:
  • True
  • False
NonFullAmrtzType
If the mortgage applied for has non-fully amortizing features. Canonical values are:
  • True
  • False
OccupCode
The code that references the occupancy of the property.
OpenEndLOCType
If the mortgage applied for is an open-end line of credit. Canonical values are:
  • True
  • False
PIAmt
The principal and interest payment amount.
PreApprvAppCode
The code that references the pre-approval process for a loan application.
PrePmtPenTerm
The integer length of the term.
ProceedAmt
The first advance amount for the new loan.
PropCode
The code that identifies the type of loan for compliance with Inter-agency Guidelines to Real Estate Lending Standards (www.fdic.gov/regulations/laws/rules/2000-8700.html).
PropEstVal
The estimated value of real estate property.
PropLegalInfo
The legal description of the property.
PropPostalCode
The ZIP code where the property is located.
PropPurchaseAmt
The purchase price of the property.
PropSMSALoc
The applicant's property is located within the lending institution's Metropolitan Statistical Area. Canonical values are:
  • false
  • true
PropState
The state where the property is located.
PurpCode
Bank-defined and is used to define the purpose of the loan.
RateLockInDt
Rate Lock In Date

If an interest rate is set after a lock-in agreement is executed between the lender and the borrower, then the date on which the agreement fixes the interest rate is the date the rate was set. If a rate is reset after a lock-in agreement is executed (for example, because the borrower exercises a float-down option or the agreement expires), then the relevant date is the date the rate is reset for the final time before closing. If no lock-in agreement is executed, then the relevant date is the date on which the institution sets the rate for the final time before closing.

RateSpread
The spread between the APR on the mortgage and the rate on Treasury securities.
RvrMtgType
If the mortgage applied for is a reverse mortgage. Canonical values are:
  • True
  • False
SbmAppType
Identifies how a loan application was submitted. Canonical values are:
  • Direct
  • NotDirect
  • NA
SecdMtgCode
The code that represents the type of secondary mortgage activity.
StreetAddr1
The street address.
TeaserRatePeriod
The integer length of the term.
TotDebtPct
The ratio of the total monthly housing expenses plus the total of other debts to the borrower's monthly income.
TotUnit
The number of units in the mortgaged property.
YrBuilt
The year the property was built.
AutoUndrwrtArray_AType

AutoUndrwrtArray_AType is an array AType element. This is an array of elements defining automated loan underwriting systems and the underwriting system result.

Contains:

  • AutoUndrwrtInfoRec_CType
AutoUndrwrtInfoRec_CType

AutoUndrwrtInfoRec_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.
AutoUndrwrtSysCode
The code that identifies the automated underwriting system used to obtain a decision.
AutoUndrwrtSysDesc
The description of the code that identifies the automated underwriting system used to obtain a decision.
AutoUndrwrtSysVal
Automated underwriting system name free form text value.
AutoUndrwrtRsltCode
The code that identifies the automated underwriting system result.
AutoUndrwrtRsltDesc
The description of the code that identifies the automated underwriting system result.
AutoUndrwrtRsltVal
Automated underwriting system result name free form text value.
DenialRsnArray_AType

DenialRsnArray_AType is an array AType element. This is an array of elements that convey the reason for a loan application denial.

Contains:

  • DenialRsnInfo_CType
DenialRsnInfo_CType

DenialRsnInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DenialRsnCode
The code that references the reason a loan application was not approved or denied.
DenialRsnDesc
The description of the code that references the reason a loan application was not approved or denied.
DenialRsnText
The description denial reason code that describes the proceeding elements in the array.
DenialRsnVal
The denial reason free form text value.
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.
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
LnFeeText
The text that describes the loan fee element that precedes it in the LnFeeArray.
LnTerm

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

This element references Term_CType.

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
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.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MoreRec
Indicates if there are more records that could be returned. Canonical values are:
  • false
  • true
SentRec
The number of records sent in the response.
TotRec
Indicates the total records the request selected, which could be larger than MaxRec.

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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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 Soap Header Fault 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 Mon Jan 24 2022