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

Customer Relationship Management Referral Inquiry

Enterprise SOAP API > API by Reference > Customer Relationship Management > Customer Relationship Management Referral Inquiry

Customer Relationship Management Referral Inquiry

Customer Relationship Management Referral Inquiry is a jXchange service designed to provide the consumer with the ability to inquire on referrals related to the specific customer identification.

Message Flow

In jXchange, the Customer Relationship Management Referral Inquiry service uses a typical exchange of MType messages to inquire on referrals related to the specific customer identification.

Primary Request

The third-party consumer forwards the CRMReferInqRq_MType message to the service provider. The message contains:

  • ActIntent
  • ReferId

Primary Response

The service provider returns the CRMReferInqRq_MType message to the third-party consumer. The message contains:

  • ActIntent
  • ActIntentKey

Customer Relationship Management Referral Inquiry Behavior

The CRMReferInqRq_MType request message requires a valid ReferId element. The requested elements can be obtained from the CRMReferSrchRq_MType service. The ActIntent element's default canonical value is ~ReadOnly~. The canonical values ~Upd~ and ~Dlt~ require the service provider return the ActIntentKey element, which is used for the subsequent modification service with the adopted concurrency model.

The CRMReferInqRs_MType response message returns the elements related to the ReferId element.

The standard inquiry message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

CRMReferInqRq_MType

CRMReferInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElemArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ReferId
The identification assigned to a CRM referral.

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 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.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element. This is an array that lists x_ elements by name, which are to be included in the response.

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.

CRMReferInqRs_MType

CRMReferInqRs_MType is a message MType element.

Contains:

  • CRMReferInqRec_CType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

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

CRMReferInqRec_CType

CRMReferInqRec_CType is a complex CType element.

Contains:

  • CRMReferInfoRec_CType
  • Custom_CType
  • x_CRMAuditHistArray_AType

Simple Elements

The following simple elements are contained within this complex.

AcctTypeDesc
A description of the account type. It includes the Rstr attribute.
BrDesc
A description of the branch name. It includes the Rstr attribute.
CRMProdDesc
A description of the type of account. It includes the Rstr attribute.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
CustRelCode

The code that references the type of relationship one customer has with another customer. This element is a hybrid open enumeration. Canonical values are:

  • Prim - Primary
  • Joint - Joint
  • Bus - Business

Leave the element blank for UNK - Unknown.

ModOffCode
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 CRMOffCode is populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:
  • CurUsr
ModOffDesc
The description of the code assigned to the CRM officer.
ModTimeDt
The date/time stamp a record was modified.
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, and SrchType attributes.

CRMReferInfoRec_CType

CRMReferInfoRec_CType is a complex CType element.

Contains:

  • CRMOffArray_AType
  • Custom_CType
  • UserDefInfoArray_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 CRMEventType for the following complex elements:

  • CRMActInqRs_MType
  • CRMActInqRec_CType
  • CRMActInfoRec_CType
  • CRMRelEventInfo_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 CRMOffCode is 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 Rstr attribute. 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 Rstr attribute.
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 Rstr attribute.
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 CRMOffCode is 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 CRMOffCode is 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 UserDefCode represents.
UserDefDt
A date field that has a relationship with the UserDefTxt or UserDefCode.
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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_CRMAuditHistArray_AType

x_CRMAuditHistArray_AType is an array AType element. This element is an array of audit history responses.

Contains:

  • CRMAuditHistRec_CType
CRMAuditHistRec_CType

CRMAuditHistRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Dictionary
ChngDesc
The description of the change applied to a record.
ModOffCode
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 CRMOffCode is populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:
  • CurUsr
ModOffDesc
The description of the code assigned to the CRM officer.
ModTimeDt
The date/time stamp a record was modified.
NewVal
If a value has changed, this is the resulting new value.
PrevVal
The previous value of a name value pair.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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.
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 Thu Feb 8 2024