Collateral Tracking Item Inquiry
Collateral Tracking Item Inquiry is a jXchange service designed to allow a consumer to gain a comprehensive view of the collateral items and document the varied account and customer relationships.
Message Flow
In jXchange, the Collateral
Tracking Item Inquiry service uses a typical exchange of
MType
messages to gain a comprehensive view of the
collateral items and document the varied account and customer
relationships.
Primary Request
The Third Party Consumer
forwards the CollatTrackItemInqRq_MType
message to the
Service Provider. The message contains:
CollatItemKey
Custom_CType
MsgRqHdr_CType
Primary Response
The Service Provider returns
the CollatTrackItemInqRs_MType
message to the Third Party
Consumer. The message contains:
CollatItemInqRec_CType
CollatItemKey
Custom_CType
MsgRsHdr_CType
Collateral Tracking Item Inquiry Behavior
The Collateral Tracking Item Inquiry
(CollatTrackItemInqRq
) request message requires a valid
CollatItemKey
element. This element may be obtained from
the Customer Collateral Search message (CustCollatSrch
)
or the Collateral Tracking Search message
(CollatTrackSrch
).
The Collateral Item Inquiry Record complex
(CollatItemInqRec_CType
) should return the collateral
item related to the CollatItemKey
element. The Collateral
Item Inquiry Record complex (CollatItemInqRec_CType
)
includes the collateral items details
(CollatItemRec_CType
), the
CustCollatDocSrchRecArray_AType
, which is an array of
collateral documents related to the collateral item, the
AcctCollatRecArray_AType
, which is an array of account
identifications related to the collateral item, and the
CollatDocItemRecArray_AType
, which is an array of
customer identification related to the collateral item.
CollatTrackItemInqRq_MType
CollatTrackItemInqRq_MType
is a message
MType
element.
Contains:
Custom_CType
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.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-Security
.
CollatTrackItemInqRs_MType
CollatTrackItemInqRs_MType
is a message
MType
element.
Contains:
CollatItemInqRec_CType
Custom_CType
MsgRsHdr_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.
CollatItemInqRec_CType
CollatItemInqRec_CType
is a complex
CType
element.
Contains:
AcctCollatRecArray_AType
CollatDocItemRecArray_AType
CollatItemRec_CType
CustIdCollatRecArray_AType
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- BrDesc
- A description of the branch name. It includes the
Rstr
attribute. - CollatCustRelDesc
- The description of the code that describes the relationship a customer has to an account.
- CollatDesc
- The collateral code description.
- CollatOffDesc
- The officer short name.
- CollatPrvStatDesc
- The description of the previous status of a collateral item.
- CollatRecDesc
- The description of the code that references the location the collateral item was recorded.
- CollatRegstDesc
- The description of the code that references the registration of the collateral item.
- CollatSrcValDesc
- The description of the code that references the source used to obtain the value of the collateral item.
- CollatStatDesc
- The description of the status of a collateral item.
- CollatToLnRelDesc
- The description of the code that references the relationship the collateral is to the loan. For example, is the collateral the primary item?
- DocLocDesc
- The description of the code that references the location of the collateral item.
AcctCollatRecArray_AType
AcctCollatRecArray_AType
is an array
AType
element. This an array of accounts related to a
collateral item.
Contains:
AcctCollatItemRec_CType
AcctCollatItemRec_CType
AcctCollatItemRec_CType
is a complex
CType
element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AcctRelDesc
- The description of the code that describes the relationship a customer has to an account.
- AcctType
- The number or character that categorizes the AcctId.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
CollatDocItemRecArray_AType
CollatDocItemRecArray_AType
is an array
AType
element. This is an array of collateral
documents.
Contains:
CollatDocItemRec_CType
CollatDocItemRec_CType
CollatDocItemRec_CType
is a complex
CType
element.
Contains:
CollatDocRec_CType
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatDocBrDesc
- A description of the branch name. It includes the
Rstr
attribute. - CollatDocDesc
- A description of the code that references the type of collateral document.
- CollatDocKey
- Returned in search and inquiry requests and is needed to modify or delete a collateral document.
- CollatDocLocDesc
- A description of the code that references the filed location of the collateral document.
- CollatDocOffDesc
- The officer short name.
- CollatDocPrvStatDesc
- The description of the previous status of a collateral document.
- CollatDocStatDesc
- The description of the status of a collateral document.
CollatDocRec_CType
CollatDocRec_CType
is a complex
CType
element.
Contains:
CollatDocInfoArray_AType
Custom_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.
- CollatDocBrCode
- The branch code.
- CollatDocCode
- A code that references the type of collateral document.
- CollatDocDt
- A date that references the collateral document.
- CollatDocExcDay
- The number of days the collateral document should delay before being considered an exception.
- CollatDocExcDt
- The date an exception letter was sent for the collateral item.
- CollatDocExcLtrId
- The ID of the exception letter sent for collateral document.
- CollatDocExcLtrNoSent
- The number of exception letters sent for collateral document.
- CollatDocExpDt
- The expiration date of the collateral document.
- CollatDocLocCode
- A code that references the filed location of the collateral document.
- CollatDocOffCode
- The code that designates the financial institution officer.
- CollatDocPrvStat
- The previous status of a collateral document.
- CollatDocPrtRcpt
- Determines if the receipt letter or notice should be printed for the collateral document.
- CollatDocRcptLtrId
- The ID of the letter sent when the collateral document was received.
- CollatDocRecvDt
- The date the collateral document was received.
- CollatDocStat
- The status of a collateral document.
- CollatDocStatDt
- The date the status of the collateral document was entered or changed.
- CollatDocWavDt
- The date the collateral document was waived.
- CustId
- The identifier attached to a customer.
CollatDocInfoArray_AType
CollatDocInfoArray_AType
is an
array AType
element. This is an array of the collateral
documentation free form descriptions.
Contains:
CollatDocInfoRec_CType
CollatDocInfoRec_CType
CollatDocInfoRec_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- CollatDocDetInfo
- A free form description/information about the collateral document.
- CollatDocDetInfoText
- The text that represents the free form description/information about the collateral document.
- CollatDocInfo
- A free form description/information about the collateral
document.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- CollatDocInfoText
- The text that represents the free form description/information
about the collateral document.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.
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.
CustIdCollatRecArray_AType
CustIdCollatRecArray_AType
is an array
AType
element. This is an array of customers related to a
collateral item.
Contains:
CustIdCollatItemRec_CType
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.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-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.