Credit Bureau Information Inquiry
Credit Bureau Information Inquiry
Credit Bureau Information Inquiry is a jXchange service designed to inquire about the credit bureau information on a loan.
Message Flow
In jXchange, the Credit Bureau Information Inquiry service uses a typical exchange of
MType messages to inquire about credit bureau information on a loan to a
service provider.
Primary Request
The third-party consumer forwards the CrBurInfoInqRq_MType message to the
service provider. The message contains AccountId_CType.
Primary Response
The service provider returns the CrBurInfoInqRs_MType message to the third-party
consumer. The message contains CrBurInfoInqRec_CType.
CrBurInfoInq Behavior
The account identification is required for the Credit Bureau Information Inquiry service.
The customer identification is optional.
The request made without the customer identification could return multiple credit bureau information due to direct and indirect account relationships.
The complexes used for the addition service are reused for the inquiry service. The inquiry response includes the description elements that correlate along with the code elements.
The response includes the account identification, customer identification, and customer name as related to the customer identification.
CrBurInfoInqRq_MType
CrBurInfoInqRq_MType is a message
MType element.
Contains:
AccountId_CTypeCustom_CTypeIncXtendElemArray_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
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.
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.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
CrBurInfoInqRs_MType
CrBurInfoInqRs_MType is a message
MType element.
Contains:
CrBurInfoInqArray_ATypeCustom_CTypeMsgRsHdr_CType
Simple Dictionary
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
CrBurInfoInqArray_AType
CrBurInfoInqArray_AType is an array
AType element. This is an array of elements for a credit
bureau information that is returned in the inquiry service.
Contains:
CrBurInfoInqRec_CType
CrBurInfoInqRec_CType
CrBurInfoInqRec_CType is a complex
CType element.
Contains:
AccountId_CTypeCrBurInfo_CTypeCustNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BnkRptcyFileDesc
- The description of the code that describes the type of filing for a bankruptcy claim.
- CrBurAcctClsfDesc
- The description of the code that identifies the account classification.
- CrBurActnDesc
- The description of the code indicating the action that should be taken for an upload account to the credit bureau.
- CrBurAddrRptDesc
- The description of the code that describes the borrower's primary or business address.
- CrBurCplDesc
- The description of the code that allows the reporting of compliance condition that is required for legal compliance with the FCRA and FCBA (Fair Credit Billing Act).
- CrBurFileMainDesc
- The description of the code that designates the type of file maintenance that is being reported to the credit bureau.
- CrBurOccupDesc
- The description of the code that references the occupancy of the property.
- CrBurPmtRateDesc
- The description of the credit bureau payment rate code.
- CrBurPrtcpDesc
- The description of the code that references the participation position of the loan.
- CrBurSpecCmntDesc
- The description of the code that references special information about the consumer classification for the account being reported to the credit bureau.
- CrBurStatDesc
- The description of the status code that properly identifies the current condition of the credit bureau account.
- CrBurTranDesc
- The description of the code that describes the type of credit bureau activity to report to an agency.
- CrClsfDesc
- The description of the code indicating a general type of business for the creditor.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- ECOADesc
- The description of the ECOA code that describes the borrower's relationship to the trade line. ECOA codes identify a trade as belonging to an individual, joint, co-signer, etc.
- OvrrdCrBurStatDesc
- The description of the status code that properly identifies the current condition of the credit bureau account.
- PmtExcpDesc
- The description of the code that designates the payment exception rule.
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
CrBurInfo_CType
CrBurInfo_CType is a complex CType element.
Contains:
DebtorAddrreferencesAddr_CTypeDebtorNamereferencesPersonName_CTypeEmplAddrreferencesAddr_CTypeHouseHoldDebtorArray_ATypeNonHouseHoldDebtorArray_ATypePmtHistArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BilDueDt
- The due date for a specific bill.
- BnkRptcyFileCode
- The code that describes the type of filing for a bankruptcy claim.
- ChgdOffAmt
- The amount charged off.
- ClsDt
- The closing date.
- CntryType
- The country abbreviation from ISO 3166.
- CrBurAcctClsfCode
- Identifies the account classification.
- CrBurActnCode
- The code indicating the action that should be taken for an upload account to the credit bureau.
- CrBurAddrRptCode
- The code that describes the borrower's primary or business address.
- CrBurCorrType
- The credit bureau correction type. Canonical values are:
- false
- true
- CrBurCplCode
- The code that allows the reporting of the compliance condition that is required for legal compliance with the FCRA and FCBA (Fair Credit Billing Act).
- CrBurCycleId
- An identification given to cycles for credit bureau reporting.
- CrBurFileMainCode
- The code that designates the type of file maintenance that is being reported to the credit bureau.
- CrBurId
- The credit bureau identification provided by credit bureau agencies.
- CrBurLnType
- The credit bureau loan type. Canonical values are:
- Install
- LOC
- Mtg
- OpenEnd
- Revol
- CrBurOccupCode
- The code that references the occupancy of the property.
- CrBurPmtRateCode
- The credit bureau payment rate code.
- CrBurPrtcpCode
- The code that references the participation position of the loan.
- CrBurRptTimeDt
- The credit bureau time date stamp.
- CrBurSpecCmntCode
- The code that references special information about the consumer classification for the account being reported to the credit bureau.
- CrBurStatCode
- The status code that properly identifies the current condition of the credit bureau account.
- CrBurTermFreqType
- The frequency of payments for credit bureau reporting. Canonical
values are:
- LOC
- OpenEnd
- Revol
- CrBurTermType
The frequency for a recurring payment. Canonical values are:
- Annual
- Every3Months
- Every6Months
- Every4Weeks
- EveryOtherMonth
- EveryOtherWeek
- Monthly
- Once
- TwiceMonthly
- Weekly
- CrBurTranCode
- The code that describes the type of credit bureau activity to report to an agency.
- CrClsfCode
- The code indicating a general type of business for the creditor.
- CurBal
- The current balance.
- DebtorBirthDt
- The date of birth.
- DebtorPhoneNum
- The phone number.
- DebtorTaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - DefPmtStartDt
- The date that the first deferred loan payment starts.
- DefRptType
- Answers whether this loan should be reported as deferred. Canonical
values are:
- True
- False
- DlqDt
- The date a loan became delinquent.
- ECOACode
- The ECOA code describes the borrower's relationship to the trade line. ECOA codes identify a trade as belonging to an individual, joint, co-signer, etc.
- EmplName
- The employer name.
- LastPmtDt
- The last payment date.
- LiabInstName
- The name of the institution that is obligated the funds owed for an individual.
- MERSId
- The identification that is used for the Mortgage Electronic Registration System (MERS).
- NameSuffix
- The name suffix. For examples, Jr. or MD.
- NonCrBurRptRsn
- The reason an account was not reported to the credit bureau.
- OccType
- The occupation description of the customer. Retail or bus.
- ODHighBal
- The highest overdraft balance amount.
- ODLmt
- The overdraft limit.
- OpenDt
- The date opened.
- OrigAcctId
- The original numbers or characters that identify an account record.
- OrigCrBurId
- The credit bureau identification provided by credit bureau agencies.
- OvrrdCrBurStatCode
- The status code that properly identifies the current condition of the credit bureau account.
- PastDueAmt
- The past due amount.
- PmtAmt
- The payment amount.
- PmtAmtTot
- The total of a loan's payments.
- PmtExcpCode
- The code that designates the payment exception rule.
- PmtExcpDueDt
- The date established for a scheduled payment.
- PmtExcpStartDt
- The date established for a scheduled payment.
- PrtcpAcctId
- The account ID of the master loan linked to the referenced loan.
- PrtcpCompName
- The name of the company or creditor that a loan was participated or purchased by.
- SecdMktAgencyType
- The secondary marketing agency that has interest in the loan.
Canonical values are:
- FannieMae
- FreddieMac
- Oth
DebtorAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
DebtorAddr
references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
DebtorName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
DebtorName
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.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
HouseHoldDebtorArray_AType
HouseHoldDebtorArray_AType is an array
AType element.
Contains:
HouseHoldDebtorInfo_CType
HouseHoldDebtorInfo_CType
HouseHoldDebtorInfo_CType is a complex
CType element.
Contains:
DebtorNamereferencesPersonName_CType
Simple Dictionary
- DebtorBirthDt
- The date of birth.
- DebtorTaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - ECOACode
- The ECOA code describes the borrower's relationship to the trade line. ECOA codes identify a trade as belonging to an individual, joint, co-signer, etc.
- BnkRptcyFileCode
- The code that describes the type of filing for a bankruptcy claim.
- CrBurTranCode
- The code that describes the type of credit bureau activity to report to an agency.
- CrBurTranDesc
- The description of the code that describes the type of credit bureau activity to report to an agency.
DebtorName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
DebtorName
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.
NonHouseHoldDebtorArray_AType
NonHouseHoldDebtorArray_AType is an
array AType element.
Contains:
NonHouseHoldDebtorInfo_CType
NonHouseHoldDebtorInfo_CType
NonHouseHoldDebtorInfo_CType is a
complex CType element.
Contains:
DebtorAddrreferencesAddr_CTypeDebtorNamereferencesPersonName_CType
Simple Dictionary
- BnkRptcyFileCode
- The code that describes the type of filing for a bankruptcy claim.
- CrBurAddrRptCode
- The code that describes the borrower's primary or business address.
- CrBurAddrRptDesc
- The description of the code that describes the borrower's primary or business address.
- CrBurOccupCode
- The code that references the occupancy of the property.
- CrBurOccupDesc
- The description of the code that references the occupancy of the property.
- CrBurTranCode
- The code that describes the type of credit bureau activity to report to an agency.
- CrBurTranDesc
- The description of the code that describes the type of credit bureau activity to report to an agency.
- DebtorBirthDt
- The date of birth.
- DebtorPhoneNum
- The phone number.
- DebtorTaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - ECOACode
- The ECOA code describes the borrower's relationship to the trade line. ECOA codes identify a trade as belonging to an individual, joint, co-signer, etc.
DebtorAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
DebtorAddr
references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
DebtorName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
DebtorName
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.
PmtHistArray_AType
PmtHistArray_AType
is an array AType element.
Contains:
PmtHistInfo_CType
PmtHistInfo_CType
PmtHistInfo_CType is
a complex CType element.
Simple Dictionary
- CalMonth
- The calendar month. Canonical values are:
- Jan
- Feb
- Mar
- Apr
- May
- June
- July
- Aug
- Sep
- Oct
- Nov
- Dec
- CalYr
- The year for the calendar period.
- PmtHistActType
- The type of payment history activity for a loan. Canonical values
are:
- ChgdOff
- Coll
- Cur
- ForeClosure
- NoPmt
- NoPmtAvl
- PastDue30to59
- PastDue60to89
- PastDue90to119
- PastDue120to149
- PastDue150to179
- PastDueGE180
- Repos
- VolSurr
- ZeroBal
CustName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CustName 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.
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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.