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

Collateral Tracking Add Validate

Enterprise SOAP API > API by Reference > Core Services > Collateral Tracking Add Validate

Collateral Tracking Add Validate

Collateral Tracking Add Validate is a jXchange service designed to validate the added items of collateral or associated collateral documentation without creating records in the database.

The addition of an item of collateral to a loan account is accomplished by supplying the information needed to populate the elements of the Collateral Item Record. The record is contained within the request message and is submitted along with the customer and/or account ID number. If documentation is to be added to an existing item of collateral, the documentation will be described within the Collateral Doc Array. The Array is submitted with the request message. The request will be submitted along with the Collateral Item Key, identifying the item of collateral that was obtained from the Collateral Tracking Search Request.

The Collateral Tracking Add Validate service is replicating the Addition service to validate that it works correctly, without creating a record of the addition.

Message Flow

In jXchange, the Collateral Tracking Add Validate service uses a typical exchange of MType messages to validate added items of collateral or associated collateral documentation to a Service Provider.

Primary Request

The Third Party Consumer forwards the CollatTrackAddValidateRq_MType message to the Service Provider. The message contains the CollatTrackAddRq_MType, which is replicated to validate the Addition service without the Service Provider creating records in the database.

Primary Response

The Service Provider returns the CollatTrackAddValidateRs_MType message to the Third Party Consumer once the request has been received and the Addition service has been validated. The message contains the RsStat element, which states if the addition was validated.

CollatTrackAddValidateRq_MType

CollatTrackAddValidateRq_MType is a message MType element. This message is optional.

Contains:

  • CollatTrackAddRq_MType
  • Custom_CType

CollatTrackAddRq_MType

CollatTrackAddRq_MType is a message MType element. This message is optional.

Contains:

  • AccountId_CType
  • CollatDocArray_AType
  • CollatItemRec_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

CollatItemKey
Returned in search and inquiry requests and is needed to modify or delete a collateral item.
CustId
The identifier attached to a customer.

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

CollatDocArray_AType

CollatDocArray_AType is an array AType element. This is an array of identification collateral items.

Contains:

  • CollatDocRec_CType

CollatItemRec_CType

CollatItemRec_CType is a complex CType element.

Contains:

  • CollatItemDescArray_AType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

BrCode
The branch code.
CollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
CollatCustRelCode
The code that describes the relationship a customer is to an account.
CollatItemDocDt
A date that references the collateral item.
CollatMatDt
The maturity date of the collateral item.
CollatOffCode
The code that designates the financial institution officer.
CollatOrigValAmt
The original value of the collateral item.
CollatOwnCustId
The identifier attached to a customer.
CollatPrvStat
The previous status of a collateral item.
CollatRecCode
The code that references the location the collateral item was recorded.
CollatRecDt
The recording date of the collateral item.
CollatRecId
The recorded identification assigned to the collateral item.
CollatRcptId
An identification of the receipt provided for the collateral item.
CollatRcptDt
The date a receipt was provided to the consumer for the collateral item.
CollatRegstCode
The code that references the registration of the collateral item.
CollatShareType
Answers the question: Can the collateral item be shared to other customers? Canonical values are:
  • false
  • true
CollatSrcValCode
The code that references the source used to obtain the value of the collateral item.
CollatStat
The status of a collateral item.
CollatStatDt
The date the status of the collateral item was entered or changed.
CollatToLnPct
The loan to collateral value represented as a percentage.
CollatToLnRelCode
The code that references the relationship the collateral is to the loan. For example, is the collateral the primary item?
CollatUnit
The number of units of the collateral item.
CollatValAmt
The current value of the collateral item.
CollatValDt
The date the current value of the collateral item was obtained.
CollatWavDt
The date the transfer of the collateral item was waived.
CusipBankId
A bank identification assigned to all stocks and registered bonds by the Committee on Uniform Security Identification Procedures.
CusipId
An identification assigned to all stocks and registered bonds by the Committee on Uniform Security Identification Procedures.
DocLocCode
The code that references the location of the collateral item.
PriceDt
The original date the collateral item was priced.
CollatItemDescArray_AType

CollatItemDescArray_AType is an array AType element. This is an array of collateral item descriptions.

Contains:

  • CollatItemDescInfo_CType
CollatItemDescInfo_CType

CollatItemDescInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CollatItemDetDesc
The text that represents the description of the collateral item.
CollatItemDetDescText
The text that represents the description of the collateral item.
CollatItemDesc
The description of the collateral item.
Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
CollatItemDescText
The text that represents the description of the collateral item.
Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType
ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

ErrCode
The Soap Header Fault error code.

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

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

CollatTrackAddValidateRs_MType

CollatTrackAddValidateRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

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