Customer Search

Enterprise SOAP API > Core Reference Resources > SilverLake Core > Customer Search

Overview

Element Name	Description
`PersonName`	A complex element containing name information. The simple elements within this complex are as follows: `ComName` (Common name, full text name like John Doe) `FirstName` `LastName` `MiddleName`
`TaxId`	The tax identifier.

XPath Elements

For this business service, certain template fields, or XPath elements, are sent in on the request and corresponding elements are returned in the response.

The following tables list the elements you send on the request and what is sent back in the response. Each table also includes any pertinent notes, such as element values or whether it is required for input.

Table 1. Input Element Fields
XPath Element	File/Field	Description	Notes
`MaxRec`	JHFREFAPI.MAXREC	Maximum Records	N/A
`Cursor`	JHFREFAPI.BEGREC	Beginning Record	N/A
`ComName`	CFMAST.CFNA1	Customer Name	N/A
`ComName.SrchType`	N/A	Full Name Search Type	Uses the `SrchType` attribute canonical values: `Exact` `StartsWith` `EndsWith` `Contains`
`FirstName`	CFMAST.CFFNA	Customer First Name	N/A
`FirstName.SrchType`	N/A	First Name Search Type	Uses the `SrchType` attribute canonical values: `Exact` `StartsWith` `EndsWith` `Contains`
`MiddleName`	CFMAST.CFMNA	Customer Middle Name	N/A
`LastName`	CFMAST.CFLNA	Customer Last Name	N/A
`LastName.SrchType`	N/A	Last Name Search Type	Uses the `SrchType` attribute canonical values: `Exact` `StartsWith` `EndsWith` `Contains`
`LegalName`	N/A	Title Search	N/A
`PhoneNum`	CFMAST.CFHPHO	Home Phone	N/A
`PhoneNum.SrchType`	N/A	Phone Number Search Type	Uses the `SrchType` attribute canonical values: `Exact` `StartsWith` `EndsWith` `Contains`
`AcctId`	CFACCT.CFACC#	Account Number	N/A
`AcctType`	CFACCT.CFATYP	Account Type	N/A
`TaxId`	CFMAST.CFSSNO	Tax ID Number	N/A
`TaxId.SrchType`	N/A	Tax ID Search Type	Uses the `SrchType` attribute canonical values: `Exact` `StartsWith` `EndsWith` `Contains`
`CustType`	CFMAST.CFINDI	Individual	N/A
`IntnetFinInstId`	HBMAST.HBCID	NetTeller ID	N/A
`SrchAddr`	N/A	Address Search	N/A
`SrchAddr.SrchType`		Address Search Type	Uses the `SrchType` attribute canonical values: `StartsWith` `Contains`
`SrchCity`	N/A	City Search	N/A
`SrchCity.SrchType`	N/A	City Search Type	Uses the `SrchType` attribute canonical values: `Exact`
`AddrCat`	N/A	Address Search Category	Canonical `All` to `All` `Cust` to `Customer` `IRSRpt` to `IRSRpt` `Phys` to `Physical` `Prop` to `Property` `Seasonal` to `Seasonal`
`State`	CFMAST.CFSTAT	State	N/A
`PostalCode`	N/A	ZIP Code	N/A
`EmailAddr`	CFMAST.CFEML1	Email Address	N/A
`EmailAddr.SrchType`	N/A	Email Search Type	Uses the `SrchType` attribute canonical values: `Exact` `StartsWith` `EndsWith` `Contains`
`BrandCode`	JHBRAND.MBCODE	Brand Code	N/A

Table 2. Output Element Fields
XPath Element	File/Field	Description	Notes
`SentRec`	JHFREFAPI.SENTREC	Number Sent Records	N/A
`MoreRec`	JHFREFAPI.MOREREC	More Records	N/A
`Cursor`	JHFREFAPI.NEXTREC	Next Record	N/A
`TotRec`	JHFREFAPI.TOTRECS	Total Number Records Exist	N/A
`Rstr`	N/A	User Access Level	Canonical Blank to Blank `A` to `ReadWrite` `C` to `Clear` `E` to `NoAccessPart` `H` to `Hid` `N` to `NoAccess` `P` to `ReadWritePart` `R` to `ReadOnly` `S` to `ReadOnlyPart` `X` to `No` `Y` to `Yes`
`CustId`	CFMAST.CFCIF#	Customer Number	N/A
`ComName`	CFMAST.CFNA1	Customer Name	N/A
`FirstName`	CFMAST.CFFNA	Customer First Name	N/A
`MiddleName`	CFMAST.CFMNA	Customer Middle Name	N/A
`LastName`	CFMAST.CFLNA	Customer Last Name	N/A
`NameSuffix`	CFMAST.CFSFX	Customer Name Suffix	N/A
`LegalName`	CFMAST.CFEXTTL	Title	N/A
`AbbName`	CFMAST.CFSNME	Short Name	N/A
`AcctId.Rstr`	N/A	User Access Acct Level	Canonical Blank to Blank `A` to `ReadWrite` `C` to `Clear` `E` to `NoAccessPart` `H` to `Hid` `N` to `NoAccess` `P` to `ReadWritePart` `R` to `ReadOnly` `S` to `ReadOnlyPart` `X` to `No` `Y` to `Yes`
`AcctId`	CFACCT.CFACC#	Account Number	N/A
`AcctType`	CFACCT.CFATYP	Account Type	N/A
`PhoneNum`	CFMAST.CFHPHO	Home Phone	N/A
`TINCode`	CFMAST.CFSSCD	Tax ID Type Code	N/A
`TaxId`	CFMAST.CFSSNO	Tax ID Number	N/A
`MaskVal`	CFMAST.CFSSNO	Masked Tax ID Number	N/A
`CustType`	CFMAST.CFINDI	Individual	N/A
`IntnetFinInstId`	HBMAST.HBCID	NetTeller ID 1-10	There are 10 total elements available for you to enter information into.
`AddrLine`	CFMAST.CFNA2	Address Line 1-6	There are six total elements available for you to enter information into.
`StreetAddr1`	CFMAST.CFNA2	Street Address Line 1	N/A
`StreetAddr2`	CFMAST.CFNA3	Street Address Line 2	N/A
`City`	CFMAST.CFCITY	City	N/A
`StateProv`	JHSTAT.JHSTAN	State Name	N/A
`StateCode`	CFMAST.CFSTAT	State	N/A
`PostalCode`	CFMAST.CFZIP	ZIP Code	N/A
`DlvryPt`	CFMAST.CFZIPD	ZIP Code Delivery Point	N/A
`Cntry`	CFMAST.CFFORC	Foreign Country	N/A
`FornAddr`	CFMAST.CFFORN	Foreign Address	N/A
`InvAddr`	CFMAST.CFBADA	Insufficient Address	N/A
`AddrCat`	N/A	Address Search Category	Canonical `All` to `All` `Cust` to `Customer` `IRSRpt` to `IRSRpt` `Phys` to `Physical` `Prop` to `Property` `Seasonal` to `Seasonal`
`EmailAddr`	CFMAST.CFEML1	Email Address	N/A
`EmailType`	N/A	Email Type	N/A
`BrandCode`	JHBRAND.MBCODE	Brand Code 1-20	There are 20 total elements available for you to enter information into.
`BrandDesc`	JHBRAND.MBNAME	Brand Name 1-20	There are 20 total elements available for you to enter information into.

Validations

Within the response, specific validations can appear in the response if incorrect or different information than what is required is sent in the request.

The following table lists the errors that can be returned and includes what prompts the error to occur.

Code	Element	System Message	Validation Trigger
1	`AcctId`	`Account not found`	Presents when the account number/type combination is not found in the CIF Account File (CFACCT).
1	`AcctType`	`Account not found`	Presents when the account number/type combination is not found in the CIF Account File (CFACCT).
7	`AcctType`	`Account type is not valid`	Presents when this element has a value of `G` or `C`.
11	`Cursor`	`Beginning Record cannot be negative`	Presents when the value in this element is less than zero.
45	`PostalCode`	`Numeric data is not valid`	Presents when the value in these elements is not numeric.
45	`TaxId`	`Numeric data is not valid`	Presents when the value in these elements is not numeric.
45	`MaxRec`	`Numeric data is not valid`	Presents when the value in these elements is not numeric.
45	`BegRec`	`Numeric data is not valid`	Presents when the value in these elements is not numeric.
45	`AcctId`	`Numeric data is not valid`	Presents when the value in these elements is not numeric.
45	`IntnetFinInstId`	`Numeric data is not valid`	Presents when the value in these elements is not numeric.
48	`MaxRec`	`Maximum records must be greater than zero and less than or equal to 4000`	Presents when the value sent in this element is less than zero or greater than 4,000.

The following table lists the warnings that can be returned and includes what prompts the warning to occur.

Code	Element	System Message	Validation Trigger
49	`AcctId`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`PhoneNum`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`TaxId`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`Name`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`IntnetFinInstId`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`AcctType`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`PhoneNum`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`LastName`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`FirstName`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`ComName`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`EmailAddr`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.
49	`LegalName`	`No Records Match Selection Criteria`	Presents when this element is not populated with a value to allow the operation to find the information within the database files.

Service Dictionary

Element Name	Field Value (ElemCanocVal)	Field Description (ElemCanocValDesc)
`Rstr`	Blank	Blank
`Rstr`	`Clear`	N/A
`Rstr`	`Hid`	N/A
`Rstr`	`No`	N/A
`Rstr`	`NoAccess`	N/A
`Rstr`	`NoAccessPart`	N/A
`Rstr`	`ReadOnly`	N/A
`Rstr`	`ReadOnlyPart`	N/A
`Rstr`	`ReadWrite`	N/A
`Rstr`	`ReadWritePart`	N/A
`Rstr`	`Yes`	N/A
`AcctId.Rstr`	Blank	Blank
`AcctId.Rstr`	`Clear`	N/A
`AcctId.Rstr`	`Hid`	N/A
`AcctId.Rstr`	`No`	N/A
`AcctId.Rstr`	`NoAccess`	N/A
`AcctId.Rstr`	`NoAccessPart`	N/A
`AcctId.Rstr`	`ReadOnly`	N/A
`AcctId.Rstr`	`ReadOnlyPart`	N/A
`AcctId.Rstr`	`ReadWrite`	N/A
`AcctId.Rstr`	`ReadWritePart`	N/A
`AcctId.Rstr`	`Yes`	N/A
`TINCode`	Pulls from CFMAST.CFSSCD	N/A
`AddrCat`	`All`	N/A
`AddrCat`	`Cust`	N/A
`AddrCat`	`IRSRpt`	N/A
`AddrCat`	`Phys`	N/A
`AddrCat`	`Prop`	N/A
`AddrCat`	`Seasonal`	N/A

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 Wed Mar 12 2025

Customer Search

Overview

CustSrch

Behavior

XPath Elements

XPath Elements

Validations

Validations

Service Dictionary

Service Dictionary