Party - Schema Documentation - V4.5.Revision
Documents generated: 4/9/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/Party.xsd
Version 4.5.Revision
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://cufxstandards.com/v4/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v4/Contact.xsd (at Contact.xsd)
    • http://cufxstandards.com/v4/Artifact.xsd (at Artifact.xsd)
    • http://cufxstandards.com/v4/CredentialGroup.xsd (at CredentialGroup.xsd)
    • http://cufxstandards.com/v4/Document.xsd (at Document.xsd)
    • http://cufxstandards.com/v4/ISOCountryCodeType-V2006.xsd (at ISOCountryCodeType-V2006.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/Party.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v4/Common.xsd
contact http://cufxstandards.com/v4/Contact.xsd
artifact http://cufxstandards.com/v4/Artifact.xsd
credentialGroup http://cufxstandards.com/v4/CredentialGroup.xsd
document http://cufxstandards.com/v4/Document.xsd
isoCountryCodeType http://cufxstandards.com/v4/ISOCountryCodeType-V2006.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/Party.xsd" version="4.5.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v4/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Contact.xsd" schemaLocation="Contact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Artifact.xsd" schemaLocation="Artifact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/CredentialGroup.xsd" schemaLocation="CredentialGroup.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Document.xsd" schemaLocation="Document.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/ISOCountryCodeType-V2006.xsd" schemaLocation="ISOCountryCodeType-V2006.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: partyList

Name partyList
Type PartyList
Nillable no
Abstract no
Documentation The parties collection/array contains all the parties, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{partyList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"party" : Party , [0..*]
partyList}
Schema Component Representation
<xs:element name="partyList" type="PartyList"/>
top

Global Definitions

Complex Type: AdditionalIncome

Name AdditionalIncome
Abstract no
Documentation Describes additional non-standard sources of income (child support, investments, e-bay, etc.).
JSON Instance Representation
{
"amount" : common:Money , [1] ?
"frequency" : common:FrequencyType , [0..1] ?
"otherFrequencyType" : xs:string , [0..1] ?
"excludeIncomeFromCalculations" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"source" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="AdditionalIncome">
<xs:complexContent>
<xs:extension base="Income">
<xs:sequence>
<xs:element name="source" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: AdditionalIncomeList

Name AdditionalIncomeList
Abstract no
Documentation List of additional non-standard sources of income (child support, investments, e-bay, etc.).
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"additionalIncome" : AdditionalIncome , [0..*] ?
}
Schema Component Representation
<xs:complexType name="AdditionalIncomeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="additionalIncome" type="AdditionalIncome" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Characteristics

Name Characteristics
Abstract no
Documentation Intended choice - Due to cross language serialization issues the choice construct has been removed. It is the responsibility of the implementer to add programmatic logic for this complex type to detect, handle and or error when population of more than one element is present.
JSON Instance Representation
{
"organization" : Organization , [0..1] ?
"individual" : Individual , [0..1] ?
"trust" : Trust , [0..1] ?
"estate" : Estate , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Characteristics">
<xs:sequence>
<xs:element name="organization" type="Organization" minOccurs="0" maxOccurs="1"/>
<xs:element name="individual" type="Individual" minOccurs="0" maxOccurs="1"/>
<xs:element name="trust" type="Trust" minOccurs="0" maxOccurs="1"/>
<xs:element name="estate" type="Estate" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Citizenship

Name Citizenship
Abstract no
Documentation Country code and certified flag for each country of which the party identifies as being a citizen.
JSON Instance Representation
{
"citizenship" : isoCountryCodeType:ISOCountryCodeType , [0..1]
"wasCitizenshipCertified" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Citizenship">
<xs:sequence>
<xs:element name="citizenship" type="isoCountryCodeType:ISOCountryCodeType" minOccurs="0" maxOccurs="1" nillable="true"/>
<xs:element name="wasCitizenshipCertified" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CitizenshipList

Name CitizenshipList
Abstract no
Documentation List of countries where the party has citizenship. Country code is expected to be ISO 3166-1 2 character codes.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"citizenship" : Citizenship , [0..*]
}
Schema Component Representation
<xs:complexType name="CitizenshipList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="citizenship" type="Citizenship" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DoingBusinessAs

Name DoingBusinessAs
Abstract no
JSON Instance Representation
{
"doingBusinessAsId" : xs:string , [1] ?
"doingBusinessAsName" : xs:string , [1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="DoingBusinessAs">
<xs:sequence>
<xs:element name="doingBusinessAsId" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="doingBusinessAsName" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: DoingBusinessAsList

Name DoingBusinessAsList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"doingBusinessAs" : DoingBusinessAs , [0..*]
}
Schema Component Representation
<xs:complexType name="DoingBusinessAsList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="doingBusinessAs" type="DoingBusinessAs" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: EligibilityRequirementMet

Name EligibilityRequirementMet
Abstract no
JSON Instance Representation
{
"requirementId" : xs:string , [1] ?
"referenceDescription" : xs:string , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="EligibilityRequirementMet">
<xs:sequence>
<xs:element name="requirementId" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="referenceDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: EligibilityRequirementMetList

Name EligibilityRequirementMetList
Abstract no
Documentation List of how the party qualified for relationship with the financial institution.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"eligibilityRequirementMet" : EligibilityRequirementMet , [0..*] ?
}
Schema Component Representation
<xs:complexType name="EligibilityRequirementMetList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="eligibilityRequirementMet" type="EligibilityRequirementMet" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Employment

Name Employment
Abstract no
Documentation Employment/employer details related to an individual.
JSON Instance Representation
{
"employmentId" : xs:string , [0..1] ?
"employerPartyId" : PartyId , [0..1] ?
"employerName" : xs:string , [0..1] ?
"employmentStartDate" : xs:date , [0..1] ?
"employmentEndDate" : xs:date , [0..1] ?
"timeAtEmployer" : xs:duration , [0..1] ?
"employeeOccupation" : xs:string , [0..1] ?
"employerAddress" : common:Address , [0..*] ?
"employerPhone" : contact:Phone , [0..*] ?
"employerStatus" : EmployerStatusType , [0..1] ?
"type" : EmploymentType , [0..1] ?
"employmentIncome" : IncomeDetail , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Employment">
<xs:sequence>
<xs:element name="employmentId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="employerPartyId" type="PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="employerName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="employmentStartDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="employmentEndDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="timeAtEmployer" type="xs:duration" minOccurs="0" maxOccurs="1"/>
<xs:element name="employeeOccupation" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="employerAddress" type="common:Address" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="employerPhone" type="contact:Phone" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="employerStatus" type="EmployerStatusType" minOccurs="0" maxOccurs="1"/>
<xs:element name="type" type="EmploymentType" minOccurs="0" maxOccurs="1"/>
<xs:element name="employmentIncome" type="IncomeDetail" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: EmploymentList

Name EmploymentList
Abstract no
Documentation Collection of employer details related to an individual.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"employment" : Employment , [0..*] ?
}
Schema Component Representation
<xs:complexType name="EmploymentList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="employment" type="Employment" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Estate

Name Estate
Abstract no
Documentation Fields related to when the party is an estate.
JSON Instance Representation
{
"estateName" : xs:string , [0..1] ?
"estateType" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Estate">
<xs:sequence>
<xs:element name="estateName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="estateType" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: IdDocumentType

Name IdDocumentType
Abstract no
Documentation Intended choice - Due to cross language serialization issues the choice construct has been removed. It is the responsibility of the implementer to add programmatic logic for this complex type to detect, handle and or error when population of more than one element is present.
JSON Instance Representation
{
"individualDocument" : IndividualDocument , [0..1] ?
"organizationDocument" : OrganizationDocument , [0..1] ?
"trustDocument" : TrustDocument , [0..1] ?
"estateDocument" : EstateDocument , [0..1] ?
"otherDocument" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="IdDocumentType">
<xs:sequence>
<xs:element name="individualDocument" type="IndividualDocument" minOccurs="0" maxOccurs="1"/>
<xs:element name="organizationDocument" type="OrganizationDocument" minOccurs="0" maxOccurs="1"/>
<xs:element name="trustDocument" type="TrustDocument" minOccurs="0" maxOccurs="1"/>
<xs:element name="estateDocument" type="EstateDocument" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherDocument" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: IdentificationDocument

Name IdentificationDocument
Abstract no
JSON Instance Representation
{
"idDocumentIdentifer" : xs:string , [1] ?
"idDocumentType" : IdDocumentType , [0..1] ?
"idIssuedBy" : xs:string , [0..1] ?
"idIssueDate" : xs:date , [0..1] ?
"idExpirationDate" : xs:date , [0..1] ?
"idDisplayOrder" : xs:nonNegativeInteger , [0..1] ?
"idVerifyDateTime" : xs:dateTime , [0..1] ?
"documentId" : document:DocumentId , [0..1] ?
}
Schema Component Representation
<xs:complexType name="IdentificationDocument">
<xs:sequence>
<xs:element name="idDocumentIdentifer" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="idDocumentType" type="IdDocumentType" minOccurs="0" maxOccurs="1"/>
<xs:element name="idIssuedBy" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="idIssueDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="idExpirationDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="idDisplayOrder" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/>
<xs:element name="idVerifyDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentId" type="document:DocumentId" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: IdentificationDocumentList

Name IdentificationDocumentList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"identificationDocument" : IdentificationDocument , [0..*] ?
}
Schema Component Representation
<xs:complexType name="IdentificationDocumentList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="identificationDocument" type="IdentificationDocument" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Income

Name Income
Abstract no
Documentation Details related to the applicant main income.
JSON Instance Representation
{
"amount" : common:Money , [1] ?
"frequency" : common:FrequencyType , [0..1] ?
"otherFrequencyType" : xs:string , [0..1] ?
"excludeIncomeFromCalculations" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Income">
<xs:sequence>
<xs:element name="amount" type="common:Money" minOccurs="1" maxOccurs="1"/>
<xs:element name="frequency" type="common:FrequencyType" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherFrequencyType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="excludeIncomeFromCalculations" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: IncomeDetail

Name IncomeDetail
Abstract no
JSON Instance Representation
{
"grossIncomeData" : Income , [0..1] ?
"netIncomeData" : Income , [0..1] ?
}
Schema Component Representation
<xs:complexType name="IncomeDetail">
<xs:sequence>
<xs:element name="grossIncomeData" type="Income" minOccurs="0" maxOccurs="1"/>
<xs:element name="netIncomeData" type="Income" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Individual

Name Individual
Abstract no
Documentation Fields related to when the party is an individual.
JSON Instance Representation
{
"firstName" : xs:string , [0..1] ?
"middleName" : xs:string , [0..1] ?
"lastName" : xs:string , [0..1] ?
"prefix" : xs:string , [0..1] ?
"suffix" : xs:string , [0..1] ?
"formattedName" : xs:string , [0..1] ?
"mothersMaidenName" : xs:string , [0..1] ?
"nickname" : xs:string , [0..1] ?
"birthdate" : xs:date , [0..1] ?
"deathDate" : xs:date , [0..1] ?
"gender" : common:Gender , [0..1] ?
"cityOfBirth" : xs:string , [0..1] ?
"citizenshipList" : CitizenshipList , [0..1] ?
"employmentStatus" : EmploymentStatusType , [0..1] ?
"employmentList" : EmploymentList , [0..1] ?
"additionalIncomeList" : AdditionalIncomeList , [0..1] ?
"liabilityList" : LiabilityList , [0..1] ?
"residence" : Residence , [0..1] ?
"ethnicity" : xs:string , [0..1] ?
"race" : xs:string , [0..1] ?
"maritalStatus" : MaritalStatus , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Individual">
<xs:sequence>
<xs:element name="firstName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="middleName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="lastName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="prefix" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="suffix" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="formattedName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="mothersMaidenName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="nickname" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="birthdate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="deathDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="gender" type="common:Gender" minOccurs="0" maxOccurs="1"/>
<xs:element name="cityOfBirth" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="citizenshipList" type="CitizenshipList" minOccurs="0" maxOccurs="1"/>
<xs:element name="employmentStatus" type="EmploymentStatusType" minOccurs="0" maxOccurs="1"/>
<xs:element name="employmentList" type="EmploymentList" minOccurs="0" maxOccurs="1"/>
<xs:element name="additionalIncomeList" type="AdditionalIncomeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="liabilityList" type="LiabilityList" minOccurs="0" maxOccurs="1"/>
<xs:element name="residence" type="Residence" minOccurs="0" maxOccurs="1"/>
<xs:element name="ethnicity" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="race" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="maritalStatus" type="MaritalStatus" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Liability

Name Liability
Abstract no
Documentation Details related to liability.
JSON Instance Representation
{
"description" : xs:string , [0..1] ?
"payment" : common:Money , [0..1] ?
"paymentFrequency" : common:FrequencyType , [0..1] ?
"balance" : common:Money , [0..1] ?
"excludeLiabilityFromCalculations" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Liability">
<xs:sequence>
<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="payment" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="paymentFrequency" type="common:FrequencyType" minOccurs="0" maxOccurs="1"/>
<xs:element name="balance" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="excludeLiabilityFromCalculations" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: LiabilityList

Name LiabilityList
Abstract no
Documentation List of liabilities.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"liability" : Liability , [0..*] ?
}
Schema Component Representation
<xs:complexType name="LiabilityList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="liability" type="Liability" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Organization

Name Organization
Abstract no
Documentation Fields related to when the party is an organization.
JSON Instance Representation
{
"organizationType" : OrganizationType , [0..1] ?
"organizationSubType" : OrganizationSubType , [0..1] ?
"organizationName" : OrganizationName , [0..1] ?
"doingBusinessAsList" : DoingBusinessAsList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Organization">
<xs:sequence>
<xs:element name="organizationType" type="OrganizationType" minOccurs="0" maxOccurs="1"/>
<xs:element name="organizationSubType" type="OrganizationSubType" minOccurs="0" maxOccurs="1"/>
<xs:element name="organizationName" type="OrganizationName" minOccurs="0" maxOccurs="1"/>
<xs:element name="doingBusinessAsList" type="DoingBusinessAsList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: OrganizationNameList

Name OrganizationNameList
Abstract no
Documentation The list of organization names that should have their associated parties either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"organizationName" : OrganizationName , [0..*] ?
}
Schema Component Representation
<xs:complexType name="OrganizationNameList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="organizationName" type="OrganizationName" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: OrganizationSubTypeList

Name OrganizationSubTypeList
Abstract no
Documentation The list of organization sub types that should have their associated parties either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"organizationSubType" : OrganizationSubType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="OrganizationSubTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="organizationSubType" type="OrganizationSubType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: OrganizationTypeList

Name OrganizationTypeList
Abstract no
Documentation The list of organization types that should have their associated parties either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"organizationType" : OrganizationType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="OrganizationTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="organizationType" type="OrganizationType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Party

Name Party
Abstract no
Documentation The party object defines all the fields necessary to define a person, credit union member, business or vendor related to a financial institution. The ID uniquely identifies the party within the financial institution.
JSON Instance Representation
{
"id" : PartyId , [0..1] ?
"taxInformationList" : TaxInformationList , [0..1] ?
"type" : PartyType , [0..1] ?
"partyStatus" : PartyStatus , [0..1] ?
"partySubStatus" : PartySubStatus , [0..1] ?
"characteristics" : Characteristics , [0..1] ?
"identificationDocumentList" : IdentificationDocumentList , [0..1] ?
"eligibilityRequirementMetList" : EligibilityRequirementMetList , [0..1] ?
"contactIdList" : contact:ContactIdList , [0..1] ?
"contactList" : contact:ContactList , [0..1] ?
"fiUserIdList" : credentialGroup:FiUserIdList , [0..1] ?
"householdId" : xs:string , [0..1] ?
"partyDateCreated" : xs:date , [0..1] ?
"partyDateTimeCreated" : xs:dateTime , [0..1] ?
"partyCreatedBy" : common:UserId , [0..1] ?
"partyDateModified" : xs:date , [0..1] ?
"partyDateTimeModified" : xs:dateTime , [0..1] ?
"partyModifiedBy" : common:UserId , [0..1] ?
"partyDateDeleted" : xs:date , [0..1] ?
"partyDateTimeDeleted" : xs:dateTime , [0..1] ?
"partyDeletedBy" : common:UserId , [0..1] ?
"noteList" : common:NoteList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"nonresidentAlienCertificationtype" : xs:string , [0..1] ?
"nonresidentAlienCertificationDateTime" : xs:dateTime , [0..1] ?
"nonresidentAlienLimitationOnBenefits" : xs:string , [0..1] ?
"nonresidentAlienSpecialWithholdingStatus" : NonresidentAlienSpecialWithholdingStatus , [0..1] ?
"nonresidentAlienSpecialWithholdingRate" : xs:decimal , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Party">
<xs:sequence>
<xs:element name="id" type="PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="taxInformationList" type="TaxInformationList" minOccurs="0" maxOccurs="1"/>
<xs:element name="type" type="PartyType" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyStatus" type="PartyStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="partySubStatus" type="PartySubStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="characteristics" type="Characteristics" minOccurs="0" maxOccurs="1"/>
<xs:element name="identificationDocumentList" type="IdentificationDocumentList" minOccurs="0" maxOccurs="1"/>
<xs:element name="eligibilityRequirementMetList" type="EligibilityRequirementMetList" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactIdList" type="contact:ContactIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactList" type="contact:ContactList" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiUserIdList" type="credentialGroup:FiUserIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="householdId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyDateCreated" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyDateTimeCreated" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyCreatedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyDateModified" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyDateTimeModified" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyModifiedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyDateDeleted" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyDateTimeDeleted" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyDeletedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="noteList" type="common:NoteList" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="nonresidentAlienCertificationtype" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="nonresidentAlienCertificationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="nonresidentAlienLimitationOnBenefits" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="nonresidentAlienSpecialWithholdingStatus" type="NonresidentAlienSpecialWithholdingStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="nonresidentAlienSpecialWithholdingRate" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: PartyIdList

Name PartyIdList
Abstract no
Documentation The list of party IDs that should be returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"partyId" : PartyId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="PartyIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="partyId" type="PartyId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: PartyList

Name PartyList
Abstract no
Documentation The parties collection/array contains all the parties, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"party" : Party , [0..*]
}
Schema Component Representation
<xs:complexType name="PartyList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="party" type="Party" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: PartyStatusList

Name PartyStatusList
Abstract no
Documentation The list of party statuses that should have their associated parties either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"partyStatus" : PartyStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="PartyStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="partyStatus" type="PartyStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: PartySubStatusList

Name PartySubStatusList
Abstract no
Documentation The list of party sub status that should have their associated parties either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"partySubStatus" : PartySubStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="PartySubStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="partySubStatus" type="PartySubStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: PartyTypeList

Name PartyTypeList
Abstract no
Documentation The list of party types that should have their associated parties either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"partyType" : PartyType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="PartyTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="partyType" type="PartyType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Residence

Name Residence
Abstract no
Documentation Details related to residence.
JSON Instance Representation
{
"currentHousingStatus" : HousingStatusType , [0..1] ?
"currentHousingOwnershipType" : HousingOwnershipType , [0..1] ?
"currentHousingDebtType" : HousingDebtType , [0..1] ?
"currentHousingType" : HousingType , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Residence">
<xs:sequence>
<xs:element name="currentHousingStatus" type="HousingStatusType" minOccurs="0" maxOccurs="1"/>
<xs:element name="currentHousingOwnershipType" type="HousingOwnershipType" minOccurs="0" maxOccurs="1"/>
<xs:element name="currentHousingDebtType" type="HousingDebtType" minOccurs="0" maxOccurs="1"/>
<xs:element name="currentHousingType" type="HousingType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TaxIdList

Name TaxIdList
Abstract no
Documentation The list of tax IDs that should have their associated parties either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"taxId" : TaxId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="TaxIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="taxId" type="TaxId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: TaxInformation

Name TaxInformation
Abstract no
JSON Instance Representation
{
"taxId" : TaxId , [0..1] ?
"taxIdEncrypted" : xs:boolean , [0..1] ?
"taxIdType" : TaxIdType , [0..1] ?
"otherTaxIdType" : xs:string , [0..1] ?
"reportingFlag" : xs:boolean , [0..1] ?
"verifiedTaxIdFlag" : xs:boolean , [0..1] ?
"taxIdWarningCount" : xs:nonNegativeInteger , [0..1] ?
"backupWithholdingFlag" : xs:boolean , [0..1] ?
"backupWithholdingReason" : xs:string , [0..1] ?
"backupWithholdingExemptionReason" : BackupWithholdingExemptionReason , [0..1] ?
"backupWithholdingEffectiveDate" : xs:date , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"withholdingsInfoList" : common:WithholdingsInfoList , [0..1] ?
"taxIdExpirationDateTime" : xs:dateTime , [0..1] ?
}
Schema Component Representation
<xs:complexType name="TaxInformation">
<xs:sequence>
<xs:element name="taxId" type="TaxId" minOccurs="0" maxOccurs="1"/>
<xs:element name="taxIdEncrypted" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="taxIdType" type="TaxIdType" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherTaxIdType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reportingFlag" type="xs:boolean" minOccurs="0" maxOccurs="1" default="true"/>
<xs:element name="verifiedTaxIdFlag" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="taxIdWarningCount" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/>
<xs:element name="backupWithholdingFlag" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="backupWithholdingReason" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="backupWithholdingExemptionReason" type="BackupWithholdingExemptionReason" minOccurs="0" maxOccurs="1"/>
<xs:element name="backupWithholdingEffectiveDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="withholdingsInfoList" type="common:WithholdingsInfoList" minOccurs="0" maxOccurs="1"/>
<xs:element name="taxIdExpirationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TaxInformationList

Name TaxInformationList
Abstract no
Documentation The tax information collection/array contains all the tax identifiers for a party.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"taxInformation" : TaxInformation , [0..*]
}
Schema Component Representation
<xs:complexType name="TaxInformationList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="taxInformation" type="TaxInformation" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Trust

Name Trust
Abstract no
Documentation Fields related to when the party is a trust.
JSON Instance Representation
{
"trustName" : xs:string , [0..1] ?
"trustType" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Trust">
<xs:sequence>
<xs:element name="trustName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="trustType" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: BackupWithholdingExemptionReason

Name BackupWithholdingExemptionReason
Content
  • Base XSD Type: string
  • value comes from list: {'ExceptFromWithholding'|'NotNotifiedByIrs'|'IrsNotifiedNoLongSubject'}
Documentation The reason that the tax ID is NOT subject to backup withholding.
Schema Component Representation
<xs:simpleType name="BackupWithholdingExemptionReason">
<xs:restriction base="xs:string">
<xs:enumeration value="ExceptFromWithholding"/>
<xs:enumeration value="NotNotifiedByIrs"/>
<xs:enumeration value="IrsNotifiedNoLongSubject"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: EmployerStatusType

Name EmployerStatusType
Content
  • Base XSD Type: string
  • value comes from list: {'Current'|'Previous'}
Documentation Represents available individual employer status values, as in currently or previously employed by an employer.
Schema Component Representation
<xs:simpleType name="EmployerStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="Current"/>
<xs:enumeration value="Previous"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: EmploymentStatusType

Name EmploymentStatusType
Content
  • Base XSD Type: string
  • value comes from list: {'Contract'|'Employed'|'Homemaker'|'Other'|'Retired'|'SelfEmployed'|'Student'|'Temporary'|'Unemployed'}
Documentation Represents available individual employment status values, i.e. employed, unemployed, contract, etc..
Schema Component Representation
<xs:simpleType name="EmploymentStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="Contract"/>
<xs:enumeration value="Employed"/>
<xs:enumeration value="Homemaker"/>
<xs:enumeration value="Other"/>
<xs:enumeration value="Retired"/>
<xs:enumeration value="SelfEmployed"/>
<xs:enumeration value="Student"/>
<xs:enumeration value="Temporary"/>
<xs:enumeration value="Unemployed"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: EmploymentType

Name EmploymentType
Content
  • Base XSD Type: string
  • value comes from list: {'FullTime'|'PartTime'}
Documentation Represents available individual employment type values, as in full or part time.
Schema Component Representation
<xs:simpleType name="EmploymentType">
<xs:restriction base="xs:string">
<xs:enumeration value="FullTime"/>
<xs:enumeration value="PartTime"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: EstateDocument

Name EstateDocument
Content
  • Base XSD Type: string
  • value comes from list: {'Will'|'EstateInstrument'}
Documentation Documentation types for estates.
Schema Component Representation
<xs:simpleType name="EstateDocument">
<xs:restriction base="xs:string">
<xs:enumeration value="Will"/>
<xs:enumeration value="EstateInstrument"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: HousingDebtType

Name HousingDebtType
Content
  • Base XSD Type: string
  • value comes from list: {'OwnWithMortgage'|'OwnWithoutMortgage'|'Rent'|'NoHousingExpense'|'Other'}
Documentation The housing debt type for the current residence.
Schema Component Representation
<xs:simpleType name="HousingDebtType">
<xs:restriction base="xs:string">
<xs:enumeration value="OwnWithMortgage"/>
<xs:enumeration value="OwnWithoutMortgage"/>
<xs:enumeration value="Rent"/>
<xs:enumeration value="NoHousingExpense"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: HousingOwnershipType

Name HousingOwnershipType
Content
  • Base XSD Type: string
  • value comes from list: {'Self'|'Government'|'Military'|'Other'}
Documentation The housing ownership type for the current residence.
Schema Component Representation
<xs:simpleType name="HousingOwnershipType">
<xs:restriction base="xs:string">
<xs:enumeration value="Self"/>
<xs:enumeration value="Government"/>
<xs:enumeration value="Military"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: HousingStatusType

Name HousingStatusType
Content
  • Base XSD Type: string
  • value comes from list: {'Rent'|'Own'|'Other'}
Documentation The housing status type for the current residence.
Schema Component Representation
<xs:simpleType name="HousingStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="Rent"/>
<xs:enumeration value="Own"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: HousingType

Name HousingType
Content
  • Base XSD Type: string
  • value comes from list: {'PrimaryResidence'|'NonPrimaryResidence'}
Documentation The housing type for the current residence.
Schema Component Representation
<xs:simpleType name="HousingType">
<xs:restriction base="xs:string">
<xs:enumeration value="PrimaryResidence"/>
<xs:enumeration value="NonPrimaryResidence"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: IndividualDocument

Name IndividualDocument
Content
  • Base XSD Type: string
  • value comes from list: {'DriversLicense'|'USPassport'|'MilitaryId'|'StateIssuedId'|'BirthCertficate'|'ForeignPassport'|'KnownExistingParty'|'ForeignGovernmentId'|'ResidentAlienCard'|'NonResidentAlienCard'|'DisabledElderlyWithNoId'|'ForeignEntityWithNoId'|'LawEnforcementId'|'AmishPartyWithNoId'|'ForeignDriversLicense'|'InsuranceCard'|'OrganizationalMembershipCard'|'Passport'|'PropertyTaxBill'|'SocialSecurityCard'|'StudentId'|'UtilityBill'|'Visa'|'DepartmentHomelandSecurityEmploymentAuthorization'|'VoterRegistrationCard'|'Photo'|'Other'}
Documentation Documentation type for individuals.
Schema Component Representation
<xs:simpleType name="IndividualDocument">
<xs:restriction base="xs:string">
<xs:enumeration value="DriversLicense"/>
<xs:enumeration value="USPassport"/>
<xs:enumeration value="MilitaryId"/>
<xs:enumeration value="StateIssuedId"/>
<xs:enumeration value="BirthCertficate"/>
<xs:enumeration value="ForeignPassport"/>
<xs:enumeration value="KnownExistingParty"/>
<xs:enumeration value="ForeignGovernmentId"/>
<xs:enumeration value="ResidentAlienCard"/>
<xs:enumeration value="NonResidentAlienCard"/>
<xs:enumeration value="DisabledElderlyWithNoId"/>
<xs:enumeration value="ForeignEntityWithNoId"/>
<xs:enumeration value="LawEnforcementId"/>
<xs:enumeration value="AmishPartyWithNoId"/>
<xs:enumeration value="ForeignDriversLicense"/>
<xs:enumeration value="InsuranceCard"/>
<xs:enumeration value="OrganizationalMembershipCard"/>
<xs:enumeration value="Passport"/>
<xs:enumeration value="PropertyTaxBill"/>
<xs:enumeration value="SocialSecurityCard"/>
<xs:enumeration value="StudentId"/>
<xs:enumeration value="UtilityBill"/>
<xs:enumeration value="Visa"/>
<xs:enumeration value="DepartmentHomelandSecurityEmploymentAuthorization"/>
<xs:enumeration value="VoterRegistrationCard"/>
<xs:enumeration value="Photo"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: MaritalStatus

Name MaritalStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Annulled'|'CommonLaw'|'Divorced'|'DomesticPartner'|'Interlocutory'|'LegallySeparated'|'Married'|'RegisteredDomesticPartner'|'Separated'|'Single'|'Widowed'|'Unknown'}
Documentation The current marital status of the individual.
Schema Component Representation
<xs:simpleType name="MaritalStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Annulled"/>
<xs:enumeration value="CommonLaw"/>
<xs:enumeration value="Divorced"/>
<xs:enumeration value="DomesticPartner"/>
<xs:enumeration value="Interlocutory"/>
<xs:enumeration value="LegallySeparated"/>
<xs:enumeration value="Married"/>
<xs:enumeration value="RegisteredDomesticPartner"/>
<xs:enumeration value="Separated"/>
<xs:enumeration value="Single"/>
<xs:enumeration value="Widowed"/>
<xs:enumeration value="Unknown"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: NonresidentAlienSpecialWithholdingStatus

Name NonresidentAlienSpecialWithholdingStatus
Content
  • Base XSD Type: string
  • value comes from list: {'None'|'Claimed'|'Exempt'}
Documentation Specifies if a claim has been made for a tax treaty benefit.
Schema Component Representation
<xs:simpleType name="NonresidentAlienSpecialWithholdingStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="None"/>
<xs:enumeration value="Claimed"/>
<xs:enumeration value="Exempt"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: OrganizationDocument

Name OrganizationDocument
Content
  • Base XSD Type: string
  • value comes from list: {'StateCorporateId'|'StateDba'|'ArticlesOfIncorporation'|'BusinessLicense'|'CorporateResolution'|'SecretaryOfStateFilingReceipt'|'AssociationMinutes'|'PartnershipAgreement'}
Documentation Documentation types for Organizations.
Schema Component Representation
<xs:simpleType name="OrganizationDocument">
<xs:restriction base="xs:string">
<xs:enumeration value="StateCorporateId"/>
<xs:enumeration value="StateDba"/>
<xs:enumeration value="ArticlesOfIncorporation"/>
<xs:enumeration value="BusinessLicense"/>
<xs:enumeration value="CorporateResolution"/>
<xs:enumeration value="SecretaryOfStateFilingReceipt"/>
<xs:enumeration value="AssociationMinutes"/>
<xs:enumeration value="PartnershipAgreement"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: OrganizationName

Name OrganizationName
Content
  • Base XSD Type: string
Documentation Standard/legal name of the organization. Completed if party type is Organization.
Schema Component Representation
<xs:simpleType name="OrganizationName">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: OrganizationSubType

Name OrganizationSubType
Content
  • Base XSD Type: string
Documentation Organization sub type is the textual representation of what kind of organization it is. Completed if party type is Organization. For example: FinancialInstitution, Vendor, CUSO, Bank, Government Agency, etc. It is up to the endpoints to determine what they will pass in sub type.
Schema Component Representation
<xs:simpleType name="OrganizationSubType">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: OrganizationType

Name OrganizationType
Content
  • Base XSD Type: string
  • value comes from list: {'SoleProprietorship'|'Llc'|'Partnership'|'Corporation'|'NotForProfit'|'Club'}
Schema Component Representation
<xs:simpleType name="OrganizationType">
<xs:restriction base="xs:string">
<xs:enumeration value="SoleProprietorship"/>
<xs:enumeration value="Llc"/>
<xs:enumeration value="Partnership"/>
<xs:enumeration value="Corporation"/>
<xs:enumeration value="NotForProfit"/>
<xs:enumeration value="Club"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PartyId

Name PartyId
Content
  • Base XSD Type: string
Documentation The party ID is a persistent and unique identifier for the party not related to the accounts they own but tied to that person or organization. It should be unique for all parties across the institution and remain the same over the life of the relationship with the financial institution.
Schema Component Representation
<xs:simpleType name="PartyId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: PartyStatus

Name PartyStatus
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="PartyStatus">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: PartySubStatus

Name PartySubStatus
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="PartySubStatus">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: PartyType

Name PartyType
Content
  • Base XSD Type: string
  • value comes from list: {'Individual'|'Organization'|'Trust'|'Estate'}
Schema Component Representation
<xs:simpleType name="PartyType">
<xs:restriction base="xs:string">
<xs:enumeration value="Individual"/>
<xs:enumeration value="Organization"/>
<xs:enumeration value="Trust"/>
<xs:enumeration value="Estate"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: TaxId

Name TaxId
Content
  • Base XSD Type: string
Documentation Individual Social Security Number (SSN), Individual Tax Payer Number (TIN), the organizational Employer Identification Number (EIN), or other international Tax ID.
Schema Component Representation
<xs:simpleType name="TaxId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: TaxIdType

Name TaxIdType
Content
  • Base XSD Type: string
  • value comes from list: {'SocialSecurityNumber'|'EmployerIdentificationNumber'|'IndividualTaxpayerIdentificationNumber'|'TaxpayerIdentificationNumberForPendingUSAdoptions'|'PreparerTaxpayerIdentificationNumber'|'ForeignNational'|'ForeignNumberNoTIN'|'Other'|'SocialInsuranceNumber'}
Documentation Identifies what type of tax ID is in the taxId field. Standard IRS codes plus two foreign codes. http://www.irs.gov/Individuals/International-Taxpayers/Taxpayer-Identification-Numbers-(TIN)
Schema Component Representation
<xs:simpleType name="TaxIdType">
<xs:restriction base="xs:string">
<xs:enumeration value="SocialSecurityNumber"/>
<xs:enumeration value="EmployerIdentificationNumber"/>
<xs:enumeration value="IndividualTaxpayerIdentificationNumber"/>
<xs:enumeration value="TaxpayerIdentificationNumberForPendingUSAdoptions"/>
<xs:enumeration value="PreparerTaxpayerIdentificationNumber"/>
<xs:enumeration value="ForeignNational"/>
<xs:enumeration value="ForeignNumberNoTIN"/>
<xs:enumeration value="Other"/>
<xs:enumeration value="SocialInsuranceNumber"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: TrustDocument

Name TrustDocument
Content
  • Base XSD Type: string
  • value comes from list: {'TrustDocument'}
Documentation Documentation types for trusts.
Schema Component Representation
<xs:simpleType name="TrustDocument">
<xs:restriction base="xs:string">
<xs:enumeration value="TrustDocument"/>
</xs:restriction>
</xs:simpleType>
top