Loan Application Register Addition Validation

Enterprise SOAP API > API by Reference > Core Services > Loan Application Register Addition Validation

Loan Application Register Addition Validation is designed to allow the consumer to validate the addition of entries into the loan application register.

Message Flow

Loan Application Register Addition Validation involves the exchange of messages containing XML complex data of type MType between the Third Party Consumer and the Service Provider.

Primary Request

The Third Party Consumer sends the message LnAppRgtrAddValidateRq_MType containing the required element LnAppRgtrAddRq_MType. The request can also contain the optional element Custom_CType.

Primary Response

The Service Provider returns LnAppRgtrAddValidateRs_MType containing the required element MsgRsHdr_CType. The response can also contain the optional elements Custom_CType and RsStat.

Loan Application Register Addition Validation Business Case

The consumer is attempting to validate a loan application register addition in this business case.

The consumer sends the LnAppRgtrAddValidateRq_MType message with the following values:

Complex Element	Simple Element	Entry Value
`LnAppRgtrAddRq`	`LnAppId`	`99235467`
`LnAppBorwInfo`	`BorwAge`	`52`
	`BorwEhnicType`	`Other`
	`BorwGender`	`Male`
	`BorwIncmAmt`	`50000`
	`BorwMaritalStatType`	`Married`

The Service Provider returns LnAppRgtrAddValidateRs_MType containing the element RsStat with a value of Success.

LnAppRgtrAddValidateRq_MType

LnAppRgtrAddValidateRq_MType is a message MType element.

Contains:

Custom_CType
LnAppRgtrAddRq_MType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnAppRgtrAddValidateRs_MType

LnAppRgtrAddValidateRs_MType is a message MType element.

Contains:

Custom_CType
MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

RsStat

The status of the response. Canonical values are:

Fail
Success

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

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

Contains:

jXchangeHdr_CType
MsgRecInfoArray_AType

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId

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

AuditWsId

The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.

AuthenUsrId

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

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

BusCorrelId

The correlation identification as related to business functions and activities.

ConsumerName

The name of the service consumer (business name) for the Soap Header Fault.

ConsumerProd

The name of the product which is consuming the service (business product name) for the Soap Header Fault.

InstEnv

An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:

Prod

InstRtId

The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId

An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.

JxVer

Contains the version jXchange is running for the Soap Header Fault.

ValidConsmName

The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.

ValidConsmProd

The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.

WorkflowCorrelId

The correlation identification as related to workflow functions and activities.

jXchangeHdr_CType Deprecation Details

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