Enterprise Solutions

Document Image Add

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

Document Image Add

Document Image Add is a jXchange service designed to add images to the document.

Message Flow

In jXchange, the Document Image Add service uses a typical exchange of MType messages to add images to the document to a service provider.

Primary Request

The third-party consumer forwards the DocImgAddRq_MType message to the service provider. The message contains:

  • DocImg
  • DocImgAuxDesc
  • DocImgEffDt
  • DocImgFormat
  • DocImgIdxName
  • DocImgIdxType
  • DocImgIdxValue
  • DocImgProcSeq
  • DocImgSize
  • DocName

Primary Response

The service provider returns the DocImgAddRs_MType message to the third-party consumer. The message contains:

  • DocImgIdxName
  • DocImgIdxType
  • DocImgIdxValue
  • DocImgProcSeq
  • DocName

DocImgAddRq_MType

DocImgAddRq_MType is a message MType element.

Contains:

  • Custom_CType
  • DocImgInfoArray_AType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

DocImgAuxDesc
An auxiliary description that further describes details about the document image.
DocImgEffDt
The date the document image was created.
DocImgFormat

Identifies the type of file that contains the document image. Canonical values are:

  • GIF
  • IOCA
  • JPG
  • PDF
  • PNG
  • TIFF
DocImgIdxName
The name that describes the naming convention for the DocImIdxType element used for indexing a document.
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.
DocImgProcSeq
A sequence number assigned to each document image that assists the service provider for processing.
DocImgSize
The size of the document image in bytes. The size is prior to compression if the image has been compressed.
DocImg
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.

DocImgInfoArray_AType

DocImgInfoArray_AType is an array AType element. This is an array of information related to the document images.

Contains:

  • DocImgInfo_CType

DocImgInfo_CType

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

Contains:

  • DocImgDetArray_AType
  • 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.
DocImgEffDt
The date the document image was created.
DocName
The name given to a document that describes the document image captured.
DocImgDetArray_AType

DocImgDetArray_AType is an array AType element. This is an array of document images.

Contains:

  • DocImgDetInfo_CType
DocImgDetInfo_CType

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

Simple Elements

The following simple elements are contained within this complex.

DocImgFormat

Identifies the type of file that contains the document image. Canonical values are:

  • GIF
  • IOCA
  • JPG
  • PDF
  • PNG
  • TIFF
DocImgProcSeq
A sequence number assigned to each document image that assists the service provider for processing.
DocImgSize
The size of the document image in bytes. The size is prior to compression if the image has been compressed.
DocImg
The document image.
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.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType

ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

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.

DocImgAddRs_MType

DocImgAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • DocImgInfoRsArray_AType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

DocImgIdxName
The name that describes the naming convention for the DocImIdxType element used for indexing a document.
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.
DocImgProcSeq
A sequence number assigned to each document image that assists the service provider for processing.
DocName
The name given to a document that describes the document image captured.
RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocImgInfoRsArray_AType

DocImgInfoRsArray_AType is an array AType element. This is an array of information returned related to document images.

Contains:

  • DocImgInfoRs_CType

DocImgInfoRs_CType

DocImgInfoRs_CType is a complex CType element. This element is required.

Contains:

  • DocImgIdxArray_AType
Simple Elements

The following simple elements are contained within this complex.

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.

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