Platform Business Entity Validate
Platform Business Entity Validate
Platform Business Entity Validate is a jXchange service designed to assist users opening a business account and validating a business name, principal owner, and authorized signers.
Message Flow
In jXchange, the Platform Business Entity Validate service uses a typical
exchange of MType messages
to assist users opening a business account and validating a business name, principal owner,
and authorized signers.
Primary Request
The consumer forwards the PltfmBusEntityValidateRq_MType
message to the service provider.
The message contains the following complex elements:
BusEntityValidateInfoRec_CTypeCustom_CTypeMsgRqHdr_CTypeValidateConfigInfoRec_CType
The message contains the following array:
IncXtendElemArray_AType
Primary Response
The service provider returns the
PltfmBusEntityValidateRs_MType message to the consumer.
The message contains the following simple element:
- TrnRcptId
The message contains the following complex elements:
BusValidateRsltInfoRec_CTypeCustom_CTypeMsgRsHdr_CTypeValidateConfigInfoRec_CType
Platform Business Entity Validate Behavior
The Platform Business Entity Validate service behavior is as follows.
Platform Business Entity Validate is for use when opening a business account and there is a need to submit a business name, principal owner, and authorized signers for validation.
PltfmBusEntityValidateRq_MType
PltfmBusEntityValidateRq_MType is a message
MType element.
Contains:
BusEntityValidateInfoRec_CTypeCustom_CTypeIncXtendElemArray_ATypeMsgRqHdr_CTypeValidateConfigInfoRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
BusEntityValidateInfoRec_CType
BusEntityValidateInfoRec_CType is a complex CType element.
Contains:
Addr_CTypeAddrTermArray_ATypeCustom_CTypeEntityNamereferencesPersonName_CTypePrevAddrreferencesAddr_CTypePrevAddrTermArrayreferencesAddrTermArray_ATypePrincOwnAuthSignerArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AcctClsfCode
- The allowed account classification values that are bank defined.
- BusStartDt
- The date that designates the starting point for date selections.
- EntityType
- The entity type used for entity matching services. This is a hybrid
enumeration due to reporting agencies. Canonical values are:
- Aircraft
- Bus
- Indv
- Vesl
- PhoneNum
- The phone number.
- 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.
- 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 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.
AddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
EntityName 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.
- 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.
PrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
PrevAddr 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 code.
- FornAddr
- Is this 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.
PrevAddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
PrevAddrTermArray_AType
references AddrTermArray_AType.Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
PrincOwnSignerArray_AType
PrincOwnSignerArray_AType is an array
AType element. This is an
array of principal business owners and/or authorized signers.
Contains:
PrincOwnAuthSignerInfoRec_CType
PrincOwnAuthSignerInfoRec_CType
PrincOwnAuthSignerInfoRec_CType is a complex CType element.
NamereferencesPersonName_CTypeAddr_CTypeAddrTermArray_ATypePrevAddrreferencesAddr_CTypePrevAddrTermArrayreferencesAddrTermArray_ATypePhoneArray_ATypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- BirthDt
- The date of birth.
- IdStateCode
- The 2 alpha long code which represents a state. For example, MO.
- IdStateNum
- The identification for a person's driver license.
- IdType
- An element representing the type of identification submitted by a
consumer. Canonical values are:
- DriverLic - DL - Driver's license/USA
- Mltry - ML - Military/USA
- Passport - PP - Passport
- ResidentAlienId - RA - Resident alien ID
- StateId - ST - State identification
- DriverLicForn - FL - Driver's license/foreign
- DriverLicCA - CL - Driver's license/Canada
- DriverLicMexico - DM - Driver's license/Mexico
- OthPrimIdForn - OF - Other primary ID/foreign
- CrCard - CR - Credit card
- EmplId - EC - Employer ID card
- EmailAddr - EM - Email address
- StudentId - SD - Student identification
- NatIdNum - SP - National identity number
- PrincOwnType
- The Principal Commercial Business Owner. Canonical values are:
- true
- false
- 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 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.
AddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
Name
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Name 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.
- 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.
PrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
PrevAddr 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 code.
- FornAddr
- Is this 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.
PrevAddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
PrevAddrTermArray_AType
references AddrTermArray_AType.Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
IncXtendElemArray_AType
IncXtendElemArray_AType is an array
AType element.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
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.
ValidateConfigInfoRec_CType
ValidateConfigInfoRec_CType is a complex CType element.
Contains:
Custom_CTypeVerifSvcArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- RegionCode
- The code that identifies a financial institution's region that would encompass a group of branches.
- VendorCode
- The code representing a Vendor.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
VerifSvcArray_AType
VerifSvcArray_AType is an array AType element. This is an array of
verifications to perform for a request.
Contains:
VerifSvcInfoRec_CType
VerifSvcInfoRec_CType
VerifSvcInfoRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- RiskAssmntStrategyCode
- The code representing the verification services risk assessment methods requested for entity validation.
- VerifSvcCode
- The code representing the verification services requested for entity validation.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmBusEntityValidateRs_MType
PltfmBusEntityValidateRs_MType is a message
MType element.
Contains:
BusValidateRsltInfoRec_CTypeCustom_CTypeMsgRsHdr_CTypeValidateConfigInfoRec_CType
Simple Elements
The following simple element is contained within this message.
- TrnRcptId
- The receipt provided for a successful transaction entry.
BusValidateRsltInfoRec_CType
BusValidateRsltInfoRec_CType is a complex CType
element.
Contains:
Addr_CTypeAddrTermArray_ATypeCustom_CTypeEntityNamereferencesPersonName_CTypePrevAddrreferencesAddr_CTypePrevAddrTermArrayreferencesAddrTermArray_ATypePrincOwnAuthSignerRsltArray_ATypex_TextRptInfoRec_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctClsfCode
- The allowed account classification values that are bank defined.
- BusStartDt
- The date that designates the starting point for date selections.
- EntityInfoVerifRs
- The Entity Information Program verification response.
- EntityRecomDec
- The Entity Information Program recommended decision.
- EntityScore
- A value representing the assessed risk of an entity.
- PhoneNum
- The phone number.
- 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.
- 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 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.
AddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EntityName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
EntityName 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.
- 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.
PrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
PrevAddr 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 code.
- FornAddr
- Is this 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.
PrevAddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
PrevAddrTermArray_AType
references AddrTermArray_AType.Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
PrincOwnAuthSignerRsltArray_AType
PrincOwnAuthSignerRsltArray_AType is
an array AType element. This is
an array of validation results for a principal owner and authorized signers.
Contains:
PrincOwnAuthSignerRsltInfoRec_CType
PrincOwnAuthSignerRsltInfoRec_CType
PrincOwnAuthSignerRsltInfoRec_CType is a complex
CType element.
Contains:
Addr_CTypeAddrTermArray_ATypeAltAddrArray_ATypeAltBirthDtArray_ATypeAltDriverLicArray_ATypeAltNameArray_ATypeAltPhoneArray_ATypeCustom_CTypeDocSetArray_ATypeEntityNamereferencesPersonName_CTypePrevAddrreferencesAddr_CTypePrevAddrTermArrayreferencesAddrTermArray_ATypePrincOwnAuthSignerRsltArray_ATypex_TextRptInfoRec_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrChkType
- Answers if the address check was okay. Canonical values are:
- True
- False
- BirthDtChkType
- Is the birth date submitted correct for the individual? Canonical
values are:
- True
- False
- BirthDtTaxIdChkType
- Is the birth date submitted after the TaxId end issue date?
Canonical values are:
- True
- False
- BirthDt
- The date of birth.
- Deceased
- The deceased customer flag. Canonical values are:
- false
- true
- DocSetCode
- The document set identifier. The set may represent a pre-defined package of documents or a pre-defined set of documents related to the stage in process (origination, closing, disclosures, etc.).
- DriverLicChkType
- Is the driver license check okay? Canonical values are:
- True
- False
- IdChkOkType
- Was the ID verification check okay? Canonical values are:
- True
- False
- IdStateCode
- The 2 alpha long code which represents a state. For example, MO.
- IdStateNum
- The identification for a person's driver license.
- IdType
- An element representing the type of identification submitted by a
consumer. Canonical values are:
- DriverLic - DL - Driver's license/USA
- Mltry - ML - Military/USA
- Passport - PP - Passport
- ResidentAlienId - RA - Resident alien ID
- StateId - ST - State identification
- DriverLicForn - FL - Driver's license/foreign
- DriverLicCA - CL - Driver's license/Canada
- DriverLicMexico - DM - Driver's license/Mexico
- OthPrimIdForn - OF - Other primary ID/foreign
- CrCard - CR - Credit card
- EmplId - EC - Employer ID card
- EmailAddr - EM - Email address
- StudentId - SD - Student identification
- NatIdNum - SP - National identity number
- MatchRecChkType
- Were no matching records found in entity validation? Canonical
values are:
- True
- False
- NameChkType
- Validated a match to an input name? Canonical values are:
- True
- False
- OFACHitChkType
- Was an OFAC hit found? Canonical values are:
- True
- False
- PhoneChkType
- Was a telephone check okay? Canonical values are:
- True
- False
- PrincOwnType
- The Principal Commercial Business Owner. Canonical values are:
- true
- false
- TaxIdChkType
- Was the TaxId matched to the TaxId input? Canonical values are:
- True
- False
- 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 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.
AddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
AltAddrArray_AType
AltAddrArray_AType is an array AType element. This is an array of
alternate addresses.
Contains:
Addr_CType
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 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.
AltBirthDtArray_AType
AltBirthDtArray_AType is an array AType element. This is an array of
alternate birth dates. Responses may be masked by changing the day to
00, such as in
10/00/2018.
Contains:
AltBirthDtInfo_CType
AltBirthDtInfo_CType
AltBirthDtInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AltDOB
- The alternate date of birth.
- DtFormatCode
- The format code to help display a date. Used for non-XML over the
wire date representation. Canonical values are:
- MM-DD-YY
- MM-DD-YYYY
- MM-YYY
- MM-YY
- DD-MM-YYY
- DD-MM-YY
- DD-Mon-YY
- MonthDDYYY
- MM-00-YYYY
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
AltDriverLicArray_AType
AltDriverLicArray_AType is an array AType element. This is an array of
alternate driver license numbers. Responses may be masked with X
after the first character, such as D80XXXXXX.
Contains:
AltDriverLicInfo_CType
AltDriverLicInfo_CType
AltDriverLicInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AltDriverLicId
- The identification for a person's driver license.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
AltNameArray_AType
AltNameArray_AType is an array AType element. This is an array of
alternate names.
Contains:
AltNameInfo_CType
AltNameInfo_CType
AltNameInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AltName
- The common name. This is the full text line name like John Doe.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
AltPhoneArray_AType
AltPhoneArray_AType is an array AType element. This is an array of
alternate phone numbers.
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.
MobPhoneInfo_CType
MobPhoneInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MobBB
- Answers the question: Is the mobile phone a Blackberry? Canonical
values are:
- false
- true
- MobPrvdCode
- The provider code for the mobile service.
- MobPrvdCodeDesc
- The description of the provider code for the mobile service.
- MobPrvdDom
- The domain of the provider of the mobile service.
- MobSendTestText
- Send a test text. Canonical values are:
- false
- true
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
DocSetArray_AType
DocSetArray_AType is an array AType element. This is an array of document(s) included in a document
set.
Contains:
DocSetInfo_CType
DocSetInfo_CType
DocSetInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DocId
- Document name, number, or other identifying value.
- DocInstcId
- The instance identifier of a document.
- DocName
- The name given to a document that describes the document image captured.
Name
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Name 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.
- 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.
PrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
PrevAddr 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 code.
- FornAddr
- Is this 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.
PrevAddrTermArray_AType
AddrTermArray_AType is an array
AType element. This is an
array to allow the collection of address terms in months, years, etc.
PrevAddrTermArray_AType
references AddrTermArray_AType.Contains:
AddrTermreferencesTerm_CType.
AddrTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
AddrTerm references
Term_CType.Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical
values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
x_TextRptInfoRec_CType
x_TextRptInfoRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- TextRpt
- An HTML formatted platform product presentation that can be used by consumers to display a webpage. This element requires CDATA markup due to the possibility of HTML formatting containing invalid characters.
- TextRptType
- The value that defines the file format used to deliver a text
report. Canonical values are:
- HTML
- FreeFormatText
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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 Soap Header Fault 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.
ValidateConfigInfoRec_CType
ValidateConfigInfoRec_CType is a complex CType element.
Contains:
Custom_CTypeVerifSvcArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- RegionCode
- The code that identifies a financial institution's region that would encompass a group of branches.
- VendorCode
- The code representing a Vendor.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
VerifSvcArray_AType
VerifSvcArray_AType is an array AType element. This is an array of
verifications to perform for a request.
Contains:
VerifSvcInfoRec_CType
VerifSvcInfoRec_CType
VerifSvcInfoRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- RiskAssmntStrategyCode
- The code representing the verification services risk assessment methods requested for entity validation.
- VerifSvcCode
- The code representing the verification services requested for entity validation.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.