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 Response Addition

Enterprise SOAP API > API by Reference > Fraud Services > BSA Due Diligence Response Addition

BSA Due Diligence Response Addition

BSA Due Diligence Response Addition 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 Response Addition 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 BSADueDilgntRsAddRq_MType message to the service provider. The message contains the following simple elements:

  • DueDilgntType
  • DueDilgntCustType
  • CustID
  • TaxID

Primary Response

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

  • RsStat

BSA Due Diligence Response Addition Behavior

The BSA Due Diligence Response Addition (BSADueDilgntRsAdd) operation behavior is as follows.

The BSA Due Diligence Response Addition root request message (BSADueDilgntRsAddRq_MType) optionally includes the Due Diligence Type DueDilgntType simple element, Due Diligence Customer Type DueDilgntCustType simple element, Account Identifier complex (AccountId_CType), Customer Identification CustId simple element, Tax Identifier TaxId simple element, Due Diligence Question Response Array (DueDilgntQuesRsArray_AType), and Due Diligence Activity Array (DueDilgntActArray_AType). The Due Diligence Customer Type DueDilgntCustType simple element default value is Indv. The Due Diligence Type DueDilgntType simple element defaults depending upon the Due Diligence identifier (AccountId_CType) and CustID simple element. The Due Diligence Type DueDilgntType simple element is required if the request only includes the Tax Id TaxId simple element.

The Account Identification complex (AccountId_CType), Customer Identification CustId, and Tax Identifier TaxId simple elements represent a documented choice statement, which means these elements are optional but at least one must be submitted in the request.

The Due Diligence Question Response Array (DueDilgntQuesRsArray_AType) encapsulates the Due Diligence Question Response Record (DueDilgntQuesRsRec_CType). The Due Diligence Question Response Record complex (DueDilgntQuesRsRec_CType) encapsulates the Due Diligence Question Identifier DueDilgntQuesId, Due Diligence Question Description DueDilgntQuesDesc, Due Diligence Answer Identifier DueDilgntAnswId, and Due Diligence Answer Description DueDilgntAnswDesc. The Due Diligence Question Identifier DueDilgntAnswId and Due Diligence Answer Identifier DueDilgntAnswId simple elements are required.

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, Activity Transaction Type ActTrnType, Due Diligence Total Type DueDilgntTotType, and Due Diligence Activity Answer DueDilgntActAns simple elements. The Due Diligence Activity Type DueDilgntActType simple element along with the Activity Transaction Type ActTrnType and Due Diligence Total Type DueDilgntTotType simple elements are the keys for the array row.

The BSA Due Diligence Response Addition root response message (BSADueDilgntRsAddRs_MType) returns the Response Status RsStat simple element.

The standard Addition 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.

BSADueDilgntRsAddRq_MType

BSADueDilgntRsAddRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • DueDilgntActArray_AType
  • DueDilgntQuesRsArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
DueDilgntCustType
Defines the type of customer being submitted for due diligent reporting. Canonical values are:
  • Indv
  • Comp
The default value is Indv.
DueDilgntType
The bank secrecy act due diligent type. Canonical values are:
  • Cust
  • Acct
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

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

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

DueDilgntQuesRsArray_AType

DueDilgntQuesRsArray_AType is an array AType element. This is the array grouping of BSA due diligent responses to questions.

Contains:

  • DueDilgntQuesRsRec_CType

DueDilgntQuesRsRec_CType

DueDilgntQuesRsRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DueDilgntAnswDesc
The description for an answer for questions as related to answer identifier.
DueDilgntAnswId
An identifier assigned to an answer to questions for the BSA due diligence.
DueDilgntQuesDesc
The description for question as related to question identifier.
DueDilgntQuesID
An identifier assigned to a question for the BSA due diligence.

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

BSADueDilgntRsAddRs_MType

BSADueDilgntRsAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

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