Customer Relationship Management Referral Search
Customer Relationship Management Referral Search
Customer Relationship Management Referral Search is a jXchange service designed to provide a listing of referrals related to a CRM customer.
Message Flow
In jXchange, the Customer Relationship Management Referral Search service uses a typical
exchange of MType messages to retrieve a list of referrals related to a
specific CRM customer.
Primary Request
The third-party consumer forwards the CRMReferSrchRq_MType message to the
service provider. The message contains:
- CustId
- EndDt
- StartDt
- TaxId
Primary Response
The service provider returns the CRMReferSrchRs_MType message to the
third-party consumer. The message contains an echo of the requested elements.
Customer Relationship Management Referral Search Behavior
The CRMReferSrchRq_MType
request message contains a documented choice statement where the elements at the root are
optional, but at least one of the elements is required. The AccountId_CType
complex, CustId element, and TaxId element are
available at the root request.
The CRMReferSrchRq_MType request message contains a documented filter
statement that contains the optional elements StartDt and
EndDt.
The CRM referral date search filters compare the ReferDt element found in the response.
A consumer request with a StartDt and without an EndDt returns all the qualified Customer Relationship Management (CRM) referral records with a date equal to and greater than the StartDt.
A consumer request with an EndDt and without a StartDt returns all the qualified Customer Relationship Management (CRM) referral records with a date equal to and less than the EndDt.
A consumer request with a StartDt and an EndDt returns all the qualified Customer Relationship Management (CRM) referral records with a date equal to and greater than the StartDt and a date equal to and less than the EndDt.
The CRMReferSrchRs_MType response message echoes the requested elements.
The CRMReferSrchArray_AType array returns all the items related to the CRM
referral requested documented choices. The response is returned in last in, first out (LIFO)
order.
The CRMReferSrchRec_CType
complex was constructed in a manner to support reuse of the CRMReferInfoRec_CType complex for future addition
and modification services. The CRMReferSrchRec_CType complex contains the Rstr
attribute.
The service provider must adhere to the established tenets for user accessibility policy. The service provider cannot apply user accessibility policies when the consumer does not include the end-user credentials.
CRMReferSrchRq_MType
CRMReferSrchRq_MType is a message
MType element.
Contains:
AccountId_CTypeCustom_CTypeIncXtendElemArray_ATypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- EndDt
- The date that designates the ending point for date selections.
- ReferOffCode
- The code assigned to the CRM officer.
- StartDt
- The date that designates the starting point for date selections.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
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
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType is an array
AType element.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message 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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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.
CRMReferSrchRs_MType
CRMReferSrchRs_MType is a message
MType element.
Contains:
AccountId_CTypeCRMReferSrchArray_ATypeCustom_CTypeSrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- EndDt
- The date that designates the ending point for date selections.
- ReferOffCode
- The code assigned to the CRM officer.
- ReferStatCode
- The code assigned to the status of a CRM referral. Referral
statuses returned in Service Dictionary Search represent a one-to-one
relationship.
- Act, Return All Referrals not in a terminating area
- Esclt, Return All Escalated Referrals (Date Escalated is populated and status is not considered)
- AltEsclt, Return All Active/Escalated Referrals (Date Escalated is populated and Referrals are in an Active status)
- Ter, Return Referrals that are in a terminating status
The default if you do not input a value is Act, Return All Referrals.
- StartDt
- The date that designates the starting point for date selections.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
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
CRMReferSrchArray_AType
CRMReferSrchArray_AType is an array
AType element. This is an array of responses for the Customer Relationship
Management referral activity search.
Contains:
CRMReferSrchRec_CType
CRMReferSrchRec_CType
CRMReferSrchRec_CType is a complex
CType element.
Contains:
AccountId_CTypeCRMReferInfoRec_CTypeCRMReferSrchCustomreferencesCustom_CTypePersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- ReferCrtOffDesc
- The description of the code assigned to the CRM officer.
- ReferId
- The identification assigned to a CRM referral.
- ReferOffDesc
- The description of the code assigned to the CRM officer.
- ReferStatDesc
- The description of the code assigned to the status of a CRM referral.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
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
CRMReferInfoRec_CType
CRMReferInfoRec_CType is a complex
CType element.
Contains:
CRMOffArray_ATypeCustom_CTypeUserDefInfoArray_AType
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.
- BrCode
- The branch code.
- CRMEventId
The identification assigned to a CRM event. It includes the JHANull and Rstr attributes.
Note:Use this element and
CRMEventTypefor the following complex elements:CRMActInqRs_MTypeCRMActInqRec_CTypeCRMActInfoRec_CTypeCRMRelEventInfo_CType
This element deprecates as of 2026-01-01.
- CRMOffCode
- The code assigned to the CRM officer. This element is Open
Enumerated to allow for display of a listing of all officer values. It includes
the OvrrdInstRtId attribute. There is one canonical value
used to identify the current user without having to find the current user's name
in the officer list. If
CRMOffCodeis populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:- CurUsr
- CRMPrivType
- Answers the question: Is the CRM entry private with a limited
number of recipients? Canonical values are:
- false
- true
- CRMProdCode
- The code that identifies a product type of account within an application.
- CustProdOwn
- Answers the question: Does the customer have ownership for a
specific product? It includes the
Rstrattribute. Canonical values are:- false
- true
- EscltDt
- The CRM Date Escalated Date.
- EventStatCode
The code related to the status of an event. Service Event statuses returned in Service Dictionary Search represent a one-to-one relationship. Use of one of the listed canonical values represents a one-to-many relationship. Canonical values are:
- Act, Return All Events not in a terminating area
- Esclt, Return All Escalated Events (Date Escalated is populated and status is not considered)
- AltEsclt, Return All Active/Escalated Events (Date Escalated is populated and Events are in an Active status
- Ter, Return Events that are in a terminating status
The default if you do not input a value is All, Return All Events.
- PotSaleId
- The identification assigned to a CRM potential sales opportunity.
- ReferBonusDueDt
- The date a referral is completed that could constitute a bonus to
the associate. It includes the
Rstrattribute. - ReferCmnt
- A free format of comments as related to CRM activities and events.
- ReferCrtOffCode
- The code assigned to the CRM officer.
- ReferDt
- The date a referral was created.
- ReferDueDt
- The referral due date. It includes the
Rstrattribute. - ReferOffCode
- The code assigned to the CRM officer.
- ReferRecv
- Answers the question: Was the CRM referral received by the CRM
assigned officer? Canonical values are:
- false
- true
- ReferStatCode
- The code assigned to the status of a CRM referral. Referral
statuses returned in Service Dictionary Search represent a one-to-one
relationship.
- Act, Return All Referrals not in a terminating area
- Esclt, Return All Escalated Referrals (Date Escalated is populated and status is not considered)
- AltEsclt, Return All Active/Escalated Referrals (Date Escalated is populated and Referrals are in an Active status)
- Ter, Return Referrals that are in a terminating status
The default if you do not input a value is Act, Return All Referrals.
- ReferTime
- The time a referral was received.
- 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
- SalesOffCode
- The code assigned to the CRM officer. This element is Open
Enumerated to allow for display of a listing of all officer values. There is
one canonical value used to identify the current user without having to find
the current user's name in the officer list. If
CRMOffCodeis populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:- CurUsr
- SalesPrivType
- Answers the question: Is the CRM entry private with a limited
number of recipients? Canonical values are:
- false
- true
- SalesStatCode
The code related to the status of an event. Service Event statuses returned in Service Dictionary Search represent a one-to-one relationship. Use of one of the listed canonical values represents a one-to-many relationship. Canonical values are:
- Act, Return All Events not in a terminating area
- Esclt, Return All Escalated Events (Date Escalated is populated and status is not considered)
- AltEsclt, Return All Active/Escalated Events (Date Escalated is populated and Events are in an Active status
- Ter, Return Events that are in a terminating status
The default if you do not input a value is All, Return All Events.
- WorkflowProcStat
- The element indicating whether a record is under the control of a
workflow process. Canonical values are:
- false
- true
The default value is false.
CRMOffArray_AType
CRMOffArray_AType is an array AType
element. This is an array of officers for the Customer Relationship Management
service.
Contains:
CRMOffRec_CType
CRMOffRec_CType
CRMOffRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- CRMOffCode
- The code assigned to the CRM officer. This element is Open
Enumerated to allow for display of a listing of all officer values. It includes
the OvrrdInstRtId attribute. There is one canonical value
used to identify the current user without having to find the current user's name
in the officer list. If
CRMOffCodeis populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:- CurUsr
- CRMOffDesc
- The description of the code assigned to the CRM officer.
- CRMOffCodeText
- The text that describes the proceeding elements for the CRM officer array.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
CRMReferSrchCustom
Custom_CType is a complex CType element.
CRMReferSrchCustom references Custom_CType.
This element is optional.
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 element 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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex
CType element. It searches
specific message response headers.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned.
Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be
larger than
MaxRec.
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.