Tax Plan Beneficiary Add Validate
Tax Plan Beneficiary Add Validate is a jXchange service designed to validate the created consumer's tax plan's beneficiary on a Service Provider by web services.
Message Flow
In jXchange, the Tax Plan Beneficiary
Add Validate service uses a typical exchange of MType
messages to validate the
created consumer's tax plan's beneficiary on a Service Provider without
creating a record.
Primary Request
The Third Party Consumer forwards the
TaxPlnBenfAddValidateRq_MType
message to the Service Provider. The message contains:
Custom_CType
TaxPlnBenfAddRq_MType
Primary Response
The Service Provider returns the
TaxPlnBenfAddValidateRs_MType
message to the Third Party Consumer. The message contains:
Custom_CType
MsgRsHdr_CType
This message also contains the RsStat
simple element, which
states the status of the request.
Tax Plan Beneficiary Add Validate Behavior
The Service Provider always performs the same processes for the validation and addition operations. The difference is that there are no records created in the respective database during the validation operation.
Do not confuse the validation operation with the certification operation, as the Service Provider continues to be stateless.
TaxPlnBenfAddValidateRq_MType
TaxPlnBenfAddValidateRq_MType
is
a message MType
element.
Contains:
Custom_CType
TaxPlnBenfAddRq_MType
TaxPlnBenfAddRq_MType
TaxPlnBenfAddRq_MType
is a message
MType
element.
Contains:
AccountId_CType
Benf_CType
Custom_CType
ErrOvrRdInfoArray_AType
MsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- CustId
- The identifier attached to a customer.
- PlnCode
- The service provider code that represents plan products for different plan types.
- PlnType
- Tax plan types as approved by the IRS. Valid plan types are:
- EDU=Educational IRA
- HSA=Health Savings
- IRA = Regular IRA
- MSA=Medical Savings
- QRP=Keogh
- RCV=ROTH Conversion
- RTH=ROTH Retirement
- SEP=Simplified Employer Plan
- SIM=Simple Retirement
Canonical values are:
- EDU
- HSA
- IRA
- MSA
- QRP
- RCV
- RTH
- SEP
- SIM
AccountId_CType
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
Benf_CType
Benf_CType
is a complex CType
element.
Contains:
BenfAddr
referencesAddr_CType
BenfName
referencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BenfAge
- The age of the beneficiary.
- BenfBirthDt
- The beneficiary date of birth.
- BenfCustId
- The customer ID for the beneficiary.
- BenfDeceasedDt
- The beneficiary date of death.
- BenfDesigId
- An identification provided to each beneficiary that designates primary and contingent beneficiaries.
- BenfDistAmt
- The amount distributed to the beneficiary.
- BenfFedWith
- The amount of federal taxes withheld from the distribution.
- BenfGender
- The gender of the beneficiary. Canonical values are:
- Female
- Male
- Other
- BenfIncMail
- Answers the question: Should the beneficiary name appear on any tax plan mailings?
- BenfPctDist
- The percentage of the proceeds the beneficiary is entitled to.
- BenfSpousCode
- The beneficiary spousal code.
- BenfStateWith
- The amount of state taxes withheld from the distribution.
- BenfTaxId
- The beneficiary tax identifier (numeric, 9 digits).
BenfAddr
Addr_CType
is a complex
CType
element containing address information. This element
is optional.
BenfAddr
references
Addr_CType
.
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.
- FornAddr
- Is this a foreign address? Where 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 2 alpha long 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.
BenfName
PersonName_CType
is a complex CType
element. It contains name information. This complex is optional.
BenfName
references
PersonName_CType
.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This 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.
- 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.
- ErrCode
- The Soap Header Fault 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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 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 byWS-Security
.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
TaxPlnBenfAddValidateRs_MType
TaxPlnBenfAddValidateRs_MType
is
a message MType
element.
Contains:
Custom_CType
MsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- 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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 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 byWS-Security
.