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

Table of Contents

top

Schema Document Properties

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

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/Relationship.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v5/Common.xsd
contact http://cufxstandards.com/v5/Contact.xsd
party http://cufxstandards.com/v5/Party.xsd
account http://cufxstandards.com/v5/Account.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/Relationship.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/Contact.xsd" schemaLocation="Contact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Party.xsd" schemaLocation="Party.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Account.xsd" schemaLocation="Account.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: relationshipList

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

Global Definitions

Complex Type: Beneficiary

Name Beneficiary
Abstract no
JSON Instance Representation
{
"isBeneficiary" : xs:boolean , [0..1] ?
"qualifier" : BeneficiaryQualifier , [1] ?
"authority" : common:Authority , [1] ?
"beneficiaryPercent" : xs:decimal , [1] ?
"beneficiaryTypes" : BeneficiaryTypes , [1] ?
}
Schema Component Representation
<xs:complexType name="Beneficiary">
<xs:sequence>
<xs:element name="isBeneficiary" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="qualifier" type="BeneficiaryQualifier" minOccurs="1" maxOccurs="1"/>
<xs:element name="authority" type="common:Authority" minOccurs="1" maxOccurs="1"/>
<xs:element name="beneficiaryPercent" type="xs:decimal" minOccurs="1" maxOccurs="1" default="1.00"/>
<xs:element name="beneficiaryTypes" type="BeneficiaryTypes" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CollateralGrantor

Name CollateralGrantor
Abstract no
JSON Instance Representation
{
"isCollateralGrantor" : xs:boolean , [0..1] ?
"authority" : common:Authority , [0..1] ?
}
Schema Component Representation
<xs:complexType name="CollateralGrantor">
<xs:sequence>
<xs:element name="isCollateralGrantor" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="authority" type="common:Authority" minOccurs="0" maxOccurs="1" default="Unauthorized"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Guarantor

Name Guarantor
Abstract no
JSON Instance Representation
{
"isGuarantor" : xs:boolean , [1] ?
"authority" : common:Authority , [1] ?
}
Schema Component Representation
<xs:complexType name="Guarantor">
<xs:sequence>
<xs:element name="isGuarantor" type="xs:boolean" minOccurs="1" maxOccurs="1"/>
<xs:element name="authority" type="common:Authority" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Holder

Name Holder
Abstract no
JSON Instance Representation
{
"isHolder" : xs:boolean , [0..1] ?
"qualifier" : PrimaryJoint , [0..1] ?
"authority" : common:Authority , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Holder">
<xs:sequence>
<xs:element name="isHolder" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="qualifier" type="PrimaryJoint" minOccurs="0" maxOccurs="1"/>
<xs:element name="authority" type="common:Authority" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: PartyRelationshipType

Name PartyRelationshipType
Abstract no
Documentation The party relationship type is the textual representation of what the party record represents to this relationship, such as primary or joint ownership, beneficiary or some other type of relationship. This value may be visible to the user and must be human-readable. If the party does not have full ownership or responsibility of all accounts within the relationship, then the party should be related to those accounts via a party list within the account object. Specific loan level ownership will also be in the accounts via a party list within the account object.
JSON Instance Representation
{
"holder" : Holder , [0..1] ?
"beneficiary" : Beneficiary , [0..1] ?
"agent" : common:Agent , [0..1] ?
"payee" : Payee , [0..1] ?
"guarantor" : Guarantor , [0..1] ?
"collateralGrantor" : CollateralGrantor , [0..1] ?
"safeDepositBoxUser" : SafeDepositBoxUser , [0..1] ?
}
Schema Component Representation
<xs:complexType name="PartyRelationshipType">
<xs:sequence>
<xs:element name="holder" type="Holder" minOccurs="0" maxOccurs="1"/>
<xs:element name="beneficiary" type="Beneficiary" minOccurs="0" maxOccurs="1"/>
<xs:element name="agent" type="common:Agent" minOccurs="0" maxOccurs="1"/>
<xs:element name="payee" type="Payee" minOccurs="0" maxOccurs="1"/>
<xs:element name="guarantor" type="Guarantor" minOccurs="0" maxOccurs="1"/>
<xs:element name="collateralGrantor" type="CollateralGrantor" minOccurs="0" maxOccurs="1"/>
<xs:element name="safeDepositBoxUser" type="SafeDepositBoxUser" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Payee

Name Payee
Abstract no
JSON Instance Representation
{
"isPayee" : xs:boolean , [0..1] ?
"qualifier" : PayeeQualifier , [1] ?
"authority" : common:Authority , [1] ?
}
Schema Component Representation
<xs:complexType name="Payee">
<xs:sequence>
<xs:element name="isPayee" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="qualifier" type="PayeeQualifier" minOccurs="1" maxOccurs="1"/>
<xs:element name="authority" type="common:Authority" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Relationship

Name Relationship
Abstract no
Documentation A grouping of related accounts tied to one or more parties that have an account relationship with the financial institution. Some financial institutions may call this a membership, parent account or other term.
JSON Instance Representation
{
"relationshipId" : RelationshipId , [0..1] ?
"dateCreated" : xs:date , [0..1] ?
"dateRelationshipEnded" : xs:date , [0..1] ?
"rewardsCode" : xs:string , [0..1] ?
"relationshipPartyList" : RelationshipPartyList , [0..1] ?
"accountIdList" : account:AccountIdList , [0..1] ?
"relationshipStatus" : RelationshipStatus , [0..1] ?
"relationshipCreatedBy" : common:UserId , [0..1] ?
"relationshipDateTimeModified" : xs:dateTime , [0..1] ?
"relationshipModifiedBy" : common:UserId , [0..1] ?
"relationshipDateTimeDeleted" : xs:dateTime , [0..1] ?
"relationshipDeletedBy" : common:UserId , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Relationship">
<xs:sequence>
<xs:element name="relationshipId" type="RelationshipId" minOccurs="0" maxOccurs="1"/>
<xs:element name="dateCreated" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="dateRelationshipEnded" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="rewardsCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipPartyList" type="RelationshipPartyList" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountIdList" type="account:AccountIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipStatus" type="RelationshipStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipCreatedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipDateTimeModified" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipModifiedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipDateTimeDeleted" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipDeletedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountIdentificationList" type="account:AccountIdentificationList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: RelationshipIdList

Name RelationshipIdList
Abstract no
Documentation The list of Relationship 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. -->
"relationshipId" : RelationshipId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RelationshipIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="relationshipId" type="RelationshipId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RelationshipList

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

Complex Type: RelationshipParty

Name RelationshipParty
Abstract no
Documentation A collection of fields required to relate this relationship with the identified parties and what level of ownership they have on the underlying accounts within the relationship.
JSON Instance Representation
{
"id" : common:PartyId , [0..1] ?
"party" : party:Party , [0..1] ?
"partyRelationshipType" : PartyRelationshipType , [0..1] ?
"ssnOverride" : xs:boolean , [0..1] ?
"contactIdList" : contact:ContactIdList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"noteList" : common:NoteList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="RelationshipParty">
<xs:sequence>
<xs:element name="id" type="common:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="party" type="party:Party" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyRelationshipType" type="PartyRelationshipType" minOccurs="0" maxOccurs="1"/>
<xs:element name="ssnOverride" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false"/>
<xs:element name="contactIdList" type="contact:ContactIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="noteList" type="common:NoteList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: RelationshipPartyList

Name RelationshipPartyList
Abstract no
Documentation A collection of party ID’s that uniquely identify each party associated to this relationship, along with how each party is related to the relationship.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"relationshipParty" : RelationshipParty , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RelationshipPartyList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="relationshipParty" type="RelationshipParty" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RelationshipStatusList

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

Complex Type: SafeDepositBoxUser

Name SafeDepositBoxUser
Abstract no
JSON Instance Representation
{
"isSafeDepositBoxUser" : xs:boolean , [0..1] ?
"qualifier" : SafeDepositBoxUserQualifier , [1] ?
"authority" : common:Authority , [1] ?
}
Schema Component Representation
<xs:complexType name="SafeDepositBoxUser">
<xs:sequence>
<xs:element name="isSafeDepositBoxUser" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="qualifier" type="SafeDepositBoxUserQualifier" minOccurs="1" maxOccurs="1"/>
<xs:element name="authority" type="common:Authority" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: BeneficiaryQualifier

Name BeneficiaryQualifier
Content
  • Base XSD Type: string
  • value comes from list: {'Standard'|'Education'}
Schema Component Representation
<xs:simpleType name="BeneficiaryQualifier">
<xs:restriction base="xs:string">
<xs:enumeration value="Standard"/>
<xs:enumeration value="Education"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: BeneficiaryTypes

Name BeneficiaryTypes
Content
  • Base XSD Type: string
  • value comes from list: {'Primary'|'Contingent'}
Schema Component Representation
<xs:simpleType name="BeneficiaryTypes">
<xs:restriction base="xs:string">
<xs:enumeration value="Primary"/>
<xs:enumeration value="Contingent"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PayeeQualifier

Name PayeeQualifier
Content
  • Base XSD Type: string
  • value comes from list: {'Dividend'|'Maturity'|'DividendAndMaturity'}
Schema Component Representation
<xs:simpleType name="PayeeQualifier">
<xs:restriction base="xs:string">
<xs:enumeration value="Dividend"/>
<xs:enumeration value="Maturity"/>
<xs:enumeration value="DividendAndMaturity"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PrimaryJoint

Name PrimaryJoint
Content
  • Base XSD Type: string
  • value comes from list: {'Primary'|'Joint'}
Schema Component Representation
<xs:simpleType name="PrimaryJoint">
<xs:restriction base="xs:string">
<xs:enumeration value="Primary"/>
<xs:enumeration value="Joint"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: RelationshipId

Name RelationshipId
Content
  • Base XSD Type: string
Documentation The relationship ID is a persistent and unique identifier for the relationship. It should be unique for all relationships across the institution and remain the same over the life of the relationship with the financial institution.
Schema Component Representation
<xs:simpleType name="RelationshipId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: RelationshipStatus

Name RelationshipStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Active'|'Closed'|'Deceased'|'Inactive'|'Prospect'|'Restricted'}
Schema Component Representation
<xs:simpleType name="RelationshipStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Active"/>
<xs:enumeration value="Closed"/>
<xs:enumeration value="Deceased"/>
<xs:enumeration value="Inactive"/>
<xs:enumeration value="Prospect"/>
<xs:enumeration value="Restricted"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: SafeDepositBoxUserQualifier

Name SafeDepositBoxUserQualifier
Content
  • Base XSD Type: string
  • value comes from list: {'Colessee'|'Deputy'}
Schema Component Representation
<xs:simpleType name="SafeDepositBoxUserQualifier">
<xs:restriction base="xs:string">
<xs:enumeration value="Colessee"/>
<xs:enumeration value="Deputy"/>
</xs:restriction>
</xs:simpleType>
top