User Enrollment Inquiry
User Enrollment Inquiry is designed to allow a consumer to determine if an end user is enrolled in a specific application.
Message Flow
Message flow involves the exchange of
messages containing XML complex data of type MType
between the Third Party
Consumer and the Service Provider.
Primary Request
In the User Enrollment Inquiry
request, the Third Party Consumer transmits (or sends) the message UsrEnrollInqRq_MType
containing
multiple simple and complex elements.
Primary Response
In the User Enrollment Inquiry
response, the Service Provider returns the message UsrEnrollInqRs_MType
containing
multiple simple and complex elements.
User Enrollment Inquiry Behavior
Overview
The request allows for the submission of Customer
Identification, CustID
,
or the Account Identification, AccountId_CType
. However, both
are optional. The Service Provider returns a fault if a request is made
without at least one of the elements.
A request made with the Customer Identification and Account Identification conveys to the service provider to return the enrollment status at the account identification level rather than the customer identification level.
A service provider does not create a fault if the
requested customer or account is not enrolled in the application, but does
create a false value for the Enrollment User element EnrollUsr
. This rule also applies
if the submitted customer or account does not exist in the service
provider's repository. However, the service provider reserves the right to
return the response to jXchange with a warning.
The Enrollment Application Type, EnrollAppType
, provides jXchange
with the routing information for the destination of the message. The
Enrollment Application Type is a closed enumerator with canonical values.
The first release of this message only provides one canonical value for VR
(Voice Response). jXchange routes the UsrEnrollInqRq
message to the
installation's installed Voice Response. However, as the canonical values
increase, jXchange will need to aggregate the response as one message
wrapped in the array to the consumer.
A warning is returned in the response by jXchange if a consumer makes a request for a specific enrollment application type that does not exist at a given installation.
A fault is not created in the response when the Enrollment Application Type is submitted for an application not installed at a given installation. Not creating a fault allows jXchange to create successful responses when multiple Enrollment Application types are submitted in the array and one or more of the submitted Enrollment Application types are installed at a given installation.
A User Enrollment Inquiry request submitted without
an Enrollment Application Type, EnrollAppType
, conveys to
jXchange to submit a message for each canonical value provided in the
Enrollment Application Type element.
The Enrollment Application Type,EnrollAppType
, is not a
representation of JHA products but applications. For example: the
Enrollment application type might have a value for Internet Banking and
Electronic Statements. The product, for example, NetTeller, might be the
product that supports both of these applications at a given
installation.
UsrEnrollInqRq_MType
UsrEnrollInqRq_MType
is a message
MType
element.
Contains:
AccountId_CType
EnrollAppInqArray_AType
MsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- CustId
- The identifier attached to a customer.
AccountId_CType
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
EnrollAppInqArray_AType
EnrollAppInqArray_AType
is an array
AType
element. This is an array of installed applications
for a financial institution.
Contains:
EnrollAppInqInfo_CType
EnrollAppInqInfo_CType
EnrollAppInqInfo_CType
is a complex
CType
element.
Simple Elements
The simple elements contained within this complex are listed below.
- EnrollAppType
- The name applications provided by service providers. Canonical value is:
- VR
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
UsrEnrollInqRs_MType
UsrEnrollInqRs_MType
is a message
MType
element.
Contains:
AccountId_CType
EnrollAppInqRsArray_AType
MsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- CustId
- The identifier attached to a customer.
AccountId_CType
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
EnrollAppInqRsArray_AType
EnrollAppInqRsArray_AType
is an
array AType
element. This is an array of responses to
convey the applications in which a customer is enrolled.
Contains:
EnrollAppInqRsInfo_CType
EnrollAppInqRsInfo_CType
EnrollAppInqRsInfo_CType
is a
complex CType
element.
Simple Elements
The simple elements contained within this complex are listed below.
- EnrollAppType
- The name applications provided by service providers. Canonical value is:
- VR
- EnrollUsr
- Answers the question: Is the customer or account the user of the JHA application?
Canonical values are:
- false
- true
- LastActDt
- The date of last activity
- PrvdFamName
- The category or group that the event owner is associated with.
Canonical values are:
- Card Services
- CkImg
- Core
- CrCardServices
- DocImg
- Fraud
- HumanCapMgmt
- JES
- OLB
- PltFm
- Wires
- VR
- PrvdName
- The owner name who submitted an event. Canonical values are:
- CIF2020
- CyberIntel
- Episys
- iTalk
- jXchange
- ODI
- Passport
- SilverLake
- YellowHammer
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-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 Soap Header Fault 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.
User Enrollment Services Business Case
User Enrollment Services Illustration
A consumer is interested if their customer (Sam Man)
is enrolled in a Voice Response application and an Internet Banking
application. They construct a User Enrollment Inquiry Request, UsrEnrollInqRq
, requesting that
information. jXchange receives the message and interrogates the Enrollment
Application Type element, EnrollAppType
, to determine the
route of the message. jXchange constructs two requests because the routing
requires delivery of the message to different service providers.
Enrollment User Inquiry Request Consumer Request and jXchange Aggregation (Detail)
The respective service providers respond to the
message request and deliver the User Enrollment Inquiry Response, UsrEnrollInqResponse
, to
jXchange. jXchange aggregates the responses from the two different service
providers to one message to be delivered to the consumer.
Enrollment User Inquiry Response jXchange Aggregation and Service Provider Response (Detail)
The response to the message in an installation that does not support some of the service providers differs from the previous illustration. The following illustrates an installation that does not support an Internet Banking Service Provider.
Enrollment User Inquiry Response With Limited Service Providers jXchange Aggregation and Service Provider Response (Detail)