Check Image Document Search
Check Image Document Search
Check Image Document Search is a jXchange service designed to allow consumers to search for statements, notices, and other documents housed in a check image provider's system.
Message Flow
In jXchange, the Check Image Document Search
service uses a typical exchange of MType messages to allow a consumer to search and retrieve statements, notices,
and other documents housed in a check image provider's system.
Primary Request
The consumer forwards the ChkImgDocSrchRq_MType message to
the service provider.
The message contains the following simple elements:
- DocDlvryMthd
- DocItemType
- DocType
- EndDt
- StartDt
The message contains the following complex elements:
Custom_CTypeSrchMsgRqHdr_CType
Primary Response
The service provider returns the ChkImgDocSrchRs_MType
message to the consumer.
The message contains the following simple elements:
- CustId
- DocDlvryMthd
- DocItemType
- DocType
- EndDt
- StartDt
The message contains the following complex elements:
AccountId_CTypeCustom_CTypeSrchMsgRsHdr_CType
The message contains the following array:
ChkImgDocSrchArray_AType
Check Image Document Search Behavior
The Check Image Document Search service behavior is as follows.
The Check Image Document Search service returns all statement, notice, or document
identifications for an AccountId or a CustId.
The ChkImgDocSrchRq_MType request message provides the following filters on
the request:
AccountId- CustId
- DocItemType (Stmt, Not)
- DocType
- DocDlvryMthd (eDoc, PrtDoc, CDDoc, All)
- EndDt
- StartDt
CustId and AccountId are documented choice elements,
which means only one is required. If both are provided by the consumer, then the
AccountId is used first. When there is more than one filter on the request,
then the selection is based on and rather than
or. A consumer request with a StartDt, without
an end date EndDt returns all the qualified statements with a date
equal to and greater than the start date. A consumer request with an
EndDt, without a StartDt, returns all the
qualified statements with a date equal to and less than the end date. A consumer request
without a StartDt or an EndDt returns all the
qualified statements for the keys requested. The service providers date value being used for
the DocDt is used for the statement date range comparisons. The
standard search message header tenets are applicable.
The elements in the ChkImgDocSrchRq_MType request message are echoed back in
the ChkImgDocSrchRs_MType response message, regardless if those same elements
exist in the repeating complex.
Consumers might use the page and enclosure count to help estimate the size of the statement, notice, or document.
ChkImgDocSrchRq_MType
ChkImgDocSrchRq_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.
- DocDlvryMthd
- The method of final delivery for account statements or documents.
Canonical values are:
- All
- CDDoc
- eDoc
- PrtDoc
- DocItemType
- DocItemType is a high-level definition of a
document's category. Canonical values are:
- Stmt
- Not
DocItemType is a hybrid open enumeration.
- DocType
- The type of a document.
- EndDt
- The date that designates the ending point for date selections.
- StartDt
- The date that designates the starting point for date selections.
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.
ChkImgDocSrchRs_MType
ChkImgDocSrchRs_MType
is a message MType element.
Contains:
AccountId_CTypeChkImgSrchArray_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.
- DocDlvryMthd
- The method of final delivery for account statements or documents.
Canonical values are:
- All
- CDDoc
- eDoc
- PrtDoc
- DocItemType
- DocItemType is a high-level definition of a
document's category. Canonical values are:
- Stmt
- Not
DocItemType is a hybrid open enumeration.
- DocType
- The type of a document.
- EndDt
- The date that designates the ending point for date selections.
- StartDt
- The date that designates the starting point for date selections.
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
ChkImgDocSrchArray_AType
ChkImgDocSrchArray_AType is an array AType element. This is an array of
responses for a statement or other document search.
Contains:
ChkImgDocSrchInfo_CType
ChkImgDocSrchInfo_CType
ChkImgDocSrchInfo_CType is a complex CType element.
Contains:
AccountId_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- DocDt
- The document date.
- DocEnclCnt
- The count of enclosures within a statement or document.
- DocId
- Document name, number, or other identifying value.
- DocItemType
- DocItemType is a high-level definition of a
document's category. Canonical values are:
- Stmt
- Not
DocItemType is a hybrid open enumeration.
- DocPgCnt
- The count of pages contained in a PDF.
- DocType
- The type of a document.
- ElecDocCode
- The code that identifies the type of electronic document.
- ElecDocDesc
- The description of the code that identifies the type of electronic document.
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.
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.