Customer Add

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

Overview

XPath Elements

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 that 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
`ErrCode`	JHFREFAPI.ERROVRRD	Error Override?	N/A
`BusSvcType`	N/A	Data Validation	Canonical Blank to Blank `NoValidate` to `N`
`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	CIF Expanded Title	N/A
`AddrLine`	CFMAST.CFNA4	Foreign Address	N/A
`StreetAddr1`	CFMAST.CFNA2	Address Line 1	N/A
`StreetAddr2`	CFMAST.CFNA3	Address Line 2	N/A
`Addr.City`	CFMAST.CFCITY	City	N/A
`Addr.StateCode`	CFMAST.CFSTAT	State	N/A
`Addr.PostalCode`	CFMAST.CFZIP	ZIP Code	N/A
`Addr.DlvryPt`	CFMAST.CFZIPD	ZIP Code Delivery Point	N/A
`Addr.Cntry`	CFMAST.CFFORC	Foreign Country	N/A
`InvAddr`	CFMAST.CFBADA	Insufficient Address	N/A
`CustType`	CFMAST.CFINDI	Individual	N/A
`NAICSCode`	VFMAST.CFNAICS	NAICS Code	N/A
`StdIndustCode`	CFMAST.CFBUST	Business Type	N/A
`Gender`	CFMAST.CFSEX	Sex	Canonical Blank to Blank `Female` to `F` `Male` to `M` `Other` to Blank
`BirthDt`	CFMAST.CFBIRD	Date of Birth (YYYYDDD)	N/A
`EmplName`	CFMAST.CFEMPL	Employer Name	N/A
`OccType`	CFMAST.CFOCPCD	CIF Occupation Code	N/A
`EmailAddr`	CFMAST.CFEML1	Email Address	N/A
`EmailAddr`	CFMAST.CFEML2	Other Email Address	N/A
`EmailType`	N/A	Email Description 1	N/A
`EmailType`	N/A	Email Description 2	N/A
`PhoneNum`	N/A	Phone Number 1	N/A
`PhoneNum`	N/A	Phone Number 2	N/A
`PhoneNum`	CFMAST.CFHPHO	Home Phone 1-6	There are 6 total elements available for you to enter information into.
`PhoneType`	N/A	Phone Type 1-8	There are 8 total elements available for you to enter information into.
`PhoneExt`	CFMAST.CFBPHX	Phone Ext ension1-8	There are 8 total elements available for you to enter information into.
`PhoneNumDsp`	N/A	Phone Number Display 1-8	There are 8 total elements available for you to enter information into.
`CrScoreId`	CFMASTV4.CFFICO	Current FICO® Score	N/A
`TINCode`	CFMAST.CFSSCD	Tax ID Type Code	N/A
`TaxId`	CFMAST.CFSSNO	Tax ID Number	N/A
`TaxIdMod`	CFMAST.CFSSFX	Tax ID Suffix	N/A
`CertCode`	CFMAST.CFTINS	TIN Status	N/A
`CertCodeDt`	CFMAST.CFTNDT	Status Changed Date	N/A
`BNotStat`	CFMAST.CFBNOT	B Notice Flag	N/A
`BNotIRSDt`	CFMAST.CFBNDT	Last IRS Notification	N/A
`TaxExtDt`	CFMAST.CFTXET	Tax Extension Date	N/A
`TaxRetDt`	CFMAST.CFTXRT	Tax Return Date	N/A
`AddrLine`	CFMAST.CFIRSF	IRS Foreign Delivery Point	N/A
`StreetAddr1`	CFMAST.CFIRSA	IRS Address	N/A
`City`	CFMAST.CFIRSC	IRS City	N/A
`StateCode`	CFMAST.CFIRSS	IRS State	N/A
`PostalCode`	CFMAST.CFIRSZ	IRS ZIP	N/A
`DlvryPt`	CFMAST.CFIRSD	IRS Delivery Point	N/A
`Cntry`	CFMAST.CFIRSFC	IRS Foreign Country	N/A
`AlienLastW8Dt`	CFMAST.CFADAT	Last Alien Certification	N/A
`ResCity`	CFORGN.FPCITY	Postal City	N/A
`ResStateProv`	CFORGN.FPPROV	Postal Province	N/A
`ResPostalCode`	CFORGN.FPCODE	Postal Code	N/A
`ResCntry`	CFORGN.FPCNTR	Postal Country	N/A
`ResCntryType`	CFORGN.FCNTRY	Residency Country	N/A
`IRSExmpCode`	CFORGN.FEXMPT	Exemption Code	N/A
`IRSRecipCode`	CFORGN.FRECIP	Recipient Code	N/A
`AlienTypeCode`	CFMAST.CFAFLG	Alien Flag	N/A
`AlienW8Type`	CFMAST.W8TYPE	W8 Type Code	Canonical Blank to Blank `BEN` to `BEN` `BEN-E` to `BNE` `ECI` to `ECI` `EXP` to `EXP` `IMY` to `IMY`
`AlienW8Stat`	CFMAST.W8STAT	W8 Status Code	N/A
`AlienW8ExpDt`	CFMAST.CFAEDAT	Alien Cert. Expiration	N/A
`FornTaxId`	CFORGN.FFORTIN	Foreign TIN	N/A
`CitzCntryType`	CFORGN.FCITZN	Citizenship Country	N/A
`GIINId`	CFORGN.FRGIIN	Recipient GIIN	N/A
`GIINDt`	CFORGN.FGIINDP7	GIIN Provided Date	N/A
`GIINCertDt`	CFORGN.FGIINDC7	GIIN Certified Date	N/A
`RptChapExst`	N/A	Chapter Exists	N/A
`RptChapType`	CFORGN.FCHAPTER	Reporting Chapter	Canonical `3` to `3` `4` to `4`
`IRSExmpCode`	CFORGN.FEXMPT	CH3 Exemption Code	N/A
`IRSRecipCode`	CFORGN.FRECIP	Chapter 3 Status	N/A
`FedWithCode`	CFMAST.CFWHCD	Fed W/H Code	N/A
`StateWithCode`	CFMAST.CFWHPR	State W/H Code	N/A
`OffCode`	CFMAST.CFOFFR	Officer Code	N/A
`BrCode`	CFMAST.CFBRNN	Branch Number	N/A
`CustCode`	CFMAST.CFCLAS	Class	N/A
`GroupCode`	CFMAST.CFGRP#	Related Group Number	N/A
`AbbrCustDesc`	CFMAST.CFINQC	Inquiry Code	N/A
`UserDefTxt`	CFPAR3.CP3UID	UIC Description 1–51	There are 51 total elements available for you to enter information into.
`UserDefCode`	CFPARB.CBFDFT	Field Default Value 1–51	There are 51 total elements available for you to enter information into.
`InsiderCode`	CFMAST.CFINSC	Insider Code	N/A
`CustImporCode`	CFMAST.CFVIPC	VIP Customer	N/A
`LeaseSecCode`	CFMAST.CFLEAS	Lease Security Flag	N/A
`NetWorth`	CFMAST.CFWRTH	Net Worth	N/A
`CustCycleCode`	CFMAST.CFCCYC	CIF Combined Cycle	N/A
`MailDirCode`	CFMAST.CFHLDM	Hold Mail Code	N/A
`ProfAnlys`	CFMAST.CFPROA	Profit Analysis	N/A
`FinStmtWavCode`	CFMAST.CFWVCD	F/S Waive Code	N/A
`FinStmtWavDt`	CFMAST.CFWVDT	F/S Waive Date	N/A
`LastFinStmtDt`	CFMAST.CFFSDT	Financial Statement Date	N/A
`FinStmtExpDt`	CFMAST.CFCFSD	Most Recent F/S Date	N/A
`LastFinStmtLtrDt`	CFMAST.CFLTDT	Last Letter Sent Date	N/A
`SalesPerson`	CFMAST.SALESAC	Sales Associate	N/A
`LangType`	CFMAST.CFLANG	Language Identifier	Canonical Blank to `ENG` `eng` to `ENG` `fre` to `FRE` `ger` to `GER` `pol` to `POL` `spa` to `SPA` `swe` to `SWE`
`NetWorthAmt`	CFMAST.CFWRTH	Net Worth Amount	N/A
`DoNotCallExpDt`	CFMAST.CFNCLEX7	CIF Do Not Call Flag Expiration Date 7	N/A
`DoNotCallCode`	CFMAST.CFNOCALL	CIF Do Not Call Flag	N/A
`RegPOptOutCode`	CFMAST.CFREGP	Privacy Act Opt Out	N/A
`RegPSentDt`	CFMAST.CFRPD7	Privacy Act Last Notice Sent Date	N/A
`CRAStateCode`	CFMAST.CFCRAS	CRA State Code	N/A
`CRACountyCode`	CFMAST.CFCNTY	County	N/A
`CRACenTract`	LNPAR5.L5CENS	Census Tract	N/A
`CRASMSACode`	CFMAST.CFSMSA	SMSA Code	N/A
`CRALoc`	CFMAST.CFCRAL	CRA Location	N/A
`CRAIncmLvl`	CFMAST.CFINCL	CRA Income Level	N/A
`AflOptOutCode`	CFMAST.CFAFLOPT	Affiliate Opt Out	N/A
`AflOptOutExcptCode`	CFMAST.CFAFLEXCD	Affiliate Opt Out Exception Code	N/A
`AflOptOutExcptDt`	CFMAST.CFAFLECD7	Affiliate Opt Out Exception Date	N/A
`AflOptOutExpDt`	CFMAST.CFAFLEXD7	Affiliate Opt Out Expiration Date	N/A
`CustDataRtnPeriod`	CFMAST.CFRETN	Retention	N/A
`RiskRateCode`	CFMAST.CFRSKRT	CIF Risk Rating	N/A
`RiskRateDt`	CFMAST.CFRSKD7	CIF Risk Rating Date	N/A
`RiskRateByCode`	CFMAST.CFRSKBY	CIF Risk Rated By Code	N/A
`ReqLegalEntityType`	CFFBENIN.FINCENLE	FinCEN Legal Entity	Canonical `false` to `E` `true` to `I`
`ExcOwnPct`	CFFBENIN.OVRPCT	Override Ownership Percentage	N/A
`ExcPctRsnCode`	CFFBENIN.PCTREASON	Override Percentage Reason	N/A
`BenflOwnExclCode`	CFFBENIN.EXCLCODE	Exclusion Code	N/A

Table 2. Output Element Fields
XPath Element	File/Field	Description	Notes
`CustId`	CFMAST.CFCIF#	Customer Number	N/A

Table 3. Maintenance
Field/Field	Maintenance Description	Field Label
CFMAST.CFCIF#	Customer Number	Customer Number
CFMAST.CFWHCD	Fed W/H Code	Fed W/H Code
CFMAST.CFWHPR	State W/H Code	State W/H Code

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 errors to occur.

Code	Element	System Message	Validation Trigger
12	`Addr1`	`Both address lines cannot be blank`	Presents when at least one address line is not populated.
12	`Addr2`	`Both address lines cannot be blank`	Presents when at least one address line is not populated.
13	`BrCode`	`Branch Number is not valid`	Presents when the branch is checked within the bank parameters and the branch does not exist.
17	`CRACenTract`	`Census Tract cannot be greater than 9999.99`	Presents when the value in this element is greater than six digits.
23	`City`	`City cannot be blank`	Presents when a value is not sent in this element or is sent as blank.
23	`Addr.City`	`City cannot be blank`	Presents when a value is not sent in this element or is sent as blank.
28	`CRAStateCode`	`CRA State code is not valid`	Presents when the value sent is not found within the core State Code File (JHSTATL1).
31	`AddrLine`	`Foreign address and City/State cannot both have values`	Presents when validating the city, state, and ZIP code. If the foreign address is populated, then the city and state cannot be populated.
31	`StreetAddr1`	`Foreign address and City/State cannot both have values`	Presents when validating the city, state, and ZIP code. If the foreign address is populated, then the city and state cannot be populated.
34	N/A	`Function is not available during Nightly Updates`	Presents when the operation is not available due to end-of-day (EOD) processing.
38	`GroupCode`	`Group number is not valid`	Presents when this element is populated and the value is not found in the CIF Related Customer Group parameter file (CFPARG).
43	`GIINDt`	`Date is not valid`	Presents when the value sent in this element is not in a valid format.
43	`AlienW8ExpDt`	`Date is not valid`	Presents when the value sent in this element is not in a valid format.
43	`GIINCertDt`	`Date is not valid`	Presents when the value sent in this element is not in a valid format.
43	`RegPSentDt`	`Date is not valid`	Presents when the value sent in this element is not in a valid format.
43	`AlienW8ExpDt`	`Date is not valid`	Presents when the value sent in this element is not in a valid format.
45	N/A	`Numeric data is not valid`	Presents when a numeric value is not sent on the request.
46	`MailDirCode`	`Mailing Instruction code is not valid`	Presents when the value in this element does not exist in Hold Mail Code Parameter File (JHMAIL).
50	`OffCode`	`Officer code is not valid`	Presents when the value in this element is not valid in the Officer File (JHOFFR).
68	`UserDefCode`	`Special information code 1 must be Y or N`	Presents when the value is in this element is not `Y` or `N`.
76	`StdIndustCode`	`Standard industry class code is not valid`	Presents when the value in this element is not equal to zero and not found in the CIF Standard Industry Classification (CFSICC) file.
79	`StateCode`	`State code is not valid`	Presents when a value is not sent for this element. This element cannot be left empty or sent as blank.
79	`Addr.StateCode`	`State code is not valid`	Presents when a value is not sent for this element. This element cannot be left empty or sent as blank.
99	`PostalCode`	`ZIP Code is required`	Presents when a value is not sent for this element. This element cannot be left empty or sent as blank.
99	`Addr.PostalCode`	`ZIP Code is required`	Presents when a value is not sent for this element. This element cannot be left empty or sent as blank.
112	`EmailAddr`	`Description is invalid`	Presents when a value is sent in the `EmailType` element but the `EmailAddr` element is blank.
112	`EmailType`	`Description is invalid`	Presents when a value is sent in the `EmailType` element but the `EmailAddr` element is blank.
121	N/A	`Description not allowed during account input`	Presents when the value is not equal to `Y`.
130	N/A	`The value entered is longer than the field length`	Presents when the value is larger than the field length.
131	N/A	`Incorrect number of decimal places`	Presents when the incorrect places after the decimal point are sent in.
235	`BirthDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`AlienTypeCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`AflOptOutExpDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`AflOptOutExcptCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`AflOptOutExcptDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`AlienLastW8Dt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`CRASMSACode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`TaxIdMod`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`CertCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`FinStmtWavCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`OffCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`OccType`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`DoNotCallExpDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`Addr2`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`NAICSCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`LastFinStmtLtrDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`LeaseSecCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`CertCodeDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`RiskRateByCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`RiskRateDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`RiskRateCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`TaxExtDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`TaxRetDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`UserDefCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`InsiderCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`AbbrCustDesc`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`CRAIncmLvl`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`MailDirCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`GroupCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`FinStmtExpDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`LastConDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`EmplName`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`EmailAddr`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`CRALoc`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`LastFinStmtDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`CRACenTract`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`NetWorthAmt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`Gender`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`CustCycleCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`StdIndustCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`BrCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`BNotIRSDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`Addr.DlvryPt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`Addr.PostalCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`Addr.StateCode`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`Addr.City`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`StreetAddr1`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`SalesPerson`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`FinStmtWavDt`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
235	`StreetAddr2`	`Field required for input`	Presents when no value is sent in this required element. These elements are checked to see if they are required.
400	`LangType`	`Language code is not a valid code`	Presents when this element is not equal to blank or the value is not found in the Preferred Language Parameter File (JHPARL).
1005	N/A	`Date field has an invalid format`	Presents when the data entered cannot be formatted into the date field.
200135	`StateWithCode`	`Invalid withholding code`	Presents when this element is populated with a value that is not found in the Federal Withholding Reason Codes (JHWITH) file.
200135	`FedWithCode`	`Invalid withholding code`	Presents when this element is populated with a value that is not found in the Federal Withholding Reason Codes (JHWITH) file.
400001	`AflOptOutCode`	`Aff Exception Code not valid when Aff Opt-out is N`	Presents when the Affiliate Opt-Out field is set to `N` and this element is not blank.
400002	`AflOptOutExpDt`	`Aff Opt-out Exception Date is not valid`	Presents when the value in this field is less than or equal to zero.
400003	`AflOptOutCode`	`Affiliate Opt-out must be Y or N`	Presents when the value in this element is not `Y` or `N`.
400004	`AlienLastW8Dt`	`Alien certification date is required when alien customer flag is Y`	Presents when the `AlienTypeCode` element is `Y` and the `AlienLastW8Dt` element is zero.
400004	`AlienTypeCode`	`Alien certification date is required when alien customer flag is Y`	Presents when the `AlienTypeCode` element is `Y` and the `AlienLastW8Dt` element is zero.
400005	`ResCntryType`	`Alien country of residency is not valid`	Presents when the value sent in this element is not found in the CIF Foreign Customer Country File (CFOPR1).
400006	`AlienTypeCode`	`Alien customer flag is not valid for this tax ID type`	Presents when this element is sent with value of `N` and the `TaxID` element is set to `A`.
400007	`AlienTypeCode`	`Alien customer flag must be Y or N`	Presents when the value sent in this element is not `Y` or `N`.
400008	`AlienLastW8Dt`	`Alien customer flag must be Y when W8 certification date has a value`	Presents when the `AlienTypeCode` element is `N` and the `AlienLastW8Dt` is not equal to zero.
400008	`AlienTypeCode`	`Alien customer flag must be Y when W8 certification date has a value`	Presents when the `AlienTypeCode` element is `N` and the `AlienLastW8Dt` is not equal to zero.
400009	`ResCity`	`Alien postal city cannot be blank`	Presents when this element is sent as blank.
400010	`ResPostalCode`	`Alien postal code is required`	Presents when this element is sent as blank.
400011	`ResCntry`	`Alien postal country code is required`	Presents when this element is sent as blank or the value is not found in the CIF Foreign Customer Country File (CFOPR1).
400012	`ResStateProv`	`Alien postal province is required`	Presents when the `ResCntry` element is sent as `CA` and this element is sent as blank.
400013	`IRSRecipCode`	`Alien recipient code is not valid`	Presents when the value sent in this element is not found in the CIF Foreign Customer Recipient Codes (CFOPR2) file or the CIF Foreign Customer Chapter 4 Status Codes (CFOPR24) file.
400014	`IRSExmpCode`	`Alien tax exemption code is not valid`	Presents when the value in this element is an invalid chapter 3 or chapter 4 code or the value is equal to zero.
400015	`AlienLastW8Dt`	`Alien W8 certification date is not valid`	Presents when this element is equal to zero.
400016	`BirthDt`	`Birth date is not valid or in the future`	Presents when the value sent in this element is less than or equal to zero.
400019	`PhoneType`	`Business cell phone number is not valid`	Presents when the value in this element is sent as `C2`.
400020	`PhoneType`	`Business fax number is not valid`	Presents when the value in this element is sent as `F2`.
400022	`PhoneType`	`Business phone number is not valid`	Presents when the value in this element is sent as `B1`.
400023	`ResStateProv`	`Canadian province must be valid as defined by the IRS`	Presents when the country is sent as `CA` and the province is not found within the CIF Foreign Customer Province File (CFOPR4).
400024	`PhoneType`	`Cell phone number is not valid`	Presents when the value in this element is sent as `C1`.
400025	`CustCycleCode`	`Combined cycle is not valid`	Presents when the value sent in this element is not found in the Deposit Cycle Code Parameter File (DDPAR7).
400026	`Custcode`	`Customer class is not valid`	Presents when the value sent in this element is blank or not found in the Class Parameter File (JHCLAS).
400029	N/A	`Individual code must be Y or N`	Presents when the field CUSTTYPE is not set to `Y` or `N`.
400030	`DoNotCallExpDt`	`Do not call expiration date is not valid`	Presents when the value sent in this element is less than or equal to zero.
400031	`DoNotCallCode`	`Do not call flag is not valid`	Presents when the value in this element is not set to blank or is not a `Y` or `N`.
400032	`PhoneType`	`Fax number is not valid`	Presents when the value in this element is sent as `F1`.
400033	`FinStmtExpDt`	`Financial statement date is not valid`	Presents when the value in this element is less than or equal to zero.
400034	`FinStmtWavCode`	`Financial statement waive code is not valid`	Presents when the value sent in this element is blank or is not found in the CIF Financial Statement Waive Code Parameter File (CFPAR9).
400036	`ComName`	`First character of customer name cannot be blank on non-individual account`	Presents when the first position of the value in this element is blank.
400037	`LastName`	`First character of last name cannot be blank`	Presents when the first position of the value in this element is blank.
400038	`FirstName`	`First name cannot be blank on individual account`	Presents when the first position of the value in this element is blank.
400039	`PhoneType`	`Home phone number is not valid`	Presents when the value in this element is sent as `H1`.
400040	`CRAIncmLvl`	`Income level is not valid`	Presents when the value sent in this element is not blank or is not found in the CIF CRA Income Level Parameter File (CFPARI).
400041	`InsiderCode`	`Insider code is not valid`	Presents when the value sent in this element is not valid in the CIF Insider Code File (CFPAR5).
400043	`AflOptOutExcptcode`	`Affiliate Opt-out Exception Code is not valid`	Presents when the value sent in this element is not blank or is not found in the CIF Affiliate Opt Out Exception Code Parameters (CFPARE) file.
400044	`AflOptOutExcptDt`	`Affiliate Opt-out Exception Date is not valid`	Presents when the date entered in this element is less than or equal to zero.
400045	`LeaseSecCode`	`Lease security code is not valid`	Presents when the value in this element is not equal to `L`, `T`, `B`, or blank.
400046	`LastName`	`Last name cannot be blank on individual account`	Presents when the value in this element is blank.
400047	`LastFinStmtDt`	`Most recent financial statement date is not valid`	Presents when the value for the data is less than or equal to zero.
400048	`NAICSCode`	`NAICS code is not valid`	Presents when the value sent in this element is populated and is not found in the LNNAIC file.
400049	`PhoneType`	`Phone extension only valid for phone type B`	Presents when the business phone extension is not equal to zero and this element is not equal to `B1` and `B2`.
400050	`RegPOptOutCode`	`Privacy act opt out flag must be Y or N`	Presents when the value in this element is not `Y` or `N`.
400051	`ProfAnlys`	`Profit analysis code must be Y or N`	Presents when the PROFANAL field is not set to `Y` or `N` for profit analysis.
400052	`CustDataRtnPeriod`	`Retention years must be 1 through 9`	Presents when the RETENTION field is not within the 1 to 9 years to retain.
400053	`RiskRateByCode`	`Risk rated by code does not match officer list`	Presents when the value sent in this element is not blank or is not found in the Officer File (JHOFFR).
400054	`RiskRateCode`	`Risk rating code is not valid`	Presents when the value sent in this element is not blank or is not found in the CIF Risk Rating Parameter File (CFPARRT).
400055	`RiskRateDt`	`Risk rating date is not valid`	Presents when the value entered for the date is less than or equal to zero.
400056	`Gender`	`Sex code must be M or F`	Presents when the value in this element is not blank or set to `M` or `F`.
400057	`CustImporCode`	`Special customer flag must be Y or N`	Presents when the VIPCUST field is not set to `Y` or `N`.
400059	`TaxExtDt`	`Tax extension date is not valid`	Presents when the value of the data is less that or equal to zero.
400061	`TaxId`	`Tax ID number cannot be zeros or all 9's`	Presents when the value in this element is validated and it contains all zeros or all nines.
400062	`TaxId`	`Tax ID type is not valid`	Presents when this element is not equal to zero or is not found in the CIF Tax ID Type Parameter File (CFPART).
400063	`FinStmtWavDt`	`Tax return date is not valid`	Presents when the date value is less than or equal to zero.
400063	`TaxRetDt`	`Tax return date is not valid`	Presents when the date value is less than or equal to zero.
400064	`CertCode`	`TIN certification date is not valid`	Presents when the TIN status is not equal to blank and the date value is equal to zero.
400065	`CertCode`	`TIN status is not valid`	Presents when the TIN status is not equal to blank and is not set to a value of `C`, `S`, or `B`.
400066	`UserDefTxt`	`User information code 1 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400066	`UserDefCode`	`User information code 1 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400067	`UserDefCode`	`User information code 2 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400067	`UserDefTxt`	`User information code 2 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400068	`UserDefTxt`	`User information code 3 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400068	`UserDefCode`	`User information code 3 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400069	`UserDefCode`	`User information code 4 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400069	`UserDefTxt`	`User information code 4 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400070	`UserDefCode`	`User information code 5 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400070	`UserDefTxt`	`User information code 5 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400071	`UserDefCode`	`User information code 6 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400071	`UserDefTxt`	`User information code 6 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400072	`UserDefTxt`	`User information code 7 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400072	`UserDefCode`	`User information code 7 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400073	`UserDefTxt`	`User information code 8 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400073	`UserDefCode`	`User information code 8 is not valid`	Presents when the user information entered is not valid within the CIF User Information Code (UIC) File (CFPAR3).
400090	`BNotStat`	`Number of B notices must be 0, 1, or 2`	Presents when the CFBNOT field is not set to `0`, `1`, or `2` for the B notices.
400091	`LastFinStmtLtrDt`	`Last financial statement letter sent date is not valid`	Presents when the date is less than or equal to zero, making it invalid.
400092	`BNotIRSDt`	`B notice date is not valid`	Presents when the date is less than or equal to zero, making it invalid.
400093	`AlienW8Type`	`W8 Type must be BEN, BNE, ECI, EXP, or IMY`	Presents when this element does not have the specific values.
400094	`AlienW8Stat`	`W8 Status must be O=on file, E=expired, or M=manual`	Presents when this element is not equal to `O`, `E`, or `M`.
400095	`Addr.DlvryPt`	`Delivery point requires ZIP4`	Presents when this element is not equal to blank and is equal to `0000`.
400095	`Addr.PostalCode`	`Delivery point requires ZIP4`	Presents when this element is not equal to blank and is equal to `0000`.
400095	`Addr.DlvryPt`	`Delivery point requires ZIP4`	Presents when this element is not equal to blank and is equal to `0000`.
400096	`PhoneType`	`Phone type required when phone number is entered`	Presents when this element is blank and the `PhoneNum` element is not equal to blank.
400105	`RptChapType`	`Invalid Chapter Code`	Presents when the value in this element is not `3` or `4`.
400106	`CitzCntryType`	`Invalid Country of Citizenship`	Presents when this element is not blank or is not found in the CIF Foreign Customer Country File (CFORP1).
400107	`GIINId`	`Invalid GIIN`	Presents when this element is not blank or is not sent in the correct format.
400110	`RptChapType`	`Chapter 4 Exemption Code required when Reporting Chapter 3`	Presents when the Chapter 4 exemption code is equal to zero and the value in this element is `3`.
400123	`TaxId`	`Supervisor Override authority required for Duplicate TIN`	Presents when the duplicate tax ID is overridden and the Require Supervisor Override on Dup SSN (DUPSSNOV) field in the CIF General Parms Index (CFPAR10) file is set to `Y`.
400128	`ReqLegalEntityType`	`FinCen Legal Entity must be I=Include or E=Exclude`	Presents when the value in this element is not set to `I` or `E`.
400129	`ReqLegalEntityType`	`Invalid Exclusion Reason`	Presents when the `ReqLegalEntityType` element is `E` and the `BenflOwnExclCode` element is blank or not equal to a value in the Beneficial Owner Exclusion Reason Parameter (CFPARN) file.
400129	`BenflOwnExclCode`	`Invalid Exclusion Reason`	Presents when the `ReqLegalEntityType` element is `E` and the `BenflOwnExclCode` element is blank or not equal to a value in the Beneficial Owner Exclusion Reason Parameter (CFPARN) file.
400130	`ReqLegalEntityType`	`Exclusion Reason not valid for code = I`	Presents when the `ReqLegalEntityType` element is `I` and the `BenflOwnExclCode` element is not blank.
400130	`BenflOwnExclCode`	`Exclusion Reason not valid for code = I`	Presents when the `ReqLegalEntityType` element is `I` and the `BenflOwnExclCode` element is not blank.
400132	`ReqLegalEntityType`	`Override Percentage not valid for code = E`	Presents when the `ReqLegalEntityType` element is `E` and the `ExcOwnPct` element is not equal to zero.
400132	`ExcOwnPct`	`Override Percentage not valid for code = E`	Presents when the `ReqLegalEntityType` element is `E` and the `ExcOwnPct` element is not equal to zero.
400133	`ReqLegalEntityType`	`Percent range must be from 00 to 25`	Presents when the `ExcPctRsnCode` is less than `0` and greater than `25`.
400133	`ExcOwnPct`	`Percent range must be from 00 to 25`	Presents when the `ExcPctRsnCode` is less than `0` and greater than `25`.
400134	`ReqLegalEntityType`	`Percentage Reason not valid for code = E`	Presents when the `ReqLegalEntityType` element is set to `E` and the `ExcPctRsnCode` is not equal to blank.
400134	`ExcPctRsnCode`	`Percentage Reason not valid for code = E`	Presents when the `ReqLegalEntityType` element is set to `E` and the `ExcPctRsnCode` is not equal to blank.
400135	`ExcPctRsnCode`	`Invalid Percentage Reason`	Presents when the `ExcPctRsnCode` element is equal to blank.
400135	`ReqLegalEntityType`	`Invalid Percentage Reason`	Presents when the `ExcPctRsnCode` element is equal to blank.
400135	`ExcPctRsnCode`	`Invalid Percentage Reason`	Presents when the `ExcPctRsnCode` element is equal to blank.
400136	`ReqLegalEntityType`	`Percentage Reason not valid if Override Percentage = 0`	Presents when the `ExcPctRsnCode` element is equal to blank.
400136	`ExcPctRsnCode`	`Percentage Reason not valid if Override Percentage = 0`	Presents when the `ExcPctRsnCode` element is equal to blank.
400140	`PhoneType`	`Business Phone Number 2 is not valid`	Presents when the value in this element is sent as `B2`.
400141	`PhoneType`	`Home Phone Number 2 is not valid`	Presents when the value in this element is sent as `H2`.
402402	`StateWithCode`	`State must be blank with a Foreign Address`	Presents when the state is blank and the `StateWithCode` element is greater than zero.
410080	`SalesPerson`	`Invalid Sales Associate Code`	Presents when the value in this element is not valid in the JHPARJ file.

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

Code	Element	System Message	Validation Trigger
290472	N/A	`Review request, data not updated for Table`	Presents when the core system cannot update the Current FICO Score (CFFICO) field in the View of CIF with FICO Values (CFMASTV4) file.
400027	`ComName`	`Customer name closely matches OFAC suspect`	Presents when the OFAC search has a match or one that closely matches.
402500	`FirstName`	`No OFAC match found`	Presents when the OFAC search does not have a match.
402500	`ComName`	`No OFAC match found`	Presents when the OFAC search does not have a match.
402527	`ComName`	`OFAC matching word`	Presents when checking for OFAC keywords and gets a match.

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

Code	Element	System Message	Validation Trigger
67	`CRAStateCode`	`SMSA, Census Tract, State, County combination is not valid`	Presents when the combination is not valid in the Census Tract Parameter File (LNPAR5).
67	`CRACenTract`	`SMSA, Census Tract, State, County combination is not valid`	Presents when the combination is not valid in the Census Tract Parameter File (LNPAR5).
67	`CRASMSACode`	`SMSA, Census Tract, State, County combination is not valid`	Presents when the combination is not valid in the Census Tract Parameter File (LNPAR5).
67	`OffCodeCRACountyCode`	`SMSA, Census Tract, State, County combination is not valid`	Presents when the combination is not valid in the Census Tract Parameter File (LNPAR5).
400021	`PhoneExt`	`Business phone ext must be zero when business phone is zero`	Presents when the business phone number is blank or zero but this element is populated.
400060	`TaxId`	`Tax ID already exists`	Presents when this element exists in the CIF Master File (CFMAST).
402090	`Addr1`	`Physical address required on P.O. Box Address`	Presents when the address is checked is a PO Box is found.
402090	`Addr2`	`Physical address required on P.O. Box Address`	Presents when the address is checked is a PO Box is found.
410001	`AlienLastW8Dt`	`Last Alien Certification required, may be overridden`	Presents when a field is required but can be overridden.
410002	`AflOptOutExcptDt`	`Affiliate Opt-out Exception Date required, may be overridden`	Presents when a field is required but can be overridden.
410003	`AflOptOutExcptCode`	`Affiliate Opt-out Exception Code required, may be overridden`	Presents when a field is required but can be overridden.
410004	`AflOptOutExpDt`	`Affiliate Opt-out Expiration Date required, may be overridden`	Presents when a field is required but can be overridden.
410005	`AlienTypeCode`	`Alien Flag required, may be overridden`	Presents when a field is required but can be overridden.
410007	`BirthDt`	`Date of Birth required, may be overridden`	Presents when a field is required but can be overridden.
410008	`BNotIRSDt`	`Last IRS Notification required, may be overridden`	Presents when a field is required but can be overridden.
410010	`PhoneNum`	`Business Phone required, may be overridden`	Presents when a field is required but can be overridden.
410011	`PhoneExt`	`Business Phone Extension required, may be overridden`	Presents when a field is required but can be overridden.
410012	`BrCode`	`BrCodeber required, may be overridden`	Presents when a field is required but can be overridden.
410013	`StdIndustCode`	`Standard Industrial Code required, may be overridden`	Presents when a field is required but can be overridden.
410014	`CustCycleCode`	`CIF Combined Cycle required, may be overridden`	Presents when a field is required but can be overridden.
410015	`PhoneType`	`Cell Phone Number required, may be overridden`	Presents when a field is required but can be overridden.
410016	`PhoneType`	`Other Cell Phone Number required, may be overridden`	Presents when a field is required but can be overridden.
410017	`CRACenTract`	`Census tract required, may be overridden`	Presents when a field is required but can be overridden.
410018	`LastFinStmtDt`	`Most Recent Financial Stmt Date required, may be overridden`	Presents when a field is required but can be overridden.
410020	`CRALoc`	`CRA Location required, may be overridden`	Presents when a field is required but can be overridden.
410021	`EmailAddr`	`E-Mail Address required, may be overridden`	Presents when a field is required but can be overridden.
410022	`EmailAddr`	`Other E-Mail Address required, may be overridden`	Presents when a field is required but can be overridden.
410023	`EmplName`	`Employer Name required, may be overridden`	Presents when a field is required but can be overridden.
410024	`PhoneType`	`Fax Number required, may be overridden`	Presents when a field is required but can be overridden.
410025	`Phonetype`	`Other Fax Number required, may be overridden`	Presents when a field is required but can be overridden.
410026	`FinStmtExpDt`	`Financial Statement Date required, may be overridden`	Presents when a field is required but can be overridden.
410027	`GroupCode`	`Related Group Number required, may be overridden`	Presents when a field is required but can be overridden.
410028	`MailDirCode`	`Hold Mail Code required, may be overridden`	Presents when a field is required but can be overridden.
410029	`PhoneType`	`Home Phone required, may be overridden`	Presents when a field is required but can be overridden.
410030	`CRAIncmLvl`	`Income Level required, may be overridden`	Presents when a field is required but can be overridden.
410031	`AbbrCustDesc`	`Inquiry Code required, may be overridden`	Presents when a field is required but can be overridden.
410032	`InsiderCode`	`Insider Code required, may be overridden`	Presents when a field is required but can be overridden.
410033	`LeaseSecCode`	`Lease Security Flag required, may be overridden`	Presents when a field is required but can be overridden.
410034	`LastFinStmtLtrDt`	`Last Letter Send Date required, may be overridden`	Presents when a field is required but can be overridden.
410035	`NAICSCode`	`NAICS Code required, may be overridden`	Presents when a field is required but can be overridden.
410038	`Addr2`	`Address Line 2 required, may be overridden`	Presents when a field is required but can be overridden.
410040	`DoNotCallExpDt`	`No Call Customer Expiration Date required, may be overridden`	Presents when a field is required but can be overridden.
410042	`OccType`	`Occupation/Nature of Business required, may be overridden`	Presents when a field is required but can be overridden.
410043	`OffCode`	`Officer Code required, may be overridden`	Presents when a field is required but can be overridden.
410047	`RiskRateByCode`	`CIF Risk Rated By required, may be overridden`	Presents when a field is required but can be overridden.
410048	`RiskRateDt`	`CIF Risk Rating Date required, may be overridden`	Presents when a field is required but can be overridden.
410049	`RiskRateCode`	`CIF Risk Rating Code required, may be overridden`	Presents when a field is required but can be overridden.
410050	`Gender`	`Sex Code required, may be overridden`	Presents when a field is required but can be overridden.
410059	`CRASMSACode`	`SMSA Code required, may be overridden`	Presents when a field is required but can be overridden.
410061	`TaxIdMod`	`Tax ID Suffix required, may be overridden`	Presents when a field is required but can be overridden.
410062	`CertCode`	`TIN Status required, may be overridden`	Presents when a field is required but can be overridden.
410063	`CertCodeDt`	`Status Changed Date required, may be overridden`	Presents when a field is required but can be overridden.
410064	`TaxExtDt`	`Tax Extension Date required, may be overridden`	Presents when a field is required but can be overridden.
410065	`TaxRetDt`	`Tax Return Date required, may be overridden`	Presents when a field is required but can be overridden.
410066	`UserDefCode`	`User Information Code 1 required, may be overridden`	Presents when a field is required but can be overridden.
410067	`UserDefCode`	`User Information Code 2 required, may be overridden`	Presents when a field is required but can be overridden.
410068	`UserDefCode`	`User Information Code 3 required, may be overridden`	Presents when a field is required but can be overridden.
410069	`UserDefCode`	`User Information Code 4 required, may be overridden`	Presents when a field is required but can be overridden.
410070	`UserDefCode`	`User Information Code 5 required, may be overridden`	Presents when a field is required but can be overridden.
410071	`UserDefCode`	`User Information Code 6 required, may be overridden`	Presents when a field is required but can be overridden.
410072	`UserDefCode`	`User Information Code 7 required, may be overridden`	Presents when a field is required but can be overridden.
410073	`UserDefCode`	`User Information Code 8 required, may be overridden`	Presents when a field is required but can be overridden.
410075	`NetWorthAmt`	`Net Worth required, may be overridden`	Presents when a field is required but can be overridden.
410076	`FinStmtWavCode`	`Financial Stmt Waive Code required, may be overridden`	Presents when a field is required but can be overridden.
410077	`FinStmtWavDt`	`Financial Stmt Waive Date required, may be overridden`	Presents when a field is required but can be overridden.
410078	`Addr.DlvryPt`	`ZIP code delivery point required, may be overridden`	Presents when a field is required but can be overridden.
410079	`SalesPerson`	`Sales Associate required, may be overridden`	Presents when a field is required but can be overridden.

Service Dictionary

Service Dictionary Search provides consumers a service that can convey a service provider's element XSD path, requirements, default values, open enumerated canonical values, help/knowledge content, and fault codes per operation.

Within the SvcDictSrch operation, you can send Operation Name in the SvcDictName element and Rq or Rs in the SvcDictType element. Within the response, SvcDictSrch returns all mapped elements, including any newly mapped elements, and any elements that have specific allowed values. The following table lists the response information for elements with specified allowed values.

Element Name	Field Value (ElemCanocVal)	Field Description (ElemCanocValDesc)
`InvAddr`	`N`	No
`InvAddr`	`Y`	Yes
`NAICSCode`	Pulls from CFMAST.CFNAICS	NAICS Code
`StdIndustCode`	Pulls from CFMAST.CFBUST	Business Type
`Gender`	`Female`	Female
`Gender`	`Male`	Male
`PhoneType`	`Home Phone`	N/A
`PhoneType`	`Home Phone 2`	N/A
`PhoneType`	`Business Phone`	N/A
`PhoneType`	`Business Phone 2`	N/A
`PhoneType`	`Home Cell Phone`	N/A
`PhoneType`	`Business Cell Phone`	N/A
`PhoneType`	`Home Fax Number`	N/A
`PhoneType`	`Business Fax Number`	N/A
`TINCode`	`A`	Applied For
`TINCode`	`B`	Business
`TINCode`	`C`	Canadian Reportable
`TINCode`	`F`	Foreign Reportable
`TINCode`	`G`	Foreign Non-Report
`TINCode`	`I`	Individual
`TINCode`	`N`	Non-Reporting Bus
`TINCode`	`T`	Business
`TINCode`	`X`	TIN not Required
`CertCode`	`B`	"B" notice has been generated by the IRS
`CertCode`	`C`	Customer has certified the TIN provided
`CertCode`	`S`	You have sent the customer a TIN certif.
`BNotStat`	`0`	Zero
`BNotStat`	`1`	One
`BNotStat`	`2`	Two
`TINMatchType`	`MNoMatch`	No
`TINMatchType`	`U`	Unknown
`TINMatchType`	`Match`	Yes
`IRSExmpCode`	`1`	Effectively connected income
`IRSExmpCode`	`2`	Exempt under IRC
`IRSExmpCode`	`3`	Income is not from U.S. sources
`IRSExmpCode`	`4`	Exempt under tax treaty
`IRSExmpCode`	`5`	Portfolio interest exempt under an IRC
`IRSExmpCode`	`6`	Qualified intermediary assumes primary
`IRSExmpCode`	`7`	Withholding foreign partnership or trust
`IRSExmpCode`	`8`	U.S. branch treated as U.S. person
`IRSExmpCode`	`9`	Territory FI treated as U.S. Person
`IRSExmpCode`	`10`	QI represents that income is exempt
`IRSExmpCode`	`11`	QSL assumes w/h responsibility
`IRSExmpCode`	`12`	Payee subjected to chapter 4 withholding
`IRSExmpCode`	`22`	QDD assumes primary w/h responsibility
`IRSExmpCode`	`23`	Exempt under section 897(I)
`IRSExmpCode`	`24`	Exempt under section 892
`IRSRecipCode`	`3`	TFI treated as U.S. Person
`IRSRecipCode`	`4`	TFI not treated as U.S. Person
`IRSRecipCode`	`5`	U.S. branch-treated as U.S. Person
`IRSRecipCode`	`6`	U.S. branch-not treated as U.S. Person
`IRSRecipCode`	`7`	U.S. branch-ECI presumption applied
`IRSRecipCode`	`8`	Partnership other than WH Foreign Partn.
`IRSRecipCode`	`9`	Withholding Foreign Partnership
`IRSRecipCode`	`10`	Trust other than WH Foreign Trust
`IRSRecipCode`	`11`	Withholding Foreign Trust
`IRSRecipCode`	`12`	Qualified Intermediary
`IRSRecipCode`	`13`	Qualified Securities Lender - QI
`IRSRecipCode`	`14`	Qualified Securities Lender - Other
`IRSRecipCode`	`15`	Corporation
`IRSRecipCode`	`16`	Individual
`IRSRecipCode`	`17`	Estate
`IRSRecipCode`	`18`	Private Foundation
`IRSRecipCode`	`19`	International Organization
`IRSRecipCode`	`20`	Tax Exempt Organization (Section 501(c))
`IRSRecipCode`	`21`	Unknown Recipient
`IRSRecipCode`	`22`	Artist or Athlete
`IRSRecipCode`	`23`	Pension
`IRSRecipCode`	`24`	Foreign Central Bank of Issue
`IRSRecipCode`	`25`	Nonqualified Intermediary
`IRSRecipCode`	`26`	Hybrid entity making Treaty Claim
`IRSRecipCode`	`27`	W/H Rate pool - General
`IRSRecipCode`	`28`	W/H Rate pool - Exempt Organization
`IRSRecipCode`	`29`	PAI WH Rate Pool - General
`IRSRecipCode`	`30`	PAI WH Rate Pool - Exempt Organization
`IRSRecipCode`	`31`	Agency WH Rate Pool - General
`IRSRecipCode`	`32`	Agency WH Rate Pool -Exempt Organization
`IRSRecipCode`	`35`	Qualified Derivatives Dealer
`IRSRecipCode`	`36`	Foreign Government - Integral Part
`IRSRecipCode`	`37`	Foreign Government - Controlled Entity
`IRSRecipCode`	`38`	Publicly Traded Partnership
`AlienTypeCode`	`N`	No
`AlienTypeCode`	`Y`	Yes
`AlienW8Type`	`BEN`	Certificate Foreign Status Individual
`AlienW8Type`	`BEN-E`	Certificate Foreign Status Entities
`AlienW8Type`	`ECI`	Certificate Foreign Person's (Business)
`AlienW8Type`	`EXP`	Certificate Foreign Government Org
`AlienW8Type`	`IMY`	Certificate Foreign Intermediary
`AlienW8stat`	`E`	Expired W8
`AlienW8stat`	`M`	Manual bypass automatic W8 functionality
`AlienW8stat`	`O`	On File/Current W8
`RptChapType`	`3`	N/A
`RptChapType`	`4`	N/A
`OffCode`	Pulls from CFMAST.CFOFFR	Officer Code
`BrCode`	Pulls from CFMAST.CFBRNN	Branch Number
`CustCode`	`B`	Business
`CustCode`	`C`	Corporation
`CustCode`	`D`	Director
`CustCode`	`E`	Employee
`CustCode`	`F`	Foreign
`CustCode`	`G`	DBA
`CustCode`	`H`	Sole Prop
`CustCode`	`I`	Individual
`CustCode`	`J`	County Govt
`CustCode`	`K`	Estate
`CustCode`	`L`	Lawyer Trust
`CustCode`	`M`	Conversion
`CustCode`	`N`	Non-Profit
`CustCode`	`O`	Officer
`CustCode`	`P`	Personal
`CustCode`	`Q`	Partnerships
`CustCode`	`R`	Church
`CustCode`	`S`	State and Pol S/D
`CustCode`	`T`	Trust
`CustCode`	`U`	U.S. Government
`CustCode`	`V`	Service Prov
`CustCode`	`W`	Fiduciary Prov
`CustCode`	`X`	Official Checks
`CustCode`	`Y`	Other FI
`CustCode`	`Z`	Public Funds
`GroupCode`	Pulls from CFMAST.CFGRP#	Related Group Number

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 Add

Overview

CustAdd

Behavior

XPath Elements

Xpath Elements

Validations

Validations

Service Dictionary

Service Dictionary