Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Customer Relationship Addition

Enterprise SOAP API > API by Reference > Core Services > Customer Relationship Addition

Customer Relationship Addition

Customer Relationship Addition is a jXchange service designed to allow the consumer to add a customer relationship.

Message Flow

In jXchange, the Customer Relationship Addition Validation service uses a typical exchange of MType messages to add a customer relationship.

Primary Request

The third-party consumer forwards the CustRelAddRq_MType message to the service provider. The message contains:

  • AcctRelCode
  • CustRelRec_CType

Primary Response

The service provider returns CustRelAddRs_MType message to the third-party consumer. The message contains:

  • Custom_CType
  • MsgRsHdr_CType
  • RsStat

Simple Relationship Addition Business Case

In the example below, a parent who has an established relationship with a bank wishes to co-sign for an auto loan for his daughter. The loan is being handled through an online auto dealership having a Third Party Consumer relationship with the bank issuing the loan.

After accepting and filing the loan application statements from both the parent and daughter, the finance agent for the online auto dealership issues a request to the bank, sending the Service Provider a message with the CustRelAddRq_MType complex element and the CustRelRec_CType complex element containing the following entries:

ComplexSimple ElementEntryExplanation
CustRelAddRq_MTypeErrOvrRdNANot applicable on the first request since no error, fault or warning has been issued.
 CustId5748902Customer ID for the parent.
 RelCustId1121334Customer ID for the child
 RelAcctId1311132Account ID for the car loan
 RelAcctTypeAutoAccount type for the car loan
CustRelRec_CTypeAcctRelCodeCSgnService Provider’s designation for a co-sign relationship
 CopyRelCustMailYParent is to be copied on all notices, statements and/or payments sent to the child concerning the loan.
 PctOwnedNAOptional elements based on guarantor relationship. Not applicable since the relationship does not involve a deposit account related to FDIC regulations for savings accounts. In such a situation, the complex can be sent without these elements.
 AmtOwnedNA 
 FDICCatNA 
 OverFDICInsurLmtNA 
 FDICMrgAcctNA 
 FDICMrgDtNA 

Once the relationship has been established by the Service Provider, the bank returns a message to the online auto dealer with the CustRelAddRs_MType complex. It contains the RsStat element with the value set to Successful to indicate that the Co-signer relationship has been established by the Service Provider.

CustRelAddRq_MType

CustRelAddRq_MType is a message MType element.

Contains:

  • BenflOwnInfo_CType
  • Custom_CType
  • CustRelRec_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

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.

RelAcctId
The related account ID or number.
RelAcctType
The related account type.
RelCustId
The related customer ID.

BenflOwnRec_CType

BenflOwnRec_CType is a complex CType element.

Contains:

  • BenflOwnInfo_CType

Simple Elements

The following simple elements are contained within this complex.

BenflOwnId
Identifies which beneficial owner record.
RmvBenflOwnDt
The date the beneficial owner was removed, as it relates to FinCEN Customer Due Diligence (CDD).

BenflOwnInfo_CType

BenflOwnInfo_CType is a complex CType element.

Contains:

  • Addr_CType
  • IdVerifyArray_AType
  • PersonName_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, and SrchType attributes.
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 IdVerifyId that 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_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 Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

CustRelAddRs_MType

CustRelAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

BenflOwnId
Identifies which beneficial owner record.
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 Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

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.
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 Thu Feb 8 2024