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

EDPP Person Search

Enterprise SOAP API > API by Reference > Platform Services > EDPP Person Search

EDPP Person Search

EDPP Person Search is a jXchange service designed to allow users to search for data on a customer.

Message Flow

In jXchange, the EDPP Person Search service uses a typical exchange of MType messages to search for data on a customer.

Primary Request

The consumer forwards the EDPPPersonSrchRq_MType message to the service provider. The message contains the following simple elements:

  • AccdId
  • AcctType
  • BrandCode
  • DriverLicId
  • DriverLicStateCode
  • FirstName
  • LastName
  • ProdCode
  • TaxID

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRqHdr_CType

Primary Response

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

  • AccdId
  • AcctType
  • BrandCode
  • DriverLicId
  • DriverLicStateCode
  • FirstName
  • LastName
  • ProdCode
  • TaxID

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRsHdr_CType

The message contains the following array elements:

  • ProdRsArray_AType

EDPP Person Search Behavior

The EDPP Person Search service behavior is as follows.

The EDPP Person Search root request (EDPPPersonSrchRq_MType) requires the Product Code (ProdCode) and Last Name (LastName).

The EDPP Person Search root request (EDPPPersonSrchRq_MType) optionally includes the Brand Code (BrandCode) and First Name (FirstName).

The Brand Code (BrandCode) is accepted as a filter-in so the persons returned would only have a relationship with a specific brand.

The EDPP Person Search root request (EDPPPersonSrchRq_MType) includes a documented choice statement where the following elements are optional but at least one is required:

  • Account Identifier (AcctId)
  • Account Type (AcctType)
  • Driver License Identifier (DriverLicId)
  • Driver License State Code (DriverLicStateCode)
  • Tax Identifier (TaxId)

The Driver License Identifier (DriverLicId) must include the Driver License State Code (DriverLicStateCode). The Account Identifier (AcctId) must include the Account Type (AcctType).

The EDPP Person Search root response (EDPPPersonSrchRs_MType) echoes back the following elements:

  • Account Identifier (AcctId)
  • Account Type (AcctType)
  • Brand Code (BrandCode)
  • Driver License Identifier (DriverLicId)
  • Driver License State Code (DriverLicStateCode)
  • First Name (FirstName)
  • Last Name (LastName)
  • Product Code (ProdCode)
  • Tax Identifier (TaxId)

The EDPP Person Search root response (EDPPPersonSrchRs_MType) contains the Product Response Array (ProdRsArray_AType) which contains the Product Response Information Record complex (ProdRsInfoRec_CType). This complex contains the following elements:

  • Product Code (ProdCode)
  • Product Description (ProdDesc)
  • Product Sub-Code (ProdSubCode)
  • Product Sub-Desc (ProdSubDesc)
  • Brand Code (BrandCode)
  • Brand Description (BrandDesc)
  • Customer Identifier (CustId)
  • Customer Status Type (CustStatusType)

The service provider returns the Brand Code (BrandCode) if the person is related to a Brand Code. The service provider could return multiple rows of a person if that person is related to multiple brands. The Customer Identifier (CustId) could be directed to a specific brand for the subsequent service calls (Collection and Deletion).

The standard search message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

EDPPPersonSrchRq_MType

EDPPPersonSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

Note: The DriverLicStateCode must be included with the DriverLicId.
AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
BrandCode
The code that defines the brandings.
DriverLicId
The identification for a person's driver license.
DriverLicStateCode
The 2 alpha long code which represents a state. For example, MO.
FirstName
The first name.
LastName
The last name.
ProdCode
The code that identifies a product type of account within an application. Canonical values are:
  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

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

EDPPPersonSrchRs_MType

EDPPPersonSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • ProdRsArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
BrandCode
The code that defines the brandings.
DriverLicId
The identification for a person's driver license.
DriverLicStateCode
The 2 alpha long code which represents a state. For example, MO.
FirstName
The first name.
LastName
The last name.
ProdCode
The code that identifies a product type of account within an application. Canonical values are:
  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ProdRsArray_AType

ProdRsArray_AType is an array AType element. This is an array of product responses to a search for a person.

Contains:

  • ProdRsInfoRec_CType

ProdRsInfoRec_CType

ProdRsInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

BrandCode
The code that defines the brandings.
BrandDesc
The description of the code that defines the brandings.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
CustStatType
The status of a customer. Canonical values are:
  • Active
  • Dormant
  • Decrease
  • NoExist
  • NonCust
ProdCode
The code that identifies a product type of account within an application. Canonical values are:
  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

ProdDesc
Description of the type of account.
ProdSubCode
The code that identifies a product type of account within an application. Canonical values are:
  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdSubCode is a hybrid open enumeration.

ProdSubDesc
Description of the type of account.

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

©1999-2020 Jack Henry & Associates, Inc.

Dates are provided as estimates only and can be changed at any time at the sole discretion of JHA.

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