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

Multilevel Lending Relationship Search

Enterprise SOAP API > API by Reference > Core Services > Multilevel Lending Relationship Search

Multilevel Lending Relationship Search

Multilevel Lending Relationship Search is a jXchange service designed to allow consumers to search Multilevel Lending relationships.

Message Flow

In jXchange, the Multilevel Lending Relationship Search service uses a typical exchange of MType messages to allow consumers to search Multilevel Lending relationships.

Primary Request

The consumer forwards the MLLRelSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • CommitAcctId
  • CustId

The message contains the following complex elements:

  • AcctId references AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

The message contains the following array:

  • IncXtendElemArray_AType

Primary Response

The service provider returns the MLLRelSrchRs_MType message to the consumer. The message contains the following simple elements:

  • CommitAcctId
  • CustId

The message contains the following complex elements:

  • AcctId references AccountId_CType
  • Custom_CType
  • SrchMsgRHdr_CType

The message contains the following array:

  • CommitSrchRecArray_AType

Multilevel Lending Relationship Search Behavior

The Multilevel Lending Relationship Search service behavior is as follows.

The Multilevel Lending Relationship Search request (MLLRelSrchRq_MType) has a documented choice statement that allows for the Customer Id (CustId), the Commitment Account Id (CommitAcctId), or the master/tranche loan Account Id (AcctId). If you enter the CustId with any other elements, the CustId) is used.

The Multilevel Lending Relationship Search response (MLLRelSrchRs_MType) is based on which search request element was used. The service always responds with a commitment number, a master loan, and a tranche. The detail of the relationship, which is the commitment, the master, and the tranche, is based on the request.

Expectations for the Search response:

  • Request Customer Id (CustId) - All commitments, all masters, and all tranches
  • Request Commitment Account Id (CommitAcctId) - The commitment selected, all masters under the commitment, and all tranches for those masters
  • Request Master Account Number (AcctId) - The commitment tied to the master requested, the master requested, and all tranches under the master
  • Request Tranche Account Number (AcctId) - The commitment tied to the tranche requested, the master of the tranche requested, and the tranche that was requested

MLLRelSrchRq_MType

MLLRelSrchRq_MType is a message MType element.

Contains:

  • AcctId references AccountId_CType
  • Custom_CType
  • IncXtendElemArray_AType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CommitAcctId
The account identification that is charged for fees from line of credit services.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.

AcctId

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

AcctId references AccountId_CType.

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. This is an array that lists x_ elements by name, which are to be included in the response.

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

MLLRelSrchRs_MType

MLLRelSrchRs_MType is a message MType element.

Contains:

  • AcctId references AccountId_CType
  • Custom_CType
  • CommitSrchRecArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

CommitAcctId
The account identification that is charged for fees from line of credit services.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.

AcctId

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

AcctId references AccountId_CType.

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

CommitSrchRecArray_AType

CommitSrchRecArray_AType is an array AType element. This is an array of responses for Multilevel Lending (MLL) search for the commitment records.

Contains:

  • CommitSrchRec_CType

CommitSrchRec_CType

CommitSrchRec_CType is a complex CType element.

Simple Elements

Contains:

  • Custom_CType
  • MasterSrchRecArray_AType
  • PersonName_CType
  • SvcPrvdInfo references CommitSrchRec_EType

The following simple elements are contained within this complex.

CommitAcctId
The account identification that is charged for fees from line of credit services.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
LOCAmt
The amount of the credit line.
LOCAvlBal
The outstanding available balance of the line of credit.
LOCCode
The code that defines the type of line of credit.
LOCDesc
The description of the code that defines the type of line of credit.
LOCExpDt
The line of credit expiration date.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MasterSrchRecArray_AType

MasterSrchRecArray_AType is an array AType element. This is an array of responses for Multilevel Lending (MLL) search for the master loan records.

Contains:

  • MasterSrchRec_CType
MasterSrchRec_CType

MasterSrchRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • MasterAcctId references AccountId_CType
  • MasterLoanSrchRecArray_AType
  • PersonName_CType
  • SvcPrvdInfo references MasterSrchRec_EType
  • TrancheSrchRecArray_AType
Simple Elements

The following simple elements are contained within this complex.

CurBal
The current balance.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
LOCAcctId
The account identification that is charged for fees from line of credit services.
LOCAmt
The amount of the credit line.
LOCAvlBal
The outstanding available balance of the line of credit.
LOCExpDt
The line of credit expiration date.
MatDt
The maturity date.
MultiLvlLndType
Defines the multilevel lending type. Canonical values are:
  • Commit
  • Master
  • Tranche
PartIdNum
The participation identification number.
PrtcpCode
The code that references the participation position of the loan.
PrtcpDesc
The description of the code that references the participation position of the loan.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MasterAcctId

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

MasterAcctId references AccountId_CType.
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
MasterLoanSrchRecArray_AType

MasterLoanSrchRecArray_AType is an array AType element. This is an array of responses for Multi Level Lending (MLL) search for loan records.

Contains:

  • MasterLoanSrchRec_CType
MasterLoanSrchRec_CType

MasterLoanSrchRec_CType is a complex CType element.

Contains:

  • MasterLoanRmkArray references Rmk_AType
MasterLoanRmkArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

MasterLoanRmkArray references Rmk_AType.

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.
PersonName_CType

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

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

TrancheSrchRecArray_AType is an array AType element. This is an array of responses for Multilevel Lending (MLL) search for the tranche records.

Contains:

  • TrancheSrchRec_CType
TrancheSrchRec_CType

TrancheSrchRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • TrancheAcctId references AccountId_CType
  • PersonName_CType
  • SvcPrvdInfo references TrancheSrchRec_EType
  • TrancheRmkArray references Rmk_AType
Simple Elements

The following simple elements are contained within this complex.

CurBal
The current balance.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
LOCAcctId
The account identification that is charged for fees from line of credit services.
LOCAmt
The amount of the credit line.
LOCAvlBal
The outstanding available balance of the line of credit.
LOCCustId
The customer identification for lines of credit.
LOCExpDt
The line of credit expiration date.
MatDt
The maturity date.
MultiLvlLndType
Defines the multilevel lending type. Canonical values are:
  • Commit
  • Master
  • Tranche
PartIdNum
The participation identification number.
PrtcpCode
The code that references the participation position of the loan.
PrtcpDesc
The description of the code that references the participation position of the loan.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MasterAcctId

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

MasterAcctId references AccountId_CType.
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
PersonName_CType

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

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

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

TrancheAcctId references AccountId_CType.
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
TrancheRmkArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

TrancheRmkArray references Rmk_Atype.

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.
PersonName_CType

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

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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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
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 Tue Jan 24 2023