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.
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 Broker
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 third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications 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.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Document Image Cross Index Add

Enterprise SOAP API > API by Reference > Document Image > Document Image Cross Index Add

Document Image Cross Index Addition

Document Image Cross Index Addition is a jXchange service designed to allow a consumer to add cross indexing to a specific document.

Message Flow

In jXchange, the Document Image Cross Index Addition service uses a typical exchange of MType messages to allow a consumer to add cross indexing to a specific document.

Primary Request

The consumer forwards the DocImgCrossIdxAddRq_MType message to the service provider.

The message contains the following simple element:

  • UniqueIndex

The message contains the following complex elements:

  • Custom_CType
  • DocImgCrossIdxRec_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the DocImgCrossIdxAddRs_MType message to the consumer.

The message contains the following simple element:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • DocImgCrossIdxRsInfo_CType
  • MsgRsHdr_CType

Document Cross Index Addition Behavior

Document Image Cross Index Addition is a jXchange service designed to allow a consumer to add cross indexing to a specific document.

The Document Cross Index Addition service behavior is as follows.

The Document Cross Index Addition root request (DocImgCrossIdxAddRq_MType) requires a valid Unique Index (UniqueIndex) and Document Image Cross Index Record complex DocImgCrossIdxRec_CType). The Document Image Cross Index Record complex contains Document Name (DocName), Document Image Auxiliary Description (DocImgAuxDesc), and Document Image Index Array (DocImgIdxArray_AType).

The Document Image Index Array is a reused resource that is part of the Document Imaging suite of services.

The Document Cross Index Addition root response (DocImgCrossIdxAddRs_MType) includes the Document Image Cross Index Response Information complex (DocImgCrossIdxRsInfo_CType). Document Image Cross Index Response Information contains the Document Name (DocName), Document Image Auxiliary Description (DocImgAuxDesc), and Document Image Cross Index Response Array (DocImgCrossIdxRsArray_AType).

The Document Image Cross Index Response Array is a reused resource that is part of the Document Imaging suite of services.

The Document Cross Index Addition root request (DocImgCrossIdxAddRq_MType) requires a valid Unique Index (UniqueIndex) from the Document Image Search (DocImgSrchRq_MType) response. Consumers may make this request for Index Only (IdxOnly) with a value of true if only the indexes are required in the response.

DocImgCrossIdxAddRq_MType

DocImgCrossIdxAddRq_MType is a message MType element.

Contains:

  • Custom_CType
  • DocImgCrossIdxRec_CType
  • MsgRqHdr_CType

Simple Elements

The following simple element is contained within this message.

UniqueIndex
Document name, number, or other identifying value.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocImgCrossIdxRec_CType

DocImgCrossIdxRec_CType is a complex CType element.

Contains:

  • DocImgIdxArray_AType

Simple Elements

The following simple elements are contained within this complex.

DocImgAuxDesc
An auxiliary description that further describes details about the document image.
DocName
The name given to a document that describes the document image captured.

DocImgIdxArray_AType

DocImgIdxArray_AType is an array AType element. This array contains document indexes used for a document image.

Contains:

  • DocImgIdx_CType
DocImgIdx_CType

DocImgIdx_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

DocImgAlgSymb
The algebraic symbol for the document index ranges. Canonical values are:
  • EQ
  • GT
  • GE
  • LT
  • LE
  • NE
DocImgIdxName
The name that describes the naming convention for the DocImIdxType element used for indexing a document.
DocImgIdxOrder
The document image order for image ranges.
DocImgIdxType
The type or classification of the index that could be used in the DocImgAdd service. Canonical values are:
  • AcctId
  • AcctType
  • Cabinet
  • CustId
  • FileName
  • Folder
  • Index
  • IndexLookup
  • Name
  • ShortName
  • TaxId
  • UniqueIndex
DocImgIdxValue
The value that correlates to the DocImgIdxName used for indexing a document image.

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 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_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.

DocImgCrossIdxAddRs_MType

DocImgCrossIdxAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • DocImgCrossIdxRsInfo_CType
  • MsgRsHdr_CType

Simple Elements

The following simple element is contained within this message.

RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocImgCrossIdxRsInfo_CType

DocImgCrossIdxRsInfo_CType is a complex CType element.

Contains:

  • Custom_CType
  • DocImgCrossIdxRsArray references DocImgCrossIdxArray_AType

Simple Elements

The following simple elements are contained within this complex.

DocImgAuxDesc
An auxiliary description that further describes details about the document image.
DocName
The name given to a document that describes the document image captured.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocImgCrossIdxRsArray

DocImgIdxArray_AType is an array AType element. This array contains document indexes used for a document image.

DocImgCrossIdxRsArray references DocImgIdxArray_AType.

Contains:

  • DocImgIdx_CType
DocImgIdx_CType

DocImgIdx_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

DocImgAlgSymb
The algebraic symbol for the document index ranges. Canonical values are:
  • EQ
  • GT
  • GE
  • LT
  • LE
  • NE
DocImgIdxName
The name that describes the naming convention for the DocImIdxType element used for indexing a document.
DocImgIdxOrder
The document image order for image ranges.
DocImgIdxType
The type or classification of the index that could be used in the DocImgAdd service. Canonical values are:
  • AcctId
  • AcctType
  • Cabinet
  • CustId
  • FileName
  • Folder
  • Index
  • IndexLookup
  • Name
  • ShortName
  • TaxId
  • UniqueIndex
DocImgIdxValue
The value that correlates to the DocImgIdxName used for indexing a document image.

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 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_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.
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 Tue Oct 17 2023