Check Image Inquiry
Both complex and simple elements are used to create check image inquiry requests and responses. Check Image Inquiry is a jXchange service designed to create check image inquiry requests and responses.
Message Flow
In jXchange, the Check Image Inquiry service uses a typical exchange of MType messages to inquire on check images.
Primary Request
The Third Party Consumer forwards the
ChkImgRq_MType message to the Service Provider. The
message contains:
ChkImgFormatChkImgIdChkImgSide
Primary Response
The Service Provider returns the
ChkImgInqRs_MType message to the Third Party Consumer.
The message contains the requested information from the request
and:
- BackChkImg
- BackChkImgLength
- FrontChkImg
- FrontChkImgLength
Check Image Inquiry Behavior
jXchange supports messaging for the inquiry of check images associated to a specific account. The service can be used by a Third Party Consumer to request a check image from a Service Provider. The Service Provider returns the image in a standard image file such as jpeg, gif, etc.
In standard check image inquiry, the Third Party Consumer requests a check image using a check image ID number to identify the check. The check image number is a unique number assigned by the Service Provider and can be obtained through the Account History Search service. The Third Party Consumer also requests whether the image is to include the front or back side of the check, or both, and the type of file format in which the image is to be returned.
Upon request, the Service Provider returns the requested image in the requested image file, compressed in Base 64.
Only one check image can be requested per request message.
ChkImgInqRq_MType
ChkImgInqRq_MType is a message
MType element.
Contains:
Custom_CTypeMsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- ChkImgFormat
- The value that defines the file format that is used to deliver the check image.
Canonical values are:
- GIF
- IOCA
- JPG
- PNG
- TIFF
- ChkImgId
- The identification assigned to a check image.
- ChkImgSide
- The value that defines which side of the check image to deliver.
Canonical values are:
- Back
- Both
- Front
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_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 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.AuthenUsrIdis 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 byWS-Security.
ChkImgInqRs_MType
ChkImgInqRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- BackChkImg
- The back of the check image.
- BackChkImgLength
- The length of the back of the check image.
- ChkImgFormat
- The value that defines the file format that is used to deliver the check image.
Canonical values are:
- GIF
- IOCA
- JPG
- PNG
- TIFF
- ChkImgId
- The identification assigned to a check image.
- ChkImgSide
- The value that defines which side of the check image to deliver.
Canonical values are:
- Back
- Both
- Front
- FrontChkImg
- The front of the check image.
- FrontChkImgLength
- The length of the front of the check image.
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 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.AuthenUsrIdis 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 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.
Check Image Inquiry Business Case
In this business case, the consumer requests a check image inquiry to verify that a check they wrote has been cashed by the proper authority. The consumer’s internet bank sends a request to the Service Provider where the check was cashed.
Request Message
After obtaining the proper
check image number through an account history search, the internet
bank forwards the ChkImgInqRq to the Service Provider
containing the following elements and values:
| Complex | Simple Element or Array | Entry Value | Explanation |
|---|---|---|---|
ChkImgInqRq_MType | ChkImgId | 37389895 | Unique number created by the Service Provider to identify the check. |
ChkImgFormat | GIF | File format in which the check image is to be returned. | |
ChkImgSide | Both | Sides of the check to be included in the response. |
Response Message
The Service Provider returns
a ChkImgInqRs_MType with the following simple elements
and values:
| Complex | Simple Element or Array | Entry Value | Explanation |
|---|---|---|---|
ChkImgInqRs_MType | ChkImgId | 37389895 | ChkImgId from Request. |
ChkImgFormat | GIF | File format submitted in request. | |
ChkImgSide | Both | Sides of the check submitted in the request. | |
FrontChkImgLength | 12000 | Length of compressed front check image in bytes. | |
FrontChkImg | ~~~~~ | Check image compressed in Base 64 binary. | |
BackChkImgLength | 10000 | Length of compressed back check image in bytes. | |
BackChkImge | ~~~~~ | Check image compressed in Base 64 binary. |