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

Entity Match Batch Status Inquiry

Enterprise SOAP API > API by Reference > Fraud Services > Entity Match Batch Status Inquiry

Entity Match Batch Status Inquiry

Entity Match Batch Status Inquiry is a jXchange service designed to allow consumers to check the status of a previously-submitted batch entity match request.

Message Flow

In jXchange, the Entity Match Batch Status Inquiry service uses a typical exchange of MType messages to allow consumers to check the status of a previously-submitted batch entity match request.

Primary Request

The consumer forwards the EntityMatchBatchStatusInqRq_MType message to the service provider. The message contains the following simple element:

  • EntityBatchRefId

Primary Response

The service provider returns the EntityMatchBatchStatusInqRs_MType message to the consumer. The message contains the following simple elements:

  • EntityBatchStat
  • RsStat

Entity Match Batch Status Inquiry Behavior

The Entity Match Batch Status Inquiry root request (EntityMatchBatchStatInqRq_MType) requires a valid Entity Batch Reference Identifier (EntityBatchRefId).

The Entity Match Batch Status Inquiry root response (EntityMatchBatchStatInqRs_MType) includes the Entity Batch Status (EntityBatchStat). The root response can include the Entity Match Batch Response Record complex (EntityMatchBatchRsRec_CType) if the entity match request represented by the Entity Batch Reference Identifier (EntityBatchRefId) was for an ACH batch request and the status of the request is complete.

The Entity Match Batch Response Record complex (EntityMatchBatchRsRec_CType) encapsulates the Entity Confidence Score (EntityConfdScore), Entity Batch Reference Identifier (EntityBatchRefId), Entity List Date (EntityListDt), Entity List Code Array (EntityListCodeArray_AType), and Entity Match Batch Array (EntityMatchBatchArray_AType).

The Entity Match Batch Array (EntityMatchBatchArray_AType) contains the Entity Match Batch Record complex (EntityMatchBatchRec_CType) which contains the Entity Name (EntityName), Street Address 1 (StreetAddr1), Street Address 2 (StreetAddr2), City (City), State Code (StateCode), Country Type (CntryType), White List Type (WhiteListType), Entity ACH Identifier (EntityACHId), Entity List Date (EntityListDt), Entity List Code Array (EntityListCodeArray_AType), Entity Array (EntityArray_AType), and Blocked Country Array (BlkCntryArray_AType).

The Entity Batch Status (EntityBatchStat) canonical values are Err, Cmplt, or Proc.

EntityMatchBatchStatInqRq_MType

EntityMatchBatchStatInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

EntityBatchRefId
A unique identification provided by the entity matching application when a request for batch is queued.

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.

EntityMatchBatchStatInqRs_MType

EntityMatchBatchStatInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • EntityMatchBatchRsRec_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

EntityBatchStat
The status related to an entity matching batch request. Canonical values are:
  • Cmplt
  • Err
  • Proc
RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

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.

EntityMatchBatchRsRec_CType

EntityMatchBatchRsRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EntityListCodeArray_AType
  • EntityMatchBatchArray_AType
Simple Elements

The following simple elements are contained within this complex.

EntityBatchRefId
A unique identification provided by the entity matching application when a request for batch is queued.
EntityConfdScore
The value given to an entity based on the confidence of a match related to that entity.
EntityListDt
The date a source published the list code.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityListCodeArray_AType

EntityListCodeArray_AType is an array AType element. This is an array of entity list codes.

Contains:

  • EntityListCodeRec_CType
EntityListCodeRec_CType

EntityListCodeRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

EntityListAgencyDesc
The description of the code that represents a published list of entity names typically managed by a governmental agency.
EntityListDesc
The description of the code that represents a published list of entity names typically managed by a governmental agency.
EntityListType
The type assigned to an entity list. Canonical values are:
  • OFAC
  • FinCEN
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityMatchBatchArray_AType

EntityMatchBatchArray_AType is an array AType element. This is an array of responses for entity matching search.

Contains:

  • EntityMatchBatchRec_CType
EntityMatchBatchRec_CType

EntityMatchBatchRec_CType is a complex CType element.

Contains:

  • BlkCntryArray_AType
  • Custom_CType
  • EntityArray_AType
  • EntityListCodeArray_AType
Simple Elements

The following simple elements are contained within this complex.

City
The city name.
CntryType
The country abbreviation from ISO 3166.
EntityACHId
The identification given to an entity.
EntityListDt
The date a source published the list code.
EntityName
The common name. This is the full text line name like John Doe.
StateCode
The 2 alpha long code which represents a state. For example, MO.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
WhiteListType
Whether the entity appears on an applications white list.
  • True
  • False
BlkCntryArray_AType

BlkCntryArray_AType is an array AType element. This is an array of blocked countries.

Contains:

  • BlkCntryRec_CType
BlkCntryRec_CType

BlkCntryRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

Cntry
The country name.
CntryConfdScore
The value given to an entity based on the confidence of a match related to that entity.
CntryType
The country abbreviation from ISO 3166.
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.

EntityArray_AType

EntityArray_AType is an array AType element. This is an array of entities.

Contains:

  • EntityRec_CType
EntityRec_CType

EntityRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EntityAddrArray_AType
  • EntityAliasArray_AType
  • EntityIdArray_AType
  • EntityNatPgmArray_AType
Simple Elements

The following simple elements are contained within this complex.

AddrExactMatchType
Was the entity type an exact match? Canonical values are:
  • True
  • False
AliasExactMatchType
Was the entity type an exact match? Canonical values are:
  • True
  • False
ComName
The common name. This is the full text line name like John Doe.
EntityConfdScore
The value given to an entity based on the confidence of a match related to that entity.
EntityId
The identification given to an entity.
EntitySrcId
The identification given to an entity by the source of record.
EntityType
The entity type used for entity matching services. This is a hybrid enumeration due to reporting agencies. Canonical values are:
  • Aircraft
  • Bus
  • Indv
  • Vesl
FirstName
The first name.
IdExactMatchType
Was the entity type an exact match? Canonical values are:
  • True
  • False
LastName
The last name.
Rmk
Application or user remarks free-form text.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityAddrArray_AType

EntityAddrArray_AType is an array AType element. This is an array of addresses related to an entity.

Contains:

  • EntityAddrRec_CType
EntityAddrRec_CType

EntityAddrRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EntityAddr references Addr_CType
Simple Elements

The following simple elements are contained within this complex.

AddrConfdScore
The value given to an entity based on the confidence of a match related to that entity.
Rmk
Application or user remarks free-form text.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityAddr

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

EntityAddr references Addr_CType.

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

EntityAliasArray_AType is an array AType element. This is an array of aliases related to an entity.

Contains:

  • EntityAliasRec_CType
EntityAliasRec_CType

EntityAliasRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AliasConfdScore
The value given to an entity based on the confidence of a match related to that entity.
AliasName
The common name. This is the full text line name like John Doe.
AliasType
The specific type of alias. Canonical values are:
  • AKA
  • FKA
  • NKA
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityIdArray_AType

EntityIdArray_AType is an array AType element. This is an array of identifications related to an entity.

Contains:

  • EntityIdRec_CType
EntityIdRec_CType

EntityIdRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

IDConfdScore
The value given to an entity based on the confidence of a match related to that entity.
IdIssCntry
The country name.
IDName
The name of a name value pair.
IdVal
The identification value.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityNatPgmArray_AType

EntityNatPgmArray_AType is an array AType element. This is an array of entity national program names.

Contains:

  • EntityNatPgmRec_CType
EntityNatPgmRec_CType

EntityNatPgmRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple element is within this complex.

SpecDesigNatPgm
The specially designated nationals list program name.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityListCodeArray_AType

EntityListCodeArray_AType is an array AType element. This is an array of entity list codes.

Contains:

  • EntityListCodeRec_CType
EntityListCodeRec_CType

EntityListCodeRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

EntityListAgencyDesc
The description of the code that represents a published list of entity names typically managed by a governmental agency.
EntityListDesc
The description of the code that represents a published list of entity names typically managed by a governmental agency.
EntityListType
The type assigned to an entity list. Canonical values are:
  • OFAC
  • FinCEN
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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