Collateral - Schema Documentation - V5.0.Revision
Documents generated: 6/7/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/Collateral.xsd
Version 5.0.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/v5/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v5/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v5/CreditReport.xsd (at CreditReport.xsd)
    • http://cufxstandards.com/v5/Relationship.xsd (at Relationship.xsd)
    • http://cufxstandards.com/v5/Contact.xsd (at Contact.xsd)
    • http://cufxstandards.com/v5/Party.xsd (at Party.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/Collateral.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v5/Common.xsd
account http://cufxstandards.com/v5/Account.xsd
credit http://cufxstandards.com/v5/CreditReport.xsd
relationship http://cufxstandards.com/v5/Relationship.xsd
contact http://cufxstandards.com/v5/Contact.xsd
party http://cufxstandards.com/v5/Party.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/Collateral.xsd" version="5.0.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v5/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Account.xsd" schemaLocation="Account.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/CreditReport.xsd" schemaLocation="CreditReport.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Relationship.xsd" schemaLocation="Relationship.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Contact.xsd" schemaLocation="Contact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Party.xsd" schemaLocation="Party.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: collateralList

Name collateralList
Type CollateralList
Nillable no
Abstract no
Documentation List of collateral returned from a data pull that was based on filters that were applied.
JSON Instance Representation
{collateralList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"collateral" : Collateral , [0..*] ?
collateralList}
Schema Component Representation
<xs:element name="collateralList" type="CollateralList"/>
top

Global Definitions

Complex Type: AircraftCollateral

Name AircraftCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
"serialNumber" : xs:string , [0..1]
"faaRegistrationNumber" : xs:string , [0..1]
"inspectionReportYN" : xs:boolean , [0..1]
"faaCoverLetterYN" : xs:boolean , [0..1]
"aircraftForCommercialUse" : xs:boolean , [0..1]
"descAvionicsEngines" : xs:string , [0..1]
"descOfLogBooks" : xs:string , [0..1]
"airportHomeBase" : xs:string , [0..1]
"hours" : xs:integer , [0..1] ?
}
Schema Component Representation
<xs:complexType name="AircraftCollateral">
<xs:complexContent>
<xs:extension base="TitledCollateralBase">
<xs:sequence>
<xs:element name="serialNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="faaRegistrationNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="inspectionReportYN" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="faaCoverLetterYN" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="aircraftForCommercialUse" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="descAvionicsEngines" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="descOfLogBooks" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="airportHomeBase" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="hours" type="xs:integer" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: BoatCollateral

Name BoatCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
"bodyStyle" : xs:string , [0..1] ?
"serialNumber" : xs:string , [0..1] ?
"marinaPort" : xs:string , [0..1] ?
"descOfEnginesEquip" : xs:string , [0..1] ?
"descOfLogBooks" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="BoatCollateral">
<xs:complexContent>
<xs:extension base="TitledCollateralBase">
<xs:sequence>
<xs:element name="bodyStyle" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="serialNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="marinaPort" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="descOfEnginesEquip" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="descOfLogBooks" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Collateral

Name Collateral
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
{
"motorVehicleCollateral" : MotorVehicleCollateral , [0..1] ?
"aircraftCollateral" : AircraftCollateral , [0..1] ?
"shipCollateral" : ShipCollateral , [0..1] ?
"trailerCollateral" : TrailerCollateral , [0..1] ?
"boatCollateral" : BoatCollateral , [0..1] ?
"otherTitledCollateral" : OtherTitledCollateral , [0..1] ?
"mobileHomeCollateral" : MobileHomeCollateral , [0..1] ?
"realEstateCollateral" : RealEstateCollateral , [0..1] ?
"uccCollateral" : UccCollateral , [0..1] ?
"savingsCDCollateral" : SavingsCDCollateral , [0..1] ?
"securitiesCollateral" : SecuritiesCollateral , [0..1] ?
"letterOfCreditCollateral" : LetterOfCreditCollateral , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Collateral">
<xs:sequence>
<xs:element name="motorVehicleCollateral" type="MotorVehicleCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="aircraftCollateral" type="AircraftCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="shipCollateral" type="ShipCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="trailerCollateral" type="TrailerCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="boatCollateral" type="BoatCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherTitledCollateral" type="OtherTitledCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="mobileHomeCollateral" type="MobileHomeCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="realEstateCollateral" type="RealEstateCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="uccCollateral" type="UccCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="savingsCDCollateral" type="SavingsCDCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="securitiesCollateral" type="SecuritiesCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="letterOfCreditCollateral" type="LetterOfCreditCollateral" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CollateralBase

Name CollateralBase
Abstract no
Documentation Details related to collateral record.
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
}
Schema Component Representation
<xs:complexType name="CollateralBase">
<xs:sequence>
<xs:element name="collateralId" type="CollateralId" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralPledgedDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="securedCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="totalSecuredAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="valuationOfCollateral" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="ownerOfCollateral" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="loanToValuePercentage" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralValueSourceDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralValueSource" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralType" type="CollateralType" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralSubType" type="CollateralSubType" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralSubTypeDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountIdentificationList" type="account:AccountIdentificationList" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="common:Address" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CollateralIdList

Name CollateralIdList
Abstract no
Documentation The list of collateral IDs that should have their associated collateral 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. -->
"collateralId" : CollateralId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="CollateralIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="collateralId" type="CollateralId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CollateralList

Name CollateralList
Abstract no
Documentation List of collateral returned from a data pull that was based on filters that were applied.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"collateral" : Collateral , [0..*] ?
}
Schema Component Representation
<xs:complexType name="CollateralList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="collateral" type="Collateral" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CollateralSubTypeList

Name CollateralSubTypeList
Abstract no
Documentation The list of CollateralSubType's that should have their associated collateral records 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. -->
"collateralSubType" : CollateralSubType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="CollateralSubTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="collateralSubType" type="CollateralSubType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CollateralTypeList

Name CollateralTypeList
Abstract no
Documentation The list of collateral types that should have their associated collateral records 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. -->
"collateralType" : CollateralType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="CollateralTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="collateralType" type="CollateralType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: LetterOfCreditCollateral

Name LetterOfCreditCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"securityCollateralValueLimit" : common:Money , [0..1] ?
"securityMarketValueLimit" : xs:decimal , [0..1] ?
"possessoryNumber" : xs:string , [0..1] ?
"issueDate" : xs:date , [0..1] ?
}
Schema Component Representation
<xs:complexType name="LetterOfCreditCollateral">
<xs:complexContent>
<xs:extension base="PossessoryCollateralBase">
<xs:sequence>
<xs:element name="possessoryNumber" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="issueDate" type="xs:date" nillable="true" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: MobileHomeCollateral

Name MobileHomeCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
"serialNumber" : xs:string , [0..1] ?
"bodyStyle" : xs:string , [0..1] ?
"descOfEquipment" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="MobileHomeCollateral">
<xs:complexContent>
<xs:extension base="TitledCollateralBase">
<xs:sequence>
<xs:element name="serialNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="bodyStyle" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="descOfEquipment" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: MotorVehicleCollateral

Name MotorVehicleCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
"vehicleIdentificationNumber" : xs:string , [0..1] ?
"mileage" : xs:integer , [0..1] ?
"licensePlateNumber" : xs:string , [0..1] ?
"licensePlateState" : xs:string , [0..1] ?
"licensePlateExpiration" : xs:date , [0..1] ?
"titleNumber" : xs:string , [0..1] ?
"titleState" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="MotorVehicleCollateral">
<xs:complexContent>
<xs:extension base="TitledCollateralBase">
<xs:sequence>
<xs:element name="vehicleIdentificationNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="mileage" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="licensePlateNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="licensePlateState" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="licensePlateExpiration" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="titleNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="titleState" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: OtherTitledCollateral

Name OtherTitledCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
"bodyStyle" : xs:string , [0..1] ?
"serialNumber" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="OtherTitledCollateral">
<xs:complexContent>
<xs:extension base="TitledCollateralBase">
<xs:sequence>
<xs:element name="bodyStyle" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="serialNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: PossessoryCollateralBase

Name PossessoryCollateralBase
Abstract yes
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"securityCollateralValueLimit" : common:Money , [0..1] ?
"securityMarketValueLimit" : xs:decimal , [0..1] ?
}
Schema Component Representation
<xs:complexType name="PossessoryCollateralBase" abstract="true">
<xs:complexContent>
<xs:extension base="CollateralBase">
<xs:sequence>
<xs:element name="securityCollateralValueLimit" type="common:Money" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="securityMarketValueLimit" type="xs:decimal" nillable="true" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RealEstateCollateral

Name RealEstateCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"taxId" : xs:string , [0..1] ?
"parcelIDNNumber" : xs:string , [0..1] ?
"section" : xs:string , [0..1] ?
"block" : xs:string , [0..1] ?
"lot" : xs:string , [0..1] ?
"firstLien" : xs:boolean , [0..1] ?
"existingLiens" : xs:boolean , [0..1] ?
"dwelling" : xs:boolean , [0..1] ?
"numberOfUnits" : xs:float , [0..1] ?
"ownerOccupied" : xs:boolean , [0..1] ?
"principalDwelling" : xs:boolean , [0..1] ?
"assumable" : xs:boolean , [0..1] ?
"manufacturedHousing" : xs:boolean , [0..1] ?
"construction" : xs:boolean , [0..1] ?
"yearBuilt" : xs:float , [0..1] ?
"condoPUD" : xs:boolean , [0..1] ?
"legalDescription" : xs:string , [0..1] ?
"rentalProperty" : xs:boolean , [0..1] ?
"yearAcquired" : xs:string , [0..1] ?
"originalCost" : common:Money , [0..1] ?
"presentValue" : common:Money , [0..1] ?
"improvements" : common:Money , [0..1] ?
"timeshare" : xs:boolean , [0..1] ?
}
Schema Component Representation
<xs:complexType name="RealEstateCollateral">
<xs:complexContent>
<xs:extension base="CollateralBase">
<xs:sequence>
<xs:element name="taxId" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="parcelIDNNumber" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="section" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="block" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="lot" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="firstLien" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="existingLiens" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="dwelling" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="numberOfUnits" type="xs:float" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="ownerOccupied" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="principalDwelling" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="assumable" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="manufacturedHousing" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="construction" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="yearBuilt" type="xs:float" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="condoPUD" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="legalDescription" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="rentalProperty" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="yearAcquired" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="originalCost" type="common:Money" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="presentValue" type="common:Money" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="improvements" type="common:Money" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="timeshare" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SavingsCDCollateral

Name SavingsCDCollateral
Abstract no
Documentation Contains details about share and CD secured collateral types.
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"securityCollateralValueLimit" : common:Money , [0..1] ?
"securityMarketValueLimit" : xs:decimal , [0..1] ?
"accountNumber" : xs:string , [0..1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"faceValue" : xs:string , [0..1] ?
"issuerType" : xs:string , [0..1] ?
"certified" : xs:boolean , [0..1] ?
"possessoryInterestRate" : common:Money , [0..1] ?
"amount" : common:Money , [0..1] ?
"percentage" : xs:decimal , [0..1] ?
"certificateNumber" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="SavingsCDCollateral">
<xs:complexContent>
<xs:extension base="PossessoryCollateralBase">
<xs:sequence>
<xs:element name="accountNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountType" type="account:AccountType" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountSubType" type="account:AccountSubType" minOccurs="0" maxOccurs="1"/>
<xs:element name="faceValue" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="issuerType" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="certified" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="possessoryInterestRate" type="common:Money" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="amount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="percentage" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="certificateNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SecuritiesCollateral

Name SecuritiesCollateral
Abstract no
Documentation Contains details about security-based secured collateral types.
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"securityCollateralValueLimit" : common:Money , [0..1] ?
"securityMarketValueLimit" : xs:decimal , [0..1] ?
"possessoryNumber" : xs:string , [0..1] ?
"faceValue" : xs:string , [0..1] ?
"issuer" : xs:string , [0..1] ?
"numberOfShares" : xs:decimal , [0..1] ?
"cusipNumber" : xs:string , [0..1] ?
"heldBy" : xs:string , [0..1] ?
"bookEntry" : xs:boolean , [0..1] ?
"valuationFrequency" : ValuationFrequency , [0..1] ?
}
Schema Component Representation
<xs:complexType name="SecuritiesCollateral">
<xs:complexContent>
<xs:extension base="PossessoryCollateralBase">
<xs:sequence>
<xs:element name="possessoryNumber" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="faceValue" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="issuer" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="numberOfShares" type="xs:decimal" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="cusipNumber" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="heldBy" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="bookEntry" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="valuationFrequency" type="ValuationFrequency" nillable="true" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ShipCollateral

Name ShipCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
"nameOfVessel" : xs:string , [0..1] ?
"officialNumber" : xs:string , [0..1] ?
"marinaPort" : xs:string , [0..1] ?
"grossTonnage" : xs:string , [0..1] ?
"netTonnage" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ShipCollateral">
<xs:complexContent>
<xs:extension base="TitledCollateralBase">
<xs:sequence>
<xs:element name="nameOfVessel" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="officialNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="marinaPort" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="grossTonnage" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="netTonnage" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: TitledCollateralBase

Name TitledCollateralBase
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="TitledCollateralBase">
<xs:complexContent>
<xs:extension base="CollateralBase">
<xs:sequence>
<xs:element name="year" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="manufacturer" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="make" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="model" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="color" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="purchasePrice" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="isVehicleUsed" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="uccCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: TrailerCollateral

Name TrailerCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"year" : xs:integer , [0..1] ?
"manufacturer" : xs:string , [0..1] ?
"make" : xs:string , [0..1] ?
"model" : xs:string , [0..1] ?
"color" : xs:string , [0..1] ?
"purchasePrice" : common:Money , [0..1] ?
"isVehicleUsed" : xs:boolean , [0..1] ?
"uccCode" : xs:string , [0..1] ?
"serialNumber" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="TrailerCollateral">
<xs:complexContent>
<xs:extension base="TitledCollateralBase">
<xs:sequence>
<xs:element name="serialNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UccCollateral

Name UccCollateral
Abstract no
JSON Instance Representation
{
"collateralId" : CollateralId , [0..1] ?
"collateralCode" : xs:string , [0..1] ?
"collateralPledgedDate" : xs:date , [0..1] ?
"description" : xs:string , [0..1] ?
"securedCode" : xs:string , [0..1] ?
"totalSecuredAmount" : common:Money , [0..1] ?
"valuationOfCollateral" : common:Money , [0..1] ?
"ownerOfCollateral" : xs:string , [0..1] ?
"loanToValuePercentage" : xs:decimal , [0..1] ?
"collateralValueSourceDate" : xs:date , [0..1] ?
"collateralValueSource" : xs:string , [0..1] ?
"collateralType" : CollateralType , [0..1] ?
"collateralSubType" : CollateralSubType , [0..1] ?
"collateralSubTypeDescription" : xs:string , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"address" : common:Address , [0..1] ?
"financingStatement" : xs:boolean , [0..1] ?
"generalDescription" : xs:string , [0..1] ?
"tortClaimDescription" : xs:string , [0..1] ?
"immovableDescription" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="UccCollateral">
<xs:complexContent>
<xs:extension base="CollateralBase">
<xs:sequence>
<xs:element name="financingStatement" type="xs:boolean" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="generalDescription" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="tortClaimDescription" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
<xs:element name="immovableDescription" type="xs:string" nillable="true" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: CollateralId

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

Simple Type: CollateralSubType

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

Simple Type: CollateralType

Name CollateralType
Content
  • Base XSD Type: string
  • value comes from list: {'aircraftCollateral'|'boatCollateral'|'letterOfCreditCollateral'|'mobileHomeCollateral'|'motorVehicleCollateral'|'otherTitledCollateral'|'realEstateCollateral'|'savingsCDCollateral'|'securitiesCollateral'|'shipCollateral'|'trailerCollateral'|'uccCollateral'}
Documentation The type of collateral.
Schema Component Representation
<xs:simpleType name="CollateralType">
<xs:restriction base="xs:string">
<xs:enumeration value="aircraftCollateral"/>
<xs:enumeration value="boatCollateral"/>
<xs:enumeration value="letterOfCreditCollateral"/>
<xs:enumeration value="mobileHomeCollateral"/>
<xs:enumeration value="motorVehicleCollateral"/>
<xs:enumeration value="otherTitledCollateral"/>
<xs:enumeration value="realEstateCollateral"/>
<xs:enumeration value="savingsCDCollateral"/>
<xs:enumeration value="securitiesCollateral"/>
<xs:enumeration value="shipCollateral"/>
<xs:enumeration value="trailerCollateral"/>
<xs:enumeration value="uccCollateral"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ValuationFrequency

Name ValuationFrequency
Content
  • Base XSD Type: string
  • value comes from list: {'Weekly'|'BiWeekly'|'Monthly'|'BiMonthly'|'Quarterly'|'SemiAnnually'|'Annually'}
Schema Component Representation
<xs:simpleType name="ValuationFrequency">
<xs:restriction base="xs:string">
<xs:enumeration value="Weekly"/>
<xs:enumeration value="BiWeekly"/>
<xs:enumeration value="Monthly"/>
<xs:enumeration value="BiMonthly"/>
<xs:enumeration value="Quarterly"/>
<xs:enumeration value="SemiAnnually"/>
<xs:enumeration value="Annually"/>
</xs:restriction>
</xs:simpleType>
top