Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Developer Account
Create a developer acccount to access resources that help you integrate with Jack Henry.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Hub
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and 3rd-party apps using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and 3rd-party apps using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Full List of APIs
Begin working with Jack Henry's public APIs to build financial applications today.

Document Electronic Receipt Inquiry

Enterprise SOAP API > API by Reference > Document Image > Document Electronic Receipt Inquiry

Document Electronic Receipt Inquiry

Document Electronic Receipt Inquiry is a jXchange service designed to provide a means to convey the current documents, signers, and status for a specific document receipt to consumers.

Message Flow

In jXchange, the Document Electronic Receipt Inquiry service uses a typical exchange of MType messages to convey the current documents, signers, and status for a specific document receipt to consumers.

Primary Request

The consumer forwards the DocElecRcptInqRq_MType message to the service provider. The message contains the following simple elements:

  • ActIntent
  • DocRcptId

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

The message contains the following array:

  • IncXtendElemArray_AType

Primary Response

The service provider returns the DocElecRcptInqRs_MType message to the consumer. The message contains the following simple elements:

  • ActIntent
  • ActIntentKey
  • DocElecRcptStat
  • DocElecRcptStatDesc
  • DocElecTimeDt
  • DocRcptId

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • x_ElecDocLocInfo_CType

The message contains the following arrays:

  • DocElecRcptInqArray_AType
  • x_DocElecAuditImgArray_AType

Document Electronic Receipt Inquiry Behavior

The Document Electronic Receipt Inquiry service behavior is as follows.

The Document Electronic Receipt Inquiry root request (DocElecRcptInqRq_MType) requires a valid Document Receipt Identifier (DocRcptId).

The Document Electronic Receipt Inquiry root response (DocElecRcptInqRs_MType) returns the following elements:

  • Document Receipt Identifier (DocRcptId)
  • Document Electronic Receipt Status (DocElecRcptStat)
  • Document Electronic Receipt Status Description (DocElecRcptStatDesc)
  • Document Element Time Date (DocElecTimeDt)
  • Document Electronic Receipt Inquiry Array (DocElecRcptInqArray_AType)

The Document Receipt Identifier (DocRcptId) is an echo back from the request.

The Document Electronic Time Date (DocElecTimeDt) is expressed in ISO 8601 time format and contains either Zulu time or local time and the UTC offset.

The standard Inquiry message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

DocElecRcptInqRq_MType

DocElecRcptInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElemArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

DocRcptId
A receipt given for a document submission.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element. This is an array that lists x_ elements by name, which are to be included in the response.

Contains:

  • IncXtendElemInfo_CType

IncXtendElemInfo_CType

IncXtendElemInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XtendElem
Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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 submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. 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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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.

DocElecRcptInqRs_MType

DocElecRcptInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • DocElecRcptInqArray_AType
  • MsgRsHdr_CType
  • x_DocElecAuditImgArray_AType
  • x_ElecDocLocInfo_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
DocElecRcptStatDesc
The description of the status of document receipt.
DocElecRcptStat
The status of document receipt. Canonical values are:
  • Aborted
  • Archived
  • Comp
  • Del
  • Exp
  • ImgPend
  • InProcess
  • Submit
  • Unknown
DocElecTimeDt

The date and timestamp of the receipt. The time is expressed in ISO 8601 time format and must contain either Zulu time or local time and the UTC offset. Format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] Valid values include:

  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52+02:00
  • 2001-10-26T19:32:52Z
  • 2001-10-26T19:32:52+00:00
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52.12679

Examples of the same moment:

  • 18:30Z
  • 22:30+04
  • 1130-0700
  • 15:00-03:30

See https://www.w3.org/TR/NOTE-datetime for further reference.

DocRcptId
A receipt given for a document submission.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocElecRcptInqArray_AType

DocElecRcptInqArray_AType is an array AType element. This is an array of responses for a document electronic receipt.

Contains:

  • DocElecRcptInqInfo_CType

DocElecRcptInqInfo_CType

DocElecRcptInqInfo_CType is a complex CType element.

Contains:

  • Custom_CType
  • DocElecRcptSigArray_AType
Simple Elements

The following simple elements are contained within this complex.

ConsmDocId
An identifier assigned to a document by the submitting consumer.
DocDesc
The description given to a document that is human-readable for UI presentation.
DocName
The name given to a document that describes the document image captured.
ElecDocType
The type of electronic document. Canonical values are:
  • Doc
  • Attach
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocElecRcptSigArray_AType

DocElecRcptSigArray_AType is an array AType element. This is an array of responses for document electronic receipt signers.

Contains:

  • DocElecRcptSigInfo_CType
DocElecRcptSigInfo_CType

DocElecRcptSigInfo_CType is a complex CType element.

Contains:

  • Custom_CType
  • ElecSigLocArray_AType
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element is the full text line name like John Doe.
DocSigStat
The status of the signatures as related to the document. Canonical values are:
  • Sign
  • UnSign
DocSigType
The type of signature requested for a document. Canonical values are:
  • Local
  • Remote
ElecSigPswd
The password for electronic document signatures for out of band processes.
EmailAddr
Email address.
FirstName
The first name.
LastName
The last name.
NxtSigInProcessType
Answers the question: Is this the signature next in the workflow of pending signatures for documents? Canonical values are:
  • false
  • true
PhoneNum
The phone number.
SigAssigneeActType
Determines the action to take for the specific signature assignee. Canonical values are:
  • ReadOnly
  • ReadWrite
  • NoAccess
SigAssigneeProcSeq
A sequence number assigned to each electronic signature that serves as an index for the document.
SigElecDocLoc
URL where a statement is located, if created.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ElecSigLocArray_AType

ElecSigLocArray_AType is an array AType element. This is an array of electronic signature locations as related to a document.

Contains:

  • ElecSigLocInfo_CType
ElecSigLocInfo_CType

ElecSigLocInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ElecSigCorrelId
The correlation identifier for correlating a signature with a date and other variables.
ElecSigDocPage
The document page number for an electronic signature.
ElecSigLocHeight
The height, in pixels, of the electronic signature for a document.
ElecSigLocId
The identifier given to a document location for signing.
ElecSigLocWidth
The width, in pixels, of the electronic signature for a document.
ElecSigLocXCoord
The X pixel coordinate of the electronic signature for a document.
ElecSigLocYCoord
The Y pixel coordinate of the electronic signature for a document.
ElecSigType
Defines the type of signature capture. Canonical values are:
  • Dt
  • Int
  • Sign
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_CType
  • MsgRecInfoArray_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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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 submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. 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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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.

x_DocElecAuditImgArray_AType

x_DocElecAuditImgArray_AType is an array AType element. This is an array of responses for auditing documents related to electronic eSignature documents.

Contains:

  • DocElecAuditImgInfo_CType

DocElecAuditImgInfo_CType

DocElecAuditImgInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

DocElecAuditImg
The document image.
ElecSigCapType
Defines the method used to capture electronic signatures. Canonical values are:
  • Local
  • Remote
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_ElecDocLocInfo_CType

x_ElecDocLocInfo_CType is a complex CType element.

Contains

  • Custom_CType

Simple Elements

The following simple element is contained within this complex:

ElecDocLoc
URI where an electronic is located.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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 Jan 24 2022