Beneficial Owner Search
Beneficial Owner Search
Beneficial Owner Search is a jXchange service designed to provide consumers the ability to search for beneficial owners as related to the FinCEN Customer Due Diligence (CDD) regulation requirements.
Message Flow
In jXchange, the Beneficial Owner Search service uses a typical exchange of
MType
messages to provide consumers the ability to search for beneficial
owners as related to the FinCEN Customer Due Diligence (CDD) regulation requirements.
Primary Request
The consumer forwards the BenflOwnSrchRq_MType
message to the
service provider. The message contains the following simple elements:
- CustId
- PersonName
- TaxId
- TINCode
Primary Response
The service provider returns the BenflOwnSrchRs_MType
message
to the consumer. The message contains the following simple elements:
- CustId
- PersonName
- TaxId
- TINCode
Beneficial Owner Search Behavior
The Beneficial Owner Search Behavior service behavior is as follows.
The Beneficial Owner Search root request (BenflOwnSrchRq_MType
)
includes a documented choice statement that requires one of the following elements:
(CustId), (TaxId), or
(PersonName). If you enter multiples, the hierarchy is in the same
order. The information in the request is about the beneficial owner. The optional elements are
(TINCode), which could be used with (TaxId),
as well as the Include Extended Element Array (IncXtendElem_AType
), which is
included due to the Person Name complex containing optional elements
(x_PersonName_CType
).
The Beneficial Owner Search root response
(BenflOwnSrchRs_MType
) echoes back the request elements of
(CustId), (TaxId),
(PersonName), and (TINCode). The Beneficial
Owner Search also contains the Legal Entity Search Rec Array
(LegalEntitySrchRecArray_AType
) which contains Legal Entity Search Rec
complex (LegalEntitySrchRec_CType
). The Legal Entity Search Rec complex
(LegalEntitySrchRec_CType
) includes the Beneficial Owner Id
(BenflOwnId), the legal entity’s customer id
(CustId), the legal entity’s name (PersonName)
which references the Person Name complex and the Beneficial Owner Type
(BenflOwnType) which relates to the ownership type, the legal
entity’s tax id (TaxId), and the (TINCode).
BenflOwnSrchRq_MType
BenflOwnSrchRq_MType
is a message MType
element.
Contains:
Custom_CType
IncXtendElemArray_AType
PersonName_CType
SrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId
,MaskVal
,Rstr
, andSrchType
attributes. - TINCode
- The code that designates the type of tax identification number.
Canonical values are:
- SSN
- EIN
- Forn
TINCode is a hybrid open enumeration.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType
is an array AType
element. This is an array that
lists x_ elements by name, which are to be included in the response.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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.
BenflOwnSrchRs_MType
BenflOwnSrchRs_MType
is a message MType
element.
Contains:
Custom_CType
LegalEntitySrchRecArray_AType
PersonName_CType
SrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId
,MaskVal
,Rstr
, andSrchType
attributes. - TINCode
- The code that designates the type of tax identification number.
Canonical values are:
- SSN
- EIN
- Forn
TINCode is a hybrid open enumeration.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
LegalEntitySrchRecArray_AType
AcctBenfArray_AType
is an array AType
element. This is an array of
responses for legal entity owners.
Contains:
LegalEntitySrchRec_CType
LegalEntitySrchRec_CType
LegalEntitySrchRec_CType
is a complex CType
element.
Contains:
PersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BenflOwnId
- Identifies which beneficial owner record.
- BenflOwnType
- The type of beneficial ownership as it relates to FinCEN Customer
Due Diligence (CDD). Canonical values are:
- Cntl - Controlling individual/significant responsibility
- Own - Beneficial owners
- CntlOwn - Both controlling individual and beneficial owner
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId
,MaskVal
,Rstr
, andSrchType
attributes. - TINCode
- The code that designates the type of tax identification number.
Canonical values are:
- SSN
- EIN
- Forn
TINCode is a hybrid open enumeration.
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.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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.