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

Account Search

Enterprise SOAP API > API by Reference > Core Services > Account Search

Account Search

Account Search is a jXchange service designed to search for the accounts that are related to a customer.

Message Flow

In jXchange, the Account Search service uses a typical exchange of MType messages to search for the accounts that are related to a customer on a service provider.

Primary Request

The consumer forwards the AcctSrchRq_MType message to the service provider. The message contains the following complex elements:

  • Custom_CType
  • PersonName_CType
  • SrchMsgRqHdr_CType
  • SvcPrvdInfo references AcctSrchRq_EType

The message contains the following array:

  • IncXtendElem_AType

The message contains the following simple elements:

  • AcctId
  • AcctType
  • AvlBalCalcCode
  • BrandCode
  • CustId
  • FirstName
  • LastName
  • TaxId

Primary Response

The service provider returns the AcctSrchRs_MType message to the consumer. The message contains the following complex elements:

  • Custom_CType
  • PersonName_CType
  • SrchMsgRsHdr_CType

The message contains the following array:

  • AcctSrchRecArray_AType

The message contains the following simple elements:

  • AcctId
  • AcctType
  • AvlBalCalcCode
  • BrandCode
  • CustId
  • TaxId

Account Search Behavior

Search message request filter elements are decorated with an attribute that clearly conveys to the service provider the search expression. The SrchType attribute is enumerated with the values: Exact, StartsWith, EndsWith, and Contains. These values could evolve based on industry standard operand expressions.

Service providers may adopt this tenet at the earliest mutually agreed upon time for each search message. A service provider cannot require exact case matches. For example, if a consumer submits a last name data value of mcgrath, the service provider responds with any data values that match regardless of case. The response could include, but is not limited to: McGrath, Mcgrath, mcgrath, MCGRATH, or any combination of case difference thereafter.

Not all search message request filters qualify for wild-card searches. These filters include, but are not limited to: enumerated elements, key elements, and range selection elements.

The request provides the following new filters in the request:

  • LastName - The SrchType attribute supported canonical values are: ~Exact, StartsWith, Contains~. The default value is StartsWith.
  • FirstName - The SrchType attribute supported canonical values are: ~Exact, StartsWith. The default value is StartsWith.
  • ComName - The SrchType attribute supported canonical values are: ~Exact, StartsWith. The default value is StartsWith.
  • MiddleName - The SrchType attribute supported canonical values are: ~Exact, StartsWith. The default value is StartsWith.
  • TaxId - The SrchType attribute supported canonical value is Exact.

When there is more than one filter on the request, then the selection is based on and rather than or.

A service provider returns a fault when the root request does not include at least one of the following elements: CustId, LastName, or TaxId.

The Available Balance Calculation Code (AvlBalCalcCode) is optional on the request.

The PersonName_CType is only included in the response when the elements included in the PersonName_CType are present in the request.

The CustSrchRec_CType only returns one time even if the customer has multiple addresses that match the requested filters. For example, when a request is made for Elm Street (<SrchAddr>Elm Street</SrchAddr>) and the Address Category is All (<AddrCat>All</AddrCat>) and a customer has multiple address matches, then the customer is only returned one time.

A service provider must compare all address lines per each category when a service provider's address database contains multiple address lines.

AcctSrchRq_MType

AcctSrchRq_MType is a message MType element. This element is optional.

Contains:

  • SvcPrvdInfo references AcctSrchRq_EType
  • Custom_CType
  • IncXtendElemArray_AType
  • PersonName_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
BrandCode
The code that defines the brandings.

This is an optional filter.

AvlBalCalcCode
A code that would convey to the service provider the method to use for the calculation of the available balance.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
FirstName
The first name.
LastName
The last name.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

SvcPrvdInfo

AcctSrchRec_EType is available only for JHA Consumers.

SvcPrvdInfo references AcctSrchRec_EType.

Contains:

  • JHAConsumer references AcctSrchRec_JIS_CType

JHAConsumer

AcctSrchRec_JIS_CType is a complex CType element.

JHAConsumer references AcctSrchRec_JIS_CType.

Simple Elements

The following simple elements are contained within this complex.

AvlBal
The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
ColBal
The collected balance.
CurPayOff
The current payoff amount.
MatDt
The maturity date.
NxtPayDt
The next payment date.
PlnCode
The service provider code that represents plan products for different plan types.
PlnDesc
The description of service provider code that represents plan products for different plan types.
PmtAmtDue
The payment amount due.
PmtAmt
The payment amount.

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.

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.

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message 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.
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_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.

AcctSrchRs_MType

AcctSrchRs_MType is a message MType element.

Contains:

  • AcctSrchRecArray_AType
  • Custom_CType
  • PersonName_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
AvlBalCalcCode
A code that would convey to the service provider the method to use for the calculation of the available balance.
BrandCode
The code that defines the brandings.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
FirstName
The first name.
LastName
The last name.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

AcctSrchRecArray_AType

AcctSrchRecArray_AType is an array AType element. This array contains the responses for an account search.

Contains:

  • AcctSrchRec_CType

AcctSrchRec_CType

AcctSrchRec_CType is a complex CType element.

Contains:

  • AccountId_CType
  • CustomAcctSrchRec references Custom_CType
  • PersonName_CType
  • SvcPrvdInfo references AcctSrchRec_EType
  • x_CondNotInfoRec_CType
Simple Elements

The following simple elements are contained within this complex.

AcctRelCode
The code that describes the relationship a customer has to an account.
AcctRelDesc
The description of the code that describes the relationship a customer has to an account.
AcctStatDesc
The account status description.
AcctStat
The account status.
Amt
The amount or quantity.
AvlBal
The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
BrandCode
The code that defines the brandings.
BrandDesc
The description of the code that defines the brandings.
CurPayOff
The current payoff amount.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
MatDt
The maturity date.
NxtPayDt
The next payment date.
PmtAmtDue
The payment amount due.
PmtAmt
The payment amount.
ProdCode
The code that identifies a product type of account within an application. Canonical values are:
  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

ProdDesc
Description of the type of account.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
TINCode
The code that designates the type of tax identification number. Canonical values are:
  • SSN
  • EIN
  • Forn

TINCode is a hybrid open enumeration.

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
CustomAcctSrchRec

Custom_CType is a complex CType element.

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

AcctSrchRec_EType is available only for JHA Consumers.

SvcPrvdInfo references AcctSrchRec_EType.

Contains:

  • JHAConsumer references AcctSrchRec_JIS_CType
JHAConsumer

AcctSrchRec_JIS_CType is a complex CType element.

JHAConsumer references AcctSrchRec_JIS_CType.

Simple Elements

The following simple elements are contained within this complex.

AvlBal
The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
ColBal
The collected balance.
CurPayOff
The current payoff amount.
MatDt
The maturity date.
NxtPayDt
The next payment date.
PlnCode
The service provider code that represents plan products for different plan types.
PlnDesc
The description of service provider code that represents plan products for different plan types.
PmtAmtDue
The payment amount due.
PmtAmt
The payment amount.
x_CondNotInfoRec_CType

x_CondNotInfoRec_CType is a complex CType element.

Contains:

  • CondNotfArray_AType
  • Custom_CType
CondNotfArray_AType

CondNotfArray_AType is an array AType element. This is an array of condition notifiers used to define conditional notification status.

Contains:

  • CondNotfInfo_CType
CondNotfInfo_CType

CondNotfInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CondNotf
The conditions that exist on an account or customer to notify the consumer to use another service. Canonical values:
  • AcctAnlys
  • AcctCombStmt
  • AcctProdOvrrd
  • AcctRecon
  • AcctSweep
  • ACHEDI
  • AddrAcct
  • AddrIRSRpt
  • AddrNot
  • AddrOvrrd
  • AddrPmts
  • AddrSeasonal
  • AddrStmt
  • AlertMsg
  • CollatMsg
  • CollatTrack
  • ColMsg
  • EnhAcctAnlys
  • Escrw
  • FASB91
  • FraudAlert
  • InstDefFld
  • LnPmtSched
  • LnRateSched
  • LnUnit
  • LineOfCr
  • MemoPost
  • Msg
  • ODProt
  • PlnBenf
  • RealEstateProp
  • StopAlerts
  • StopHold
  • StopPay
  • Stops
  • StopSpecInstr
  • TimeDepRenOvrrd
  • XferACH
  • XferFut
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.

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.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_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_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 Mon Jan 24 2022