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

BSA Due Diligence Pool Search

Enterprise SOAP API > API by Reference > Fraud Services > BSA Due Diligence Pool Search

BSA Due Diligence Pool Search

BSA Due Diligence Pool Search is a jXchange service designed to allow a consumer to fulfill the Bank Secrecy Act (BSA) customer/account due diligence requirements.

Message Flow

In jXchange, the BSA Due Diligence Pool Search service uses a typical exchange of MType messages to allow consumers to fulfill the BSA customer/account due diligence requirements.

Primary Request

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

  • DueDilgntType

Primary Response

The service provider returns the BSADueDilgntPoolSrchRs_MType message to the consumer. The message contains the following simple element:

  • DueDilgntType

BSA Due Diligence Pool Search Behavior

The BSA Due Diligence Pool Search (BSADueDilgntPoolSrch) operation behavior is as follows.

The BSA Due Diligence Pool Search root request message (BSADueDilgntPoolSrchRq_MType) requires a Due Diligence Type DueDilgntType simple element.

The BSA Due Diligence Pool Search root response message (BSADueDilgntPoolSrchRs_MType) echoes back the request elements. The BSA Due Diligence Pool Search root response (BSADueDilgntPoolSrchRs_MType) encapsulates the Due Diligence Question Array (DueDilgntQuesArray_AType) and Due Diligence Activity Array (DueDilgntActArray_AType).

The Due Diligence Question Array (DueDilgntQuesArray_AType) returns the pool of questions as related to the customer or account tree of due diligence questions along with the canonical answers, if applicable.

The Due Diligence Question Array (DueDilgntQuesArray_AType) encapsulates the Due Diligence Question Record complex (DueDilgntQuesRec_CType). The Due Diligence Question Record complex (DueDilgntQuesRec_CType) encapsulates the Due Diligence Question Identifier DueDilgntQuesId simple element, Due Diligence Question Description DuedilgntQuesDesc simple element, Question Remark Array (QuesRmkArray_AType), Answer Data Type AnswDataType simple element, Answer Canonical Type AnswCanocType simple element, Answer Canonical Array (AnswCanocArray_AType), and Due Diligence Answer Array (DueDilgntAnswArray_AType). The Due Diligence Question Identifier DueDilgntQuesId simple element is the key for the array row. The Answer Data Type default value is string. The Answer Canonical Type default value is NA.

The Answer Canonical Array (AnswCanocArray_AType) encapsulates the Answer Canonical Record complex (AnswCanocRec_CType). The Answer Canonical Record complex (AnswCanocRec_CType) encapsulates the Element Canonical Value ElemCanocVal and Element Canonical Value Description ElemCanocValDesc simple elements. These values coincide with the Answer Canonical Type AnswCanocType simple element.

The Due Diligence Answer Array (DueDilgntAnswArray_AType) encapsulates the Due Diligence Answer Record complex (DueDilgntAnswRec_CType). The Due Diligence Answer Record complex (DueDilgntAnswRec_CType) encapsulates the Due Diligence Answer Identifier DueDilgntAnswId simple element, Due Diligence Answer Description DuedilgntAnswDesc simple element, Answer Remark Array (AnswRmkArray_AType), and Due Diligence Question Array (DueDilgntQuesArray_AType). The Due Diligence Answer Identifier DueDilgntAnswId simple element is the key for the array row.

The Due Diligence Question Array (DueDilgntQuesArray_AType) is a recursive object that is repeated based on the due diligence question tree. The question array is related to the answer array row.

The Due Diligence Activity Array (DueDilgntActArray_AType) encapsulates the Due Diligence Activity Record complex (DueDilgntActRec_CType). The Due Diligence Activity Record complex (DueDilgntActRec_CType) encapsulates the Due Diligence Activity Type DueDilgntActType simple element, Activity Transaction Type ActTrnType simple element, Due Diligence Activity Count DueDilgntActCnt simple element, and Due Diligence Activity Amount DueDilgntActAmt simple element. The Due Diligence Activity Type DueDilgntActType along with the Activity Transaction Type ActTrnType simple elements are the keys for the array row.

The standard Search message tenets are applicable.

Adhere to the tenets related to Fault and Warnings conveyed in the message as related to business faults.

Adhere to the tenets related to Backwards Compatibility.

BSADueDilgntPoolSrchRq_MType

BSADueDilgntPoolSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

DueDilgntType
The bank secrecy act due diligent type. Canonical values are:
  • Cust
  • Acct

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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

BSADueDilgntPoolSrchRs_MType

BSADueDilgntPoolSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • DueDilgntActArray_AType
  • DueDilgntQuesArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this complex.

DueDilgntType
The bank secrecy act due diligent type. Canonical values are:
  • Cust
  • Acct

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DueDilgntActArray_AType

DueDilgntActArray_AType is an array AType element. This is the array grouping of BSA due diligent activity information.

Contains:

  • DueDilgntActRec_CType
DueDilgntActRec_CType

DueDilgntActRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ActTrnTotType
Describes the type of activity transaction total. Canonical values are:
  • Cnt
  • Amt
ActTrnType
Describes the type of activity transaction type. Canonical values are:
  • Dr
  • Cr
DueDilgntActAns
The answers for the activity per category.
DueDilgntActType
Describes the type of due diligent activity category. Canonical values are:
  • ATM
  • Cash
  • Wire
  • IntlWire
  • IntlACH
  • Chks
  • ACH
  • Oth
  • TotWire
  • Tot

DueDilgntQuesArray_AType

DueDilgntQuesArray_AType is an array AType element. This is an array grouping of BSA due diligent questions.

Contains:

  • DueDilgntQuesRec_CType
DueDilgntQuesRec_CType

DueDilgntQuesRec_CType is a complex CType element.

Contains:

  • QuesRmkArray references Rmk_AType
  • AnswCanocArray_AType
  • DueDilgntAnswArray_AType
Simple Elements

The following simple elements are contained within this complex.

AnswCanocType
Describes the type of canonical values that would exist for an answer. Canonical values are:
  • NAICS
  • Cntry
  • State
  • StdIndust
  • OpenEnum
  • NA
AnswDataType
Describes the type of data for the answers. Canonical values are:
  • Dt
  • Dec
  • Int
  • String
DueDilgntQuesDesc
The description for question as related to question identifier.
DueDilgntQuesID
An identifier assigned to a question for the BSA due diligence.

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