Collateral Tracking Add
Collateral Tracking Add
Collateral Tracking Add is a jXchange service designed to add items of collateral or associated collateral documentation in association with a loan or consumer.
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 is described within the collateral doc array. The array is submitted with the request message. The request is submitted along with the collateral item key, identifying the item of collateral that was obtained from the collateral tracking search request.
If a request has been made for an item of collateral to be added to a loan, the response message states if the requested addition was successful. The response message contains a key to identify the item of collateral in the event the collateral item requires deletion or modification, or if an item of documentation needs to be added to the item of collateral.
If the request was to add an item of documentation to an item of collateral, the response also signifies whether the requested addition was successful.
Message Flow
In jXchange, the Collateral Tracking Add service uses a typical exchange of
MType messages to add items of collateral or associated collateral
documentation in association with a loan or consumer to a service provider.
Primary Request
The third-party consumer forwards the CollatTrackAddRq_MType message to the
service provider. The message contains the person's name, account ID number, customer ID
number, collateral item key, if created, and details of the collateral to be listed and the
associated documentation. Multiple CollatDocRec elements can be
submitted for listing of multiple documents within the CollatDocArray. Only
one collateral item can be listed per request message.
Primary Response
The service provider returns the CollatTrackAddRs_MType message to the
third-party consumer once the initial request has been received and the collateral item and
its documentation have been listed. The message contains keys for the documentation and the
item and the RsStat element, which states if the requested addition
was successful.
CollatTrackAddRq_MType
CollatTrackAddRq_MType is a message
MType element. This message is optional.
Contains:
AccountId_CTypeCollatDocArray_ATypeCollatItemRec_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CollatItemKey
- Returned in search and inquiry requests and is needed to modify or delete a collateral item.
- 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
CollatDocArray_AType
CollatDocArray_AType is an array
AType element. This is an
array of identification collateral items.
Contains:
CollatDocRec_CType
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.
CollatItemRec_CType
CollatItemRec_CType is a complex
CType element.
Contains:
CollatItemDescArray_ATypeCustom_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.
- CollatRcptDt
- The date a receipt was provided to the consumer for the collateral item.
- CollatRcptId
- An identification of the receipt provided for the 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.
- 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.
- CollatStatDt
- The date the status of the collateral item was entered or changed.
- CollatStat
- The status of a collateral item.
- 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.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request 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.
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.
CollatTrackAddRs_MType
CollatTrackAddRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CollatItemKey
- Returned in search and inquiry requests and is needed to modify or delete a collateral item.
- 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_CTypeMsgRecInfoArray_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_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.