Developer Resources

Enterprise SOAP API > API by Reference > Core Services > Check Image Inquiry > Developer Resources

Details

SoapAction	http://jackhenry.com/ws/ChkImgInq
Input Name	ChkImgInq
Output Name	ChkImgInqResponse
Input Namespace	http://jackhenry.com/jxchange/TPG/2008
Group Name	Image
Container	TPG_ImageMaster.xsd

XML Examples

ChkImgInq Request

XML

 <?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SOAP-ENV:Header>
    <wsse:Security
      xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
      xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
      <wsse:UsernameToken
        xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:Username>INSERT</wsse:Username>
        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">INSERT</wsse:Password>
        <wsu:Created
          xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2018-01-09T17:44:28Z
        </wsu:Created>
      </wsse:UsernameToken>
    </wsse:Security>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ChkImgInq
      xmlns="http://jackhenry.com/jxchange/TPG/2008">
      <MsgRqHdr>
        <jXchangeHdr>
          <JxVer/>
          <AuditUsrId>INSERT</AuditUsrId>
          <AuditWsId>INSERT</AuditWsId>
          <AuthenUsrId/>
          <ConsumerName/>
          <ConsumerProd/>
          <Ver_1/>
          <jXLogTrackingId>INSERT</jXLogTrackingId>
          <Ver_2/>
          <InstRtId JHANull="" Rstr="">INSERT</InstRtId>
          <InstEnv>INSERT</InstEnv>
          <Ver_3/>
          <BusCorrelId/>
          <Ver_4/>
          <WorkflowCorrelId/>
          <Ver_5/>
          <ValidConsmName>INSERT</ValidConsmName>
          <ValidConsmProd>INSERT</ValidConsmProd>
          <Ver_6/>
        </jXchangeHdr>
        <Ver_1/>
        <Ver_2/>
        <Ver_3/>
      </MsgRqHdr>
      <ChkImgId>INSERT</ChkImgId>
      <ChkImgFormat>INSERT</ChkImgFormat>
      <ChkImgSide>INSERT</ChkImgSide>
      <Custom/>
      <Ver_1/>
    </ChkImgInq>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ChkImgInq Back Request

XML

 <?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SOAP-ENV:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
      xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
      <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:Username>{Insert}</wsse:Username>
        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
        <wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2017-11-21T19:16:23Z
        </wsu:Created>
      </wsse:UsernameToken>
    </wsse:Security>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ChkImgInq xmlns="http://jackhenry.com/jxchange/TPG/2008">
      <MsgRqHdr>
        <jXchangeHdr>
          <JxVer>R2016.2</JxVer>
          <AuditUsrId/>
          <AuditWsId/>
          <ConsumerName/>
          <ConsumerProd/>
          <Ver_1/>
          <jXLogTrackingId>468ff20e-82bd-4593-bf0f-a6478bc5fc54</jXLogTrackingId>
          <Ver_2/>
          <InstRtId>011001276</InstRtId>
          <InstEnv>TEST</InstEnv>
          <Ver_3/>
          <BusCorrelId>468ff20e-82bd-4593-bf0f-a6478bc5fc54</BusCorrelId>
          <Ver_4/>
          <Ver_5/>
          <ValidConsmName>{Insert}</ValidConsmName>
          <ValidConsmProd>{Insert}</ValidConsmProd>
        </jXchangeHdr>
      </MsgRqHdr>
      <ChkImgId>517100400000265</ChkImgId>
      <ChkImgSide>Back</ChkImgSide>
    </ChkImgInq>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ChkImgInq Back Response

XML

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <s:Header>
    <o:Security s:mustUnderstand="1"
      xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <u:Timestamp u:Id="_0">
        <u:Created>2021-03-30T21:11:11.956Z</u:Created>
        <u:Expires>2021-03-30T21:16:11.956Z</u:Expires>
      </u:Timestamp>
    </o:Security>
  </s:Header>
  <s:Body>
    <ChkImgInqResponse xmlns="http://jackhenry.com/jxchange/TPG/2008">
      <MsgRsHdr>
        <jXchangeHdr>
          <JxVer>R2017.4</JxVer>
          <AuditUsrId>
          </AuditUsrId>
          <AuditWsId>
          </AuditWsId>
          <ConsumerName>
          </ConsumerName>
          <ConsumerProd>
          </ConsumerProd>
          <Ver_1>
          </Ver_1>
          <jXLogTrackingId>468ff20e-82bd-4593-bf0f-a6478bc5fc54</jXLogTrackingId>
          <Ver_2>
          </Ver_2>
          <InstRtId>011001276</InstRtId>
          <InstEnv>TEST</InstEnv>
          <Ver_3>
          </Ver_3>
          <BusCorrelId>468ff20e-82bd-4593-bf0f-a6478bc5fc54</BusCorrelId>
          <Ver_4>
          </Ver_4>
          <Ver_5>
          </Ver_5>
          <ValidConsmName></ValidConsmName>
          <ValidConsmProd></ValidConsmProd>
        </jXchangeHdr>
      </MsgRsHdr>
      <ChkImgId>517100400000265</ChkImgId>
      <ChkImgFormat>TIFF</ChkImgFormat>
      <ChkImgSide>Back</ChkImgSide>
      <FrontChkImgLength xsi:nil="true"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      </FrontChkImgLength>
      <FrontChkImg xsi:nil="true"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      </FrontChkImg>
      <BackChkImgLength>680</BackChkImgLength>
      <BackChkImg>SUkqAAgAAAATAP4ABAABAAAAAAAAAAABBAABAAAAqAYAAAEBBAABAAAAtQIAAAIBAwABAAAAAQAAAAMBAwABAAAABAAAAAYBAwABAAAAAAAAAAoBAwABAAAAAQAAABEBBAABAAAAAgEAABIBAwABAAAAAQAAABUBAwABAAAAAQAAABYBBAABAAAAtQIAABcBBAABAAAApgEAABoBBQABAAAA8gAAABsBBQABAAAA+gAAABwBAwABAAAAAQAAACQBBAABAAAAAAAAACUBBAABAAAAAAAAACgBAwABAAAAAgAAACkBAwACAAAAAAAAAAAAAADIAAAAAQAAAMgAAAABAAAA////////////////////////////////////////////////////////////////////JuBCnUUlzJApGGdBTQNBoKdRTqKS5kgU6inUWEGEGoQeEHhBhBhBqEGEGEHTTVNU9NNNU008lDkoayUNZKGRByUOShyUNUStyUOSh0m0m9JsKk2kk2k2k3pNpNpN6enWnBafp6enWunp666r66rrrruuvq6vq5IfV1V1dXj1dX/18f1//Vf/vuiY/f39990TH++9dddfXpdddel1//X/6//1hf//pf/1/+lkMT//6X/6//pf////////h///S//r/9LKcf//0v/1//Sw3/////r////vvoQb++r776EG77////////+uvr6pa665gvXXdXR1K67rurq6OpfdXV9/f36fff3V9/a2va9qtra2vfa2ttJtLbS20ttJtJtLYYSbSbSxUVxXFJRUVFbFRUVaa2traaa2mmoYQYWGFhhJBhBhBhYYQYQYURERERERER//////////////////////////////////////////+ACACAA=</BackChkImg>
      <Custom xsi:nil="true"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      </Custom>
    </ChkImgInqResponse>
  </s:Body>
</s:Envelope>

ChkImgInq FAQ

Question: Silverlake Would the ChkImgInq operation return check images from JHA 4|Sight? Or does that need to be accessed via the separate jXchange 4Sight provider?

Answer: Check images would come back from 4|Sight and do require separate setup of the 4|Sight provider in jXchange Service Gateway.

Question: In the request below, what is ChkImgId, is it a combination of different fields such as account number and check number?

XML

 <ChkImgInq xmlns="http://jackhenry.com/jxchange/TPG/2008">
  <MsgRqHdr>
    <jXchangeHdr>
      <JxVer>R2016.1</JxVer>
      <AuditUsrId />
      <AuditWsId />
      <ConsumerName/>
      <Ver_1/>
      <jXLogTrackingId>5137ce18-a011-4da0-b670-d31592b0ef90</jXLogTrackingId>
      <Ver_2/>
      <InstRtId>011001276</InstRtId>
      <InstEnv>TEST</InstEnv>
      <Ver_3/>
      <BusCorrelId />
      <Ver_4/>
      <Ver_5/>
      <ValidConsmName></ValidConsmName>
      <ValidConsmProd></ValidConsmProd>
    </jXchangeHdr>
  </MsgRqHdr>
  <ChkImgId>517100400000264</ChkImgId>
</ChkImgInq>

Answer: No, ChkImgId is sometimes called a HIN and should be treated as a unique individual number. The HIN should be retrieved either from the core, or from the ChkImgSrch operation.

Have a Question?

Have a how-to question? Seeing a weird error? Get help on StackOverflow.

Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.

Last updated Mon Apr 15 2024