Document Electronic Signature Addition
Document Electronic Signature Addition
Document Electronic Signature Addition is a jXchange service designed to allow consumers to submit documents with embedded electronic signature requirements.
Message Flow
In jXchange, the Document Electronic Signature Addition service uses a typical exchange of
MType messages to allow consumers to submit documents with embedded
electronic signature requirements.
Primary Request
The consumer forwards the DocElecSigAddRq_MType message to the service
provider. The message contains the following simple elements:
- DocColKey
- FinalDocElecSig
- ElecSigCapType
Primary Response
The service provider returns the DocElecSigAddRs_MType message to the
consumer. The message contains the following simple elements:
- DocColKey
- DocRcptId
- ElecDocLoc
Document Electronic Signature Add Behavior
The Document Electronic Signature Add (DocElecSigAdd) operation
behavior is as follows.
The Document Electronic Signature Addition root request message
(DocElecSigAddRq_MType) contains a documented choice statement that
includes the Final Document Electronic Signature (FinalDocElecSig)
simple element and/or Document Electronic Signature array
(DocElecSigArray_AType). Both may exist in the request, but at least one
must exist. The root request also includes Document Collection Key
(DocColKey) and Electronic Signature Capture Type
(ElecSigCapType) simple elements.
The Document Receipt Identifier (DocRcptId) simple element correlates submitted documents in a related group. The Final Document Electronic Signature (FinalDocElecSig) simple element conveys to the service provider when the user submits the last document of a group.
The Electronic Signature Capture Type (ElecSigCapType) simple element tells the service provider the method used to capture the signatures.
The Document Electronic Signature array (DocElecSigArray_AType) contains the
Document Electronic Signature Information complex (DocElecSigInfo_CType). The
array contains the document(s), electronic signature assignee(s), and template information.
The initial service provider only supports one document submission per message request. The
Document Electronic Signature Information complex (DocElecSigInfo_CType)
contains the Consumer Document Identifier (ConsmDocId), Document Name
(DocName), Document Description (DocDesc),
Document Image (DocImg), Document Image Size
(DocImgSize), and Document Image Format
(DocImgFormat) simple elements, and the Electronic Signature Assignee
array (ElecSigAssigneeArray_AType) and Document Template Information complex
(DocTmpltInfo_CType). The current service provider only supports the
PDF canonical value for the Document Image Format
(DocImgFormat) simple element.
The Consumer Document Identifier ConsmDocId, Document Image
(DocImg), Document Description (DocDesc), and
Document Image Size (DocImgSize) simple elements are required when the
Document Electronic Signature Information complex (DocElecSigInfo_CType) is
present. The Document Image (DocImg) is base64Binary type. The Document
Image Size (DocImgSize) is represented in bytes.
The PDF document users submit for electronic signatures must meet the following requirements:
- The PDF cannot be encrypted.
- The PDF cannot be an embedded image.
- The PDF cannot have any fillable fields (including any read-only fields).
- The PDF must be flattened except for signature, initial and associated date fields.
- The PDF cannot rely on any JavaScript to be completed.
- The PDF cannot have Rights Management or other Reader-enabled features.
- The PDF cannot be larger than 2.5MB.
The Electronic Signature Assignee array (ElecSigAssigneeArray_AType)
contains the Electronic Signature Assignee Information complex
(ElecSigAssigneeInfo_CType). The array contains the signature(s) variable,
demographic information and Electronic Signature locations information. The Electronic
Signature Assignee Information complex (ElecSigAssigneeInfo_CType) contains
the Signature Assignee Processing Sequence (SiqAssigneeProcSeq),
Signature Assignee Activity Type (SigAssigneeActType), Signature
Assignee Role (SigAssigneeRole), Tax Identifier
(TaxId), Birth Date (BirthDt), Electronic
Signature Authentication Type (ElecSigAuthenType), and Electronic
Signature Password (ElecSigPswd) simple elements, and the Person Name
complex (PersonName_CType), Address complex (Addr_CType),
Phone array (PhoneArray_AType), Email array
(EmailArray_AType), and Electronic Signature Location array
(ElecSigLocArray_AType). The Phone Type (PhoneType)
simple element value Home is supported. The Email Type
(EmailType) simple element values Home and
Work are supported.
The Electronic Signature Location array (ElecSigLocArray_AType) contains the
Electronic Signature Location Information complex (ElecSigLocInfo_CType). The
array contains the signature(s) location information. The Electronic Signature Location
Information complex (ElecSigLocInfo_CType) contains the Electronic Signature
Correlation (IdentifierElecSigCorrelId), 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), and Electronic Signature Location Height
(ElecSigLocHeight) simple elements.
Use the Document Template Information complex (DocTmpltInfo_CType) to
reference an existing template or create a template for a newly-submitted document. The
Document Template Information complex (DocTmpltInfo_CType) is contained by
the Document Template Identifier (DocTmpltId), Document Template
Abbreviation (DocTmpltAbbr), and Document Template Description
(DocTmpltDesc) simple elements.
The request includes a Synergy Service Provider Information complex to allow the consumer to submit Synergy-specific document indexes when Synergy is tightly coupled to the eSignature provider.
The Document Electronic Signature Addition root response message
(DocElecSigAddRs_MType) returns the Document Collection Key
(DocColKey), Document Receipt Identifier
(DocRcptId) and/or Electronic Document Location
(ElecDocLoc) simple elements. The Document Receipt Identifier
(DocRcptId) and Document Collection Key
(DocColKey) are cached by the consumer for subsequent message
submissions to correlate documents. The Electronic Document Location
(ElecDocLoc) is cached by the consumer to use for the re-direct to
the eSignature provider’s site for the electronic signature(s) capture process. The Document
Receipt Identifier (DocRcptId) is cached by the consumer for subsequent
document electronic signature services. The Document Collection Key
(DocColKey) becomes invalid upon delivery of the last document for a
specific collection.
The standard addition message tenets are applicable.
Adhere to the tenets related to the JHANull attribute.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
DocElecSigAddRq_MType
DocElecSigAddRq_MType is a message MType
element.
Contains:
Custom_CTypeDocElecSigArray_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- 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
- FinalDocElecSig
- Identifies whether this document submitted for electronic signature
represents the last document for a signature group. Canonical values are:
- false
- true
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
DocElecSigArray_AType
DocElecSigArray_AType is an array AType element. This
is an array of responses for a document electronic signature.
Contains:
DocElecSigInfo_CType
DocElecSigArray_AType
DocElecSigArray_AType is an array AType element. This
is an array of responses for a document electronic signature.
Contains:
DocElecSigInfo_CType
DocElecSigInfo_CType
DocElecSigInfo_CType is a complex CType
element.
Contains:
Custom_CTypeDocTmpltInfo_CTypeElecSigAssigneeArray_ATypeSvcPrvdInforeferencesDocElecSigInfo_EType
Simple Elements
The following simple elements are contained within this message.
- 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.
- DocImgFormat
Identifies the type of file that contains the document image. Canonical values are:
- GIF
- IOCA
- JPG
- PNG
- TIFF
- 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.
DocTmpltInfo_CType
DocTmpltInfo_CType is a complex CType
element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- DocTmpltAbbr
- An abbreviated representation of a document template.
- DocTmpltDesc
- A description of a document template.
- DocTmpltId
- An identifier assigned to a template for a document.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ElecSigAssigneeArray_AType
ElecSigAssigneeArray_AType is an array AType element.
This is an array of assignees for a document electronic signature.
Contains:
ElecSigAssigneeInfo_CType
ElecSigAssigneeInfo_CType
ElecSigAssigneeInfo_CType is a complex CType element.
This is a package of assignee(s) for electronic signatures.
Contains:
Addr_CTypeCustom_CTypeElecSigLocArray_ATypeEmailArray_ATypePersonName_CTypePhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BirthDt
- The date of birth.
- ElecSigAuthenType
- The type of authentication to use for electronic out of band
processes. Canonical values are:
- KBA
- Pswd
- Tele
- ElecSigPswd
- The password for electronic document signatures for out of band processes.
- 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.
- SigAssigneeRole
- The role the signature assignee has for the document. Examples include Notary, Customer, or Loan Officer.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
Addr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
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.
- 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.
EmailArray_AType
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
PersonName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PhoneArray_AType
PhoneArray_AType is an array AType
element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell. Canonical values
are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
SvcPrvdInfo
DocElecSigInfo_EType is an extended
EType element.
SvcPrvdInfo references DocElecSigInfo_EType.
Contains:
SynergyreferencesDocElecSigInfo_Synergy_CType
Synergy
DocElecSigInfo_Synergy_CType
is a complex CType element.
Synergy references DocElecSigInfo_Synergy_CType.
Contains:
DocImgIdxArray_AType
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
DocElecSigAddRs_MType
DocElecSigAddRs_MType is a message MType
element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- DocColKey
- The key assigned to a collection of documents. This key becomes invalid upon delivery of the last document for a specific collection.
- DocRcptId
- A receipt given for a document submission.
- ElecDocLoc
- URI where an electronic is located.
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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.