Customer Collateral Search
Customer Collateral Search
Customer Collateral Search 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 Customer Collateral
Search 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 CustCollatSrchRq_MType message to the
service provider. The message contains:
AccountId_CType- CustId
Custom_CTypeSrchMsgRqHdr_CType
Primary Response
The service provider forwards the CustCollatSrchRs_MType message to the
third-party consumer. The message contains:
AccountId_CTypeCustCollatDocSrchRecArray_ATypeCustCollatSrchRecArray_AType- CustId
Custom_CTypeSrchMsgRsHdr_CType
Customer Collateral Search Behavior
The CustCollatSrchRq_MType request message contains a documented choice
statement where the elements at the root are optional but at least one of the elements is
required. The CustId element and AccountId_CType
complex are available at the root request. The account identification is provided to obtain
the customer identification should it not be available by the consumer.
The objective of this message is to provide the consumer with a comprehensive view of:
- Collateral items and documents as related to a customer and other accounts.
- Customers as related to that collateral item.
This process requires two messages: CustCollatSrchRq and
CollatTrackItemInqRq. The Customer Collateral Search
(CustCollatSrchRq_MType) provides a lightweight response, which contains
collateral items related to the customer. The Collateral Track Item Inquiry
(CollatTrackItemInqRq_MType) provides the details of the collateral item
and the account and customer relationships related to that piece of collateral.
The Customer Collateral Search (CustCollatSrchRs_MType) response message
echoes the requested elements. The CustCollatSrchRecArray_AType should return
all the items related to the customer. The CustCollSrchRec_CType complex
includes the CollatItemRec_CType complex and the
CustCollatDocSrchRecArray_AType, which is an array of collateral documents
related to the collateral item. The Customer Collateral Document Search Record array
(CustCollatDocSrchRec_Array) at the root response only returns the
collateral item documents that are not related to any collateral item, but are related to a
customer.
The standard search message header tenets are applicable.
CustCollatSrchRq_MType
CustCollatSrchRq_MType is a message
MType element.
Contains:
AccountId_CTypeCustom_CTypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
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
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
CustCollatSrchRs_MType
CustCollatSrchRs_MType is a message
MType element.
Contains:
AccountId_CTypeCustCollatDocSrchRecArray_ATypeCustCollatSrchRecArray_ATypeCustom_CTypeSrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
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
CustCollatDocSrchRecArray_AType
CustCollatDocSrchRecArray_AType is an array
AType element. This is an array of collateral
documents.
Contains:
CustCollatDocSrchRec_CType
CustCollatDocSrchRec_CType
CustCollatDocSrchRec_CType is a complex
CType element.
Contains:
CollatDocRec_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatDocBrDesc
- A description of the branch name. It includes the
Rstrattribute. - CollatDocDesc
- A description of the code that references the type of collateral document.
- CollatDocInstDefKey
- The institution-defined field key.
- 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_ATypeCustom_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.
- CollatDocPrtRcpt
- Determines if the receipt letter or notice should be printed for the collateral document.
- CollatDocPrvStat
- The previous status of a collateral document.
- CollatDocRcptLtrId
- The ID of the letter sent when the collateral document was received.
- CollatDocRecvDt
- The date the collateral document was received.
- CollatDocStatDt
- The date the status of the collateral document was entered or changed.
- CollatDocStat
- The status of a collateral document.
- CollatDocWavDt
- The date the collateral document was waived.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
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.
CustCollatSrchRecArray_AType
CustCollatSrchRecArray_AType is an array
AType element. This is an array of responses of collateral
items and documents for a specific customer.
Contains:
CustCollatSrchRec_CType
CustCollatSrchRec_CType
CustCollatSrchRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- CollatDesc
- The collateral code description.
- 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.
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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.