Developer Programs
Getting Started
Get started working with Jack Henry's developer programs today.
Fintech Integration Network (FIN)
Jack Henry's Integration Program for Fintechs.
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
Authentication Framework
Map customer identities to your existing system IDs.
Banno SDK
Create exceptional banking experiences.
Data Hub
Get deeper access to financial institution data.
Digital Core
Modernize with cloud-native core banking technology.
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.
Payments Orchestrator
Embed multiple payment rails and virtual accounts into your solution.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Full List of APIs
Begin working with Jack Henry's public APIs to build financial applications today.

Document Electronic Signature Assignee Modification

API by Reference > Document Image > Document Electronic Signature Assignee Modification

Home >

Document Electronic Signature Assignee Modification

Document Electronic Signature Assignee Modification is a jXchange service designed to allow users to modify assignees for electronic signatures.

Message Flow

In jXchange, the Document Electronic Signature Assignee Modification service uses a typical exchange of MType messages to allow users to modify assignees for electronic signatures.

Primary Request

The consumer forwards the DocElecSigAssigneeModRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntentKey
  • Dlt
  • DocColKey
  • ElecSigCapType
  • ElecSigLocId
  • SigAssigneeActType
  • SigAssigneeProcSeq

The message contains the following complex elements:

  • Custom_CType
  • DocElecSigAssigneeInfo_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the DocElecSigAssigneeModRqRs_MType message to the consumer.

The message contains the following simple element:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • DocElecSigAssigneeInfo_CType
  • MsgRsHdr_CType

Document Electronic Signature Assignee Modification Behavior

Document Electronic Signature Assignee Modification is a jXchange service designed to allow users to modify assignees for electronic signatures.

The Document Electronic Signature Assignee Modification service behavior is as follows.

The Document Electronic Signature Assignee Modification root request requires values for Document Collection Key (DocColKey), Signature Assignee Process Sequence (SigAssigneeProcSeq), and Activity Intention Key (ActIntentKey).

The Document Electronic Signature Assignee Modification root request optionally includes the Electronic Signature Capture Type (ElecSigCapType), Electronic Signature Location Identifier (ElecSigLocId), Document Electronic Signature Assignee Information complex (DocelecSigAssigneeInfo_CType), and Delete (Dlt) elements.

A request targets a specific document signature location when the Electronic Signature Location Identifier (ElecSigLocId) is included in the request.

A request without the Electronic Signature Location Identifier (ElecSigLocId) and the Delete element with a value of (true) conveys to the provider to delete/null the Assignee and all related document signature locations.

The Document Electronic Assignee Information complex (DocElecSigAssigneeInfo_CType) contains:

  • Email Address (EmailAddr)
  • Common Name (ComName)
  • First Name (FirstName)
  • Last Name (LastName)
  • Phone number (PhoneNum)
  • Electronic Signature Password (ElecSigPswd)
  • Electronic Signature Location Array (ElecSigLocArray_AType)

The Electronic Signature Location Array (ElecSigLocArray_AType) contains:

  • Electronic Signature Correlation Identifier (ElecSigCorrelId)
  • Electronic Signature Document Page (ElecSigDocPage)
  • Electronic Signature Type (ElecSigType)
  • Electronic Signature Location X Coordinates (ElecSigLocXCoord)
  • Electronic Signature Location Y Coordinates (ElecSigLocYCoord)
  • Electronic Signature Location Width (ElecSigLocWidth)
  • Electronic Signature Location Height (ElecSigLocHeight)
  • Electronic Signature Location Identifier (ElecSigLocId)

DocElecSigAssigneeModRq_MType

DocElecSigAssigneeModRq_MType is a message MType element.

Contains:

  • Custom_CType
  • DocElecSigAssigneeInfo_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntentKey
The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
Dlt

The delete element. Canonical values are:

  • false
  • true
DocColKey
The key assigned to a collection of documents. This key becomes invalid upon delivery of the last document for a specific collection.
ElecSigCapType
Defines the method used to capture electronic signatures. Canonical values are:
  • Local
  • Remote
ElecSigLocId
The identifier given to a document location for signing.
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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocElecSigAssigneeInfo_CType

DocElecSigAssigneeInfo_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.
ElecSigPswd
The password for electronic document signatures for out of band processes.
EmailAddr
Email address.
FirstName
The first name.
LastName
The last name.
PhoneNum
The phone number.

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.

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.

DocElecSigAssigneeModRs_MType

DocElecSigAssigneeModRs_MType is a message MType element.

Contains:

  • Custom_CType
  • DocElecSigAssigneeInfo_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are 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.

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.

Topics in this section

Have a Question?
  • Have a how-to question? Seeing a weird error? Get help on our collaborative Discourse page.
  • Register for the Developer Office Hours where we answer technical Q&A, in real time, from the audience.
Did this page help you?
Last updated Wed Sep 16 2026