Customer Relationship Modification
Customer Relationship Modification
Customer Relationship Modification is a jXchange service designed to allow the consumer to modify the customer relationship.
Message Flow
In jXchange, the Customer Relationship Modification service uses a typical exchange of
MType messages to modify a customer relationship.
Primary Request
The third-party consumer forwards the CustRelModRq_MType message to the
service provider. The message contains:
CustRelRec_CType- defines the requested modification- Dlt - should be set to false
If a consumer to consumer relationship is requested, only the
AcctRelCode element is required in the
CustRelRec_CType complex.
Primary Response
The service provider returns CustRelModRs_MType message to the third-party
consumer. The message contains the RsStat simple element, which
states if the requested relationship was successfully modified.
CustRelModRq_MType
CustRelModRq_MType is a message
MType element.
Contains:
BenflOwnInfo_CTypeCustom_CTypeCustRelRec_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_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.
- BenflOwnId
- Identifies which beneficial owner record.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- CustRelCode
The code that references the type of relationship one customer has with another customer. This element is a hybrid open enumeration. Canonical values are:
- Prim - Primary
- Joint - Joint
- Bus - Business
Leave the element blank for UNK - Unknown.
- Dlt
The delete element. Canonical values are:
- false
- true
- RelAcctId
- The related account ID or number.
- RelAcctType
- The related account type.
- RelCustId
- The related customer ID.
BenflOwnInfo_CType
BenflOwnInfo_CType is a complex CType element.
Contains:
Addr_CTypeIdVerifyArray_ATypePersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BenflOwnPct
- The percentage that is owned.
- BenflOwnType
- The type of beneficial ownership as it relates to FinCEN Customer
Due Diligence (CDD). Canonical values are:
- Cntl - Controlling individual/significant responsibility
- Own - Beneficial owners
- CntlOwn - Both controlling individual and beneficial owner
- BirthDt
- The date of birth.
- CntlIndivTitle
- Title of the individual with significant responsibility to control, manage, or direct a legal entity customer, as defined by FinCEN Customer Due Diligence (CDD).
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- Dlt
The delete element. Canonical values are:
- false
- true
- PassPortIssCntry
- The passport issuance country.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - TINCode
- The code that designates the type of tax identification number.
Canonical values are:
- SSN
- EIN
- Forn
TINCode is a hybrid open enumeration.
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.
IdVerifyArray_AType
IdVerifyArray_AType is an array
AType element. This is an array of simple elements used to
define identification of verification values.
Contains:
IdVerify_CType
IdVerify_CType
IdVerify_CType is a complex
CType element. This element contains basic identification
verification information and is optional.
Contains:
IdVerifyQueryArray_AType
Simple Elements
The following simple elements are contained within this complex.
- IdIssueBy
- The individual that issued the identification value
IdVerifyId. - IdVerifyBy
- The individual that verified the authenticity of the identification
value
IdVerifyId. - IdVerifyCode
- The identification code that is used to authenticate the customer.
- IdVerifyDesc
- The description of the identification code that is used to authenticate the customer.
- IdVerifyVal
- The identification value that is used to authenticate the customer.
IdVerifyQueryArray_AType
IdVerifyQueryArray_AType is an array
AType element. This array includes identification query/questions and their
respective values for customer/account verification.
Contains:
IdVerifyQueryInfo_CType
IdVerifyQueryInfo_CType
IdVerifyQueryInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- IdVerifyQuery
- A description of the query/question that could be used for
customer/account identification purposes. Canonical values are:
- ConDt
- DocType
- ExpDt
- IssDt
- IssLoc
- IssState
- VerifId
- IdVerifyQueryVal
- A value that corresponds with the description of the query/question
IdVerifyIdthat could be used for customer/account identification purposes. - IdVerifyQueryDataType
- Identifies what type of attributes corresponds with the
IdVerifyQueryVal. Canonical values are:- Decimal
- Dt
- Integer
- String
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CustRelRec_CType
CustRelRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AmtOwned
- The amount that is owned.
- CopyRelCustMail
- Answers the question: Would you like a copy of all related customer
mailings? This element is optional and defaults to N when absent.
Canonical values are:
- N
- Y
- FDICCat
FDIC Category where:
- CP - Corporate/Partnership
- EB - Employee Benefits
- IR - Retirement
- IT - Irrevocable Trust
- JO - Joint
- PU - Public Unit
- RT - Revocable trust
- SO - Single
Canonical values are:
- CP
- EB
- IR
- IT
- JO
- PU
- RT
- SO
- FDICMrgAcct
- Old account number prior to merger of financial institution.
- FDICMrgDt
- Date the merger of the account took place.
- IdVerifyBy
- The individual that verified the authenticity of the identification
value
IdVerifyId. - IdVerifyRsnCode
- The reason code the beneficial owner information was verified as it relates to FinCEN Customer Due Diligence (CDD).
- LegalEntityId
- The customer's Legal Entity Identifier (LEI).
- OvrFDICInsurLmt
Over FDIC insurance limit. There are three canonical values:
- Exmp - exempt from coverage
- false - FDIC insured because they were under the limit
- true - not covered because they are over the limit
false is the default.
- PctOwned
- The percentage that is owned.
- PrtPastDueNotCode
- Print past due notice.
- StopACHItems
- Stop ACH items. Canonical values are:
- false
- true
- VerifyDt
- Date of verification of beneficial owners as it relates to FinCEN Customer Due Diligence (CDD).
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_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
CustRelModRs_MType
CustRelModRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
Delete a Relationship
As with all jXchange services, message flow for deleting customer relationships follows a standardized message flow based on insertion of normalized complex and simple elements.
Primary Request
To delete a relationship, the third-party consumer sends a request message containing the
CustRelMod_MType message to request the deletion with the
Dlt element value set to Yes. The
CustRelRec_CType complex is not required for deletion.
Primary Response
Once the relationship has been deleted, the service provider sends the
CustRelModRs_MType message. The message contains the standard message
header, custom modification element, and the RsStat element, which
states if the requested relationship was successfully deleted.