Entity Match Batch Inquiry
Entity Match Batch Inquiry
Entity Match Batch Inquiry is a jXchange service designed to allow consumers to submit a batch of entity values for screening with agencies' entity values.
Message Flow
In jXchange, the Entity Match Batch Inquiry service uses a typical exchange of
MType messages to allow
consumers to submit a batch of entity values for screening with agencies' entity values.
Primary Request
The consumer forwards the EntityMatchBatchInqRq_MType
message to the service provider. The message contains the following simple elements:
- BirthDtTolr
- EntityBatchSrcType
- EntityConfdScore
Primary Response
The service provider returns the EntityMatchBatchInqRs_MType
message to the consumer. The message contains the following simple elements:
- BirthDtTolr
- EntityBatchRefId
- EntityBatchSrcType
- EntityConfdScore
- RsStat
Entity Match Batch Inquiry Behavior
The Entity Match Batch Inquiry service behavior is as follows.
The Entity Match Batch Inquiry root request (EntityMatchBatchInqRq_MType)
requires an Entity Batch Source Type (EntityBatchSrcType) and Entity
Name Array (EntityNameArray_AType).
The root request optionally includes Entity List Code Array
(EntityListCodeArray_AType), Selection Array
(SelArray_AType), Entity Confidence Score
(EntityConfdScore), and Birth Date Tolerance
(BirthDtTolr).
The Entity Batch Source Array (EntityBatchSrchArray_AType) should only be
delivered if the consumer requests multiple entity sources.
The Entity Batch Source Type (EntityBatchSrcType) represents the ODI table that is available for the Entity Name batch matching process. The canonical values are:
- CustDetail - Customer Details (typically core banking customer demographic data)
- Cust_Addr - Customer Addresses (typically core banking customer additional addresses as identified by the address category usage elements)
- Cust_BenflOwnDetail - Customer Beneficial Ownership Details
- Dep_AcctTitle - Deposit Account Title (typically additional names as related to deposit accounts)
- Ln_AcctTitle - Loan Account Title (typically additional names as related to loan accounts)
- SafeDep_AcctTitle - Safe Deposit Box Account Title (typically additional names as related to safe deposit boxes)
- TimeDep_AcctTitle - Time Deposit Account Title (typically additional names as related to time deposit accounts)
- BilPayMerDetail - Bill Pay Merchant Details (typically merchant payee accounts as related to a bill pay subscriber)
The Entity Name Array (EntityNameArray_AType) contains the
Entity Name Record complex (EntityNameRec_CType) which contains the Element
Name (ElemName) and Entity Category Type
(EntityCatType). The message consumer can display the element names
for each Entity Batch Source Type to the end consumer for selection. The Entity Category Type
(EntityCatType) element is required to provide Enterprise Entity
Matching Service (EEMS) the correct classification of an element to ensure proper entity
matching algorithm processes.
The Entity List Code Array (EntityListCodeArray_AType) can contain the codes
that represent the published list of entity names typically managed by a governmental agency.
The default value is [OFAC] when the array is absent/null.
The Select Array (SelArray_AType) contains the Select Record
complex (SelRec_CType) which encompasses the Select Order
(SelOrder), Selection Code (SelCode), Select
Operand (SelOperand), and Select Value (SelVal).
The select array can be leveraged to convey to EEMS which rows to be selected for the entity
matching batch process. The relationship of [AND] is used between
select records. For example, a consumer only wants to process a batch entity matching for the
new customers in the past month. The following is an example of the select object;
<SelArray>
<SelRec>
<SelOrder>1</SelOrder>
<SelCode>CustOrgDt</SelCode>
<SelOperand>GE</SelOperand>
<SelVal>2017-03-01</SelVal>
</SelRec>
<SelOrder>2</SelOrder>
<SelCode>CustOrgDt</SelCode>
<SelOperand>LE</SelOperand>
<SelVal>2017-03-31</SelVal>
</SelRec>
</SelArray>The Birth Date Tolerance (BirthDtTolr) is ignored if the Entity Category Type (EntityCatType) does not include the [BirthDt] canonical value. The Birth Date Tolerance (BirthDtTolr) allows for a numeric value +/- from the Birth Date (BirthDt). For example, if a birth date of January 5, 1979 is entered as (BirthDt>1979-01-05</BirthDt> and the Birth Date Tolerance is entered as <BirthDtTolr>2</BirthDtTolr> then the date range used in the search is January 5, 1977 through January 5, 1981.
The Entity Confidence score (EntityConfdScore) is a value given to an entity based on the confidence of a match as related to the entity. The default value is .85 (85%).
The Consumer Reference Identifier (ConsmRefId) is prefixed to the batch name for the user experience ([ConsmRefId]_[EntityBatchRefId]). The service consumer can dictate the provisions for the Consumer Reference Identifier (ConsmRefId). The Consumer Reference Identifier (ConsmRefId) is limited to A-Z or 0–9 with no special characters or spaces. It is not case-sensitive.
The Entity Match Batch Inquiry root response
(EntityMatchBatchInqRs_MType) echoes back the elements at the root request.
The Entity Match Batch Inquiry root response (EntityMatchBatchInqRs_MType)
includes the Entity Batch Reference Identifier (EntityBatchRefId). The
consumer caches this value for the subsequent Entity Match Batch Status inquiry as well as
identifying the EES event that conveys the batch is complete along with the batch results.
A fault returns if the Entity Batch Source Type (EntityBatchSrchType) is absent/null at the root request.
EntityMatchBatchInqRq_MType
EntityMatchBatchInqRq_MType is a message MType element.
Contains:
Custom_CTypeEntityBatchSrcArrayNote: This array is only required if you want to aggregate entity batch sources.EntityListCodeArray_ATypeEntityNameArray_ATypeMsgRqHdr_CTypeSelArray_AType
Simple Elements
The following simple elements are contained within this message.
- BirthDtTolr
- The birth date tolerance for using the birth date as a search filter.
- ConsmRefId
- A reference assigned to an activity by the consumer of the service.
- EntityBatchSrcType
- The source to use for the entity match batch process. Canonical values
are:
- BilPayMerDetail
- Cust Addr
- CustDetail
- Dep AcctTitle
- Ln AcctTitle
- SafeDep AcctTitle
- TimeDep AcctTitle
- EntityConfdScore
- The value given to an entity based on the confidence of a match related to that entity.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityBatchSrcArray_AType
EntityBatchSrcArray_AType is an array
AType element. This is an
array of entity sources to use for the matching service.
Contains:
EntityBatchSrcRec_CType
EntityBatchSrcRec_CType
EntityBatchSrcRec_CType is a complex
CType element.
Contains:
Custom_CTypeEntityNameArray_ATypeSelArray_AType
Simple Elements
The following simple elements are contained within this complex.
- EntityBatchSrcType
- The source to use for the entity match batch process. Canonical values
are:
- BilPayMerDetail
- Cust Addr
- CustDetail
- Dep AcctTitle
- Ln AcctTitle
- SafeDep AcctTitle
- TimeDep AcctTitle
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityNameArray_AType
EntityNameArray_AType is an array
AType element. This is an array of entity names to be used for the matching
service.
Contains:
EntityNameRec_CType
EntityNameRec_CType
EntityNameRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ElemName
- The name provided to an element. It includes the OvrrdInstRtId attribute.
- EntityCatType
- The entity-specific category. Canonical values are:
- BusComName
- IndvComName
- ComName
- LegalName
- StreetAddr
- City
- StateCode
- Cntry
- CntryType
- BirthDt
- PostalCode
- CustId
- ACHInbound
- ACHOutbound
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SelArray_AType
SelArray_AType is an array
AType element. This is an array of select statements.
Contains:
SelRec_CType
SelRec_CType
SelRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- SelCode
- The code to use as part of a select statement.
- SelOperand
- The allowable operands to provide choices between select conditions. Canonical values
are:
- EQ
- GE
- GT
- LE
- LT
- NE
- SelOrder
- The order of select statements.
- SelVal
- The value used for select statements.
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 code that represents a published list of entity names typically
managed by a governmental agency. This is a hybrid enumeration due to custom lists.
Canonical values are:
- FinCEN
- OFAC
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityNameArray_AType
EntityNameArray_AType is an array
AType element. This is an array of entity names to be used for the matching
service.
Contains:
EntityNameRec_CType
EntityNameRec_CType
EntityNameRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ElemName
- The name provided to an element. It includes the OvrrdInstRtId attribute.
- EntityCatType
- The entity-specific category. Canonical values are:
- BusComName
- IndvComName
- ComName
- LegalName
- StreetAddr
- City
- StateCode
- Cntry
- CntryType
- BirthDt
- PostalCode
- CustId
- ACHInbound
- ACHOutbound
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_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-Security.
SelArray_AType
SelArray_AType is an array
AType element. This is an array of select statements.
Contains:
SelRec_CType
SelRec_CType
SelRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- SelCode
- The code to use as part of a select statement.
- SelOperand
- The allowable operands to provide choices between select conditions. Canonical values
are:
- EQ
- GE
- GT
- LE
- LT
- NE
- SelOrder
- The order of select statements.
- SelVal
- The value used for select statements.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityMatchBatchInqRs_MType
EntityMatchBatchInqRs_MType is a message MType element.
Contains:
Custom_CTypeEntityBatchSrcArrayEntityListCodeArray_ATypeEntityNameArray_ATypeMsgRsHdr_CTypeSelArray_AType
Simple Elements
The following simple elements are contained within this message.
- BirthDtTolr
- The birth date tolerance for using the birth date as a search filter.
- EntityBatchRefId
- A unique identification provided by the entity matching application when a request for batch is queued.
- EntityBatchSrcType
- The source to use for the entity match batch process. Canonical values
are:
- BilPayMerDetail
- Cust Addr
- CustDetail
- Dep AcctTitle
- Ln AcctTitle
- SafeDep AcctTitle
- TimeDep AcctTitle
- EntityConfdScore
- The value given to an entity based on the confidence of a match related to that entity.
- RsStat
- The status of the response. Canonical values are:
- Fail
- Success
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityBatchSrcArray_AType
EntityBatchSrcArray_AType is an array
AType element. This is an
array of entity sources to use for the matching service.
Contains:
EntityBatchSrcRec_CType
EntityBatchSrcRec_CType
EntityBatchSrcRec_CType is a complex
CType element.
Contains:
Custom_CTypeEntityNameArray_ATypeSelArray_AType
Simple Elements
The following simple elements are contained within this complex.
- EntityBatchSrcType
- The source to use for the entity match batch process. Canonical values
are:
- BilPayMerDetail
- Cust Addr
- CustDetail
- Dep AcctTitle
- Ln AcctTitle
- SafeDep AcctTitle
- TimeDep AcctTitle
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityNameArray_AType
EntityNameArray_AType is an array
AType element. This is an array of entity names to be used for the matching
service.
Contains:
EntityNameRec_CType
EntityNameRec_CType
EntityNameRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ElemName
- The name provided to an element. It includes the OvrrdInstRtId attribute.
- EntityCatType
- The entity-specific category. Canonical values are:
- BusComName
- IndvComName
- ComName
- LegalName
- StreetAddr
- City
- StateCode
- Cntry
- CntryType
- BirthDt
- PostalCode
- CustId
- ACHInbound
- ACHOutbound
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SelArray_AType
SelArray_AType is an array
AType element. This is an array of select statements.
Contains:
SelRec_CType
SelRec_CType
SelRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- SelCode
- The code to use as part of a select statement.
- SelOperand
- The allowable operands to provide choices between select conditions. Canonical values
are:
- EQ
- GE
- GT
- LE
- LT
- NE
- SelOrder
- The order of select statements.
- SelVal
- The value used for select statements.
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 code that represents a published list of entity names typically
managed by a governmental agency. This is a hybrid enumeration due to custom lists.
Canonical values are:
- FinCEN
- OFAC
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityNameArray_AType
EntityNameArray_AType is an array
AType element. This is an array of entity names to be used for the matching
service.
Contains:
EntityNameRec_CType
EntityNameRec_CType
EntityNameRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ElemName
- The name provided to an element. It includes the OvrrdInstRtId attribute.
- EntityCatType
- The entity-specific category. Canonical values are:
- BusComName
- IndvComName
- ComName
- LegalName
- StreetAddr
- City
- StateCode
- Cntry
- CntryType
- BirthDt
- PostalCode
- CustId
- ACHInbound
- ACHOutbound
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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-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.
SelArray_AType
SelArray_AType is an array
AType element. This is an array of select statements.
Contains:
SelRec_CType
SelRec_CType
SelRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- SelCode
- The code to use as part of a select statement.
- SelOperand
- The allowable operands to provide choices between select conditions. Canonical values
are:
- EQ
- GE
- GT
- LE
- LT
- NE
- SelOrder
- The order of select statements.
- SelVal
- The value used for select statements.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.