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

User Consumer Credential Addition

Enterprise SOAP API > API by Reference > Online Banking > User Consumer Credential Addition

User Consumer Credential Addition

User Consumer Credential Addition is a jXchange service designed to allow a consumer with a method to create a set of user credentials.

Message Flow

In jXchange, the User Consumer Credential Addition service uses a typical exchange of MType messages to create a set of user credentials.

Primary Request

The third-party consumer forwards the UsrConsmCredAddRq_MType message to the service provider.

The message contains the following simple elements:

  • CrtTempPswd
  • IMSOrgId
  • IncUsrNameSug

The message contains the following complex elements:

  • AliasClaimRec_CType
  • Custom_CType
  • MsgRqHdr_CType
  • UsrCred_CType
  • UsrCredInfo_CType

Primary Response

The service provider returns the UsrConsmCredAddRs_MType message to the third-party consumer.

The message contains the following simple elements:

  • IMSSubj
  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • UsrCred_CType

The message contains the following array:

  • UsrNameSugArray_AType

User Consumer Credential Add Behavior

The UsrConsmCredAddRq_MType message request optionally allows for an IMSOrgId, if needed. The default organization is the organization used in the routing of the message.

The request includes the optional IncUsrNameSug simple element, which conveys to the service provider to include an array of user name suggestions if the user credentials submitted were invalid. The default value is ~false~.

The request also includes the optional Create Temporary Password simple element, which conveys to the service provider to return a password. The default value is ~false~.

The UsrCred_CType complex is required. This complex is in the form of a WS Security token.

The UsrCredInfo_CType complex is required even though the elements encapsulated by the complex are all optional. The UsrCredInfo_CType complex was created for reuse for possible future modification service. The User Credential Status defaults to a value of ~Init~ for the addition service.

The AliasClaimRec_CType complex is optional and represents an alias given to the user name for a specific consumer's application. A single user may have several aliases that only relate to that application.

The UsrCred simple element returned in the UsrConsmCredAddRs_MType response message includes the password generated by the service provider, if the Create Temporary Password was submitted with a value of ~true~.

The service provider should return an error category of <Fault> when the user credential submitted on the request is invalid, but the consumer submitted the Include User Name Suggestions element value of ~true~. The RsStat simple element returns ~Fail~ when the user credentials are not created.

The service provider returns an error category of <Error> when the user credential submitted in the request is invalid and the consumer submitted the Include User Name Suggestions element value of ~false~, there is an absence from the request, or null. The RsStat simple element returns ~Fail~ when the user credentials are not created.

UsrConsmCredAddRq_MType

UsrConsmCredAddRq_MType is a message MType element.

Contains:

  • AliasClaimRec_CType
  • Custom_CType
  • UsrCred_CType
  • UsrCredInfo_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CrtTempPswd
Answers the question: Should the IMS provider generate a temporary password? Canonical values are:
  • false
  • true
IMSOrgId
The identification assigned to an organization in IMS. An organization that is a financial institution entity should use the routing transit or ABA 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 uses a mutually agreed upon identification that must contain at least one non-integer character.
IncUsrNameSug
Answers the question: Should the IMS provider include user name suggestions? Canonical values are:
  • false
  • true

AliasClaimRec_CType

AliasClaimRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Alias
The IMS named alias.
AliasContext
The context value for the alias.
AliasDesc
The generic description.
AliasDft
Answers the question: Is the alias the default alias in IMS? Canonical values are:
  • false
  • true
AliasInstRtId
The identification of the institution related to the alias. A financial institution entity uses the routing transit or ABA 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 uses a mutually agreed upon identification that must contain at least one non-integer character.
AppliesToApp
Requires the digital certificate owner to submit the URI of the Relying Party.
UniqueId
A unique identifier (GUID) applied to claims packages.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

UsrCred_CType

UsrCred_CType is a complex CType element.

User Credentials in the form of a WS Security Token. http://www.oasis-open.org/committees/download.php/16782/wss-v1.1-spec-os-UsernameTokenProfile.pdf

UsrCredInfo_CType

UsrCredInfo_CType is a complex CType element.

Contains:

  • PhoneInfo_CType

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.
EmailAddr
Email address.
FirstName
The first name.
LastFourTaxId
The last four characters/digits of a tax identification.
LastName
The last name.
MiddleName
The middle name.
UsrCredStat
The status of the user credentials. Canonical values are:
  • Act
  • Del
  • InAct
  • Init
WaterMarkImgId
The identification assigned to the watermark image that appears to the user for selection.

PhoneInfo_CType

PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.

Contains:
  • 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.

MobPhoneInfo_CType

MobPhoneInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

MobBB
Answers the question: Is the mobile phone a Blackberry? Canonical values are:
  • false
  • true
MobPrvdCode
The provider code for the mobile service.
MobPrvdCodeDesc
The description of the provider code for the mobile service.
MobPrvdDom
The domain of the provider of the mobile service.
MobSendTestText
Send a test text. Canonical values are:
  • false
  • true

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.

UsrConsmCredAddRs_MType

UsrConsmCredAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • UsrCred_CType
  • UsrNameSugArray_AType

Simple Elements

The following simple elements are contained within this message.

IMSSubj
The IMS subject.
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 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.

UsrCred_CType

UsrCred_CType is a complex CType element.

User Credentials in the form of a WS Security Token. http://www.oasis-open.org/committees/download.php/16782/wss-v1.1-spec-os-UsernameTokenProfile.pdf

UsrNameSugArray_AType

UsrNameSugArray_AType is an array AType element. This is an array of suggestions for user names from an IMS provider.

Contains:

  • UsrNameSugRec_CType

UsrNameSugRec_CType

UsrNameSugRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

UsrName
A user name assigned to a person.
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