Platform Application Addition
Platform Application Addition
Platform Application Addition is a jXchange messaging service designed for a third-party consumer to submit an application to add an account and consumer to a service provider.
Message Flow
In jXchange, the Platform Application Addition service uses a typical exchange
of MType messages for a
third-party consumer to submit an application to add an account and consumer to a service
provider.
Primary Request
The third-party consumer forwards the PltfmAppAddRq_MType complex to the
service provider.
The message contains the following simple element:
- PltfmAppActnType
The message contains the following complex elements:
Custom_CTypeMsgRqHdr_CTypePltfmDepAppAdd_CTypePltfmLnAppAdd_CTypePltfmTimeDepAppAdd_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the PltfmAppAddRs_MType message to the
consumer.
The message contains the following simple elements:
- PltfmId
- PltfmStat
- PltfmStatDesc
- RsStat
The message contains the following complex elements:
AccountId_CTypeCustom_CTypeMsgRsHdr_CType
The message contains the following arrays:
CustIdArray_ATypeDocLocArray_AType
Platform App Addition Behavior
The behavior of PltfmAppAdd.
The root message PltfmAppAddRq houses the three
general complex elements:
PltfmLnAppAddPltfmDepAppAddPltfmTimeDepAdd
This represents a documented choice statement where all three of the complex elements are optional. However, the third-party consumer must submit one of the complex elements depending on the third-party consumer's application requirements.
The PltfmDepAppAdd and PltfmTimeDepAppAdd share the PltfmAppCustArray. This array houses
the complex element PltfmAppCustInfo for the submission
of customer information. This allows for multiple customers to be
submitted for one deposit or time deposit account.
The CustId element is encapsulated in the
PltfmAppCustInfo complex for submission of an existing third-party
consumer. The third-party consumer does not need to submit the elements that proceeded
the CustId for an existing third-party consumer.
The PltfmAppCustInfo provides the third-party consumer with the means to submit
identification information. The identification elements are encapsulated in the
IdVerifyArray. This array is an established service.
The ACH elements housed in the PltfmAppTimeDepInfo complex are only required if
the IntDisp element canonical value is
PayByACH.
The loan application documents for all three types of loans were used as the element requirements.
The lending aspect for the PltfmAppAdd simulates a drill-down to granular
lending classifications. The PltfmLnAppAdd houses three types of
lending applications:
- Commercial:
PltmfCommLnAppAdd - Consumer:
PltfmConsmLnAppAdd - Residential:
PltfmResLnAppAdd
This represents a documented choice statement where all three of the complex elements are optional, however the third-party consumer must submit one of the complex elements depending on the third-party consumer's lending application requirements.
The commercial lending complex PltfmCommLnAppAdd houses three complex elements:
- PltfmAppLnInfo
- This is a required complex. The complex contains general information about the loan and is the same complex used for consumer and residential.
- PltfmCommCollatInfo
- This complex is used to submit the collateral information for the commercial loan.
- PltfmAppCommInfo
- This complex is used to submit information specific to the commercial loan. This complex houses several arrays for the reporting of multiple entities or information specific to a commercial borrower.
The consumer lending complex PltfmConsmLnAppAdd houses four complex elements:
- PltfmAppLnInfo
- This is a required complex.
- PltfmConsmCollatInfo
- This complex is used to submit the collateral information for the consumer loan.
- PltfmAppBorwInfo
- This complex is used to submit the information specific to the primary borrower for a loan.
- PltfmAppCoBorwArray
- This array is used to submit any number of co-borrowers that might exist for a loan. The service provider may limit the number of co-borrowers submitted in any payload.
The borrower and co-borrower complex houses PltfmAppAssetLiabInfo to allow the
third-party consumer to submit the asset and liability specific to each borrower. The
third-party consumer may submit a combined asset and liability data in the
PltfmAppBorwInfo complex. The simple element
AssetLiabJoint is used to broadcast that the assets and
liabilities have been combined for all borrowers.
The PltfmAppAssetLiabInfo is further broken down
into two arrays:
- AssetAppArray
- This array is used to submit the asset portion and the array.
- LiabAppArray
- This array is used to submit the liability portion.
The real estate lending complex PltfmResLnAppAdd houses five complex elements.
All the complex elements housed in the consumer lending complex are duplicated except
for the PltfmConsmCollatInfo. This complex is replaced with the
PltfmRECollatInfo. The additional complex
PltfmAppHousingInfo is used to submit the borrower's present
monthly housing expenses.
The elements housed in the PltfmAppCustInfo can be matched to the elements in
the lending complex objects when the business model requires a platform loan be
submitted without application printing. Most elements, depending on the type of loan,
can be found in the PltfmAppLnInfo, PltfmAppBorwInfo,
and PltfmAppCommInfo.
The existing element BorwSelfEmpl was changed
from a string to a closed enumerator. The canonical values are true and false.
The response includes the application status from the service provider. This explains the status of the application to the third-party consumer, however, at a minimum, the service provider must return Pending to the third-party consumer. This is true if the service provider cannot respond within the jXchange given tolerances for response times.
The PltfmAppCustInfo contains the PltfmAppCustArray to allow for delivery of multiple customers per non-loan platform
account. The AcctRelCode was added to the customer
complex to identify the relationship of the customer to the account.
The PltfmAppAssetLiabInfo was moved into the borrower and co-borrower complexes
to allow the third-party consumer to submit the asset and liability data specific to
each borrower.
Additional elements were added to the PltfmConsmCollatInfo to broadcast additional information about the collateral.
Platform Application Addition Business Case
In this example, a Consumer wants to add a new savings account.
The Consumer sends the PltfmAppAddRq message to the
Service Provider with the following values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
PltfmDepAppAdd | ||
PltfmAppCustArray | ||
PltfmAppCustInfo | ||
Addr | StreetAddr1 | 555 W. Hwy 5 |
City | Monett | |
StateCode | MO | |
PostalCode | 55555 | |
PersonName | FirstName | John |
LastName | Doe | |
PltfmAppDepInfo | ProdCode | RegDp |
The Service Provider returns the PltfmId Pltfm987 and RsStat with a status of
Success.
The Consumer decides to inquire about the status of
the account. The Consumer sends the PltfmStatInqRq with the PlatfmId Pltfm987.
The Service Provider returns the PltfmStatInqRs with the following
values:
| Message | Simple Element | Entry Value |
|---|---|---|
PltfmStatInqRs | PltfmStat | P |
PltfmStatDesc | Pending Approval |
The next day the consumer inquires about the status
again. The Service Provider returns the PltfmStatInqRs with the following
values:
| Message | Simple Element or Complex | Simple Element | Entry Value |
|---|---|---|---|
PltfmStatInqRs | PltfmStat | A | |
PltfmStatDesc | Approved | ||
AccountId | AcctId | 8989898 | |
AcctType | S |
PltfmAppAddRq_MType
PltfmAppAddRq_MType is a message
MType element.
PltfmDepAppAdd_CType
and PltfmTimeDepAdd_CType
are part of a documented choice statement. One of the two elements should be included in the
request based on the type of application account being established.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CTypePltfmDepAppAdd_CTypePltfmLnAppAdd_CTypePltfmTimeDepAppAdd_CType
Simple Elements
The following simple element is contained within this message.
- PltfmAppActnType
The action to take when a platform application is submitted. Canonical values are:
- *Orign - Validate required platform fields and save submitted data to platform database for work to be completed via platform UI later.
- GenDocs - Validate submitted data to final destination (Core), generate documents and save this data to platform database.
- LoadAcct - Validate complete, docs generated, requested, and signed, load this new customer/account to the final destination (Core).
- NoActn - No action, allowing the user to park the application and resume working on it at a later time.
- LoadCust - Load customer, allowing the user to create customer identifier records for the customer information submitted.
Note: InPltfmAppAddRq_MType, the default value is Orign if the element is left blank or empty.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array
AType element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_CType is a complex CType element. This
element is used to override errors created in a previous request. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_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.
PltfmDepAppAdd_CType
PltfmDepAppAdd_CType is a complex
CType element. It contains the complex for submitting a
deposit or savings account application.
Contains:
Custom_CTypePltfmAppCustArray_ATypePltfmAppDepInfo_CTypePltfmAppSigInfo_CTypePltfmAppTaxPlnInfo_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmAppCustArray_AType
PltfmAppCustArray_AType is an array AType element. This is an array of customers
submitted for a platform application.
Contains:
PltfmAppCustInfo_CType
PltfmAppCustInfo_CType
PltfmAppCustInfo_CType is a complex CType element.
Contains:
Addr_CTypeAlien_CTypeBenflOwnInfoArray_ATypeBenflOwnIdVerifyInfo_CTypeCustBenfInfo_CTypeCustom_CTypeCustSvcOptArray_ATypeDueDilgntCmpltArray_ATypeEmailArray_ATypeIdVerifyArray_ATypeOffInfoArray_ATypePersonName_CTypePhoneArray_ATypePltfmAddrArray_ATypeCommAgentAuthArray_ATypeRoleCodeArray_ATypeTINInfo_CTypeUserDefInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AbbrCustDesc
- An abbreviated customer description.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AlienNonResidentType
- Answers the question: Is the applicant a non-permanent resident
alien? Canonical values are:
- false
- true
- AlienResident
- Answers the question: Is the applicant a permanent resident alien?
Canonical values are:
- false
- true
- AlienW8Type
- The type that identifies the IRS classification that grants a
foreigner an exemption from certain U.S. information return reporting and backup
withholding regulations. Canonical values are:
- BEN-E - beneficial owner
- ECI - income connected with the conduct of a trade
- EXP - foreign government or other foreign organization
- IMY - foreign intermediary or foreign flow through entity
- ApointCptyDesc
- The description of the entity's legal capacity.
- ApointCptyType
- The entity's legal capacity. Canonical values are:
- Conservator
- Executor
- Executrix
- Guardian
- LegalRep
- Oth
- PrsnlRep
- BenflOwnExclCode
- The exclusion code for being exempt from FinCEN Customer Due Diligence (CDD) regulation.
- BirthDt
- The date of birth.
- BrCode
- The branch code.
- CommAgentTitle
- The title an employee holds in a corporation or business.
- CustCode
- The code that further defines the customer.
- CustSubClsfCode
- The code that further defines the customer.
- CustType
- The customer type. Examples include business or individual.
Canonical values are:
- Bus
- Indv
- DscSigType
Is the entity authorized to act as a disclosure signer? Canonical values are:
- true
- false
- EmplName
- The employer name.
- EntityRgtrLocType
The type of location where an entity is registered. Canonical values are:
- OthCntry - other country, not one of the United States or a United States territory
- State - the name of the state located in the United States
- Terr - the name of the United States territory
- EntityRgtrLoc
- Where an entity is registered.
- EstbDt
- The date established.
- ExcOwnPct
- The exception/override percentage for the legal entity customer, as it relates to FinCEN Customer Due Diligence (CDD).
- ExcPctRsnCode
- The exception/override percentage reason as it relates to FinCEN Customer Due Diligence (CDD).
- FinInstNonCustType
The information being collected is for a non-customer of the financial institution. Canonical values are:
- false
- true
The default value is false.
- Gender
- The customer's gender. Canonical values are:
- Female
- Male
- Other
- HldMailCode
- Includes the mailing instructions. Valid values are 1–9 or blank.
- IsPrimCustRel
- Answers the question: Does the entity represent the primary entry
for a grouping of entities? Canonical values are:
- false
- true
- LegalEntityId
- The customer's Legal Entity Identifier (LEI).
- NAICSCode
- A valid NAICS (Northern American Industry Classification System) code. Value is passed from the service of record during the pilot phase.
- NonPrftOrgType
Is the entity a non-profit organization? Canonical values are:
- true
- false
- NonUSCitizen
- Is the applicant not a U.S. citizen? Canonical values are:
- false
- true
- OccType
- The occupation description of the customer. Retail or bus.
- PltfmCustCode
- The Platform Customer Code that further defines the Customer Type.
- ReqLegalEntityType
- Is this customer required to be reported as a legal entity?
Canonical values are:
- false
- true
- StdIndustCode
- The standard industry code.
- TINCertType
- Customer can legally certify the Tax Identification Number.
Canonical values are:
- false
- true
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.
Alien_CType
Alien_CType is a complex
CType element.
Contains:
RptChapArray_AType
Simple Elements
The following are the simple elements contained within this complex.
- AlienIRSRptType
The type of reporting to the IRS for an alien. Canonical values are:
- 1042S
- 1099INT
- NoRpt
- AlienLastW8Dt
- The last alien certification date.
- AlienTypeCode
- The code that describes the type of alien applied to a customer.
- AlienTypeDesc
- The description of the code that describes the type of alien applied to a customer.
- AlienW8ExpDt
- The expiration date of the W8 Alien Tax form.
- AlienW8StatDesc
- The description of the status of the filing of the W8 Alien Tax forms.
- AlienW8Stat
- The status of the filing of the W8 Alien Tax forms.
- AlienW8Type
- The type that identifies the IRS classification that grants a
foreigner an exemption from certain U.S. information return reporting and backup
withholding regulations. Canonical values are:
- BEN-E - beneficial owner
- ECI - income connected with the conduct of a trade
- EXP - foreign government or other foreign organization
- IMY - foreign intermediary or foreign flow through entity
- CitzCntryType
- Citizen Country - These are predefined by the IRS for an alien customer.
- FornTaxId
- Foreign Tax Identifier
- GIINCertDt
- Alien Global Intermediary Identification Number Certification Date.
- GIINDt
- The date the Alien Global Intermediary Identification Number was provided.
- GIINId
- Alien Global Intermediary Identification Number that is assigned by IRS to a participating FFI or registered deemed-compliant FFI. Reference IRS Rev. Proc. 2014-38
- IRSExmpCode
- The exemption code must be entered as defined by the IRS and setup
in the bank parameter file when the ALL of the following apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSExmpDesc
- The description of the exemption code must be entered as defined by
the IRS and setup in the bank parameter file when the ALL of the following
apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSRecipCode
- If Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- IRSRecipDesc
- The description of the Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- ResCity
- The alien residence foreign city.
- ResCntry
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
- ResCntryType
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
- ResPostalCode
- The alien residence foreign postal code.
- ResStateProv
- The alien residence foreign state or province.
- ResStrAddr1
- The alien residence foreign address 1.
- ResStrAddr2
- The alien residence foreign address 2.
RptChapArray_AType
RptChapArray_AType is an array
AType element. This is an array of reporting chapters.
Contains:
RptChapInfoRec_CType
RptChapInfoRec_CType
RptChapInfoRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- IRSExmpCode
- The exemption code must be entered as defined by the IRS and setup
in the bank parameter file when the ALL of the following apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSExmpDesc
- The description of the exemption code must be entered as defined by
the IRS and setup in the bank parameter file when the ALL of the following
apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSRecipCode
- If Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- IRSRecipDesc
- The description of the Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- RptChapExst
- Represents which chapter is being reported. Canonical values are:
- false
- true
- RptChapType
- The code that designates the reporting chapter as defined by the
IRS. Canonical values are:
- 3
- 4
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
BenflOwnInfoArray_AType
BenflOwnInfoArray_AType is an array
AType element. This is an
array of beneficial owner information.
Contains:
BenflOwnInfo_CType
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.
BenflOwnIdVerifyInfo_CType
BenflOwnIdVerifyInfo_CType is a complex CType
element. This element contains ID Verification information related to beneficial
owners.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- 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).
- VerifyDt
- Date of verification of beneficial owners as it relates to FinCEN Customer Due Diligence (CDD).
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CommAgentAuthArray_AType
CommAgentAuthArray_AType is an array AType element. This is an array of
authorizations assigned to a commercial account agent.
Contains:
CommAgentAuthRec_CType
CommAgentAuthRec_CType
CommAgentAuthRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CommAuthCode
- The Entity Authorization Code.
- CommAuthType
- The authority granted to an entity. Canonical values are:
- Basic - simple authorities
- Extend - elevated authorizations
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CustBenfInfo_CType
CustBenfInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- BenfDesigId
- An identification provided to each beneficiary that designates primary and contingent beneficiaries.
- BenfId
- An identification (i.e., Tax Identification, Drivers License) provided to identify the beneficiary.
- BenfPctDist
- The percentage of the proceeds the beneficiary is entitled to.
- BenfRel
- The relationship the beneficiary has to the account holder.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EmailArray_AType
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
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
OffInfoArray_AType
OffInfoArray_AType is an array
AType element. This is an array of officers.
Contains:
OffInfoRec_CType
OffInfoRec_CType
OffInfoRec_CType is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- OffCode
- The code that designates the financial institution officer.
- OffCodeText
- The text that describes the preceding elements for the
OffInfoArry. - OffDesc
- The officer short name.
- OffRmk
- Application or user remarks free-form text.
PersonName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PhoneArray_AType
PhoneArray_AType is an array AType
element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
PltfmAddrArray_AType
PltfmAddrArray_AType is an array
AType element. This is an array of platform application customer
addresses.
Contains:
PltfmAddrInforeferencesPltfmAddrRec_CType
PltfmAddrInfo
PltfmAddrRec_CType is a complex
CType element.
PltfmAddrInfo references PltfmAddrRec_CType.
Contains:
AddrInfo_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrCatUse
- Address category type. Canonical values are:
- Acct - Account
- Cust - Customer
- IRSRpt - IRS Reporting
- Not - Notice
- Pmt - Payments (Distributions or interest checks)
- Seasonal
- Stmt - Statement
- AddrCat2Use
Address category 2 type
- Cat=Not has
- AdvOfCr
- Bil
- CrBack
- EOYTax
- InsufFunds
- IRAMat
- OD
- PastDue
- RateChg
- RtnItems
- TeleTrf
- Cat=Pmt has
- EscrwRefund
- Int
- IRADistr
- XMAS
- Cat1=Stmt has
- Escrw
- IRAPeriodic
- LOC
- Periodic
Canonical values are:
- AdvOfCr
- All
- Bil
- CrBack
- EOYTax
- Escrw
- EscrwRefund
- Exc
- InsufFunds
- Int
- IRADistr
- IRAMat
- IRAPeriodic
- IRS
- LOC
- OD
- PastDue
- Periodic
- Phys
- RateChg
- RtnItems
- Seasonal
- ScsrCstdn
- TeleTrf
- XMAS
- Cat=Not has
AddrInfo_CType
AddrInfo_CType is a complex CType element used to define the listed address. This element is
optional.
Contains:
Addr_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrLastChng
- Date the address was last changed.
- AddrLastVerify
- Date the address was last verified.
- MailDirCode
- The code for the mail directive, such as Hold.
- SeasonBegDt
- The beginning date for a seasonal address.
- SeasonEndDt
- The ending date for a seasonal address.
- SeasonReocur
- Determines if the seasonal address reoccurs.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CustSvcOptArray_AType
CustSvcOptArray_AType is an array AType element. This element is an
array of service options available for the customer.
Contains:
CustSvcOptInfoRec_CType
CustSvcOptInfo_CType
CustSvcOptInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- CustSvcOptCode
- Service options available for the product offered.
- CustSvcOptDesc
- Descriptions of the service options available for the product.
RoleCodeArray_AType
RoleCodeArray_AType is an array
AType element.
Contains:
RoleCodeRec_CType
RoleCodeRec_CType
RoleCodeRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- RoleCode
- The code that describes the customer role related to an account relationship.
- RoleDesc
- The description of the code that describes the customer role related to an account.
TINInfo_CType
TINInfo_CType is a complex
CType element. This element contains tax information number
codes and descriptions. This element is optional.
Contains:
TaxIdOwnerNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BNotIRSDt
- The last IRS notification.
- BNotStat
- The B notice flag.
- CertCodeDesc
- The description of the code that represents the certification behavior for a tax ID.
- CertCodeDt
- The certification code date.
- CertCode
- The code that represents the certification behavior for a tax ID.
- TaxIdMod
- A tax ID modifier assigned by the SSA to some individuals.
- 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.
- TINDesc
- The description of the code that designates the type of tax identification number.
TaxIdOwnerName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
TaxIdOwnerName references PersonName_CType.
The TaxIdOwnerName
is optional and is only required when the customer level tax ID is different than the
account level.
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.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
PltfmAppDepInfo_CType
PltfmAppDepInfo_CType is a complex
CType element.
Contains:
AccountId_CTypeAcctTitleArray_ATypeBenfArray_ATypeBusResInfo_CTypeCommAuthArray_ATypeCRARec_CTypeDueDilgntCmpltArray_ATypeEstbPersonNamereferencesPersonName_CTypeODPrvlgOptInfo_ATypeOffInfoArray_ATypePltfmAddrArray_ATypeProdSvcOptArray_ATypeSrcFundsArray_ATypeUserDefInfoArray_ATypeVarIntRateInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctClsfCode
- The allowed account classification values that are bank defined.
- AcctId
- The number or character that identifies an account record.
- AcctLvlSecCode
- The code that references the special handling security processes/accesses at the account level.
- AcctOwnType
- Defines the ownership category for an account identification.
Canonical values are:
- Bus
- Custodial
- Ind
- Joint
- Trust
- AcctPurp
- The purpose of an account (used for document preparation and printing).
- AcctResDesc
- The description of the code that describes documentation proof of a non-individual entity.
- AcctType
- The number or character that categorizes the AcctId.
- BrCode
- The branch code.
- CallRptCode
- The call report code.
- ClubPln
- If the account is a club type account, a plan number may be entered in this field to determine the type of plan. Valid entries are 1–9. This element is required for account type X.
- DormantChgWav
- A list of values that designate the behavior for charging or waiving
dormant charges. Canonical values are:
- Chg
- NA
- Wav
- EstbPersonTitle
- The title an employee holds in a corporation or business.
- FedWithCode
- The federal withholding code passed from the service of record during the pilot phase.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- IncSoleProprtrNameType
- Determines if the Sole Proprietor Name should be included in the
title on documents. Canonical values are:
- true
- false
- IntCycle
- The interest cycle.
- IntDispAcctId
- The interest disposition account number.
- IntDispAcctType
- The interest disposition account type.
- IntDisp
- Designates the disposition of interest. Canonical values are:
- AddBackToAcct
- DepToAcct
- NA
- PayByACH
- PayByChk
- IntRate
- The interest rate.
- IRSExmpCode
- The exemption code must be entered as defined by the IRS and setup
in the bank parameter file when the ALL of the following apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- ItmTrunc
- Item truncation/safekeeping with canonical values of:
- Img
- ImgAndTrunc
- NA
- NoTrunc
- Trunc
- MailDirCode
- The code for the mail directive, such as Hold.
- OpenBal
- The amount of funds used to establish an account.
- OpenDt
- The date opened.
- PltfmClsfPrimType
- Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
- PltfmOwnCode
- The code that describes the ownership of an account from a platform perspective.
- PODRegType
- Account is subject to the non-probate Payable On Death Statute
transfer. Canonical values are:
- false
- true
- ProdCode
The code that identifies a product type of account within an application. Canonical values are:
- jha-4sight
- jha-argokeys
- jha-cif2020
- jha-coredirector
- jha-imagecenter
- jha-silverlake
- jha-synapsys
ProdCode is a hybrid open enumeration.
- RateTypeDesc
- Description of the type of interest rate.
- RateType
- Types of interest rates. Canonical values are:
- Adj
- Fix
- Renew
- Vrbl
- RegionCode
- The code that identifies a financial institution's region that would encompass a group of branches.
- SalesPerson
- The code value that represents the sales person. This element was changed from a string to an open enumerated type in 4/2011. This element resides as an exception and is not to be suffixed with code rather than deprecate the element. The element does have a description.
- ScsrCstdnName
- The common name. This is the full text line name like John Doe.
- SerChgCycle
- The service charge cycle used when an institution debits the account for service charges.
- SerChgWavExpDt
- Service charge waived expiration date.
- SerChgWavRsnCode
- The code that indicates the reason an account is not being charged any fees.
- SerChgWav
- The field that defines when an institution debits the account
for service charges. Canonical values are:
- Chg
- NA
- Wav
- SrcFundsCode
- A code that represents the source of funds for credit transactions and the outgoing source for debit transactions.
- StmtCycle
- The statement cycle.
- StmtPasCode
- The code that designates if the account holder has a passbook
for transaction posting. Canonical values are:
- NA
- Pas
- Stmt
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
AcctTitleArray_AType
AcctTitleArray_AType is an array AType element. This is an array of
account titles used to define the customer and additional names. This element is
optional.
Contains:
AcctTitleInfo_CType
AcctTitleInfo_CType
AcctTitleInfo_CType is a complex
CType element.
Contains:
AddlNamereferencesPersonName_CTypeAddlPhoneArrayreferencesPhoneArray_ATypeAddlTINreferencesTINInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctTitle
- The account title including customer name and additional
names.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- AddlBirthDt
- The date of birth.
- AddlNameStat
- The additional person status. Canonical values are:
- Act - active
- NotAct - not active
The ComName
element is contained by the AddlName complex and replaces the AcctTitle element. The
depreciation effective date for AcctTitle is 2012-01-01.
AddlName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AddlName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AddlPhoneArray
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.
AddlPhoneArray references PhoneArray_AType.
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.
AddlTIN
TINInfo_CType is a complex
CType element. This element contains tax information number
codes and descriptions. This element is optional.
AddlTIN references TINInfo_CType.
Contains:
TaxIdOwnerNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BNotIRSDt
- The last IRS notification.
- BNotStat
- The B notice flag.
- CertCodeDesc
- The description of the code that represents the certification behavior for a tax ID.
- CertCodeDt
- The certification code date.
- CertCode
- The code that represents the certification behavior for a tax ID.
- TaxIdMod
- A tax ID modifier assigned by the SSA to some individuals.
- 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.
- TINDesc
- The description of the code that designates the type of tax identification number.
TaxIdOwnerName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
TaxIdOwnerName references PersonName_CType.
The TaxIdOwnerName
is optional and is only required when the customer level tax ID is different than the
account level.
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.
BenfArray_AType
BenfArray_AType is an array
AType element. This is an array of beneficiaries on an account.
Contains:
BenfRec_CType
BenfRec_CType
BenfRec_CType is a complex
CType element.
Contains:
AcctBenf_CType
Simple Elements
The following simple elements are contained within this complex.
- BenfKey
- The key for each beneficiary per each tax plan.
AcctBenf_CType
AcctBenf_CType is a complex CType element. This element is
optional.
Contains:
BenfAddrreferencesAddr_CTypeBenfNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BenfDesigId
- An identification provided to each beneficiary that designates primary and contingent beneficiaries.
- BenfId
- An identification (i.e., Tax Identification, Drivers License) provided to identify the beneficiary.
- BenfPctDist
- The percentage of the proceeds the beneficiary is entitled to.
- BenfRel
- The relationship the beneficiary has to the account holder.
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 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.
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.
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 element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
PersonName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
BusResInfo_CType
BusResInfo_CType is a complex CType element.
Contains:
AcctAuthorizedreferencesAccountId_CTypeResolvingPartyArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AttestorName
- The common name. This is the full text line name like John Doe.
- AttestorTitle
- The title an employee holds in a corporation or business.
- BusResCode
- The code representing a business resolution. The resolutions are used to determine which corporate officers are legally able to perform certain functions for the business.
- CertifierName
- The common name. This is the full text line name like John Doe.
- CertifierTitle
- The title an employee holds in a corporation or business.
- FilingOffc
- The filing office for a business resolution (used for document preparation and printing).
- ResCmpltDt
- The completed business resolution date.
- ResEffDt
- The effective business resolution date.
AcctAuthorized
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
AcctAuthorized
references AccountId_CType.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
ResolvingPartyArray_AType
CustSvcOptArray_AType is an array AType element. This element is an
array of resolving parties on a commercial account.
Contains:
ResolvingPartyInfo_CType
ResolvingPartyInfo_CType
ResolvingPartyInfo_CType is a complex CType element.
Contains:
CommAuthArray_AType
Simple Elements
The following simple elements are contained within this complex.
- GenLmt
- Application or user remarks free-form text.
- ResolvingPartyName
- The common name. This is the full text line name like John Doe.
- ResolvingPartyTitle
- The title an employee holds in a corporation or business.
CommAuthArray_AType
CommAuthArray_AType is an array AType element. This is an array of
commercial authorizations necessary to open a deposit account.
Contains:
CommAuthRec_CType
CommAuthRec_CType
CommAuthRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CommAuthCode
- The Entity Authorization Code.
- CommAuthType
- The authority granted to an entity. Canonical values are:
- Basic - simple authorities
- Extend - elevated authorizations
- ResAuthType
- Is the business/corporate officer authorized to perform the listed
resolution item? Canonical values are:
- true
- false
- SigNumCnt
- The number of signers required.
- SpecificLmt
- Application or user remarks free-form text.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CommAuthArray_AType
CommAuthArray_AType is an array AType element. This is an array of
commercial authorizations necessary to open a deposit account.
Contains:
CommAuthRec_CType
CommAuthRec_CType
CommAuthRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CommAuthCode
- The Entity Authorization Code.
- CommAuthType
- The authority granted to an entity. Canonical values are:
- Basic - simple authorities
- Extend - elevated authorizations
- ResAuthType
- Is the business/corporate officer authorized to perform the listed
resolution item? Canonical values are:
- true
- false
- SigNumCnt
- The number of signers required.
- SpecificLmt
- Application or user remarks free-form text.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CRARec_CType
CRARec_CType is a complex
CType element. This complex contains CRA information. This
element is optional.
Simple Elements
The following simple elements are contained within this complex.
- CRAAnnIncmAboveMil
- Is the borrower's income above $1,000,000?
- CRAAnnIncmAmt
- The annual income of the borrower.
- CRACenTract
- Census tract information for Community Reinvestment Act reporting.
- CRACode
- The code that designates the type of loan predetermined by CRA.
- CRACountyCode
- County code for Community Reinvestment Act reporting.
- CRACountyDesc
- County for Community Reinvestment Act reporting.
- CRADesc
- The description of the code that designates the type of loan predetermined by CRA.
- CRAId
- An ID for the CRA account record.
- CRAIncmLvl
- Income level for Community Reinvestment Act reporting.
- CRALoc
- Location information for Community Reinvestment Act reporting.
- CRAMilitaryCode
- Military code for Community Reinvestment Act reporting.
- CRAMilitaryDesc
- Military description for Community Reinvestment Act reporting.
- CRAOrigBal
- The original or renewal amount to be reported under the rules of CRA.
- CRAOrigLocCode
- Designates where the loan was originated.
- CRAOrigLocDesc
- The description of the code that designates where the loan was originated.
- CRAOrigRenDt
- The original or renewal date, in accord with CRA reporting.
- CRAPurchaseLn
- Determines if the loan was purchased or originated by the bank.
- CRASMSACode
- Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
- CRASMSADesc
- Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
- CRAStateCode
- The state code for Community Reinvestment Act reporting.
- CRAStateDesc
- The state for Community Reinvestment Act reporting.
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EstbPersonName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
EstbPersonName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
ODPrvlgOptInfoArray_AType
ODPrvlgOptInfoArray_AType is an
array AType element. This is an array of overdraft
privilege option settings.
Contains:
ODPrvlgOptInfoRec_CType
ODPrvlgOptInfoRec_CType
ODPrvlgOptInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- ODPrvlgOptDt
- Identifies the date the value of the overdraft privilege option type was last updated.
- ODPrvlgOptType
- Identifies the type of overdraft privilege option. Canonical values
are:
- Elec
- ODPrvlgOptVal
- Identifies the value of the overdraft privilege option
type. Canonical values are:
- Accept
- Decline
- Exmp
- Inelgb
- NoRs
- Revo
OffInfoArray_AType
OffInfoArray_AType is an array
AType element. This is an array of officers.
Contains:
OffInfoRec_CType
OffInfoRec_CType
OffInfoRec_CType is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- OffCode
- The code that designates the financial institution officer.
- OffCodeText
- The text that describes the preceding elements for the
OffInfoArry. - OffDesc
- The officer short name.
- OffRmk
- Application or user remarks free-form text.
PltfmAddrArray_AType
PltfmAddrArray_AType is an array
AType element. This is an array of platform application customer
addresses.
Contains:
PltfmAddrInforeferencesPltfmAddrRec_CType
PltfmAddrInfo
PltfmAddrRec_CType is a complex
CType element.
PltfmAddrInfo references PltfmAddrRec_CType.
Contains:
AddrInfo_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrCatUse
- Address category type. Canonical values are:
- Acct - Account
- Cust - Customer
- IRSRpt - IRS Reporting
- Not - Notice
- Pmt - Payments (Distributions or interest checks)
- Seasonal
- Stmt - Statement
- AddrCat2Use
Address category 2 type
- Cat=Not has
- AdvOfCr
- Bil
- CrBack
- EOYTax
- InsufFunds
- IRAMat
- OD
- PastDue
- RateChg
- RtnItems
- TeleTrf
- Cat=Pmt has
- EscrwRefund
- Int
- IRADistr
- XMAS
- Cat1=Stmt has
- Escrw
- IRAPeriodic
- LOC
- Periodic
Canonical values are:
- AdvOfCr
- All
- Bil
- CrBack
- EOYTax
- Escrw
- EscrwRefund
- Exc
- InsufFunds
- Int
- IRADistr
- IRAMat
- IRAPeriodic
- IRS
- LOC
- OD
- PastDue
- Periodic
- Phys
- RateChg
- RtnItems
- Seasonal
- ScsrCstdn
- TeleTrf
- XMAS
- Cat=Not has
AddrInfo_CType
AddrInfo_CType is a complex CType element used to define the listed address. This element is
optional.
Contains:
Addr_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrLastChng
- Date the address was last changed.
- AddrLastVerify
- Date the address was last verified.
- MailDirCode
- The code for the mail directive, such as Hold.
- SeasonBegDt
- The beginning date for a seasonal address.
- SeasonEndDt
- The ending date for a seasonal address.
- SeasonReocur
- Determines if the seasonal address reoccurs.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ProdSvcOptArray_AType
ProdSvcOptArray_AType is an array
AType element. This is an array of service options available for the
product.
Contains:
ProdSvcOptInfo_CType
ProdSvcOptInfo_CType
ProdSvcOptInfo_CType is a complex CType
element.
Simple Elements
The following simple elements are contained within this complex.
- ProdSvcOptCode
- Service options available for the product offered.
- ProdSvcOptDesc
- Descriptions of the service options available for the product.
SrcFundsArray_AType
SrcFundsArray_AType is an array
AType element. This is an array of items related to source of funds used to
open an account.
Contains:
SrcFundsInfo_CType
SrcFundsInfo_CType
SrcFundsInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- PrimSrcFundsType
The source of funds to open an account is primary. Canonical values are:
- false
- true
The default is false.
- SrcFundsAmt
- Amount of the source of funds used to open an account.
- SrcFundsCode
- A code that represents the source of funds for credit transactions and the outgoing source for debit transactions.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
VarIntRateInfo_CType
VarIntRateInfo_CType is a complex
CType element. This element contains variable interest rate
information. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- PrimeRateIdx
- The prime rate index.
- RateCeil
- The rate ceiling entry that sets a top rate above which the rate never rises.
- RateFlr
- The rate floor entry that sets a base rate below which the rate of the loan never falls.
- RateRevDt
- The date used to determine if a rate should be changed.
- RateRevTerm
- The rate review term. The system checks the prime rate for change at the interval specified in this field. Entries may be in number of days or number of months.
- RateRevTermUnits
- The rate review term code. This code determines whether the prime
review term is in months or days. Canonical values are:
- Days
- Month
- NA
- RateVarCode
- The rate variance code. This code tells the system if the
variance from prime is above, below, or is of a percentage. Canonical values
are:
- NA
- Negative
- Pct
- Positive
- RateVar
- The rate variance. The amount of variance from the prime rate allowed for the account.
PltfmAppSigInfo_CType
PltfmAppSigInfo_CType is a
complex CType element. This complex gathers the necessary information for a
document signing ceremony.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- DocStateCode
- The two-character alpha code which represents a state. For example, MO.
- SigNumCnt
- The number of signers required.
- TempSigCardType
- Generate temporary signature cards. Canonical values are:
- false
- true
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmAppTaxPlnInfo_CType
PltfmAppTaxPlnInfo_CType is a
complex CType element.
Contains:
CntrbArray_ATypeCustom_CTypeEmplrInfo_CTypePlnBenfArray_ATypePlnCntrbArray_ATypeRespPrtyRec_CType
Simple Elements
The following simple elements are contained within this complex.
- FirstContrbDt
- The date of the first tax plan contribution.
- OrigOwnBirthDt
- The original owners of the tax plan's birth date.
- OrigOwnDeceaseDt
- The original owners of the tax plan's date of death.
- OrigOwnName
- The name of the original owner of the tax plan.
- PlnBirthDt
- Defines the actual birth date to use for determining tax plan distributions.
- PlnCntrbYr
- The applicable year for the tax plan contribution.
- PlnCode
- The service provider code that represents plan products for different plan types.
- PlnCvrgType
- Identifies who is covered by a Health Insurance Plan. Canonical
values are:
- Fam
- Indv
- PlnEstbDt
- The date the tax plan was established.
- PlnFeeCode
- The code for the fees charged to the tax plan.
- PlnType
- Tax plan types as approved by the IRS. Canonical values 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
- SoleSpousDistCode
- The code that references if the sole beneficiary is the spouse.
- SpousPlnCode
- The code to determine if the tax plan qualifies as a spousal retirement plan in accord with IRS Regulations.
CntrbArray_AType
CntrbArray_AType is an array
AType element. This is an array of items related to tax plan
contributors.
Contains:
CntrbInfo_CType
CntrbInfo_CType
CntrbInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- CntrbAmt
- Contribution amount.
- CntrbType
- Tax Plan Contribution types are:
- Conv - Conversion
- DstrCmbt - Disaster/Combat Zone Postponed Contribution
- EmplCntrb - Employer Contribution
- Reg - Regular (including Catch-Up)
- QualRsrv - Qualified Reservist/Designated Disaster Distribution Repayment
- ReChr - Recharacterization
- Rlovr - Rollover
- RlovrDir - Rollover/Direct Rollover from an Eligible Retirement Plan
- RlovrRth - Rollover/Direct Rollover from a designated Roth Account
- RlovrSimple - Rollover from a Simple IRA
- SEP - Simplified Employee Pension
- Xfer - Transfer
- XferSimple - Transfer from a Simple IRA
- CntrbYr
- The applicable year for the tax plan contribution.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EmplrInfo_CType
EmplrInfo_CType is a complex
CType element.
Contains:
Custom_CTypeEmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- EmplConName
- The employer name.
- EmplName
- The employer name.
- EmplTaxId
- The employer's tax identification number, which is nine digits.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
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.
EmplPhone references
PhoneArray_AType
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
PlnBenfArray_AType
PlnBenfArray_AType is an array
AType element. This is an array of tax plan beneficiary
information.
Contains:
PlnBenf_CType
PlnBenf_CType
PlnBenf_CType is a complex
CType element.
Contains:
BenfAddrreferencesAddr_CTypeBenfNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BenfBirthDt
- The beneficiary date of birth.
- BenfDeceasedDt
- The beneficiary date of death.
- BenfDesigId
- An identification provided to each beneficiary that designates primary and contingent beneficiaries.
- 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.
- BenfRel
- The relationship the beneficiary has to the account holder.
- BenfTaxId
- The beneficiary tax identifier (numeric, nine 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 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.
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 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.
PlnCntrbArray_AType
PlnCntrbArray_AType is an array
AType element. This is an array of items related to tax plan
contributors.
Contains:
PlnCntrbRec_CType
PlnCntrbRec_CType
PlnCntrbRec_CType is a complex
CType element. This contributor information is specific to a tax
plan.
Contains:
Addr_CTypeCustom_CTypeNamereferencesPersonName_CTypePhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
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.
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 element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PhoneArray_AType
PhoneArray_AType is an array AType
element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
RespPrtyRec_CType
RespPrtyRec_CType is a complex
CType element.
Contains:
Addr_CTypeCustom_CTypeEmailArray_ATypeNamereferencesPersonName_CTypePhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AcctRelDesc
- The description of the code that describes the relationship a customer has to an account.
- BenfToRespPrty
- The designated beneficiary will become the responsible party at age
of majority. Canonical values are:
- false
- true
- CanChngBenf
- The responsible party can change the designated beneficiary.
Canonical values are:
- false
- true
- HouseHoldMbrRel
- The relationship of the household member to the customer. Canonical
values are:
- Daughter
- Father
- GrandFather
- GrandMother
- Guard
- Husband
- Mother
- Oth
- Son
- Wife
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EmailArray_AType
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
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 element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PhoneArray_AType
PhoneArray_AType is an array AType
element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
PltfmLnAppAdd_CType
PltfmLnAppAdd_CType is a complex
CType element. It contains the complex for submitting a
loan application.
Custom_CTypePltfmCommLnAppAdd_CTypePltfmConsmLnAppAdd_CTypePltfmResLnAppAdd_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmCommLnAppAdd_CType
PltfmCommLnAppAdd_CType is a complex CType element. It contains the complex
for submitting a commercial loan application.
Contains:
Custom_CTypePltfmAppCommInfo_CTypePltfmAppLnInfo_CTypePltfmCommCollatInfo_CTypePltfmCommCollatInfoArray_AType
PltfmCommCollatInfo. If there are multiple collateral items, use the
PltfmCommCollatInfoArray to capture additional collateral item
information.Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmAppCommInfo_CType
PltfmAppCommInfo_CType is a complex
CType element.
Contains:
AcctInfo_CTypeAflEntityNameArray_ATypeCorpPrincArray_ATypeCorpStmtArray_ATypeExecOffcAddrreferencesAddr_CTypeExecOffcPhoneArrayreferencesPhoneArray_ATypeGuarAppInfo_CTypeLocalAddrreferencesAddr_CTypeLocalPhoneArrayreferencesPhoneArray_ATypePrevTradeNameArray_ATypeTradeNameArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BusActCode
- Describes the nature/activity of a business/corporation.
- CorpLegalOrgDt
- The original date when a company was incorporated.
- CorpLegalOrgLoc
- The original location where a company was incorporated.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- FranchiseName
- The name of the franchise.
- 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. - NAICSCode
- A valid NAICS (Northern American Industry Classification System) code. Value is passed from the service of record during the pilot phase.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
AccntInfo_CType
AccntInfo_CType is a complex
CType element.
Contains:
AccntAddrreferencesAddr_CTypeAccntNamereferencesPersonName_CTypeAccntPhonereferencesPhoneInfo_CType
AccntAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
AccntAddr 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 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.
AccntName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AccntName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AccntPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
AccntPhone references PhoneInfo_CType.
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.
AflEntityNameArray_AType
AflEntityNameArray_AType is an
array AType element. This is an array of ACH affiliated
entities for a corporation.
Contains:
AflEntityNameInfoRec_CType
AflEntityNameInfoRec_CType
AflEntityNameInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AflEntityName
- The name of affiliation entities for a corporation.
CorpPrincArray_AType
CorpPrincArray_AType is an array
AType element. This is an
array of principal individuals that are part of a corporation.
Contains:
CorpPrincInfoRec_CType
CorpPrincInfoRec_CType
CorpPrincInfoRec_CType is a complex
CType element.
Contains
PrincAddrreferencesAddr_CTypePrincNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- PrincBirthDt
- The date of birth.
- PrincEmplTitle
- The title an employee holds in a corporation or business.
- PrincTaxId
- The tax identifier. It includes the
MaskVal,Rstr, andSrchTypeattributes.
PrincAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
PrincAddr references the 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 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.
PrincName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
PrincName references the PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CorpStmtArray_AType
CorpStmtArray_AType is an array
AType element. This is an array of corporate/business
statements.
Contains:
CorpStmtInfo_CType
CorpStmtInfo_CType
CorpStmtInfo_CType is a complex
CType element. This is a complex of corporate/business
statements.
Simple Elements
The following simple elements are contained within this complex.
- CorpStmtAuxDesc
- A free-form description to be used with other corporate statement types.
- CorpStmtBegDt
- The corporate statement represented beginning date.
- CorpStmtDt
- The corporate statement represented by a specific date.
- CorpStmtEndDt
- The corporate statement represented ending date.
- CorpStmtFiscalYr
- The corporate statement represented fiscal year.
- CorpStmtType
- The type of corporate statements for a commercial loan application.
Canonical values are:
- AcctRecv
- BusPln
- FinStmt
- FranchiseAgreement
- IncmTax
- InventorySched
- Oth
- OutstandingJudgements
- ProjectPln
- CorpStmtYr
- The corporate statement represented calendar year.
ExecOffcAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains executive officer address information.
ExecOffcAddr 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 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.
ExecOffcPhoneArray
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.
ExecOffcPhoneArray references PhoneArray_AType.
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.
GuarAppInfo_CType
GuarAppInfo_CType is a complex
CType element. This element is optional.
Contains:
GuarAddrreferencesAddr_CTypeGuarCollatHolderAddrreferencesAddr_CTypeGuarCollatHolderNamereferencesPersonName_CTypeGuarPhonereferencesPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- GuarBnkRptcyYr
- The year that a guarantor for a commercial filed bankruptcy.
- GuarCollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- GuarCollatLienAmt
- The amount of any liens that exist on a loan collateral item.
- GuarCollatNonApplicant
- Answers the question: Are the owners of the loan collateral the
applicant for the loan? Canonical values are:
- false
- true
- GuarFinStmtIncl
- Answers the question: Has the guarantor for a commercial loan
provided financial statements? Canonical values are:
- false
- true
- GuarInsurPlcyAmt
- The amount of insurance for a specific policy.
- GuarInsurPlcyCode
- The code that describes the type of insurance policy.
- GuarInsurPlcyDedctAmt
- The amount of a deductible for collateral for an insurance policy.
- GuarInsurPlcyTerm
- The integer length of the term.
- GuarInsurPlcyTermUnits
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- GuarLegalName
- 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.
GuarAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
GuarAddr 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 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.
GuarCollatHolderAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
GuarCollatHolderAddr 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 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.
GuarCollatHolderName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
GuarCollatHolderName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
GuarPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
GuarPhone references PhoneInfo_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.
LocalAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
LocalAddr 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 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.
LocalPhoneArray
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.
LocalPhoneArray references PhoneArray_AType.
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.
PrevTradeNameArray_AType
PrevTradeNameArray_AType is an array
AType element. This is an array of previous
trade names used by a corporation.
Contains:
TradeNameInfoRec_CType
TradeNameInfoRec_CType
TradeNameInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- TradeName
- Trade names used by a corporation.
TradeNameArray_AType
TradeNameArray_AType
is a array AType element. This is an array of trade names
used by a corporation.
Contains:
TradeNameInfoRec_CType
TradeNameInfoRec_CType
TradeNameInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- TradeName
- Trade names used by a corporation.
PltfmAppLnInfo_CType
PltfmAppLnInfo_CType is a complex CType element. It
contains the submission of a loan application that contains the general information of the
application.
Contains:
LnTermreferencesTerm_CTypePmtTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BallPmtAmt
- The balloon payment amount.
- BrCode
- The branch code.
- CrAppCode
- The code that further defines the type of loan credit application.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- FirstPmtDt
- The first payment date.
- IntCalcCode
- The interest calculation method.
- IntRate
- The interest rate.
- LnAppType
- The loan application type. Canonical values are:
- New
- Refi
- Renew
- RenewWithMod
- Mod
- LnRePmtSrc
- The sources that are used for the loan repayment.
- PltfmClsfPrimType
- Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
- PmtCode
- The payment code. The payment code determines how the payment is applied to the loan.
- ProceedAmt
- The first advance amount for the new loan.
- ProdCode
The code that identifies a product type of account within an application. Canonical values are:
- jha-4sight
- jha-argokeys
- jha-cif2020
- jha-coredirector
- jha-imagecenter
- jha-silverlake
- jha-synapsys
ProdCode is a hybrid open enumeration.
- PurpCode
- Bank-defined and is used to define the purpose of the loan.
Canonical values are:
- CashOutRefi
- HomeImprov
- HomePurch
- Oth
- Refi
- RateIdxDesc
- The rate index description.
- RateType
- Types of interest rates. Canonical values are:
- Adj
- Fix
- Renew
- Vrbl
- RegionCode
- The code that identifies a financial institution's region that would encompass a group of branches.
LnTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
LnTerm 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
PmtTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
PmtTerm references the 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
PltfmCommCollatInfo_CType
PltfmCommCollatInfo_CType is a
complex CType element.
Contains:
CollatHolderAddrreferencesAddr_CTypeCollatHolderNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- CollatDesc
- The collateral code description.
- CollatLienAmt
- The amount of any liens that exist on a loan collateral item.
- CollatNonApplicant
- Answers the question: Are the owners of the loan
collateral the applicant for the loan? Canonical values are:
- false
- true
- CollatValAmt
- The current value of the collateral item.
- InsurPlcyAmt
- The amount of insurance for a specific policy.
- InsurPlcyCode
- The code that describes the type of insurance policy.
- InsurPlcyDedctAmt
- The amount of a deductible for collateral for an insurance policy.
- InsurPlcyTerm
- The insurance policy's term.
- InsurPlcyTermUnits
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- LienClsf
- The expanse of the lien that is placed on collateral items offered for a loan.
- NonPurchCollatAmt
- The amount of a collateral purchase that is used towards a secured loan.
- NonPurchCollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- PurchCollatAmt
- The amount of a loan that is used for the purchase towards the collateral of the loan.
CollatHolderAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatHolderAddr references Addr_CType.
CollatInstAddr complex will replace this instance
of CollatHolderAddr.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.
CollatHolderName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatHolderName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PltfmCommCollatInfoArray_AType
PltfmCommCollatInfoArray_AType is an array AType element. This element is an
array of multiple collateral items.
Contains:
PltfmCommCollatInfo_CType
PltfmCommCollatInfo_CType
PltfmCommCollatInfo_CType is a
complex CType element.
Contains:
CollatHolderAddrreferencesAddr_CTypeCollatHolderNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- CollatDesc
- The collateral code description.
- CollatLienAmt
- The amount of any liens that exist on a loan collateral item.
- CollatNonApplicant
- Answers the question: Are the owners of the loan
collateral the applicant for the loan? Canonical values are:
- false
- true
- CollatValAmt
- The current value of the collateral item.
- InsurPlcyAmt
- The amount of insurance for a specific policy.
- InsurPlcyCode
- The code that describes the type of insurance policy.
- InsurPlcyDedctAmt
- The amount of a deductible for collateral for an insurance policy.
- InsurPlcyTerm
- The insurance policy's term.
- InsurPlcyTermUnits
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- LienClsf
- The expanse of the lien that is placed on collateral items offered for a loan.
- NonPurchCollatAmt
- The amount of a collateral purchase that is used towards a secured loan.
- NonPurchCollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- PurchCollatAmt
- The amount of a loan that is used for the purchase towards the collateral of the loan.
CollatHolderAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatHolderAddr references Addr_CType.
CollatInstAddr complex will replace this instance
of CollatHolderAddr.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.
CollatHolderName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatHolderName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PltfmConsmLnAppAdd_CType
PltfmConsmLnAppAdd_CType is a complex CType element. It contains the complex
for submitting a consumer loan application.
Contains:
Custom_CTypePltfmAppBorwInfo_CTypePltfmAppCoBorwArray_ATypePltfmAppLnInfo_CTypePltfmConsmCollatInfo_CTypePltfmConsmCollatInfoArray_AType
PltfmConsmCollatInfo. If there are multiple collateral
items, use the PltfmConsmCollatInfoArray to capture additional collateral
item information.Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmAppBorwInfo_CType
PltfmAppBorwInfo_CType is a complex CType element.
Contains:
BorwAddrreferencesAddr_CTypeBorwAppAssetLiabInforeferencesPltfmAppAssetLiabInfo_CTypeBorwDeclAppInforeferencesDeclAppInfo_CTypeBorwDepdentArrayreferencesDepdentArray_ATypeBorwEmailArrayreferencesEmailArray_ATypeBorwEmplArray_ATypeBorwEmplInforeferencesEmplInfo_CTypeBorwHousingTermreferencesTerm_CTypeBorwIncmInforeferencesIncmInfo_CTypeBorwMailAddrreferencesAddr_CTypeBorwNamereferencesPersonName_CTypeBorwNearRelAddrreferencesAddr_CTypeBorwNearRelNamereferencesPersonName_CTypeBorwNearRelPhonereferencesPhoneInfo_CTypeBorwPhoneInfoArrayreferencesPhoneArray_ATypeBorwPrevAddrreferencesAddr_CTypeBorwPrevEmplArray_ATypeBorwPrevHousingTermreferencesTerm_CTypeDueDilgntCmpltArray_ATypeIdVerifyArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AbbrCustDesc
- An abbreviated customer description.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AcctRelDesc
- The description of the code that describes the relationship a customer has to an account.
- AssetLiabJoint
- Is the asset and liability section of the loan application completed
jointly? Canonical values are:
- false
- true
- BorwAlimonyOthMainType
- The source of obligation for alimony, child support, or separate
maintenance required. Canonical values are:
- CourtOrder
- OralUnderstanding
- WrittenAgreement
- BorwBirthDt
- The borrower's birth date.
- BorwDepdentNum
- The number of dependents that exist for a person.
- BorwDriverLicId
- The identification for a person's driver license.
- BorwEthnicType
- The ethnicity of an individual. Canonical values are:
- Cuban
- Latino
- Mexican
- NA
- OptOut
- Oth
- OthHis
- PuertoRican
- BorwGender
- The borrower's gender. Canonical values are:
- Female
- Male
- NotPrvd
- BorwHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- BorwIncmRed
- Answers the question: Will any of the income reported on a loan
application be reduced prior to the loan being paid off? Canonical values are:
- false
- true
- BorwIncmRedRsn
- The reason/explanation why income reported on a loan application will be reduced prior to the loan being paid off.
- BorwMaritalStatType
- The marital status of a person. Canonical values are:
- Divorce
- Married
- Separated
- Single
- Widow
- BorwMltryBr
- The branch of the military for an individual. Canonical values are:
- AirForce
- Army
- CoastGuard
- Marines
- Navy
- BorwMltryStat
- The military status of an individual. Canonical values are:
- Act
- NatGuard
- Resrv
- BorwNearRelCode
- The code that describes the relationship a person has with an account applicant.
- BorwPrevCrRecv
- Answers the question: Has the loan applicant received credit from
the same institution that a new loan application is being submitted? Canonical
values are:
- false
- true
- BorwPrevCrRecvDt
- The date the loan applicant has received credit from the same institution that a new loan application is being submitted.
- BorwPrevHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- BorwRaceCode
- The code that references the borrower's race. Canonical values
are:
- AfroAm
- Asia
- AsiaInd
- Cau
- CHN
- GUM
- HI
- HIPacIslnd
- JPN
- KOR
- OthAsia
- OthPacIslnd
- PHL
- USIndAk
- VNM
- WSM
- BorwTaxId
- The tax identifier. It includes the
MaskVal,Rstr, andSrchTypeattributes. - BorwYrEduc
- The number of years of education for a person.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- IdIssueDt
- The date the identification was issued.
- IdIssueExpDt
- The expiration date of the identification issued.
- IdStateIssue
- The state the identification was issued.
BorwAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwAddr 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 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.
BorwAppAssetLiabInfo
PltfmAppAssetLiabInfo_CType is a complex
CType element.
BorwAppAssetLiabInfo references
PltfmAppAssetLiabInfo_CType.
Contains:
AssetAppArray_ATypeLiabAppArray_AType
AssetAppArray_AType
AssetAppArray_AType is an array
AType element. This is an array of assets submitted on a
loan application.
Contains:
AssetAppInfo_CType
AssetAppInfo_CType
AssetAppInfo_CType is a complex
CType element.
Contains:
AssetAcctNamereferencesPersonName_CTypeAssetInstAddrreferencesAddr_CTypeDownPmtSrcNamereferencesPersonName_CTypeREOAppInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AssetAcctId
- The number or character that identifies an account record.
- AssetAppType
- The type of asset. Canonical values are:
- AcctRecd
- Auto
- Bond
- BrokerageAcct
- BusNetWorth
- Checking
- CloselyHeldStock
- DownPmt
- Equipment
- LifeInsur
- MoneyMkt
- MutualFunds
- NonMktSecurity
- Oth
- Partnership
- PersonalProp
- RealEstate
- Retirement
- Savings
- Securities
- TimeDep
- AssetDefName
- A free-form definition/description of the asset.
- AssetInstName
- The name of the institution that holds the asset on behalf of an individual.
- AssetSubjDebt
- Is the asset subject to any debt commitment? Canonical values are:
- false
- true
- AssetValAmt
- The value of the asset.
AssetAcctName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AssetAcctName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AssetInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
AssetInstAddr 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 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.
DownPmtSrcName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
DownPmtSrcName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
REOAppInfo_CType
REOAppInfo_CType is a complex
CType element.
Contains:
REOAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- REOClassType
- The classification of real estate owned included on a loan
application. Canonical values are:
- PendingSale
- Rental
- Sold
- REOEscrwPmtAmt
- The escrow mortgage payment for real estate owned.
- REOLienAmt
- The number of liens that exist for any real estate owned.
- REOPIAmt
- The mortgage principal and interest payment for real estate owned.
- REORentAmt
- The gross amount of rental income from real estate owned.
- REOType
- The type of real estate owned included on a loan application.
Canonical values are:
- COM - commercial
- RES - residential
- SEC - secondary residence
- VAC - vacation
REOAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
REOAddr 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 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.
LiabAppArray_AType
LiabAppArray_AType is an array
AType element. This is an array of liabilities submitted on
a loan applicant.
Contains:
LiabAppInfo_CType
LiabAppInfo_CType
LiabAppInfo_CType is a complex
CType element. This element is optional.
Contains:
LiabInstAddrreferences theAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- LiabAcctId
- The number or character that identifies an account record.
- LiabAcctName
- The name in which the liability is carried.
- LiabAppType
- The type of liability reported on a loan application. Canonical
values are:
- Alimony
- Auto
- ChargeAcct
- ChildSupport
- JobExpenses
- Landlord
- Main
- MtgHolder
- Oth
- StockPledge
- LiabCurBal
- The current outstanding balance owed for a liability.
- LiabDefName
- A free-form definition/description of the liability.
- LiabInstName
- The name of the institution that is obligated the funds owed for an individual.
- LiabMonthPmtAmt
- The monthly payment obligation for a liability.
- LiabOrigAmt
- The original amount owed for a liability.
LiabInstAddr
LiabInstAddr
is a complex CType element.
LiabInstAddr 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 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.
BorwDeclAppInfo
DeclAppInfo_CType is a complex
CType element. The complex
for loan application declarations.
BorwDeclAppInfo references DeclAppInfo_CType.
Contains:
OthForeClosureAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- AlienNonResidentType
- Answers the question: Is the applicant a non-permanent resident
alien? Canonical values are:
- false
- true
- AlienResident
- Answers the question: Is the applicant a permanent resident alien?
Canonical values are:
- false
- true
- AlimonyMainExst
- Answers the question: Is the applicant obligated to pay alimony,
child support, or separation maintenance? Canonical values are:
- false
- trueNote: When true, the liability information related to alimony, child support, separate maintenance, job-related expenses, or other are entered in
BorwAppAssetLiabInfoorCoBorwAppAssetLiabInfo.
- DeclBnkrptcy
- Answers the question: Has the applicant declared bankruptcy?
Canonical values are:
- false
- true
- DeclBnkrptcyLoc
- The location that the applicant declared bankruptcy.
- DeclBnkrptcyYr
- The year the applicant declared bankruptcy.
- DownPmtBorw
- Answers the question: Is part of the loan down payment borrowed?
Canonical values are:
- false
- true
- EndorCoBorwExst
- Answer the question: Is the applicant co-maker or endorser on any
other loans? Canonical values:
- false
- true
- EndorCoBorwForName
- The name of the person or entity the applicant is endorsing for a loan.
- EndorCoBorwToName
- The name of the institution the applicant is obligated to as an endorser.
- ForeClosureExst
- Answers the question: Has the applicant had property that has been
foreclosed? Canonical values are:
- false
- true
- JudgementAmt
- The amount the applicant is obligated to pay due to a court judgment.
- JudgementExst
- Answers the question: Does the applicant have any outstanding
judgments? Canonical values are:
- false
- true
- JudgementToName
- The name of the person or entity the applicant is obligated to pay due to a court judgment.
- LawsuitExst
- Answers the question: Is the applicant party to a lawsuit?
Canonical values are:
- false
- true
- NonUSCitizen
- Is the applicant not a U.S. citizen? Canonical values are:
- false
- true
- OccupProp
- Answers the question: Is the applicant planning to occupy the
property being used as collateral for the loan? Canonical values are:
- false
- true
- OthDlqExst
- Answers the question: Is the applicant delinquent or in default on
any debts? Canonical values are:
- false
- true
- OthForeClosureDt
- The date a lender foreclosed on property that the applicant had an interest in.
- OthForeClosureExst
- Answers the question: Has the applicant been indirectly obligated
on a loan that has been foreclosed? Canonical values are:
- false
- true
- OthForeClosureName
- The name of the lender that foreclosed on property that the applicant had an interest in.
- OthForeClosureRsn
- The reason a lender foreclosed on property that the applicant had an interest in.
- PriorPropOwner
- Answers the question: Has the applicant had ownership in a property
in the past? Canonical values are:
- false
- true
- PriorPropTitleType
- The type of title of property the application has had ownership.
Canonical values are:
- Oth
- Sole
- SpousJoint
- PriorPropType
- The type of property the application has had ownership. Canonical
values are:
- InvestmentProp
- PrinRes
- SecdHome
OthForeClosureAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
OthForeClosureAddr 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 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.
BorwDepdentArray
BorwDepdentArray is an array
AType element.
BorwDepdentArray references
DepdentArray_AType.
Contains:
DepdentInfoRec_CType
DepdentInfoRec_CType
DepdentInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- DepdentAge
- The age of the dependents that exist for a person.
BorwEmailArray
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
BorwEmailArray references EmailArray_AType.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
BorwEmplArray_AType
BorwEmplArray_AType is an array AType element. This array contains
employers information for an individual.
Contains:
BorwEmplInfoRecInfo_CType
BorwEmplInfoRec_CType
BorwEmplInfoRec_CType
is a complex CType element. This
complex describes borrower employment information.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
SalaryInfo_CType
SalaryInfo_CType is a complex CType element. This complex describes
components of salary/income for an individual.
Simple Elements
The following simple elements are contained within this complex.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
BorwEmplInfo
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
BorwEmplInfo references EmplInfo_CType.
BorwEmplInfo.
If there are multiple borrower employers, use BorwEmplArray to capture
multiple borrower employer information.Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
BorwHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
BorwHousingTerm 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
BorwIncmInfo
IncmInfo_CType is a complex
CType element that describes income for an individual. This
element is optional.
BorwIncmInfo references IncmInfo_CType.
Contains:
OthIncmArray_AType
Simple Elements
The following simple elements are contained within this complex.
- DivdIntMonthAmt
- The monthly amount of dividend and interest paid to a person.
- RentMonthIncmAmt
- The monthly amount of rental income paid to a person.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
OthIncmArray_AType
OthIncmArray_AType is an array
AType element. This is an array of other monthly income for
loan applicants.
Contains:
OthIncmInfo_CType
OthIncmInfo_CType
OthIncmInfo_CType is a complex CType element. This element contains
basic phone contact information and is optional.
Simple Elements
The following simple elements are contained within this complex.
- NonTaxblIncmType
- Income being reported is non-taxable. Canonical values are:
- false
- true
- OthIncmAmt
- The amount of other income paid to a person that cannot be classified into other amounts.
- OthIncmCode
- The code that describes the other income amount element.
- OthIncmFreq
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- OthIncmSrcCode
- The code that describes the source of other income amount element.
BorwMailAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwMailAddr 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 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.
BorwName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
BorwName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
BorwNearRelAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwNearRelAddr 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 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.
BorwNearRelName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
BorwNearRelName references
PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
BorwNearRelPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
BorwNearRelPhone references
PhoneInfo_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.
BorwPhoneInfoArray
BorwPhoneInfoArray is an array
AType element.
BorwPhoneInfoArray references
PhoneArray_AType.
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.
BorwPrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwPrevAddr 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 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.
BorwPrevEmplArray_AType
BorwPrevEmplArray_AType is an array
AType element. This is an array of employers for an
individual.
Contains:
EmplInfo_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
BorwPrevHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
BorwPrevHousingTerm 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
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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
PltfmAppCoBorwArray_AType
PltfmAppCoBorwArray_AType is an array
AType element. This is an array of
co-borrowers for a loan.
Contains:
PltfmAppCoBorwInfoRec_CType
PltfmAppCoBorwInfoRec_CType
PltfmAppCoBorwInfoRec_CType is a
complex CType element.
Contains:
CoBorwAddrreferencesAddr_CTypeCoBorwAppAssetLiabInforeferencesPltfmAppAssetLiabInfo_CTypeCoBorwDeclAppInforeferencesDeclAppInfo_CTypeCoBorwDepdentArrayreferencesDepdentArray_ATypeCoBorwEmailArrayreferencesEmailArray_ATypeCoBorwEmplArrayreferencesBorwEmplArray_ATypeCoBorwEmplInforeferencesEmplInfo_CTypeCoBorwHousingTermreferencesTerm_CTypeCoBorwIncmInforeferencesIncmInfo_CTypeCoBorwMailAddrreferencesAddr_CTypeCoBorwNamereferencesPersonName_CTypeCoBorwNearRelAddrreferencesAddr_CTypeCoBorwNearRelNamereferencesPersonName_CTypeCoBorwNearRelPhonereferencesPhoneInfo_CTypeCoBorwPhoneInfoArrayreferencesPhoneArray_ATypeCoBorwPrevAddrreferencesAddr_CTypeCoBorwPrevEmplArrayreferencesBorwPrevEmplArray_ATypeCoBorwPrevHousingTermreferencesTerm_CTypeDueDilgntCmpltArray_ATypeIdVerifyArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AbbrCustDesc
- An abbreviated customer description.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AcctRelDesc
- The description of the code that describes the relationship a customer has to an account.
- CoBorwAlimonyOthMainType
- The source of obligation for alimony, child support, or separate
maintenance required. Canonical values are:
- CourtOrder
- OralUnderstanding
- WrittenAgreement
- CoBorwBirthDt
- The co-borrower's birth date.
- CoBorwDepdentNum
- The number of dependents that exist for a person.
- CoBorwDriverLicId
- The identification for a person's driver license.
- CoBorwEthnicType
- The ethnicity of an individual. Canonical values are:
- Latino
- OptOut
- Oth
- CoBorwGender
- The co-borrower's gender. Valid options are:
- Female
- Male
- Other
- CoBorwHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- Parent
- CoBorwIncmRed
- Answers the question: Will any of the income reported on a loan
application be reduced prior to the loan being paid off? Canonical values are:
- false
- true
- CoBorwIncmRedRsn
- The reason/explanation why income reported on a loan application will be reduced prior to the loan being paid off.
- CoBorwMaritalStatType
- The marital status of a person. Canonical values are:
- Divorce
- Married
- Separated
- Single
- Widow
- CoBorwMltryBr
- The branch of the military for an individual. Canonical values are:
- AirForce
- Army
- CoastGuard
- Marines
- Navy
- CoBorwMltryStat
- The military status of an individual. Canonical values are:
- Act
- NatGuard
- Resrv
- CoBorwNearRelCode
- The code that describes the relationship a person has with an account applicant.
- CoBorwPrevCrRecv
- Answers the question: Has the loan applicant received credit from
the same institution that a new loan application is being submitted? Canonical
values are:
- false
- true
- CoBorwPrevCrRecvDt
- The date the loan applicant has received credit from the same institution that a new loan application is being submitted.
- CoBorwPrevHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- Parent
- CoBorwRaceCode
- The code that references the co-borrower's race.
- CoBorwTaxId
- The tax identifier. It includes the
MaskVal,Rstr, andSrchTypeattributes. - CoBorwYrEduc
- The number of years of education for a person.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- IdIssueDt
- The date the identification was issued.
- IdIssueExpDt
- The expiration date of the identification issued.
- IdStateIssue
- The state the identification was issued.
CoBorwAppAssetLiabInfo
PltfmAppAssetLiabInfo_CType is a complex
CType element.
CoBorwAppAssetLiabInfo references
PltfmAppAssetLiabInfo_CType.
Contains:
AssetAppArray_ATypeLiabAppArray_AType
AssetAppArray_AType
AssetAppArray_AType is an array
AType element. This is an array of assets submitted on a
loan application.
Contains:
AssetAppInfo_CType
AssetAppInfo_CType
AssetAppInfo_CType is a complex
CType element.
Contains:
AssetAcctNamereferencesPersonName_CTypeAssetInstAddrreferencesAddr_CTypeDownPmtSrcNamereferencesPersonName_CTypeREOAppInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AssetAcctId
- The number or character that identifies an account record.
- AssetAppType
- The type of asset. Canonical values are:
- AcctRecd
- Auto
- Bond
- BrokerageAcct
- BusNetWorth
- Checking
- CloselyHeldStock
- DownPmt
- Equipment
- LifeInsur
- MoneyMkt
- MutualFunds
- NonMktSecurity
- Oth
- Partnership
- PersonalProp
- RealEstate
- Retirement
- Savings
- Securities
- TimeDep
- AssetDefName
- A free-form definition/description of the asset.
- AssetInstName
- The name of the institution that holds the asset on behalf of an individual.
- AssetSubjDebt
- Is the asset subject to any debt commitment? Canonical values are:
- false
- true
- AssetValAmt
- The value of the asset.
AssetAcctName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AssetAcctName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AssetInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
AssetInstAddr 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 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.
DownPmtSrcName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
DownPmtSrcName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
REOAppInfo_CType
REOAppInfo_CType is a complex
CType element.
Contains:
REOAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- REOClassType
- The classification of real estate owned included on a loan
application. Canonical values are:
- PendingSale
- Rental
- Sold
- REOEscrwPmtAmt
- The escrow mortgage payment for real estate owned.
- REOLienAmt
- The number of liens that exist for any real estate owned.
- REOPIAmt
- The mortgage principal and interest payment for real estate owned.
- REORentAmt
- The gross amount of rental income from real estate owned.
- REOType
- The type of real estate owned included on a loan application.
Canonical values are:
- COM - commercial
- RES - residential
- SEC - secondary residence
- VAC - vacation
REOAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
REOAddr 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 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.
LiabAppArray_AType
LiabAppArray_AType is an array
AType element. This is an array of liabilities submitted on
a loan applicant.
Contains:
LiabAppInfo_CType
LiabAppInfo_CType
LiabAppInfo_CType is a complex
CType element. This element is optional.
Contains:
LiabInstAddrreferences theAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- LiabAcctId
- The number or character that identifies an account record.
- LiabAcctName
- The name in which the liability is carried.
- LiabAppType
- The type of liability reported on a loan application. Canonical
values are:
- Alimony
- Auto
- ChargeAcct
- ChildSupport
- JobExpenses
- Landlord
- Main
- MtgHolder
- Oth
- StockPledge
- LiabCurBal
- The current outstanding balance owed for a liability.
- LiabDefName
- A free-form definition/description of the liability.
- LiabInstName
- The name of the institution that is obligated the funds owed for an individual.
- LiabMonthPmtAmt
- The monthly payment obligation for a liability.
- LiabOrigAmt
- The original amount owed for a liability.
LiabInstAddr
LiabInstAddr
is a complex CType element.
LiabInstAddr 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 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.
CoBorwAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwAddr 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 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.
CoBorwDeclAppInfo
DeclAppInfo_CType is a complex
CType element. The complex
for loan application declarations.
CoBorwDeclAppInfo references DeclAppInfo_CType.
Contains:
OthForeClosureAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- AlienNonResidentType
- Answers the question: Is the applicant a non-permanent resident
alien? Canonical values are:
- false
- true
- AlienResident
- Answers the question: Is the applicant a permanent resident alien?
Canonical values are:
- false
- true
- AlimonyMainExst
- Answers the question: Is the applicant obligated to pay alimony,
child support, or separation maintenance? Canonical values are:
- false
- trueNote: When true, the liability information related to alimony, child support, separate maintenance, job-related expenses, or other are entered in
BorwAppAssetLiabInfoorCoBorwAppAssetLiabInfo.
- DeclBnkrptcy
- Answers the question: Has the applicant declared bankruptcy?
Canonical values are:
- false
- true
- DeclBnkrptcyLoc
- The location that the applicant declared bankruptcy.
- DeclBnkrptcyYr
- The year the applicant declared bankruptcy.
- DownPmtBorw
- Answers the question: Is part of the loan down payment borrowed?
Canonical values are:
- false
- true
- EndorCoBorwExst
- Answer the question: Is the applicant co-maker or endorser on any
other loans? Canonical values:
- false
- true
- EndorCoBorwForName
- The name of the person or entity the applicant is endorsing for a loan.
- EndorCoBorwToName
- The name of the institution the applicant is obligated to as an endorser.
- ForeClosureExst
- Answers the question: Has the applicant had property that has been
foreclosed? Canonical values are:
- false
- true
- JudgementAmt
- The amount the applicant is obligated to pay due to a court judgment.
- JudgementExst
- Answers the question: Does the applicant have any outstanding
judgments? Canonical values are:
- false
- true
- JudgementToName
- The name of the person or entity the applicant is obligated to pay due to a court judgment.
- LawsuitExst
- Answers the question: Is the applicant party to a lawsuit?
Canonical values are:
- false
- true
- NonUSCitizen
- Is the applicant not a U.S. citizen? Canonical values are:
- false
- true
- OccupProp
- Answers the question: Is the applicant planning to occupy the
property being used as collateral for the loan? Canonical values are:
- false
- true
- OthDlqExst
- Answers the question: Is the applicant delinquent or in default on
any debts? Canonical values are:
- false
- true
- OthForeClosureDt
- The date a lender foreclosed on property that the applicant had an interest in.
- OthForeClosureExst
- Answers the question: Has the applicant been indirectly obligated
on a loan that has been foreclosed? Canonical values are:
- false
- true
- OthForeClosureName
- The name of the lender that foreclosed on property that the applicant had an interest in.
- OthForeClosureRsn
- The reason a lender foreclosed on property that the applicant had an interest in.
- PriorPropOwner
- Answers the question: Has the applicant had ownership in a property
in the past? Canonical values are:
- false
- true
- PriorPropTitleType
- The type of title of property the application has had ownership.
Canonical values are:
- Oth
- Sole
- SpousJoint
- PriorPropType
- The type of property the application has had ownership. Canonical
values are:
- InvestmentProp
- PrinRes
- SecdHome
OthForeClosureAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
OthForeClosureAddr 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 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.
CoBorwDepdentArray
DepdentArray_AType is an array
AType element. This is an array of an individual's
dependents.
CoBorwDepdentArray references DepdentArray_AType.
Contains:
DepdentInfoRec_CType
DepdentInfoRec_CType
DepdentInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- DepdentAge
- The age of the dependents that exist for a person.
EmailArray_AType
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
BorwEmplArray_AType
BorwEmplArray_AType is an array AType element. This array contains
employers information for an individual.
Contains:
BorwEmplInfoRecInfo_CType
BorwEmplInfoRec_CType
BorwEmplInfoRec_CType
is a complex CType element. This
complex describes borrower employment information.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
SalaryInfo_CType
SalaryInfo_CType is a complex CType element. This complex describes
components of salary/income for an individual.
Simple Elements
The following simple elements are contained within this complex.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
CoBorwEmplInfo
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
CoBorwEmplInfo references EmplInfo_CType.
CoBorwEmplInfo. If there are multiple coborrower employers, use
CoBorwEmplArray to capture multiple coborrower employer
information.Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
CoBorwHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
CoBorwHousingTerm 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
CoBorwIncmInfo
IncmInfo_CType is a complex
CType element that describes income for an individual. This
element is optional.
CoBorwIncmInfo references IncmInfo_CType.
Contains:
OthIncmArray_AType
Simple Elements
The following simple elements are contained within this complex.
- DivdIntMonthAmt
- The monthly amount of dividend and interest paid to a person.
- RentMonthIncmAmt
- The monthly amount of rental income paid to a person.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
OthIncmArray_AType
OthIncmArray_AType is an array
AType element. This is an array of other monthly income for
loan applicants.
Contains:
OthIncmInfo_CType
OthIncmInfo_CType
OthIncmInfo_CType is a complex CType element. This element contains
basic phone contact information and is optional.
Simple Elements
The following simple elements are contained within this complex.
- NonTaxblIncmType
- Income being reported is non-taxable. Canonical values are:
- false
- true
- OthIncmAmt
- The amount of other income paid to a person that cannot be classified into other amounts.
- OthIncmCode
- The code that describes the other income amount element.
- OthIncmFreq
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- OthIncmSrcCode
- The code that describes the source of other income amount element.
CoBorwAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwAddr 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 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.
CoBorwName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CoBorwName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CoBorwNearRelAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwNearRelAddr 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 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.
CoBorwNearRelName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CoBorwNearRelName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CoBorwNearRelPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
CoBorwNearRelPhone references
PhoneInfo_CType.
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.
CoBorwPhoneInfoArray
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.
CoBorwPhoneInfoArray references
PhoneArray_AType.
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.
CoBorwPrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwPrevAddr 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 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.
CoBorwPrevEmplArray
CoBorwPrevEmplArray is an array
AType element. This is an array of employers for a
co-borrower.
CoBorwPrevEmplArray references
BorwPrevEmplArray_AType.
Contains:
EmplInfo_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
CoBorwPrevHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
CoBorwPrevHousingTerm 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
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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
PltfmAppLnInfo_CType
PltfmAppLnInfo_CType is a complex CType element. It
contains the submission of a loan application that contains the general information of the
application.
Contains:
LnTermreferencesTerm_CTypePmtTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BallPmtAmt
- The balloon payment amount.
- BrCode
- The branch code.
- CrAppCode
- The code that further defines the type of loan credit application.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- FirstPmtDt
- The first payment date.
- IntCalcCode
- The interest calculation method.
- IntRate
- The interest rate.
- LnAppType
- The loan application type. Canonical values are:
- New
- Refi
- Renew
- RenewWithMod
- Mod
- LnRePmtSrc
- The sources that are used for the loan repayment.
- PltfmClsfPrimType
- Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
- PmtCode
- The payment code. The payment code determines how the payment is applied to the loan.
- ProceedAmt
- The first advance amount for the new loan.
- ProdCode
The code that identifies a product type of account within an application. Canonical values are:
- jha-4sight
- jha-argokeys
- jha-cif2020
- jha-coredirector
- jha-imagecenter
- jha-silverlake
- jha-synapsys
ProdCode is a hybrid open enumeration.
- PurpCode
- Bank-defined and is used to define the purpose of the loan.
Canonical values are:
- CashOutRefi
- HomeImprov
- HomePurch
- Oth
- Refi
- RateIdxDesc
- The rate index description.
- RateType
- Types of interest rates. Canonical values are:
- Adj
- Fix
- Renew
- Vrbl
- RegionCode
- The code that identifies a financial institution's region that would encompass a group of branches.
LnTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
LnTerm 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
PmtTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
PmtTerm references the 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
PltfmConsmCollatInfo_CType
PltfmConsmCollatInfo_CType is a
complex CType element.
Contains:
Addr_CTypeCollatHolderAddrreferencesAddr_CTypeCollatHolderNamereferencesPersonName_CTypeCollatInstAddrreferencesAddr_CTypeCollatInsurArray_ATypeCollatOwnArray_ATypeLienExstArray_ATypeSpousNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatBodyStyleCode
- The code that represents the manufacture's body style for a specific piece of collateral.
- CollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- CollatDesc
- The collateral code description.
- CollatEstVal
- A collateral's estimate value at the time of a loan application submission.
- CollatExpDt
- The date the collateral item expires.
- CollatHolderOnUs
- Identifies whether collateral is held by the lending financial
institution. Canonical values are:
- false
- true
- CollatId
- A manufacturer provided, unique identification for the collateral.
- CollatInstName
- The institution that is holding the actual collateral.
- CollatIssueDt
- The date the collateral item was issued.
- CollatMake
- The manufacturer's specific make for a specific model/style of the collateral.
- CollatMeterVal
- The meter measurement value for the collateral. For example, this could be odometer reading for an automobile or hours for a boat.
- CollatMeterValType
- The method of measurement used for providing the meter value of the
collateral. Canonical values are:
- Hours
- Miles
- Oth
- CollatModel
- The manufacturer's model/style of the collateral.
- CollatStat
- The status of a collateral item.
- CollatValDt
- The date the current value of the collateral item was obtained.
- CollatValMthd
- The method used for providing the value of the collateral. Canonical
values are:
- Invoice
- KBB
- MSRP
- NADA
- Oth
- SalesPrice
- CollatYr
- The year the collateral was created by the manufacturer.
- InstrmClsf
- The instrument offered as collateral for a loan.
- LienClsf
- The expanse of the lien that is placed on collateral items offered for a loan.
- NonPurchCollatAmt
- The amount of a collateral purchase that is used towards a secured loan.
- PledgeAcctId
- The pledge account identification.
- PropPurchaseAmt
- The purchase price of the property.
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.
CollatHolderAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatHolderAddr references Addr_CType.
CollatInstAddr complex will replace this instance
of CollatHolderAddr.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.
CollatHolderName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatHolderName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CollatInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatInstAddr
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 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.
CollatInsurArray_AType
CollatInsurArray_AType is an array AType element. This is an array of
collateral insurance information.
Contains:
CollatInsurInfo_CType
CollatInsurInfo_CType
CollatInsurInfo_CType is a complex CType element.
Contains:
Custom_CTypeInsurCompAddrreferencesAddr_CTypePhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- InsurCompCode
- The code that represents an insurance company.
- InsurPlcyAmt
- The amount of insurance for a specific policy.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InsurCompAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
InsurCompAddr
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 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.
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.
CollatOwnArray_AType
CollatOwnArray_AType is an array
AType element. This is an
array of collateral holder information.
Contains:
CollatOwnInfo_CType
CollatOwnInfo_CType
CollatOwnInfo is a complex CType element.
Contains:
CollatOwnAddrreferencesAddr_CTypeCollatOwnNamereferencesPersonName_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatOwnCode
- The code that defines the collateral holder's relationship to the borrower or coborrower, third-party individual, third-party DBA/sole proprietor, third-party trust, third-party corporation, third-party general partnership, third-party limited partnership, etc.
- CollatOwnCustId
- The identifier attached to a customer.
- CollatPctOwned
- The percentage that is owned.
- CollatTitleCode
- The code that represents the form of ownership in a piece of collateral.
CollatOwnAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatOwnAddr
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 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.
CollatOwnName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatOwnName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienExstArray_AType
LienExstArray_AType is an array
AType element. This is an
array of existing liens encumbering a piece of collateral.
Contains:
LienExstInfo_CType
LienExstInfo_CType
LienExstInfo is a complex CType element.
Contains:
AccountID_CTypeCustom_CTypeLienHolderAddrreferencesAddr_CTypeLienHolderNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- LienAmt
- The amount of any liens that exist on a loan collateral item.
- LienHolderOnUs
- Identifies whether collateral is held by the lending financial
institution. Canonical values are:
- false
- true
- LienPositCode
- The lien position for a loan. For example, first lien position, second lien position, etc.
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
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienHolderAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
LienHolderAddr_CType
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 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.
LienHolderName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
LienHolderName_CType references
PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SpousName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
SpousName references the PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PltfmConsmCollatInfoArray_AType
PltfmConsmCollatInfoArray_AType is an array AType element. This element is an
array of multiple collateral items.
Contains:
PltfmConsmCollatInfo_CType
PltfmConsmCollatInfo_CType
PltfmConsmCollatInfo_CType is a
complex CType element.
Contains:
Addr_CTypeCollatHolderAddrreferencesAddr_CTypeCollatHolderNamereferencesPersonName_CTypeCollatInstAddrreferencesAddr_CTypeCollatInsurArray_ATypeCollatOwnArray_ATypeLienExstArray_ATypeSpousNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatBodyStyleCode
- The code that represents the manufacture's body style for a specific piece of collateral.
- CollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- CollatDesc
- The collateral code description.
- CollatEstVal
- A collateral's estimate value at the time of a loan application submission.
- CollatExpDt
- The date the collateral item expires.
- CollatHolderOnUs
- Identifies whether collateral is held by the lending financial
institution. Canonical values are:
- false
- true
- CollatId
- A manufacturer provided, unique identification for the collateral.
- CollatInstName
- The institution that is holding the actual collateral.
- CollatIssueDt
- The date the collateral item was issued.
- CollatMake
- The manufacturer's specific make for a specific model/style of the collateral.
- CollatMeterVal
- The meter measurement value for the collateral. For example, this could be odometer reading for an automobile or hours for a boat.
- CollatMeterValType
- The method of measurement used for providing the meter value of the
collateral. Canonical values are:
- Hours
- Miles
- Oth
- CollatModel
- The manufacturer's model/style of the collateral.
- CollatStat
- The status of a collateral item.
- CollatValDt
- The date the current value of the collateral item was obtained.
- CollatValMthd
- The method used for providing the value of the collateral. Canonical
values are:
- Invoice
- KBB
- MSRP
- NADA
- Oth
- SalesPrice
- CollatYr
- The year the collateral was created by the manufacturer.
- InstrmClsf
- The instrument offered as collateral for a loan.
- LienClsf
- The expanse of the lien that is placed on collateral items offered for a loan.
- NonPurchCollatAmt
- The amount of a collateral purchase that is used towards a secured loan.
- PledgeAcctId
- The pledge account identification.
- PropPurchaseAmt
- The purchase price of the property.
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.
CollatHolderAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatHolderAddr references Addr_CType.
CollatInstAddr complex will replace this instance
of CollatHolderAddr.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.
CollatHolderName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatHolderName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CollatInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatInstAddr
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 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.
CollatInsurArray_AType
CollatInsurArray_AType is an array AType element. This is an array of
collateral insurance information.
Contains:
CollatInsurInfo_CType
CollatInsurInfo_CType
CollatInsurInfo_CType is a complex CType element.
Contains:
Custom_CTypeInsurCompAddrreferencesAddr_CTypePhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- InsurCompCode
- The code that represents an insurance company.
- InsurPlcyAmt
- The amount of insurance for a specific policy.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InsurCompAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
InsurCompAddr
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 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.
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.
CollatOwnArray_AType
CollatOwnArray_AType is an array
AType element. This is an
array of collateral holder information.
Contains:
CollatOwnInfo_CType
CollatOwnInfo_CType
CollatOwnInfo is a complex CType element.
Contains:
CollatOwnAddrreferencesAddr_CTypeCollatOwnNamereferencesPersonName_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatOwnCode
- The code that defines the collateral holder's relationship to the borrower or coborrower, third-party individual, third-party DBA/sole proprietor, third-party trust, third-party corporation, third-party general partnership, third-party limited partnership, etc.
- CollatOwnCustId
- The identifier attached to a customer.
- CollatPctOwned
- The percentage that is owned.
- CollatTitleCode
- The code that represents the form of ownership in a piece of collateral.
CollatOwnAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatOwnAddr
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 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.
CollatOwnName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatOwnName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienExstArray_AType
LienExstArray_AType is an array
AType element. This is an
array of existing liens encumbering a piece of collateral.
Contains:
LienExstInfo_CType
LienExstInfo_CType
LienExstInfo is a complex CType element.
Contains:
AccountID_CTypeCustom_CTypeLienHolderAddrreferencesAddr_CTypeLienHolderNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- LienAmt
- The amount of any liens that exist on a loan collateral item.
- LienHolderOnUs
- Identifies whether collateral is held by the lending financial
institution. Canonical values are:
- false
- true
- LienPositCode
- The lien position for a loan. For example, first lien position, second lien position, etc.
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
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienHolderAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
LienHolderAddr_CType
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 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.
LienHolderName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
LienHolderName_CType references
PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SpousName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
SpousName references the PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PltfmResLnAppAdd_CType
PltfmResLnAppAdd_CType is a complex CType element. This complex is for
submitting a residential loan application.
Contains:
Custom_CTypePltfmAppBorwInfo_CTypePltfmAppCoBorwArray_ATypePltfmAppHousingInfo_CTypePltfmAppLnInfo_CTypePltfmRECollatInfo_CTypePltfmRECollatInfoArray_AType
PltfmRECollatInfo. If there are multiple collateral
items, use the PltfmRECollatInfoArray to capture additional collateral item
information.Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmAppBorwInfo_CType
PltfmAppBorwInfo_CType is a complex CType element.
Contains:
BorwAddrreferencesAddr_CTypeBorwAppAssetLiabInforeferencesPltfmAppAssetLiabInfo_CTypeBorwDeclAppInforeferencesDeclAppInfo_CTypeBorwDepdentArrayreferencesDepdentArray_ATypeBorwEmailArrayreferencesEmailArray_ATypeBorwEmplArray_ATypeBorwEmplInforeferencesEmplInfo_CTypeBorwHousingTermreferencesTerm_CTypeBorwIncmInforeferencesIncmInfo_CTypeBorwMailAddrreferencesAddr_CTypeBorwNamereferencesPersonName_CTypeBorwNearRelAddrreferencesAddr_CTypeBorwNearRelNamereferencesPersonName_CTypeBorwNearRelPhonereferencesPhoneInfo_CTypeBorwPhoneInfoArrayreferencesPhoneArray_ATypeBorwPrevAddrreferencesAddr_CTypeBorwPrevEmplArray_ATypeBorwPrevHousingTermreferencesTerm_CTypeDueDilgntCmpltArray_ATypeIdVerifyArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AbbrCustDesc
- An abbreviated customer description.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AcctRelDesc
- The description of the code that describes the relationship a customer has to an account.
- AssetLiabJoint
- Is the asset and liability section of the loan application completed
jointly? Canonical values are:
- false
- true
- BorwAlimonyOthMainType
- The source of obligation for alimony, child support, or separate
maintenance required. Canonical values are:
- CourtOrder
- OralUnderstanding
- WrittenAgreement
- BorwBirthDt
- The borrower's birth date.
- BorwDepdentNum
- The number of dependents that exist for a person.
- BorwDriverLicId
- The identification for a person's driver license.
- BorwEthnicType
- The ethnicity of an individual. Canonical values are:
- Cuban
- Latino
- Mexican
- NA
- OptOut
- Oth
- OthHis
- PuertoRican
- BorwGender
- The borrower's gender. Canonical values are:
- Female
- Male
- NotPrvd
- BorwHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- BorwIncmRed
- Answers the question: Will any of the income reported on a loan
application be reduced prior to the loan being paid off? Canonical values are:
- false
- true
- BorwIncmRedRsn
- The reason/explanation why income reported on a loan application will be reduced prior to the loan being paid off.
- BorwMaritalStatType
- The marital status of a person. Canonical values are:
- Divorce
- Married
- Separated
- Single
- Widow
- BorwMltryBr
- The branch of the military for an individual. Canonical values are:
- AirForce
- Army
- CoastGuard
- Marines
- Navy
- BorwMltryStat
- The military status of an individual. Canonical values are:
- Act
- NatGuard
- Resrv
- BorwNearRelCode
- The code that describes the relationship a person has with an account applicant.
- BorwPrevCrRecv
- Answers the question: Has the loan applicant received credit from
the same institution that a new loan application is being submitted? Canonical
values are:
- false
- true
- BorwPrevCrRecvDt
- The date the loan applicant has received credit from the same institution that a new loan application is being submitted.
- BorwPrevHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- BorwRaceCode
- The code that references the borrower's race. Canonical values
are:
- AfroAm
- Asia
- AsiaInd
- Cau
- CHN
- GUM
- HI
- HIPacIslnd
- JPN
- KOR
- OthAsia
- OthPacIslnd
- PHL
- USIndAk
- VNM
- WSM
- BorwTaxId
- The tax identifier. It includes the
MaskVal,Rstr, andSrchTypeattributes. - BorwYrEduc
- The number of years of education for a person.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- IdIssueDt
- The date the identification was issued.
- IdIssueExpDt
- The expiration date of the identification issued.
- IdStateIssue
- The state the identification was issued.
BorwAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwAddr 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 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.
BorwAppAssetLiabInfo
PltfmAppAssetLiabInfo_CType is a complex
CType element.
BorwAppAssetLiabInfo references
PltfmAppAssetLiabInfo_CType.
Contains:
AssetAppArray_ATypeLiabAppArray_AType
AssetAppArray_AType
AssetAppArray_AType is an array
AType element. This is an array of assets submitted on a
loan application.
Contains:
AssetAppInfo_CType
AssetAppInfo_CType
AssetAppInfo_CType is a complex
CType element.
Contains:
AssetAcctNamereferencesPersonName_CTypeAssetInstAddrreferencesAddr_CTypeDownPmtSrcNamereferencesPersonName_CTypeREOAppInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AssetAcctId
- The number or character that identifies an account record.
- AssetAppType
- The type of asset. Canonical values are:
- AcctRecd
- Auto
- Bond
- BrokerageAcct
- BusNetWorth
- Checking
- CloselyHeldStock
- DownPmt
- Equipment
- LifeInsur
- MoneyMkt
- MutualFunds
- NonMktSecurity
- Oth
- Partnership
- PersonalProp
- RealEstate
- Retirement
- Savings
- Securities
- TimeDep
- AssetDefName
- A free-form definition/description of the asset.
- AssetInstName
- The name of the institution that holds the asset on behalf of an individual.
- AssetSubjDebt
- Is the asset subject to any debt commitment? Canonical values are:
- false
- true
- AssetValAmt
- The value of the asset.
AssetAcctName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AssetAcctName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AssetInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
AssetInstAddr 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 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.
DownPmtSrcName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
DownPmtSrcName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
REOAppInfo_CType
REOAppInfo_CType is a complex
CType element.
Contains:
REOAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- REOClassType
- The classification of real estate owned included on a loan
application. Canonical values are:
- PendingSale
- Rental
- Sold
- REOEscrwPmtAmt
- The escrow mortgage payment for real estate owned.
- REOLienAmt
- The number of liens that exist for any real estate owned.
- REOPIAmt
- The mortgage principal and interest payment for real estate owned.
- REORentAmt
- The gross amount of rental income from real estate owned.
- REOType
- The type of real estate owned included on a loan application.
Canonical values are:
- COM - commercial
- RES - residential
- SEC - secondary residence
- VAC - vacation
REOAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
REOAddr 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 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.
LiabAppArray_AType
LiabAppArray_AType is an array
AType element. This is an array of liabilities submitted on
a loan applicant.
Contains:
LiabAppInfo_CType
LiabAppInfo_CType
LiabAppInfo_CType is a complex
CType element. This element is optional.
Contains:
LiabInstAddrreferences theAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- LiabAcctId
- The number or character that identifies an account record.
- LiabAcctName
- The name in which the liability is carried.
- LiabAppType
- The type of liability reported on a loan application. Canonical
values are:
- Alimony
- Auto
- ChargeAcct
- ChildSupport
- JobExpenses
- Landlord
- Main
- MtgHolder
- Oth
- StockPledge
- LiabCurBal
- The current outstanding balance owed for a liability.
- LiabDefName
- A free-form definition/description of the liability.
- LiabInstName
- The name of the institution that is obligated the funds owed for an individual.
- LiabMonthPmtAmt
- The monthly payment obligation for a liability.
- LiabOrigAmt
- The original amount owed for a liability.
LiabInstAddr
LiabInstAddr
is a complex CType element.
LiabInstAddr 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 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.
BorwDeclAppInfo
DeclAppInfo_CType is a complex
CType element. The complex
for loan application declarations.
BorwDeclAppInfo references DeclAppInfo_CType.
Contains:
OthForeClosureAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- AlienNonResidentType
- Answers the question: Is the applicant a non-permanent resident
alien? Canonical values are:
- false
- true
- AlienResident
- Answers the question: Is the applicant a permanent resident alien?
Canonical values are:
- false
- true
- AlimonyMainExst
- Answers the question: Is the applicant obligated to pay alimony,
child support, or separation maintenance? Canonical values are:
- false
- trueNote: When true, the liability information related to alimony, child support, separate maintenance, job-related expenses, or other are entered in
BorwAppAssetLiabInfoorCoBorwAppAssetLiabInfo.
- DeclBnkrptcy
- Answers the question: Has the applicant declared bankruptcy?
Canonical values are:
- false
- true
- DeclBnkrptcyLoc
- The location that the applicant declared bankruptcy.
- DeclBnkrptcyYr
- The year the applicant declared bankruptcy.
- DownPmtBorw
- Answers the question: Is part of the loan down payment borrowed?
Canonical values are:
- false
- true
- EndorCoBorwExst
- Answer the question: Is the applicant co-maker or endorser on any
other loans? Canonical values:
- false
- true
- EndorCoBorwForName
- The name of the person or entity the applicant is endorsing for a loan.
- EndorCoBorwToName
- The name of the institution the applicant is obligated to as an endorser.
- ForeClosureExst
- Answers the question: Has the applicant had property that has been
foreclosed? Canonical values are:
- false
- true
- JudgementAmt
- The amount the applicant is obligated to pay due to a court judgment.
- JudgementExst
- Answers the question: Does the applicant have any outstanding
judgments? Canonical values are:
- false
- true
- JudgementToName
- The name of the person or entity the applicant is obligated to pay due to a court judgment.
- LawsuitExst
- Answers the question: Is the applicant party to a lawsuit?
Canonical values are:
- false
- true
- NonUSCitizen
- Is the applicant not a U.S. citizen? Canonical values are:
- false
- true
- OccupProp
- Answers the question: Is the applicant planning to occupy the
property being used as collateral for the loan? Canonical values are:
- false
- true
- OthDlqExst
- Answers the question: Is the applicant delinquent or in default on
any debts? Canonical values are:
- false
- true
- OthForeClosureDt
- The date a lender foreclosed on property that the applicant had an interest in.
- OthForeClosureExst
- Answers the question: Has the applicant been indirectly obligated
on a loan that has been foreclosed? Canonical values are:
- false
- true
- OthForeClosureName
- The name of the lender that foreclosed on property that the applicant had an interest in.
- OthForeClosureRsn
- The reason a lender foreclosed on property that the applicant had an interest in.
- PriorPropOwner
- Answers the question: Has the applicant had ownership in a property
in the past? Canonical values are:
- false
- true
- PriorPropTitleType
- The type of title of property the application has had ownership.
Canonical values are:
- Oth
- Sole
- SpousJoint
- PriorPropType
- The type of property the application has had ownership. Canonical
values are:
- InvestmentProp
- PrinRes
- SecdHome
OthForeClosureAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
OthForeClosureAddr 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 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.
BorwDepdentArray
BorwDepdentArray is an array
AType element.
BorwDepdentArray references
DepdentArray_AType.
Contains:
DepdentInfoRec_CType
DepdentInfoRec_CType
DepdentInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- DepdentAge
- The age of the dependents that exist for a person.
BorwEmailArray
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
BorwEmailArray references EmailArray_AType.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
BorwEmplArray_AType
BorwEmplArray_AType is an array AType element. This array contains
employers information for an individual.
Contains:
BorwEmplInfoRecInfo_CType
BorwEmplInfoRec_CType
BorwEmplInfoRec_CType
is a complex CType element. This
complex describes borrower employment information.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
SalaryInfo_CType
SalaryInfo_CType is a complex CType element. This complex describes
components of salary/income for an individual.
Simple Elements
The following simple elements are contained within this complex.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
BorwEmplInfo
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
BorwEmplInfo references EmplInfo_CType.
BorwEmplInfo.
If there are multiple borrower employers, use BorwEmplArray to capture
multiple borrower employer information.Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
BorwHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
BorwHousingTerm 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
BorwIncmInfo
IncmInfo_CType is a complex
CType element that describes income for an individual. This
element is optional.
BorwIncmInfo references IncmInfo_CType.
Contains:
OthIncmArray_AType
Simple Elements
The following simple elements are contained within this complex.
- DivdIntMonthAmt
- The monthly amount of dividend and interest paid to a person.
- RentMonthIncmAmt
- The monthly amount of rental income paid to a person.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
OthIncmArray_AType
OthIncmArray_AType is an array
AType element. This is an array of other monthly income for
loan applicants.
Contains:
OthIncmInfo_CType
OthIncmInfo_CType
OthIncmInfo_CType is a complex CType element. This element contains
basic phone contact information and is optional.
Simple Elements
The following simple elements are contained within this complex.
- NonTaxblIncmType
- Income being reported is non-taxable. Canonical values are:
- false
- true
- OthIncmAmt
- The amount of other income paid to a person that cannot be classified into other amounts.
- OthIncmCode
- The code that describes the other income amount element.
- OthIncmFreq
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- OthIncmSrcCode
- The code that describes the source of other income amount element.
BorwMailAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwMailAddr 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 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.
BorwName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
BorwName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
BorwNearRelAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwNearRelAddr 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 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.
BorwNearRelName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
BorwNearRelName references
PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
BorwNearRelPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
BorwNearRelPhone references
PhoneInfo_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.
BorwPhoneInfoArray
BorwPhoneInfoArray is an array
AType element.
BorwPhoneInfoArray references
PhoneArray_AType.
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.
BorwPrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
BorwPrevAddr 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 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.
BorwPrevEmplArray_AType
BorwPrevEmplArray_AType is an array
AType element. This is an array of employers for an
individual.
Contains:
EmplInfo_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
BorwPrevHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
BorwPrevHousingTerm 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
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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
PltfmAppCoBorwArray_AType
PltfmAppCoBorwArray_AType is an array
AType element. This is an array of
co-borrowers for a loan.
Contains:
PltfmAppCoBorwInfoRec_CType
PltfmAppCoBorwInfoRec_CType
PltfmAppCoBorwInfoRec_CType is a
complex CType element.
Contains:
CoBorwAddrreferencesAddr_CTypeCoBorwAppAssetLiabInforeferencesPltfmAppAssetLiabInfo_CTypeCoBorwDeclAppInforeferencesDeclAppInfo_CTypeCoBorwDepdentArrayreferencesDepdentArray_ATypeCoBorwEmailArrayreferencesEmailArray_ATypeCoBorwEmplArrayreferencesBorwEmplArray_ATypeCoBorwEmplInforeferencesEmplInfo_CTypeCoBorwHousingTermreferencesTerm_CTypeCoBorwIncmInforeferencesIncmInfo_CTypeCoBorwMailAddrreferencesAddr_CTypeCoBorwNamereferencesPersonName_CTypeCoBorwNearRelAddrreferencesAddr_CTypeCoBorwNearRelNamereferencesPersonName_CTypeCoBorwNearRelPhonereferencesPhoneInfo_CTypeCoBorwPhoneInfoArrayreferencesPhoneArray_ATypeCoBorwPrevAddrreferencesAddr_CTypeCoBorwPrevEmplArrayreferencesBorwPrevEmplArray_ATypeCoBorwPrevHousingTermreferencesTerm_CTypeDueDilgntCmpltArray_ATypeIdVerifyArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AbbrCustDesc
- An abbreviated customer description.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AcctRelDesc
- The description of the code that describes the relationship a customer has to an account.
- CoBorwAlimonyOthMainType
- The source of obligation for alimony, child support, or separate
maintenance required. Canonical values are:
- CourtOrder
- OralUnderstanding
- WrittenAgreement
- CoBorwBirthDt
- The co-borrower's birth date.
- CoBorwDepdentNum
- The number of dependents that exist for a person.
- CoBorwDriverLicId
- The identification for a person's driver license.
- CoBorwEthnicType
- The ethnicity of an individual. Canonical values are:
- Latino
- OptOut
- Oth
- CoBorwGender
- The co-borrower's gender. Valid options are:
- Female
- Male
- Other
- CoBorwHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- Parent
- CoBorwIncmRed
- Answers the question: Will any of the income reported on a loan
application be reduced prior to the loan being paid off? Canonical values are:
- false
- true
- CoBorwIncmRedRsn
- The reason/explanation why income reported on a loan application will be reduced prior to the loan being paid off.
- CoBorwMaritalStatType
- The marital status of a person. Canonical values are:
- Divorce
- Married
- Separated
- Single
- Widow
- CoBorwMltryBr
- The branch of the military for an individual. Canonical values are:
- AirForce
- Army
- CoastGuard
- Marines
- Navy
- CoBorwMltryStat
- The military status of an individual. Canonical values are:
- Act
- NatGuard
- Resrv
- CoBorwNearRelCode
- The code that describes the relationship a person has with an account applicant.
- CoBorwPrevCrRecv
- Answers the question: Has the loan applicant received credit from
the same institution that a new loan application is being submitted? Canonical
values are:
- false
- true
- CoBorwPrevCrRecvDt
- The date the loan applicant has received credit from the same institution that a new loan application is being submitted.
- CoBorwPrevHousingDispType
- The disposition of the housing arrangement for borrowers. Canonical
values are:
- Own
- Rent
- Parent
- CoBorwRaceCode
- The code that references the co-borrower's race.
- CoBorwTaxId
- The tax identifier. It includes the
MaskVal,Rstr, andSrchTypeattributes. - CoBorwYrEduc
- The number of years of education for a person.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- IdIssueDt
- The date the identification was issued.
- IdIssueExpDt
- The expiration date of the identification issued.
- IdStateIssue
- The state the identification was issued.
CoBorwAppAssetLiabInfo
PltfmAppAssetLiabInfo_CType is a complex
CType element.
CoBorwAppAssetLiabInfo references
PltfmAppAssetLiabInfo_CType.
Contains:
AssetAppArray_ATypeLiabAppArray_AType
AssetAppArray_AType
AssetAppArray_AType is an array
AType element. This is an array of assets submitted on a
loan application.
Contains:
AssetAppInfo_CType
AssetAppInfo_CType
AssetAppInfo_CType is a complex
CType element.
Contains:
AssetAcctNamereferencesPersonName_CTypeAssetInstAddrreferencesAddr_CTypeDownPmtSrcNamereferencesPersonName_CTypeREOAppInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AssetAcctId
- The number or character that identifies an account record.
- AssetAppType
- The type of asset. Canonical values are:
- AcctRecd
- Auto
- Bond
- BrokerageAcct
- BusNetWorth
- Checking
- CloselyHeldStock
- DownPmt
- Equipment
- LifeInsur
- MoneyMkt
- MutualFunds
- NonMktSecurity
- Oth
- Partnership
- PersonalProp
- RealEstate
- Retirement
- Savings
- Securities
- TimeDep
- AssetDefName
- A free-form definition/description of the asset.
- AssetInstName
- The name of the institution that holds the asset on behalf of an individual.
- AssetSubjDebt
- Is the asset subject to any debt commitment? Canonical values are:
- false
- true
- AssetValAmt
- The value of the asset.
AssetAcctName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AssetAcctName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AssetInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
AssetInstAddr 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 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.
DownPmtSrcName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
DownPmtSrcName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
REOAppInfo_CType
REOAppInfo_CType is a complex
CType element.
Contains:
REOAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- REOClassType
- The classification of real estate owned included on a loan
application. Canonical values are:
- PendingSale
- Rental
- Sold
- REOEscrwPmtAmt
- The escrow mortgage payment for real estate owned.
- REOLienAmt
- The number of liens that exist for any real estate owned.
- REOPIAmt
- The mortgage principal and interest payment for real estate owned.
- REORentAmt
- The gross amount of rental income from real estate owned.
- REOType
- The type of real estate owned included on a loan application.
Canonical values are:
- COM - commercial
- RES - residential
- SEC - secondary residence
- VAC - vacation
REOAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
REOAddr 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 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.
LiabAppArray_AType
LiabAppArray_AType is an array
AType element. This is an array of liabilities submitted on
a loan applicant.
Contains:
LiabAppInfo_CType
LiabAppInfo_CType
LiabAppInfo_CType is a complex
CType element. This element is optional.
Contains:
LiabInstAddrreferences theAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- LiabAcctId
- The number or character that identifies an account record.
- LiabAcctName
- The name in which the liability is carried.
- LiabAppType
- The type of liability reported on a loan application. Canonical
values are:
- Alimony
- Auto
- ChargeAcct
- ChildSupport
- JobExpenses
- Landlord
- Main
- MtgHolder
- Oth
- StockPledge
- LiabCurBal
- The current outstanding balance owed for a liability.
- LiabDefName
- A free-form definition/description of the liability.
- LiabInstName
- The name of the institution that is obligated the funds owed for an individual.
- LiabMonthPmtAmt
- The monthly payment obligation for a liability.
- LiabOrigAmt
- The original amount owed for a liability.
LiabInstAddr
LiabInstAddr
is a complex CType element.
LiabInstAddr 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 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.
CoBorwAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwAddr 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 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.
CoBorwDeclAppInfo
DeclAppInfo_CType is a complex
CType element. The complex
for loan application declarations.
CoBorwDeclAppInfo references DeclAppInfo_CType.
Contains:
OthForeClosureAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- AlienNonResidentType
- Answers the question: Is the applicant a non-permanent resident
alien? Canonical values are:
- false
- true
- AlienResident
- Answers the question: Is the applicant a permanent resident alien?
Canonical values are:
- false
- true
- AlimonyMainExst
- Answers the question: Is the applicant obligated to pay alimony,
child support, or separation maintenance? Canonical values are:
- false
- trueNote: When true, the liability information related to alimony, child support, separate maintenance, job-related expenses, or other are entered in
BorwAppAssetLiabInfoorCoBorwAppAssetLiabInfo.
- DeclBnkrptcy
- Answers the question: Has the applicant declared bankruptcy?
Canonical values are:
- false
- true
- DeclBnkrptcyLoc
- The location that the applicant declared bankruptcy.
- DeclBnkrptcyYr
- The year the applicant declared bankruptcy.
- DownPmtBorw
- Answers the question: Is part of the loan down payment borrowed?
Canonical values are:
- false
- true
- EndorCoBorwExst
- Answer the question: Is the applicant co-maker or endorser on any
other loans? Canonical values:
- false
- true
- EndorCoBorwForName
- The name of the person or entity the applicant is endorsing for a loan.
- EndorCoBorwToName
- The name of the institution the applicant is obligated to as an endorser.
- ForeClosureExst
- Answers the question: Has the applicant had property that has been
foreclosed? Canonical values are:
- false
- true
- JudgementAmt
- The amount the applicant is obligated to pay due to a court judgment.
- JudgementExst
- Answers the question: Does the applicant have any outstanding
judgments? Canonical values are:
- false
- true
- JudgementToName
- The name of the person or entity the applicant is obligated to pay due to a court judgment.
- LawsuitExst
- Answers the question: Is the applicant party to a lawsuit?
Canonical values are:
- false
- true
- NonUSCitizen
- Is the applicant not a U.S. citizen? Canonical values are:
- false
- true
- OccupProp
- Answers the question: Is the applicant planning to occupy the
property being used as collateral for the loan? Canonical values are:
- false
- true
- OthDlqExst
- Answers the question: Is the applicant delinquent or in default on
any debts? Canonical values are:
- false
- true
- OthForeClosureDt
- The date a lender foreclosed on property that the applicant had an interest in.
- OthForeClosureExst
- Answers the question: Has the applicant been indirectly obligated
on a loan that has been foreclosed? Canonical values are:
- false
- true
- OthForeClosureName
- The name of the lender that foreclosed on property that the applicant had an interest in.
- OthForeClosureRsn
- The reason a lender foreclosed on property that the applicant had an interest in.
- PriorPropOwner
- Answers the question: Has the applicant had ownership in a property
in the past? Canonical values are:
- false
- true
- PriorPropTitleType
- The type of title of property the application has had ownership.
Canonical values are:
- Oth
- Sole
- SpousJoint
- PriorPropType
- The type of property the application has had ownership. Canonical
values are:
- InvestmentProp
- PrinRes
- SecdHome
OthForeClosureAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
OthForeClosureAddr 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 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.
CoBorwDepdentArray
DepdentArray_AType is an array
AType element. This is an array of an individual's
dependents.
CoBorwDepdentArray references DepdentArray_AType.
Contains:
DepdentInfoRec_CType
DepdentInfoRec_CType
DepdentInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- DepdentAge
- The age of the dependents that exist for a person.
EmailArray_AType
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
BorwEmplArray_AType
BorwEmplArray_AType is an array AType element. This array contains
employers information for an individual.
Contains:
BorwEmplInfoRecInfo_CType
BorwEmplInfoRec_CType
BorwEmplInfoRec_CType
is a complex CType element. This
complex describes borrower employment information.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
SalaryInfo_CType
SalaryInfo_CType is a complex CType element. This complex describes
components of salary/income for an individual.
Simple Elements
The following simple elements are contained within this complex.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
CoBorwEmplInfo
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
CoBorwEmplInfo references EmplInfo_CType.
CoBorwEmplInfo. If there are multiple coborrower employers, use
CoBorwEmplArray to capture multiple coborrower employer
information.Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
CoBorwHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
CoBorwHousingTerm 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
CoBorwIncmInfo
IncmInfo_CType is a complex
CType element that describes income for an individual. This
element is optional.
CoBorwIncmInfo references IncmInfo_CType.
Contains:
OthIncmArray_AType
Simple Elements
The following simple elements are contained within this complex.
- DivdIntMonthAmt
- The monthly amount of dividend and interest paid to a person.
- RentMonthIncmAmt
- The monthly amount of rental income paid to a person.
- SalaryBonusAmt
- The monthly number of bonuses paid to an employee.
- SalaryComsonAmt
- The monthly amount of commission paid to an employee.
- SalaryMonthAmt
- The gross monthly salary amount for an employee.
- SalaryNetMonthAmt
- The net monthly salary amount for an employee.
- SalaryOvertimeAmt
- The monthly amount of overtime paid to an employee.
OthIncmArray_AType
OthIncmArray_AType is an array
AType element. This is an array of other monthly income for
loan applicants.
Contains:
OthIncmInfo_CType
OthIncmInfo_CType
OthIncmInfo_CType is a complex CType element. This element contains
basic phone contact information and is optional.
Simple Elements
The following simple elements are contained within this complex.
- NonTaxblIncmType
- Income being reported is non-taxable. Canonical values are:
- false
- true
- OthIncmAmt
- The amount of other income paid to a person that cannot be classified into other amounts.
- OthIncmCode
- The code that describes the other income amount element.
- OthIncmFreq
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- OthIncmSrcCode
- The code that describes the source of other income amount element.
CoBorwAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwAddr 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 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.
CoBorwName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CoBorwName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CoBorwNearRelAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwNearRelAddr 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 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.
CoBorwNearRelName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CoBorwNearRelName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CoBorwNearRelPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
CoBorwNearRelPhone references
PhoneInfo_CType.
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.
CoBorwPhoneInfoArray
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.
CoBorwPhoneInfoArray references
PhoneArray_AType.
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.
CoBorwPrevAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CoBorwPrevAddr 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 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.
CoBorwPrevEmplArray
CoBorwPrevEmplArray is an array
AType element. This is an array of employers for a
co-borrower.
CoBorwPrevEmplArray references
BorwPrevEmplArray_AType.
Contains:
EmplInfo_CType
EmplInfo_CType
EmplInfo_CType is a complex
CType element. This complex describes current and previous
employment history.
Contains:
EmplAddrreferencesAddr_CTypeEmplPhonereferencesPhoneInfo_CTypeEmplTermreferencesTerm_CTypeProfesEmplTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BorwSelfEmpl
- Answers the question: Is the borrower self-employed? Values are:
- false
- true
- EmplEndDt
- The ending date of employment for an employee.
- EmplName
- The employer name.
- EmplPrimType
- Answers the question: Does the employer represent the primary
employer for an individual? Canonical values are:
- false
- true
- EmplStartDt
- The starting date of employment for an employee.
- EmplTitle
- The title an employee holds in a corporation or business.
EmplAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
This complex contains employee address information.
EmplAddr 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 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.
EmplPhone
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
EmplPhone references PhoneInfo_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.
EmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
EmplTerm 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
ProfesEmplTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
ProfesEmplTerm 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
CoBorwPrevHousingTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
CoBorwPrevHousingTerm 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
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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
PltfmAppHousingInfo_CType
PltfmAppHousingInfo_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- HazInsurAmt
- The payment amount for hazard insurance.
- HomeOwnerAssnAmt
- The payment amount for home owners association fees.
- MtgInsurAmt
- The payment amount for mortgage insurance.
- PIAmt
- The principal and interest payment amount.
- RealEstateTaxAmt
- The payment amount for real estate taxes.
- RentAmt
- The rent amount.
- SecdPIAmt
- The principal and interest payment of any secondary funding for a loan.
PltfmAppLnInfo_CType
PltfmAppLnInfo_CType is a complex CType element. It
contains the submission of a loan application that contains the general information of the
application.
Contains:
LnTermreferencesTerm_CTypePmtTermreferencesTerm_CType
Simple Elements
The following simple elements are contained within this complex.
- BallPmtAmt
- The balloon payment amount.
- BrCode
- The branch code.
- CrAppCode
- The code that further defines the type of loan credit application.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- FirstPmtDt
- The first payment date.
- IntCalcCode
- The interest calculation method.
- IntRate
- The interest rate.
- LnAppType
- The loan application type. Canonical values are:
- New
- Refi
- Renew
- RenewWithMod
- Mod
- LnRePmtSrc
- The sources that are used for the loan repayment.
- PltfmClsfPrimType
- Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
- PmtCode
- The payment code. The payment code determines how the payment is applied to the loan.
- ProceedAmt
- The first advance amount for the new loan.
- ProdCode
The code that identifies a product type of account within an application. Canonical values are:
- jha-4sight
- jha-argokeys
- jha-cif2020
- jha-coredirector
- jha-imagecenter
- jha-silverlake
- jha-synapsys
ProdCode is a hybrid open enumeration.
- PurpCode
- Bank-defined and is used to define the purpose of the loan.
Canonical values are:
- CashOutRefi
- HomeImprov
- HomePurch
- Oth
- Refi
- RateIdxDesc
- The rate index description.
- RateType
- Types of interest rates. Canonical values are:
- Adj
- Fix
- Renew
- Vrbl
- RegionCode
- The code that identifies a financial institution's region that would encompass a group of branches.
LnTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
LnTerm 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
PmtTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
PmtTerm references the 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
PltfmRECollatInfo_CType
PltfmRECollatInfo_CType is a
complex CType element.
Contains:
CollatHolderAddrreferencesAddr_CTypeCollatInsurArray_ATypeCollatOwnArray_ATypeLienExstArray_ATypePersonName_CTypePropAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- ApprDt
- The last appraisal date of the account.
- CollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- CollatDesc
- The collateral code description.
- CollatLienAmt
- The amount of any liens that exist on a loan collateral item.
- DownPmtSrcCode
- The code that represents the source of the borrower's down payment.
- ImprovCostAmt
- The number of improvement costs for real estate property.
- LotValAmt
- The value amount of real estate property lot.
- NonPurchCollatAmt
- The amount of a collateral purchase that is used towards a secured loan.
- NumUnit
- The number of units in the mortgaged property.
- OccupProp
- Answers the question: Is the applicant planning to occupy the
property being used as collateral for the loan? Canonical values are:
- false
- true
- OrigPropCostAmt
- The original cost of a real estate property.
- PropAcctTitle
- The account title including customer name and additional
names.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- PropCode
- The code that identifies the type of loan for compliance with Inter-Agency Guidelines to Real
Estate Lending Standards. Canonical values are:
- Fam
- MH
- MultiDwell
- PropEstateType
- The manner the estate is held for property. Canonical values are:
- FeeSimple
- Leassehold
- PropEstVal
- The estimated value of real estate property.
- PropLeaseExpDt
- The expiration date for a lease for a property in an estate.
- PropLegalInfo
- The legal description of the property.
- PropPurchaseAmt
- The purchase price of the property.
- PropTitleType
- The forms of ownership for property. Canonical values are:
- FeeSimple
- JTWROS
- PeriodicTenancy
- TenancyCom
- TenancyEntirety
- TenancyWill
- TenancyYr
- PropType
- The type of property the application has ownership. Canonical
values are:
- Condo
- Manufactured
- MultiFamily
- Oth
- SingleFamily
- TownHome
- RefinImprovCost
- The cost of improvements on a property for refinance a loan.
- RefinImprovExst
- Answers the question: Do the improvements to a property exist for a
refinance loan request? Canonical values are:
- false
- true
- RefinImprovInfo
- A detail description code that represents the purpose of a loan refinance.
- RefinPurpCode
- The code that represents the purpose of a loan refinance.
- ResType
- The type of property the application has ownership. Canonical values
are:
- Invest
- Princ
- Oth
- Secd
- YrBuilt
- The year the property was built.
- YrLotAcq
- The year a real estate property lot was acquired.
- YrPropAcq
- The year a real estate property was acquired.
CollatHolderAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatHolderAddr references Addr_CType.
CollatInstAddr complex will replace this instance
of CollatHolderAddr.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.
CollatInsurArray_AType
CollatInsurArray_AType is an array AType element. This is an array of
collateral insurance information.
Contains:
CollatInsurInfo_CType
CollatInsurInfo_CType
CollatInsurInfo_CType is a complex CType element.
Contains:
Custom_CTypeInsurCompAddrreferencesAddr_CTypePhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- InsurCompCode
- The code that represents an insurance company.
- InsurPlcyAmt
- The amount of insurance for a specific policy.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InsurCompAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
InsurCompAddr
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 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.
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.
CollatOwnArray_AType
CollatOwnArray_AType is an array
AType element. This is an
array of collateral holder information.
Contains:
CollatOwnInfo_CType
CollatOwnInfo_CType
CollatOwnInfo is a complex CType element.
Contains:
CollatOwnAddrreferencesAddr_CTypeCollatOwnNamereferencesPersonName_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatOwnCode
- The code that defines the collateral holder's relationship to the borrower or coborrower, third-party individual, third-party DBA/sole proprietor, third-party trust, third-party corporation, third-party general partnership, third-party limited partnership, etc.
- CollatOwnCustId
- The identifier attached to a customer.
- CollatPctOwned
- The percentage that is owned.
- CollatTitleCode
- The code that represents the form of ownership in a piece of collateral.
CollatOwnAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatOwnAddr
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 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.
CollatOwnName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatOwnName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienExstArray_AType
LienExstArray_AType is an array
AType element. This is an
array of existing liens encumbering a piece of collateral.
Contains:
LienExstInfo_CType
LienExstInfo_CType
LienExstInfo is a complex CType element.
Contains:
AccountID_CTypeCustom_CTypeLienHolderAddrreferencesAddr_CTypeLienHolderNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- LienAmt
- The amount of any liens that exist on a loan collateral item.
- LienHolderOnUs
- Identifies whether collateral is held by the lending financial
institution. Canonical values are:
- false
- true
- LienPositCode
- The lien position for a loan. For example, first lien position, second lien position, etc.
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
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienHolderAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
LienHolderAddr_CType
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 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.
LienHolderName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
LienHolderName_CType references
PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
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.
PropAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
PropAddr 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 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.
PltfmRECollatInfoArray_AType
PltfmRECollatInfoArray_AType is an array AType element. This element is an
array of multiple collateral items.
Contains:
PltfmRECollatInfo_CType
PltfmRECollatInfo_CType
PltfmRECollatInfo_CType is a
complex CType element.
Contains:
CollatHolderAddrreferencesAddr_CTypeCollatInsurArray_ATypeCollatOwnArray_ATypeLienExstArray_ATypePersonName_CTypePropAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- ApprDt
- The last appraisal date of the account.
- CollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- CollatDesc
- The collateral code description.
- CollatLienAmt
- The amount of any liens that exist on a loan collateral item.
- DownPmtSrcCode
- The code that represents the source of the borrower's down payment.
- ImprovCostAmt
- The number of improvement costs for real estate property.
- LotValAmt
- The value amount of real estate property lot.
- NonPurchCollatAmt
- The amount of a collateral purchase that is used towards a secured loan.
- NumUnit
- The number of units in the mortgaged property.
- OccupProp
- Answers the question: Is the applicant planning to occupy the
property being used as collateral for the loan? Canonical values are:
- false
- true
- OrigPropCostAmt
- The original cost of a real estate property.
- PropAcctTitle
- The account title including customer name and additional
names.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- PropCode
- The code that identifies the type of loan for compliance with Inter-Agency Guidelines to Real
Estate Lending Standards. Canonical values are:
- Fam
- MH
- MultiDwell
- PropEstateType
- The manner the estate is held for property. Canonical values are:
- FeeSimple
- Leassehold
- PropEstVal
- The estimated value of real estate property.
- PropLeaseExpDt
- The expiration date for a lease for a property in an estate.
- PropLegalInfo
- The legal description of the property.
- PropPurchaseAmt
- The purchase price of the property.
- PropTitleType
- The forms of ownership for property. Canonical values are:
- FeeSimple
- JTWROS
- PeriodicTenancy
- TenancyCom
- TenancyEntirety
- TenancyWill
- TenancyYr
- PropType
- The type of property the application has ownership. Canonical
values are:
- Condo
- Manufactured
- MultiFamily
- Oth
- SingleFamily
- TownHome
- RefinImprovCost
- The cost of improvements on a property for refinance a loan.
- RefinImprovExst
- Answers the question: Do the improvements to a property exist for a
refinance loan request? Canonical values are:
- false
- true
- RefinImprovInfo
- A detail description code that represents the purpose of a loan refinance.
- RefinPurpCode
- The code that represents the purpose of a loan refinance.
- ResType
- The type of property the application has ownership. Canonical values
are:
- Invest
- Princ
- Oth
- Secd
- YrBuilt
- The year the property was built.
- YrLotAcq
- The year a real estate property lot was acquired.
- YrPropAcq
- The year a real estate property was acquired.
CollatHolderAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatHolderAddr references Addr_CType.
CollatInstAddr complex will replace this instance
of CollatHolderAddr.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.
CollatInsurArray_AType
CollatInsurArray_AType is an array AType element. This is an array of
collateral insurance information.
Contains:
CollatInsurInfo_CType
CollatInsurInfo_CType
CollatInsurInfo_CType is a complex CType element.
Contains:
Custom_CTypeInsurCompAddrreferencesAddr_CTypePhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- InsurCompCode
- The code that represents an insurance company.
- InsurPlcyAmt
- The amount of insurance for a specific policy.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InsurCompAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
InsurCompAddr
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 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.
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.
CollatOwnArray_AType
CollatOwnArray_AType is an array
AType element. This is an
array of collateral holder information.
Contains:
CollatOwnInfo_CType
CollatOwnInfo_CType
CollatOwnInfo is a complex CType element.
Contains:
CollatOwnAddrreferencesAddr_CTypeCollatOwnNamereferencesPersonName_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- CollatOwnCode
- The code that defines the collateral holder's relationship to the borrower or coborrower, third-party individual, third-party DBA/sole proprietor, third-party trust, third-party corporation, third-party general partnership, third-party limited partnership, etc.
- CollatOwnCustId
- The identifier attached to a customer.
- CollatPctOwned
- The percentage that is owned.
- CollatTitleCode
- The code that represents the form of ownership in a piece of collateral.
CollatOwnAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
CollatOwnAddr
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 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.
CollatOwnName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
CollatOwnName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienExstArray_AType
LienExstArray_AType is an array
AType element. This is an
array of existing liens encumbering a piece of collateral.
Contains:
LienExstInfo_CType
LienExstInfo_CType
LienExstInfo is a complex CType element.
Contains:
AccountID_CTypeCustom_CTypeLienHolderAddrreferencesAddr_CTypeLienHolderNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- LienAmt
- The amount of any liens that exist on a loan collateral item.
- LienHolderOnUs
- Identifies whether collateral is held by the lending financial
institution. Canonical values are:
- false
- true
- LienPositCode
- The lien position for a loan. For example, first lien position, second lien position, etc.
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
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LienHolderAddr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
LienHolderAddr_CType
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 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.
LienHolderName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
LienHolderName_CType references
PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
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.
PropAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
PropAddr 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 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.
PltfmTimeDepAppAdd_CType
PltfmTimeDepAppAdd_CType is a complex CType element.
The complex for submitting a time deposit account application.
Contains:
Custom_CTypePltfmAppCustArray_ATypePltfmAppSigInfo_CTypePltfmAppTaxPlnInfo_CTypePltfmAppTimeDepInfo_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmAppCustArray_AType
PltfmAppCustArray_AType is an array AType element. This is an array of customers
submitted for a platform application.
Contains:
PltfmAppCustInfo_CType
PltfmAppCustInfo_CType
PltfmAppCustInfo_CType is a complex CType element.
Contains:
Addr_CTypeAlien_CTypeBenflOwnInfoArray_ATypeBenflOwnIdVerifyInfo_CTypeCustBenfInfo_CTypeCustom_CTypeCustSvcOptArray_ATypeDueDilgntCmpltArray_ATypeEmailArray_ATypeIdVerifyArray_ATypeOffInfoArray_ATypePersonName_CTypePhoneArray_ATypePltfmAddrArray_ATypeCommAgentAuthArray_ATypeRoleCodeArray_ATypeTINInfo_CTypeUserDefInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AbbrCustDesc
- An abbreviated customer description.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AlienNonResidentType
- Answers the question: Is the applicant a non-permanent resident
alien? Canonical values are:
- false
- true
- AlienResident
- Answers the question: Is the applicant a permanent resident alien?
Canonical values are:
- false
- true
- AlienW8Type
- The type that identifies the IRS classification that grants a
foreigner an exemption from certain U.S. information return reporting and backup
withholding regulations. Canonical values are:
- BEN-E - beneficial owner
- ECI - income connected with the conduct of a trade
- EXP - foreign government or other foreign organization
- IMY - foreign intermediary or foreign flow through entity
- ApointCptyDesc
- The description of the entity's legal capacity.
- ApointCptyType
- The entity's legal capacity. Canonical values are:
- Conservator
- Executor
- Executrix
- Guardian
- LegalRep
- Oth
- PrsnlRep
- BenflOwnExclCode
- The exclusion code for being exempt from FinCEN Customer Due Diligence (CDD) regulation.
- BirthDt
- The date of birth.
- BrCode
- The branch code.
- CommAgentTitle
- The title an employee holds in a corporation or business.
- CustCode
- The code that further defines the customer.
- CustSubClsfCode
- The code that further defines the customer.
- CustType
- The customer type. Examples include business or individual.
Canonical values are:
- Bus
- Indv
- DscSigType
Is the entity authorized to act as a disclosure signer? Canonical values are:
- true
- false
- EmplName
- The employer name.
- EntityRgtrLocType
The type of location where an entity is registered. Canonical values are:
- OthCntry - other country, not one of the United States or a United States territory
- State - the name of the state located in the United States
- Terr - the name of the United States territory
- EntityRgtrLoc
- Where an entity is registered.
- EstbDt
- The date established.
- ExcOwnPct
- The exception/override percentage for the legal entity customer, as it relates to FinCEN Customer Due Diligence (CDD).
- ExcPctRsnCode
- The exception/override percentage reason as it relates to FinCEN Customer Due Diligence (CDD).
- FinInstNonCustType
The information being collected is for a non-customer of the financial institution. Canonical values are:
- false
- true
The default value is false.
- Gender
- The customer's gender. Canonical values are:
- Female
- Male
- Other
- HldMailCode
- Includes the mailing instructions. Valid values are 1–9 or blank.
- IsPrimCustRel
- Answers the question: Does the entity represent the primary entry
for a grouping of entities? Canonical values are:
- false
- true
- LegalEntityId
- The customer's Legal Entity Identifier (LEI).
- NAICSCode
- A valid NAICS (Northern American Industry Classification System) code. Value is passed from the service of record during the pilot phase.
- NonPrftOrgType
Is the entity a non-profit organization? Canonical values are:
- true
- false
- NonUSCitizen
- Is the applicant not a U.S. citizen? Canonical values are:
- false
- true
- OccType
- The occupation description of the customer. Retail or bus.
- PltfmCustCode
- The Platform Customer Code that further defines the Customer Type.
- ReqLegalEntityType
- Is this customer required to be reported as a legal entity?
Canonical values are:
- false
- true
- StdIndustCode
- The standard industry code.
- TINCertType
- Customer can legally certify the Tax Identification Number.
Canonical values are:
- false
- true
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.
Alien_CType
Alien_CType is a complex
CType element.
Contains:
RptChapArray_AType
Simple Elements
The following are the simple elements contained within this complex.
- AlienIRSRptType
The type of reporting to the IRS for an alien. Canonical values are:
- 1042S
- 1099INT
- NoRpt
- AlienLastW8Dt
- The last alien certification date.
- AlienTypeCode
- The code that describes the type of alien applied to a customer.
- AlienTypeDesc
- The description of the code that describes the type of alien applied to a customer.
- AlienW8ExpDt
- The expiration date of the W8 Alien Tax form.
- AlienW8StatDesc
- The description of the status of the filing of the W8 Alien Tax forms.
- AlienW8Stat
- The status of the filing of the W8 Alien Tax forms.
- AlienW8Type
- The type that identifies the IRS classification that grants a
foreigner an exemption from certain U.S. information return reporting and backup
withholding regulations. Canonical values are:
- BEN-E - beneficial owner
- ECI - income connected with the conduct of a trade
- EXP - foreign government or other foreign organization
- IMY - foreign intermediary or foreign flow through entity
- CitzCntryType
- Citizen Country - These are predefined by the IRS for an alien customer.
- FornTaxId
- Foreign Tax Identifier
- GIINCertDt
- Alien Global Intermediary Identification Number Certification Date.
- GIINDt
- The date the Alien Global Intermediary Identification Number was provided.
- GIINId
- Alien Global Intermediary Identification Number that is assigned by IRS to a participating FFI or registered deemed-compliant FFI. Reference IRS Rev. Proc. 2014-38
- IRSExmpCode
- The exemption code must be entered as defined by the IRS and setup
in the bank parameter file when the ALL of the following apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSExmpDesc
- The description of the exemption code must be entered as defined by
the IRS and setup in the bank parameter file when the ALL of the following
apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSRecipCode
- If Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- IRSRecipDesc
- The description of the Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- ResCity
- The alien residence foreign city.
- ResCntry
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
- ResCntryType
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
- ResPostalCode
- The alien residence foreign postal code.
- ResStateProv
- The alien residence foreign state or province.
- ResStrAddr1
- The alien residence foreign address 1.
- ResStrAddr2
- The alien residence foreign address 2.
RptChapArray_AType
RptChapArray_AType is an array
AType element. This is an array of reporting chapters.
Contains:
RptChapInfoRec_CType
RptChapInfoRec_CType
RptChapInfoRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- IRSExmpCode
- The exemption code must be entered as defined by the IRS and setup
in the bank parameter file when the ALL of the following apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSExmpDesc
- The description of the exemption code must be entered as defined by
the IRS and setup in the bank parameter file when the ALL of the following
apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- IRSRecipCode
- If Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- IRSRecipDesc
- The description of the Alien Customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable, then the recipient code must be entered as defined by the IRS and setup in the bank parameter file.
- RptChapExst
- Represents which chapter is being reported. Canonical values are:
- false
- true
- RptChapType
- The code that designates the reporting chapter as defined by the
IRS. Canonical values are:
- 3
- 4
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
BenflOwnInfoArray_AType
BenflOwnInfoArray_AType is an array
AType element. This is an
array of beneficial owner information.
Contains:
BenflOwnInfo_CType
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.
BenflOwnIdVerifyInfo_CType
BenflOwnIdVerifyInfo_CType is a complex CType
element. This element contains ID Verification information related to beneficial
owners.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- 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).
- VerifyDt
- Date of verification of beneficial owners as it relates to FinCEN Customer Due Diligence (CDD).
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CommAgentAuthArray_AType
CommAgentAuthArray_AType is an array AType element. This is an array of
authorizations assigned to a commercial account agent.
Contains:
CommAgentAuthRec_CType
CommAgentAuthRec_CType
CommAgentAuthRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CommAuthCode
- The Entity Authorization Code.
- CommAuthType
- The authority granted to an entity. Canonical values are:
- Basic - simple authorities
- Extend - elevated authorizations
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CustBenfInfo_CType
CustBenfInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- BenfDesigId
- An identification provided to each beneficiary that designates primary and contingent beneficiaries.
- BenfId
- An identification (i.e., Tax Identification, Drivers License) provided to identify the beneficiary.
- BenfPctDist
- The percentage of the proceeds the beneficiary is entitled to.
- BenfRel
- The relationship the beneficiary has to the account holder.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EmailArray_AType
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
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
OffInfoArray_AType
OffInfoArray_AType is an array
AType element. This is an array of officers.
Contains:
OffInfoRec_CType
OffInfoRec_CType
OffInfoRec_CType is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- OffCode
- The code that designates the financial institution officer.
- OffCodeText
- The text that describes the preceding elements for the
OffInfoArry. - OffDesc
- The officer short name.
- OffRmk
- Application or user remarks free-form text.
PersonName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
PhoneArray_AType
PhoneArray_AType is an array AType
element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
PltfmAddrArray_AType
PltfmAddrArray_AType is an array
AType element. This is an array of platform application customer
addresses.
Contains:
PltfmAddrInforeferencesPltfmAddrRec_CType
PltfmAddrInfo
PltfmAddrRec_CType is a complex
CType element.
PltfmAddrInfo references PltfmAddrRec_CType.
Contains:
AddrInfo_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrCatUse
- Address category type. Canonical values are:
- Acct - Account
- Cust - Customer
- IRSRpt - IRS Reporting
- Not - Notice
- Pmt - Payments (Distributions or interest checks)
- Seasonal
- Stmt - Statement
- AddrCat2Use
Address category 2 type
- Cat=Not has
- AdvOfCr
- Bil
- CrBack
- EOYTax
- InsufFunds
- IRAMat
- OD
- PastDue
- RateChg
- RtnItems
- TeleTrf
- Cat=Pmt has
- EscrwRefund
- Int
- IRADistr
- XMAS
- Cat1=Stmt has
- Escrw
- IRAPeriodic
- LOC
- Periodic
Canonical values are:
- AdvOfCr
- All
- Bil
- CrBack
- EOYTax
- Escrw
- EscrwRefund
- Exc
- InsufFunds
- Int
- IRADistr
- IRAMat
- IRAPeriodic
- IRS
- LOC
- OD
- PastDue
- Periodic
- Phys
- RateChg
- RtnItems
- Seasonal
- ScsrCstdn
- TeleTrf
- XMAS
- Cat=Not has
AddrInfo_CType
AddrInfo_CType is a complex CType element used to define the listed address. This element is
optional.
Contains:
Addr_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrLastChng
- Date the address was last changed.
- AddrLastVerify
- Date the address was last verified.
- MailDirCode
- The code for the mail directive, such as Hold.
- SeasonBegDt
- The beginning date for a seasonal address.
- SeasonEndDt
- The ending date for a seasonal address.
- SeasonReocur
- Determines if the seasonal address reoccurs.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CustSvcOptArray_AType
CustSvcOptArray_AType is an array AType element. This element is an
array of service options available for the customer.
Contains:
CustSvcOptInfoRec_CType
CustSvcOptInfo_CType
CustSvcOptInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- CustSvcOptCode
- Service options available for the product offered.
- CustSvcOptDesc
- Descriptions of the service options available for the product.
RoleCodeArray_AType
RoleCodeArray_AType is an array
AType element.
Contains:
RoleCodeRec_CType
RoleCodeRec_CType
RoleCodeRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- RoleCode
- The code that describes the customer role related to an account relationship.
- RoleDesc
- The description of the code that describes the customer role related to an account.
TINInfo_CType
TINInfo_CType is a complex
CType element. This element contains tax information number
codes and descriptions. This element is optional.
Contains:
TaxIdOwnerNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BNotIRSDt
- The last IRS notification.
- BNotStat
- The B notice flag.
- CertCodeDesc
- The description of the code that represents the certification behavior for a tax ID.
- CertCodeDt
- The certification code date.
- CertCode
- The code that represents the certification behavior for a tax ID.
- TaxIdMod
- A tax ID modifier assigned by the SSA to some individuals.
- 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.
- TINDesc
- The description of the code that designates the type of tax identification number.
TaxIdOwnerName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
TaxIdOwnerName references PersonName_CType.
The TaxIdOwnerName
is optional and is only required when the customer level tax ID is different than the
account level.
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.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
PltfmAppTimeDepInfo_CType
PltfmAppTimeDepInfo_CType is a
complex CType element.
Contains:
AccountId_CTypeAcctTitleArray_CTypeBenfArray_ATypeBusResInfo_CTypeCommAuthArray_ATypeCRARec_CTypeDueDilgntCmpltArray_ATypeEstbPersonNamereferencesPersonName_CTypeOffInfoArray_ATypePltfmAddrArray_ATypeProdSvcOptArray_ATypeRateSchedArray_ATypeSrcFundsArray_ATypeUserDefInfoArray_ATypeVarIntRateInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctClsfCode
- The allowed account classification values that are bank defined.
- AcctId
- The number or character that identifies an account record.
- AcctLvlSecCode
- The code that references the special handling security processes/accesses at the account level.
- AcctOwnType
- Defines the ownership category for an account identification.
Canonical values are:
- Bus
- Custodial
- Ind
- Joint
- Trust
- AcctPurp
- The purpose of an account (used for document preparation and printing).
- AcctResDesc
- The description of the code that describes documentation proof of a non-individual entity.
- AcctType
- The number or character that categorizes the AcctId.
- ACHCrAcctId
- The account ID of the credit account for the ACH item.
- ACHCrName
- The account holder's name of the credit account for the ACH item.
- ACHCrRtNum
- The routing and transit number of the credit account's bank for the ACH item.
- ACHTrnCode
- The transaction code to be used for the ACH item, as governed by Nacha® rules.
- IncSoleProprtrNameType
- Determines if the Sole Proprietor Name should be included in the
title on documents. Canonical values are:
- true
- false
The values 22=Deposit and 32=Savings.
IntDisp element equals
PaybyACH.- AutoRenType
- Instrument renews automatically at maturity. Canonical values
are:
- false
- true
- BrCode
- The branch code.
- CallRptCode
- The call report code.
- CDTerm
- The CD term.
- CDTermUnits
- The CD term units. Canonical values are:
- Days
- Months
- NA
- SemiMonthly
- Years
- EstbPersonTitle
- The title an employee holds in a corporation or business.
- FedWithCode
- The federal withholding code passed from the service of record during the pilot phase.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- IntCalcCode
- The interest calculation method.
- IntDayMonth
- The day of month that interest payments should always be generated.
- IntDispAcctId
- The interest disposition account number.
- IntDispAcctType
- The interest disposition account type.
- IntDisp
- Designates the disposition of interest. Canonical values are:
- AddBackToAcct
- DepToAcct
- NA
- PayByACH
- PayByChk
IntDisp element equals DepToAcct.- IntRate
- The interest rate.
- IntTerm
- The interest term.
- IntTermUnits
- Interest term units canonical values are:
- Days
- Months
- NA
- SemiMonthly
- Years
- IntYrBaseCode
- The code for the Year Base.
- IRSExmpCode
- The exemption code must be entered as defined by the IRS and setup
in the bank parameter file when the ALL of the following apply:
- Alien Customer is flagged as Y.
- The TAX ID type code is set up in the bank parameters as Alien reportable.
- This customer is exempt from withholding for IRS form 1042S.
- MatDt
- The maturity date.
- NxtPayDt
- The next payment date.
- OpenBal
- The amount of funds used to establish an account.
- OpenDt
- The date opened.
- PenCode
- The code that references the penalty for early withdrawals of a deposit instrument.
- PltfmClsfPrimType
- Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
- PltfmOwnCode
- The code that describes the ownership of an account from a platform perspective.
- PODRegType
- Account is subject to the non-probate Payable On Death Statute
transfer. Canonical values are:
- false
- true
- ProdCode
The code that identifies a product type of account within an application. Canonical values are:
- jha-4sight
- jha-argokeys
- jha-cif2020
- jha-coredirector
- jha-imagecenter
- jha-silverlake
- jha-synapsys
ProdCode is a hybrid open enumeration.
- RateTypeDesc
- Description of the type of interest rate.
- RateType
- Types of interest rates. Canonical values are:
- Adj
- Fix
- Renew
- Vrbl
- RegionCode
- The code that identifies a financial institution's region that would encompass a group of branches.
- SalesPerson
- The code value that represents the sales person. This element was changed from a string to an open enumerated type in 4/2011. This element resides as an exception and is not to be suffixed with code rather than deprecate the element. The element does have a description.
- ScsrCstdnName
- The common name. This is the full text line name like John Doe.
- SrcFundsCode
- A code that represents the source of funds for credit transactions and the outgoing source for debit transactions.
- StmtFreqCode
- The statement frequency code.
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
AcctTitleArray_AType
AcctTitleArray_AType is an array AType element. This is an array of
account titles used to define the customer and additional names. This element is
optional.
Contains:
AcctTitleInfo_CType
AcctTitleInfo_CType
AcctTitleInfo_CType is a complex
CType element.
Contains:
AddlNamereferencesPersonName_CTypeAddlPhoneArrayreferencesPhoneArray_ATypeAddlTINreferencesTINInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctTitle
- The account title including customer name and additional
names.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- AddlBirthDt
- The date of birth.
- AddlNameStat
- The additional person status. Canonical values are:
- Act - active
- NotAct - not active
The ComName
element is contained by the AddlName complex and replaces the AcctTitle element. The
depreciation effective date for AcctTitle is 2012-01-01.
AddlName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AddlName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AddlPhoneArray
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.
AddlPhoneArray references PhoneArray_AType.
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.
AddlTIN
TINInfo_CType is a complex
CType element. This element contains tax information number
codes and descriptions. This element is optional.
AddlTIN references TINInfo_CType.
Contains:
TaxIdOwnerNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BNotIRSDt
- The last IRS notification.
- BNotStat
- The B notice flag.
- CertCodeDesc
- The description of the code that represents the certification behavior for a tax ID.
- CertCodeDt
- The certification code date.
- CertCode
- The code that represents the certification behavior for a tax ID.
- TaxIdMod
- A tax ID modifier assigned by the SSA to some individuals.
- 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.
- TINDesc
- The description of the code that designates the type of tax identification number.
TaxIdOwnerName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
TaxIdOwnerName references PersonName_CType.
The TaxIdOwnerName
is optional and is only required when the customer level tax ID is different than the
account level.
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.
BenfArray_AType
BenfArray_AType is an array
AType element. This is an array of beneficiaries on an account.
Contains:
BenfRec_CType
BenfRec_CType
BenfRec_CType is a complex
CType element.
Contains:
AcctBenf_CType
Simple Elements
The following simple elements are contained within this complex.
- BenfKey
- The key for each beneficiary per each tax plan.
AcctBenf_CType
AcctBenf_CType is a complex CType element. This element is
optional.
Contains:
BenfAddrreferencesAddr_CTypeBenfNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BenfDesigId
- An identification provided to each beneficiary that designates primary and contingent beneficiaries.
- BenfId
- An identification (i.e., Tax Identification, Drivers License) provided to identify the beneficiary.
- BenfPctDist
- The percentage of the proceeds the beneficiary is entitled to.
- BenfRel
- The relationship the beneficiary has to the account holder.
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 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.
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.
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 element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
PersonName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
BusResInfo_CType
BusResInfo_CType is a complex CType element.
Contains:
AcctAuthorizedreferencesAccountId_CTypeResolvingPartyArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AttestorName
- The common name. This is the full text line name like John Doe.
- AttestorTitle
- The title an employee holds in a corporation or business.
- BusResCode
- The code representing a business resolution. The resolutions are used to determine which corporate officers are legally able to perform certain functions for the business.
- CertifierName
- The common name. This is the full text line name like John Doe.
- CertifierTitle
- The title an employee holds in a corporation or business.
- FilingOffc
- The filing office for a business resolution (used for document preparation and printing).
- ResCmpltDt
- The completed business resolution date.
- ResEffDt
- The effective business resolution date.
AcctAuthorized
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
AcctAuthorized
references AccountId_CType.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
ResolvingPartyArray_AType
CustSvcOptArray_AType is an array AType element. This element is an
array of resolving parties on a commercial account.
Contains:
ResolvingPartyInfo_CType
ResolvingPartyInfo_CType
ResolvingPartyInfo_CType is a complex CType element.
Contains:
CommAuthArray_AType
Simple Elements
The following simple elements are contained within this complex.
- GenLmt
- Application or user remarks free-form text.
- ResolvingPartyName
- The common name. This is the full text line name like John Doe.
- ResolvingPartyTitle
- The title an employee holds in a corporation or business.
CommAuthArray_AType
CommAuthArray_AType is an array AType element. This is an array of
commercial authorizations necessary to open a deposit account.
Contains:
CommAuthRec_CType
CommAuthRec_CType
CommAuthRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CommAuthCode
- The Entity Authorization Code.
- CommAuthType
- The authority granted to an entity. Canonical values are:
- Basic - simple authorities
- Extend - elevated authorizations
- ResAuthType
- Is the business/corporate officer authorized to perform the listed
resolution item? Canonical values are:
- true
- false
- SigNumCnt
- The number of signers required.
- SpecificLmt
- Application or user remarks free-form text.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CommAuthArray_AType
CommAuthArray_AType is an array AType element. This is an array of
commercial authorizations necessary to open a deposit account.
Contains:
CommAuthRec_CType
CommAuthRec_CType
CommAuthRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CommAuthCode
- The Entity Authorization Code.
- CommAuthType
- The authority granted to an entity. Canonical values are:
- Basic - simple authorities
- Extend - elevated authorizations
- ResAuthType
- Is the business/corporate officer authorized to perform the listed
resolution item? Canonical values are:
- true
- false
- SigNumCnt
- The number of signers required.
- SpecificLmt
- Application or user remarks free-form text.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CRARec_CType
CRARec_CType is a complex
CType element. This complex contains CRA information. This
element is optional.
Simple Elements
The following simple elements are contained within this complex.
- CRAAnnIncmAboveMil
- Is the borrower's income above $1,000,000?
- CRAAnnIncmAmt
- The annual income of the borrower.
- CRACenTract
- Census tract information for Community Reinvestment Act reporting.
- CRACode
- The code that designates the type of loan predetermined by CRA.
- CRACountyCode
- County code for Community Reinvestment Act reporting.
- CRACountyDesc
- County for Community Reinvestment Act reporting.
- CRADesc
- The description of the code that designates the type of loan predetermined by CRA.
- CRAId
- An ID for the CRA account record.
- CRAIncmLvl
- Income level for Community Reinvestment Act reporting.
- CRALoc
- Location information for Community Reinvestment Act reporting.
- CRAMilitaryCode
- Military code for Community Reinvestment Act reporting.
- CRAMilitaryDesc
- Military description for Community Reinvestment Act reporting.
- CRAOrigBal
- The original or renewal amount to be reported under the rules of CRA.
- CRAOrigLocCode
- Designates where the loan was originated.
- CRAOrigLocDesc
- The description of the code that designates where the loan was originated.
- CRAOrigRenDt
- The original or renewal date, in accord with CRA reporting.
- CRAPurchaseLn
- Determines if the loan was purchased or originated by the bank.
- CRASMSACode
- Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
- CRASMSADesc
- Standard Metropolitan Statistical Area information for Community Reinvestment Act reporting.
- CRAStateCode
- The state code for Community Reinvestment Act reporting.
- CRAStateDesc
- The state for Community Reinvestment Act reporting.
DueDilgntCmpltArray_AType
DueDilgntCmpltArray_AType is an array AType element. This is an array of due
diligence requirements completed by the supported provider.
Contains:
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType
DueDilgntCmpltInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DueDilgntCmpltType
- The action being reported has been completed. Canonical values
are:
- false
- true
- PrvdNameCode
- The code that represents a provider.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
OffInfoArray_AType
OffInfoArray_AType is an array
AType element. This is an array of officers.
Contains:
OffInfoRec_CType
OffInfoRec_CType
OffInfoRec_CType is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- OffCode
- The code that designates the financial institution officer.
- OffCodeText
- The text that describes the preceding elements for the
OffInfoArry. - OffDesc
- The officer short name.
- OffRmk
- Application or user remarks free-form text.
PltfmAddrArray_AType
PltfmAddrArray_AType is an array
AType element. This is an array of platform application customer
addresses.
Contains:
PltfmAddrInforeferencesPltfmAddrRec_CType
PltfmAddrInfo
PltfmAddrRec_CType is a complex
CType element.
PltfmAddrInfo references PltfmAddrRec_CType.
Contains:
AddrInfo_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrCatUse
- Address category type. Canonical values are:
- Acct - Account
- Cust - Customer
- IRSRpt - IRS Reporting
- Not - Notice
- Pmt - Payments (Distributions or interest checks)
- Seasonal
- Stmt - Statement
- AddrCat2Use
Address category 2 type
- Cat=Not has
- AdvOfCr
- Bil
- CrBack
- EOYTax
- InsufFunds
- IRAMat
- OD
- PastDue
- RateChg
- RtnItems
- TeleTrf
- Cat=Pmt has
- EscrwRefund
- Int
- IRADistr
- XMAS
- Cat1=Stmt has
- Escrw
- IRAPeriodic
- LOC
- Periodic
Canonical values are:
- AdvOfCr
- All
- Bil
- CrBack
- EOYTax
- Escrw
- EscrwRefund
- Exc
- InsufFunds
- Int
- IRADistr
- IRAMat
- IRAPeriodic
- IRS
- LOC
- OD
- PastDue
- Periodic
- Phys
- RateChg
- RtnItems
- Seasonal
- ScsrCstdn
- TeleTrf
- XMAS
- Cat=Not has
AddrInfo_CType
AddrInfo_CType is a complex CType element used to define the listed address. This element is
optional.
Contains:
Addr_CType
Simple Elements
The following simple elements are contained within this complex.
- AddrLastChng
- Date the address was last changed.
- AddrLastVerify
- Date the address was last verified.
- MailDirCode
- The code for the mail directive, such as Hold.
- SeasonBegDt
- The beginning date for a seasonal address.
- SeasonEndDt
- The ending date for a seasonal address.
- SeasonReocur
- Determines if the seasonal address reoccurs.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ProdSvcOptArray_AType
ProdSvcOptArray_AType is an array
AType element. This is an array of service options available for the
product.
Contains:
ProdSvcOptInfo_CType
ProdSvcOptInfo_CType
ProdSvcOptInfo_CType is a complex CType
element.
Simple Elements
The following simple elements are contained within this complex.
- ProdSvcOptCode
- Service options available for the product offered.
- ProdSvcOptDesc
- Descriptions of the service options available for the product.
RateSchedArray_AType
RateSchedArray_AType is an array
AType element. This is an array of items related to time deposit rate
schedules.
Contains:
RateSchedRec_CType
RateSchedRec_CType
RateSchedRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- BaseRate
- The interest rate.
- NewRateEffDt
- The effective date a new rate is applied to an account.
- NewRate
- The current interest rate for a specific account on a specific date.
- RateType
- Types of interest rates. Canonical values are:
- Adj
- Fix
- Renew
- Vrbl
- RateVarCode
- The rate variance code. This code tells the system if the
variance from prime is above, below, or is of a percentage. Canonical values
are:
- NA
- Negative
- Pct
- Positive
- RateVar
- The rate variance. The amount of variance from the prime rate allowed for the account.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrcFundsArray_AType
SrcFundsArray_AType is an array
AType element. This is an array of items related to source of funds used to
open an account.
Contains:
SrcFundsInfo_CType
SrcFundsInfo_CType
SrcFundsInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- PrimSrcFundsType
The source of funds to open an account is primary. Canonical values are:
- false
- true
The default is false.
- SrcFundsAmt
- Amount of the source of funds used to open an account.
- SrcFundsCode
- A code that represents the source of funds for credit transactions and the outgoing source for debit transactions.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
VarIntRateInfo_CType
VarIntRateInfo_CType is a complex
CType element. This element contains variable interest rate
information. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- PrimeRateIdx
- The prime rate index.
- RateCeil
- The rate ceiling entry that sets a top rate above which the rate never rises.
- RateFlr
- The rate floor entry that sets a base rate below which the rate of the loan never falls.
- RateRevDt
- The date used to determine if a rate should be changed.
- RateRevTerm
- The rate review term. The system checks the prime rate for change at the interval specified in this field. Entries may be in number of days or number of months.
- RateRevTermUnits
- The rate review term code. This code determines whether the prime
review term is in months or days. Canonical values are:
- Days
- Month
- NA
- RateVarCode
- The rate variance code. This code tells the system if the
variance from prime is above, below, or is of a percentage. Canonical values
are:
- NA
- Negative
- Pct
- Positive
- RateVar
- The rate variance. The amount of variance from the prime rate allowed for the account.
PltfmAppSigInfo_CType
PltfmAppSigInfo_CType is a
complex CType element. This complex gathers the necessary information for a
document signing ceremony.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- DocStateCode
- The two-character alpha code which represents a state. For example, MO.
- SigNumCnt
- The number of signers required.
- TempSigCardType
- Generate temporary signature cards. Canonical values are:
- false
- true
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PltfmAppTaxPlnInfo_CType
PltfmAppTaxPlnInfo_CType is a
complex CType element.
Contains:
CntrbArray_ATypeCustom_CTypeEmplrInfo_CTypePlnBenfArray_ATypePlnCntrbArray_ATypeRespPrtyRec_CType
Simple Elements
The following simple elements are contained within this complex.
- FirstContrbDt
- The date of the first tax plan contribution.
- OrigOwnBirthDt
- The original owners of the tax plan's birth date.
- OrigOwnDeceaseDt
- The original owners of the tax plan's date of death.
- OrigOwnName
- The name of the original owner of the tax plan.
- PlnBirthDt
- Defines the actual birth date to use for determining tax plan distributions.
- PlnCntrbYr
- The applicable year for the tax plan contribution.
- PlnCode
- The service provider code that represents plan products for different plan types.
- PlnCvrgType
- Identifies who is covered by a Health Insurance Plan. Canonical
values are:
- Fam
- Indv
- PlnEstbDt
- The date the tax plan was established.
- PlnFeeCode
- The code for the fees charged to the tax plan.
- PlnType
- Tax plan types as approved by the IRS. Canonical values 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
- SoleSpousDistCode
- The code that references if the sole beneficiary is the spouse.
- SpousPlnCode
- The code to determine if the tax plan qualifies as a spousal retirement plan in accord with IRS Regulations.
PltfmAppAddRs_MType
PltfmAppAddRs_MType is a message
MType element.
Contains:
AccountId_CTypeCustIdArray_ATypeCustom_CTypeDocLocArray_ATypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- PltfmId
- The identification provided to a platform record that can be used for other services.
- PltfmStat
- The status that represents the state or condition of a platform record.
- PltfmStatDesc
- The description of the status that represents the state or condition of a platform record.
- RsStat
The status of the response. Canonical values are:
- fail
- success
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
CustIdArray_AType
CustIdArray_AType is an array AType element. This is an array of customer identifiers.
Contains:
CustIdInfoRec_CType
CustIdInfoRec_CType
CustIdInfoRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
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.
DocLocArray_AType
DocLocArray_AType is an array AType element. This is an array of name/value pairs used to identify document
locations.
Contains:
DocLocInfo_CType
DocLocInfo_CType
DocLocInfo_CType is a complex CType element. This complex contains the document delivery location
information.
Simple Elements
The following simple elements are contained within this complex.
- DocLocName
- The document location name.
- DocLocVal
- The document location value.
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.