Customer Modification
Customer Mod
Customer Modification is a jXchange messaging service designed to allow third-party consumers to modify or delete consumer information existing on a service provider.
Message elements for Customer Mod are similar to those for Customer Add, with the addition of a customer ID (used for identifying the customer listing to be modified) and a customer listing deletion request element. Simple, complex, and array elements are used in Customer Mod. Optional complex elements are not used in Customer Mod messaging.
Message Flow
In jXchange, the Customer Modification
service uses a typical exchange of MType
messages to
modify or delete consumer information.
Primary Request
The third-party consumer forwards the CustModRq_MType
message to the
service provider. The message contains:
BusDetail_CType
CustDetail_CType
RegDetail_CType
TaxDetail_CType
Only the simple elements with values requiring change need to be included in the request within those complexes. The CustId element must also be included to identify the customer listing to be changed.
Primary Response
The service provider returns the CustModRq_MType
to the third-party consumer.
The message contains:
- Dlt
The False default value for the Dlt element must be reassigned to True for a deletion to be requested.
Customer Modification Behavior
The ActIntent element exists on all inquiry operations that support a modification mate. For example, the Account Inquiry operation's modification mate is the Account Modification operation.
The ActIntent element allows the consumer to convey to the Service Provider their intention for the data returned in the response. The ActIntent element supports three canonical values:
- ReadOnly - Read-only
- Upd - Update
- Dlt - Delete
The ReadOnly canonical value is the default.
The service provider echoes the ActIntent element in the response. The service provider returns an ActIntentKey element when the third-party consumer submits the ActIntent element canonical values of Upd or Dlt. The third-party consumer should cache the ActIntentKey so it can be submitted in a subsequent modification request.
Request a Modification
This is an example document.
After seeing that the consumer’s phone extension is incorrectly listed, the Internet bank submits a modification request to the Service Provider containing the following values:
Complex | Contains | Entry Value |
---|---|---|
CustModRq_MType | CustId | IND372216 |
CustDetail_CType | ||
CustDetail_CType | PhoneArray_AType | |
PhoneArray_AType | PhoneInfo_CType | |
PhoneInfo_CType | PhoneExt | 1758 |
Initial Response
Once the consumer’s extension has
been modified, the Service Provider returns the CustModRs_MType
complex to the
Third Party Consumer (Internet bank) with the following
value:
Complex | Contains | Entry Value |
---|---|---|
CustModRs_MType | RsStat | Success |
CustModRq_MType
CustModRq_MType
is a message
MType
element.
Contains:
BusDetail_CType
ConDetailArray_AType
CustDetail_CType
Custom_CType
ErrOvrRdInfoArray_AType
MsgRqHdr_CType
RegDetail_CType
TaxDetail_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- Dlt
The delete element. Canonical values are:
- false
- true
BusDetail_CType
BusDetail_CType
is a complex CType
element containing customer, statement, bank officer, and branch codes. This element is
optional.
Contains:
BnkRptcyInfoRec_CType
Custom_CType
OffInfoArray_AType
UserDefInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AbbrCustDesc
- An abbreviated customer description.
- BrCode
- The branch code.
- CustCode
- The code that further defines the customer.
- CustCycleCode
- The customer cycle code.
- CustImporCode
- The customer importance code. Example, VIP.
- FinStmtExpDt
- Financial statement expiration date.
- FinStmtWavCode
- F/S waive code.
- FinStmtWavDt
- F/S waive date.
- GroupCode
- Used to group loans of different types for general ledger reporting purposes. It may also be used to group customer accounts together.
- InsiderCode
- Insider code.
- LangType
- The language as defined by ISO 639-2 Language code list, available
at http://www.loc.gov/standards/iso639-2/php/code_list.php. Canonical
values are:
- chi
- eng
- fre
- ger
- ita
- jpn
- kor
- pol
- por
- spa
- swe
- zho
- LastConDt
- The date of last contact.
- LastFinStmtDt
- The last financial statement date.
- LastFinStmtLtrDt
- The last financial statement letter sent date.
- LeaseSecCode
- For lease security accounts, this flag represents the category that
this record falls under. Valid entries are:
- B - building
- L - landlord
- T - tenant
- MailDirCode
- The code for the mail directive, such as Hold.
- NetWorthAmt
- The net worth of an entity.
- OffCode
- The code that designates the financial institution officer.
- ProfAnlys
- For profit analysis.
- SalesPerson
- The code value that represents the sales person. This element was changed from a string to an open enumerated type in 4/2011. This element resides as an exception and is not to be suffixed with code rather than deprecate the element. The element does have a description.
ConDetailArray_AType
ConDetailArray_AType
is an array AType
element. This
is an array of contact information.
Contains:
ConDetailRec_CType
ConDetailRec_CType
ConDetailRec_CType
is a complex CType element.
Contains:
ConDetail_CType
Simple Elements
The following simple elements are contained within this complex.
- MobPrvdCodeDesc
- The description of the provider code for the mobile service.
ConDetail_CType
ConDetail_CType
is a complex CType
element.
Simple Elements
The following simple elements are contained within this complex.
- ConName
- Contact name example: home phone, cell phone, email address.
- ConText
- Unique row key for this array.
- ConType
- The recipient contact type. Canonical values are:
- EmailHTML
- EmailText
- SMSNative
- SMSSMTP
- ConVal
- Contact value that pertains to the contact name.
- MobPrvdCode
- The provider code for the mobile service.
- PrioritySeq
- The assignment of a priority sequence for an array of items.
CustDetail_CType
CustDetail_CType
is a complex
CType
element. This element
is optional.
Contains:
Addr_CType
CrScoreArray_AType
Custom_CType
EmailArray_AType
HouseHoldMbrArray_AType
PersonName_CType
PhoneArray_AType
SpousName
referencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- AnnIncmAmt
- The annual income amount. This field is used for reporting purposes for the bank.
- AssetTotAmt
- The total number of assets owned by a customer.
- BirthDt
- The date of birth.
- CustCrtRsnCode
- The code that conveys the reason the customer was created.
- CustOrgDt
- The original customer date.
- CustType
- The customer type. Examples include business or individual.
- DeceasedDt
- The date deceased.
- Deceased
- The deceased customer flag. Canonical values are:
- false
- true
- EducLvl
- The level of completed accredited education for a customer.
Canonical values are:
- AssocDegree
- BachelorDegree
- Doctorate
- Elementary
- HighSchool
- MastersDegree
- EmplName
- The employer name.
- EmplTitle
- The title an employee holds in a corporation or business.
- Gender
- The customer's gender. Canonical values are:
- Female
- Male
- Other
- HouseHoldName
- The name provided to a customer household. For example, this could be their last name followed by household.
- HouseHoldNum
- The number of persons that resides in the customer's household.
- LastConDt
- The date of last contact.
- LastMainDt
- The last maintenance date.
- NAICSCode
- A valid NAICS (Northern American Industry Classification System) code. Value is passed from the service of record during the pilot phase.
- OccType
- The occupation description of the customer. Retail or bus.
- StdIndustCode
- The standard industry code.
- WithNot
- Withhold a notice. When a business function would normally generate a notice and you wish to override, set this value to Yes.
Addr_CType
Addr_CType
is a complex
CType
element containing address information. This element
is optional.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType
is an array AType
element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
CrScoreArray_AType
CrScoreArray_AType
is an array AType
element. This is an array of
credit scores.
Contains:
CrScoreInfo_CType
CrScoreInfo_CType
CrScoreInfo_CType
is a complex CType
element. This element is a
package of data related to credit scores.
Simple Elements
The following simple elements are contained within this complex.
- CrScoreCapDt
- The date information was captured, created, or updated.
- CrScoreId
- Identifies the borrower's credit score.
- CrScoreModelCode
- The code that identifies the name and version of a credit scoring
model. Canonical values are:
- Equifax
- Experian
- FICO04
- FICO98
- Multi
- Oth
- VantgScore2
- VantgScore3
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
EmailArray_AType
EmailArray_AType
is an array AType
element. This is an array used to define email contact
information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype
is a complex
CType
element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
HouseHoldMbrArray_AType
HouseHoldMbrArray_AType
is an array
AType
element. This is an array of household
members.
Contains:
HouseHoldMbrInfo_CType
HouseholdMbrInfo_CType
HouseholdMbrInfo_CType
is a complex
CType
element.
HouseHoldMbrName
references
PersonName_CType
.Simple Elements
The following simple elements are contained within this complex.
- HouseHoldMbrBirthDt
- The date of birth.
- HouseHoldMbrRel
- The relationship of the household member to the customer. Canonical
values are:
- Daughter
- Father
- GrandFather
- GrandMother
- Guard
- Husband
- Mother
- Oth
- Son
- Wife
- HouseHoldMbrText
- The text that describes the household member element details that
proceeds it in the
HouseHoldMbrArray
.
HouseholdMbrName
PersonName_CType
is a complex CType
element. It contains name information. This complex is optional.
HouseholdMbrName
references PersonName_CType
.
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
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 element 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.
PhoneArray_AType
PhoneArray_AType
is an array AType
element. This array contains one or more PhoneInfo_CType
complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType
is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
SpousName
PersonName_CType
is a complex CType
element. It contains name information. This complex is optional.
SpousName
references the PersonName_CType
.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element 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.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType
is an array
AType
element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_CType
is a complex CType
element. This
element is used to override errors created in a previous request. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
MsgRqHdr_CType
MsgRqHdr_CType
is a complex CType
element. This is
the default message request header.
Contains:
AuthenUsrCred_CType
jXchangeHdr_CType
Simple Elements
The following simple elements are contained within this complex.
- AuthenProdCred
- Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType
AuthenUsrCred_CType
is a complex CType
element. This element represents authentication of the end-user credentials in
the form of a WS Security element that contains a single SAML V2.0
Assertion.
Simple Elements
The following simple elements are contained within this complex.
- Security
- Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType
jXchangeHdr_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CType
and the Message Request 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.
RegDetail_CType
RegDetail_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- AflOptOutCode
- The affiliate opt-out code.
- AflOptOutExcptCode
- The affiliate opt-out exception code.
- AflOptOutExcptDt
- The affiliate opt-out exception date.
- AflOptOutExpDt
- The affiliate opt-out expiration date.
- AnnRevenueAmt
- The business's annual revenue amount.
- BenflOwnExclCode
- The exclusion code for being exempt from FinCEN Customer Due Diligence (CDD) regulation.
- CustDataRtnPeriod
- The time that designates when a customer's information should be removed from the service providers data repository when the customer does not have any account relationships.
- DoNotCallCode
- The code that designates the behavior for calling a customer.
- DoNotCallExpDt
- The date the Do Not Call Code expires.
- ExcOwnPct
- The exception/override percentage for the legal entity customer, as it relates to FinCEN Customer Due Diligence (CDD).
- ExcPctRsnCode
- The exception/override percentage reason as it relates to FinCEN Customer Due Diligence (CDD).
- RegPOptOutCode
- Privacy Act opt-out internal use for Reg P compliance.
- RegPSentDt
- Privacy Act last notice sent date.
- ReqLegalEntityType
- Is this customer required to be reported as a legal entity?
Canonical values are:
- false
- true
- RiskRateByCode
- Code for person doing the rating.
- RiskRateCode
- Risk rating code assigned by bank.
- RiskRateDt
- Date risk rating is assigned.
CustModRs_MType
CustModRs_MType
is a message
MType
element.
Contains:
Custom_CType
MsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- RsStat
The status of the response. Canonical values are:
- fail
- success
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
MsgRsHdr_CType
MsgRsHdr_CType
is a complex
CType
element. This is the default message response
header.
Contains:
jXchangeHdr_CType
MsgRecInfoArray_AType
jXchangeHdr_CType
jXchangeHdr_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CType
and the Message Request 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.