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 Account Relationship Inquiry

Enterprise SOAP API > API by Reference > Core Services > Customer Account Relationship Inquiry

Customer Account Relationship Inquiry

Customer Account Relationship Inquiry is a jXchange service designed to provide the consumer with the ability to inquire on the account identifications related to the specific customer identification.

Message Flow

In jXchange, the Customer Account Relationship Inquiry service uses a typical exchange of MType messages to inquire on the account identifications related to the specific customer identification.

Primary Request

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

  • CustId

Primary Response

The service provider returns the CustAcctRelInqRs_MType message to the third-party consumer. The message contains an echo of the requested elements.

Customer Account Relationship Inquiry Behavior

The CustId element is required in the request.

The CustAcctRelInqRs_MType response message contains two arrays. The CustBalInfoRecArray_AType array provides the summarized balances for the account identifications related to the customer identification. The CustAcctRelInqRecArray_AType array provides the detail account identifications related to the customer identification.

The CustBalInfoRecArray_AType array encapsulates the explicitly defined application types count, amounts, and weighted average rates. The CustRelType element provides the key that designates counts, balances, and weighted average rates representation and is a required element. The canonical values for CustRelType are Direct, Indirect, and Related.

The CustAcctRelInqRecArray_AType array encapsulates the individual account identifications related to the customer identification. The CustAcctRelInqRecArray_AType array reuses the CustRelRec_CType complex that is encapsulated by the Customer Relationship Addition and Modification services. The AccountID_CType complex is required.

CustAcctRelInqRq_MType

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

CustId
The identifier attached to a customer.

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

CustAcctRelInqRs_MType

CustAcctRelInqRs_MType is a message MType element.

Contains:

  • BenflOwnRecArray_AType
  • CustAcctRelInqRecArray_AType
  • CustBalInfoRecArray_AType
  • 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.
CustId
The identifier attached to a customer.

BenflOwnRecArray_AType

BenflOwnRecArray_AType is an array AType element. This is an array of beneficial owners for FinCEN Customer Due Diligence (CDD).

Contains:

  • BenflOwnRec_CType

BenflOwnRec_CType

BenflOwnRec_CType is a complex CType element.

Contains:

  • BenflOwnInfo_CType
Simple Elements

The following simple elements are contained within this complex.

BenflOwnId
Identifies which beneficial owner record.
RmvBenflOwnDt
The date the beneficial owner was removed, as it relates to FinCEN Customer Due Diligence (CDD).
BenflOwnInfo_CType

BenflOwnInfo_CType is a complex CType element.

Contains:

  • Addr_CType
  • IdVerifyArray_AType
  • PersonName_CType
Simple Elements

The following simple elements are contained within this complex.

BenflOwnPct
The percentage that is owned.
BenflOwnType
The type of beneficial ownership as it relates to FinCEN Customer Due Diligence (CDD). Canonical values are:
  • Cntl - Controlling individual/significant responsibility
  • Own - Beneficial owners
  • CntlOwn - Both controlling individual and beneficial owner
BirthDt
The date of birth.
CntlIndivTitle
Title of the individual with significant responsibility to control, manage, or direct a legal entity customer, as defined by FinCEN Customer Due Diligence (CDD).
CustId
The identifier attached to a customer.
Dlt
The delete element. Canonical values are:
  • false
  • true
PassPortIssCntry
The passport issuance country.
TaxId
The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
TINCode
The code that designates the type of tax identification number.
Addr_CType

Addr_CType is a complex CType element containing address information. This element is optional.

Contains:

  • FreeFormAddr_AType
Simple Elements

The following simple elements are contained within this complex.

BusAddr
Answers the question: Is this a business address? Y states it is a business address.
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
County
The county name.
DlvryPt
The delivery point added to the zip.
FornAddr
Is this a foreign address? Y states it is a foreign address.
InvAddr
Is this address invalid? Y states mail has been returned from this address.
PostalCode
The postal code or ZIP code.
StateCode
The 2 alpha long code which represents a state. For example, MO.
StateProv
The state or province or region.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
StreetAddr3
The third line of street address.
FreeFormAddr_AType

FreeFormAddr_AType is an array AType element. This is an array of free form address lines 1–11 in a printable/usable form.

Contains:

  • AddrLineInfo_CType
AddrLineInfo_CType

AddrLineInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AddrLine
Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
IdVerifyArray_AType

IdVerifyArray_AType is an array AType element. This is an array of simple elements used to define identification of verification values.

Contains:

  • IdVerify_CType
IdVerify_CType

IdVerify_CType is a complex CType element. This element contains basic identification verification information and is optional.

Simple Elements

The following simple elements are contained within this complex.

IdIssueBy
The individual that issued the identification value IdVerifyId.
IdVerifyBy
The individual that verified the authenticity of the identification value IdVerifyId.
IdVerifyCode
The identification code that is used to authenticate the customer.
IdVerifyDesc
The description of the identification code that is used to authenticate the customer.
IdVerifyVal
The identification value that is used to authenticate the customer.
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 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.

CustAcctRelInqRecArray_AType

CustAcctRelInqRecArray_AType is an array AType element. This is an array of accounts/drafts related to a specific customer.

Contains:

  • CustAcctRelInqRec_CType

CustAcctRelInqRec_CType

CustAcctRelInqRec_CType is a complex CType element.

Contains:

  • AccountId_CType
  • CustomCustAcctRelInqRec references Custom_CType
  • CustRelRec_CType
  • Rmk_AType
Simple Elements

The following simple elements are contained within this complex.

AcctRelDesc
The description of the code that describes the relationship a customer has to an account.
AvlBal
The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
ColBal
The collected balance.
CurBal
The current balance.
CustId
The identifier attached to a customer.
IdVerifyRsnDesc
The description reason the beneficial owner information was verified as it relates to FinCEN Customer Due Diligence (CDD) regulation.
ProdCode
The code that identifies a product type of account within an application.
ProdDesc
Description of the type of account.
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
CustomCustAcctRelInqRec

Custom_CType is a complex CType element.

CustomCustAcctRelInqRec references Custom_CType.

This element is optional.

CustRelRec_CType

CustRelRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AcctRelCode
The code that describes the relationship a customer has to an account.
AmtOwned
The amount that is owned.
CopyRelCustMail
Answers the question: Would you like a copy of all related customer mailings? This element is optional and defaults to N when absent. Canonical values are:
  • N
  • Y
FDICCat
FDIC Category where:
  • CP - Corporate/Partnership
  • EB - Employee Benefits
  • IR - Retirement
  • IT - Irrevocable Trust
  • JO - Joint
  • PU - Public Unit
  • RT - Revocable trust
  • SO - Single

Canonical values are:

  • CP
  • EB
  • IR
  • IT
  • JO
  • PU
  • RT
  • SO
FDICMrgAcct
Old account number prior to merger of financial institution.
FDICMrgDt
Date the merger of the account took place.
IdVerifyBy
The individual that verified the authenticity of the identification value IdVerifyId.
IdVerifyRsnCode
The reason code the beneficial owner information was verified as it relates to FinCEN Customer Due Diligence (CDD).
LegalEntityId
The customer's Legal Entity Identifier (LEI)
OvrFDICInsurLmt
Over FDIC insurance limit. There are three canonical values:
  • Exmp - exempt from coverage
  • false - FDIC insured because they were under the limit
  • true - not covered because they are over the limit

false is the default.

PctOwned
The percentage that is owned.
PrtPastDueNotCode
Print past due notice.
StopACHItems
Stop ACH items. Canonical values are:
  • false
  • true
VerifyDt
Date of verification of beneficial owners as it relates to FinCEN Customer Due Diligence (CDD).
Rmk_AType

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.

CustBalInfoRecArray_AType

CustBalInfoRecArray_AType is an array AType element. This is an array of summary balances categorized by relationships.

Contains:

  • CustBalInfoRec_CType

CustBalInfoRec_CType

CustBalInfoRec_CType is a complex CType element.

Contains:

  • CustomCustBalInfoRec references Custom_CType
Simple Elements

The following simple elements are contained within this complex.

CustRelType
The type of high-level relationship accounts/drafts have to a specific customer. Canonical values are:
  • Direct
  • Indirect
  • Related
DepAcctBalAmt
The balances of deposits, drafts, savings, and/or time deposits accounts as related to a customer.
DepAcctNum
The count of deposits, drafts, savings, and/or time deposits accounts as related to a customer.
DepAcctRate
The weighted average of deposits, drafts, savings, and/or time deposits accounts as related to a customer.
LiabAcctBalAmt
The number of accounts that a customer can be liable to the FI for, regardless of any outstanding balance.
LiabAcctNum
The number of accounts that a customer can be liable to the FI for, regardless of any outstanding balance.
LiabAcctRate
The weighted average of accounts that a customer can be liable to the FI for, regardless of any outstanding balance.
LnAcctBalAmt
The balance of loan accounts related to a customer.
LnAcctNum
The count of loan accounts related to a customer.
LnAcctRate
The weighted average of loan accounts related to a customer.
OthAcctNum
The number of accounts related to a customer that cannot be categorized as a deposit/draft/loan.
CustomCustBalInfoRec

Custom_CType is a complex CType element.

CustomCustBalInfoRec references Custom_CType.

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