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 Participation Inquiry

Enterprise SOAP API > API by Reference > Core Services > Loan Participation Inquiry

Loan Participation Inquiry

Loan Participation Inquiry is a jXchange service designed to provide a consumer with the ability to inquire on the institutions participated for a specific loan.

Message Flow

In jXchange, the Loan Participation Inquiry service uses a typical exchange of MType messages to provide consumers with the ability to inquire on institutions who participated for a specific loan.

Primary Request

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

The message contains the following complex elements:

  • Custom_CType
  • InAcctId references AccountId_CType
  • MsgRqHdr_CType

The message contains the following array:

  • IncXtendElemArray_AType

Primary Response

The service provider returns the LnPrtcpInqRs_MType message to the third-party consumer. The message contains multiple occurrences of the match account identification of the institutions that participated with the loan.

The message contains the following complex elements:

  • Custom_CType
  • InAcctId references AccountId_CType
  • MsgRsHdr_CType

The message contains the following array:

  • LnPrtcpInqRecArray_AType

Loan Participation Inquiry Behavior

The InAcctId complex is required for this inquiry service.

The LnPrtcpInqRs_MType response message returns multiple occurrences of the match account identification of the institutions that participated with the loan.

The LnPrtcpInqRecArray_AType array includes the following arrays:

  • Investor Phone Array – The phone numbers that are assigned to the participated institution.
  • Investor Email Array – The email addresses that are assigned to the participated institution.
  • Investor Contact Array – The contacts assigned to a participated institution. The investor contact type may serve as the key for the array.

LnPrtcpInqRq_MType

LnPrtcpInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • IncXtendElemArray_AType
  • MsgRqHdr_CType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

InAcctId

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

InAcctId 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

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_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

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

AuthenUsrCred_CType

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

Simple Elements

The following simple elements are contained within this complex.

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

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

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

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

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

The element is required in all message requests.

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

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

LnPrtcpInqRs_MType

LnPrtcpInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • LnPrtcpInqRecArray_AType
  • MsgRsHdr_CType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

InAcctId

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

InAcctId 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

LnPrtcpInqRecArray_AType

LnPrtcpInqRecArray_AType is an array AType element. This is an array of responses for the loan participation inquiry.

Contains:

  • LnPrtcpInqRec_CType

LnPrtcpInqRec_CType

LnPrtcpInqRec_CType is a complex CType element.

Contains:

  • InvAddr references Addr_CType
  • InvContactArray_AType
  • InvEmailArray references EmailArray_AType
  • InvPhoneArray references PhoneArray_AType
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.
AflCrtCustIdType
Answers the question: Should the affiliate financial institution automatically create a customer identification? Canonical values are:
  • false
  • true
AflCrtLnIdType
Answers the question: Should the affiliate financial institution automatically create a loan identification? Canonical values are:
  • false
  • true
AflCustId
The identifier attached to a customer.
AflDftBrCode
The branch code.
AflDftBrDesc
A description of the branch name. It includes the Rstr attribute.
AflDftDataId
The default data/cache named identifier for an affiliated loan.
AflDftOffCode
The code that designates the financial institution officer.
AflDftOffDesc
The officer short name.
AflDftPrtcpId
The default participation identifier for an affiliated loan.
AflFinInstId
An identifier of the participated financial institution for an affiliated loan.
AflInterfaceBrCode
The branch code.
AflInterfaceBrDesc
A description of the branch name. It includes the Rstr attribute.
AflInterfaceGLCostCtr
The GL cost center provided for bank use in reporting the account to a specific GL cost center.
AflInterfaceProdCode
The code that identifies a product type of account within an application.
AflInterfaceProdDesc
Description of the type of account.
CurBal
The current balance.
IntRate
The interest rate.
InvContactName
The main contact for an institution participating in the purchase of a sold loan.
InvInstRtId
The identification of the institution invested in a sold loan. A financial institution entity uses the routing transit or ABA 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 uses a mutually agreed upon identification that must contain at least one non-integer character.
InvMailReciptId
An identifier given to the mail recipient for all mail related to the serviced loan.
NxtPayDt
The next payment date.
PartIdNum
The participation identification number.
PrtcpAutoAdvType
Answers the question: Should the sold loan advance be automatically advanced to the participation loan? Canonical values are:
  • false
  • true
PrtcpAutoInterfaceType
The type of participation loan activity that is automatically interfaced. Canonical values are:
  • Bought
  • BoughtSold
  • None
  • Sold
PrtcpBrCode
The branch code.
PrtcpCorrelId
An identification provided by the consumer that correlates a group of log messages.
PrtcpInterfaceAcctId
The number or character that identifies an account record.
PrtcpInterfaceAcctType
The number or character that categorizes the AcctId.
PrtcpInvName
The name of the institution participating in the purchase of a sold loan.
PrtcpPct
The percentage of the loan an institution owns of a sold loan.
PrtcpRemitType
Answers the question: What is the method of remittance to the participated institutions? Canonical values are:
  • ACH
  • Chk
  • Dep
PrtcpTaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
InvAddr

Addr_CType is a complex CType element containing address information. This element is optional.

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

InvContactArray_AType is an array AType element. This is an array of contacts for serviced loans.

Contains:

  • InvContactRec_CType
InvContactRec_CType

InvContactRec_CType is a complex CType element.

Contains:

  • Addr_CType
  • EmailArray_AType
  • PersonName_CType
  • PhoneArray_AType
Simple Elements

The following simple elements are contained within this complex.

InvContactType
The contact type for a service loan that serves as a key for an investor contact array.
Addr_CType

Addr_CType is a complex CType element containing address information. This element is optional.

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

EmailArray_AType is an array AType element. This is an array used to define email contact information.

Contains:

  • EmailInfo_CType
EmailInfo_CType

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

Simple Elements

The following simple elements are contained within this complex.

EmailAddr
Email address.
EmailType
Email type. Examples: Home, Work, Statement, Notice. Canonical values are:
  • Prim
  • Secd
  • OLB

EmailType is a hybrid open enumeration.

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

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.

Contains:

  • PhoneInfo_CType
PhoneInfo_CType

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

Contains:
  • MobPhoneInfo_CType
Simple Elements

The following simple elements are contained within this complex.

ConEndTime
The Greenwich Mean time when contact availability ends.
ConStartTime
The Greenwich Mean time when contact availability starts.
PhoneExt
The phone extension.
PhoneNumDsp
Phone Number Display, based on format codes which may include special formatting. Examples include:
  • (XXX)XXX-XXXX
  • XXX-XXX-XXXX
  • XXX/XXX/XXXX
  • XXX.XXX.XXXX
  • XXX-XXX-XXXXXX
  • XXXXX-XXX-XXX-XXXX
PhoneNum
The phone number.
PhoneTime
Best phone usage time, day, or evening.
PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
  • Home
  • SecdHome
  • Bus
  • SecdBus
  • HomeCell
  • BusCell
  • PersonalCell
  • HomeFax
  • BusFax
  • SecdBusCell

PhoneType is a hybrid open enumeration.

InvEmailArray

EmailArray_AType is an array AType element. This is an array used to define email contact information.

InvEmailArray references EmailArray_AType.

Contains:

  • EmailInfo_CType
EmailInfo_CType

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

Simple Elements

The following simple elements are contained within this complex.

EmailAddr
Email address.
EmailType
Email type. Examples: Home, Work, Statement, Notice. Canonical values are:
  • Prim
  • Secd
  • OLB

EmailType is a hybrid open enumeration.

InvPhoneArray

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.

InvPhoneArray references PhoneArray_AType.

Contains:

  • PhoneInfo_CType
PhoneInfo_CType

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

Contains:
  • MobPhoneInfo_CType
Simple Elements

The following simple elements are contained within this complex.

ConEndTime
The Greenwich Mean time when contact availability ends.
ConStartTime
The Greenwich Mean time when contact availability starts.
PhoneExt
The phone extension.
PhoneNumDsp
Phone Number Display, based on format codes which may include special formatting. Examples include:
  • (XXX)XXX-XXXX
  • XXX-XXX-XXXX
  • XXX/XXX/XXXX
  • XXX.XXX.XXXX
  • XXX-XXX-XXXXXX
  • XXXXX-XXX-XXX-XXXX
PhoneNum
The phone number.
PhoneTime
Best phone usage time, day, or evening.
PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
  • Home
  • SecdHome
  • Bus
  • SecdBus
  • HomeCell
  • BusCell
  • PersonalCell
  • HomeFax
  • BusFax
  • SecdBusCell

PhoneType is a hybrid open enumeration.

MsgRsHdr_CType

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

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

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

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

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

The element is required in all message requests.

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

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

MsgRecInfoArray_AType

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

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022