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 Activity Inquiry

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

Customer Relationship Management Activity Inquiry

Customer Relationship Management Activity Inquiry is a jXchange service designed to inquire on CRM activities.

Message Flow

In jXchange, the Customer Relationship Management Activity Inquiry service uses a typical exchange of MType messages to inquire on CRM activities.

Primary Request

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

  • ActIntent
  • CRMActId
  • CRMActType

Primary Response

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

  • ActIntent
  • ActIntentKey

Customer Relationship Management Activity Inquiry Behavior

The CRMActInqRq_MType request message requires valid CRMActId and CRMActType elements. These requested elements can be obtained from the CRMActSrchRq_MType service.

The ActIntent element's default canonical value is ~ReadOnly~. The canonical values ~Upd~ or ~Dlt~ require the service provider to return the ActIntentKey element, which is used for the subsequent modification service with the adopted concurrency model.

The CRMActInqRs_MType response message returns the CRMActId and CRMActType elements.

CRMActInqRq_MType

CRMActInqRq_MType is a message MType element.

Contains:

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

CRMActId
The identification assigned to a CRM activity.
CRMActType
The type of CRM activity. Canonical values are:
  • All
  • Cmpgn
  • Mailing
  • Meet
    • The Meet canonical value is scheduled for deprecation. Effective date: 2018-01-01.
  • Msg
  • Note
  • Phone

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.

CRMActInqRs_MType

CRMActInqRs_MType is a message MType element.

Contains:

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

CRMActInqRec_CType

CRMActInqRec_CType is a complex CType element.

Contains:

  • CRMActInfoRec_CType
  • Custom_CType
  • x_MktCmpgnInfoArray

Simple Elements

The following simple elements are contained within this complex element.

ActCrtOffCode
The code assigned to the CRM officer.
ActCrtOffDesc
The description of the code assigned to the CRM officer.
ActCrtTimeDt
The time and date assigned to the creation of an activity.
CRMActId
The identification assigned to a CRM activity.
CRMActStatDesc
The description of the code assigned to the status of a CRM activity.
CRMActSumDesc
The description of the code that describes the summary/results of the CRM activity.
CRMActType
The type of CRM activity. Canonical values are:
  • All
  • Cmpgn
  • Mailing
  • Meet
    • The Meet canonical value is scheduled for deprecation. Effective date: 2018-01-01.
  • Msg
  • Note
  • Phone
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.

CRMRelCode
The code that describes the relationship a customer is to an account.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
MeetLocDesc
The description of the code of the location that a meeting was held.
PurpDesc
The purpose code description.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

CRMActInfoRec_CType

CRMActInfoRec_CType is a complex CType element.

Contains:

  • ActOffArray references CRMOffArray_AType
  • CRMRelEventInfo_CType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

Note:

The following elements should be used when CRMActType is set to Meet to convey the time and date for a CRM Activity.

  • MeetStartTimeDt
  • MeetEndTimeDt

This element deprecates as of 2026-01-01.

ActCrtTimeDt
The time and date assigned to the creation of an activity.
ActCmnt
A free format of comments as related to CRM activities and events.
ActCrtOffCode
The code assigned to the CRM officer.
ActExpDt
The expiration date of the activity.
CRAMeetType
Is the CRM activity related to a Community Reinvestment Act (CRA) meeting? Canonical values are:
  • true
  • false
CRMActDt
The date the activity was created.
CRMActRecv
Answers the question: Was the CRM activity received by the CRM assigned officer? Canonical values are:
  • false
  • true
CRMActStatCode
The code assigned to the status of a CRM activity.
CRMActStatDesc
The description of the code assigned to the status of a CRM activity.
CRMActSumCode
The code that describes the summary/results of the CRM activity.
CRMActTime

The time an activity was created.

Note: This element deprecates as of 2026-01-01.
MeetEndTimeDt
The date and time that designates the ending point for date/time selections.
MeetLocCode
The code of the location that a meeting was held.
MeetStartTimeDt
The date and time that designates the starting point for date/time selections.
PurpCode
Bank-defined and is used to define the purpose of the loan. Canonical values are:
  • CashOutRefi
  • HomeImprov
  • HomePurch
  • Oth
  • Refi
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
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.

ActOffArray

CRMOffArray_AType is an array AType element. This is an array of officers for the Customer Relationship Management service.

ActOffArray references CRMOffArray_AType.

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

CRMRelEventInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

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.

CRMEventType
The type of CRM event. It includes the JHANull and Rstr attributes. Canonical values are:
  • All
  • CustCon
  • Incen
  • Sale
  • Svc
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.

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.

x_MktCmpgnInfoArray_AType

x_MktCmpgnInfoArray_AType is an array AType element. This element is an array of marketing campaign information.

Contains:

  • MktCmpgnInfoRec_CType
MktCmpgnInfoRec_CType

MktCmpgnInfoRec_CType is a complex CType element.

Contains:

  • CRMProdArray_AType
  • Custom_CType
Simple Dictionary
MktCmpgnDesc
The description of the marketing campaign.
MktCmpgnEndDt
The date that designates the ending point for date selections.
MktCmpgnExpDt
The expiration date.
MktCmpgnId
The identification assigned to a CRM marketing campaign.
MktCmpgnName
The name given to a marketing campaign.
MktCmpgnStartDt
The date that designates the starting point for date selections.
MktCmpgnType

The status of an activity specific to the payment hub. Canonical values are:

  • PSO
  • Cmpgn
  • DynamicCmpgn
CRMProdArray_AType

CRMProdArray_AType is an array AType element. This element is an array of CRM products.

Contains:

  • CRMProdInfoRec_CType
CRMProdInfoRec_CType

CRMProdInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Dictionary
AcctTypeDesc
A description of the account type. It includes the Rstr attribute.
AcctType
The number or character that categorizes the AcctId.
CRMProdCode
The code that identifies a product type of account within an application.
CRMProdDesc
A description of the type of account. It includes the Rstr attribute.
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.

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 Wed Nov 8 2023