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

Table of Contents

top

Schema Document Properties

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

Declared Namespaces

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

Global Declarations

Element: documentList

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

Global Definitions

Complex Type: Document

Name Document
Abstract no
Documentation The document defines the information stored when a person signs a document or agreement either electronically or manually. This also relates documents to the party, relationship and/or account to which the document is legally bound.
JSON Instance Representation
{
"documentId" : DocumentId , [0..1] ?
"documentTitle" : DocumentTitle , [0..1] ?
"documentType" : DocumentType , [0..1] ?
"documentSubType" : DocumentSubType , [0..1] ?
"appliesTo" : common:CustomData , [0..1] ?
"documentStatus" : DocumentStatus , [0..1] ?
"documentVersion" : DocumentVersion , [0..1] ?
"effectiveDateTime" : xs:dateTime , [0..1] ?
"expirationDateTime" : xs:dateTime , [0..1] ?
"documentArtifactIdList" : artifact:ArtifactIdList , [0..1] ?
"partyIdList" : common:PartyIdList , [0..1] ?
"relationshipId" : relationship:RelationshipId , [0..1] ?
"accountIdList" : account:AccountIdList , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
"prefillable" : xs:boolean , [0..1] ?
"prefilled" : xs:boolean , [0..1] ?
"documentSignatureList" : DocumentSignatureList , [0..1] ?
"witnessList" : WitnessList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"documentArtifactList" : artifact:ArtifactList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Document">
<xs:sequence>
<xs:element name="documentId" type="DocumentId" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentTitle" type="DocumentTitle" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentType" type="DocumentType" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentSubType" type="DocumentSubType" minOccurs="0" maxOccurs="1"/>
<xs:element name="appliesTo" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentStatus" type="DocumentStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentVersion" type="DocumentVersion" minOccurs="0" maxOccurs="1"/>
<xs:element name="effectiveDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="expirationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentArtifactIdList" type="artifact:ArtifactIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyIdList" type="common:PartyIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipId" type="relationship:RelationshipId" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountIdList" type="account:AccountIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountIdentificationList" type="account:AccountIdentificationList" minOccurs="0" maxOccurs="1"/>
<xs:element name="prefillable" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="prefilled" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentSignatureList" type="DocumentSignatureList" minOccurs="0" maxOccurs="1"/>
<xs:element name="witnessList" type="WitnessList" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentArtifactList" type="artifact:ArtifactList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: DocumentIdList

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

Complex Type: DocumentList

Name DocumentList
Abstract no
Documentation The documents collection/array list contains all the documents or document templates, 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. -->
"document" : Document , [0..*]
}
Schema Component Representation
<xs:complexType name="DocumentList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="document" type="Document" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DocumentSignature

Name DocumentSignature
Abstract no
JSON Instance Representation
{
"documentSignatureType" : DocumentSignatureType , [0..1] ?
"signaturePurpose" : xs:string , [0..1] ?
"signatureArtifactId" : artifact:ArtifactId , [0..1] ?
"documentSignedDateTime" : xs:dateTime , [0..1] ?
"signaturePartyId" : common:PartyId , [0..1] ?
"signedWithIpAddress" : common:IpAddress , [0..1] ?
"documentDigitalFingerprint" : xs:string , [0..1] ?
"documentDigitalAlgorithm" : xs:string , [0..1] ?
"documentDigitalCertificate" : xs:string , [0..1] ?
"usersPublicKey" : xs:string , [0..1] ?
"viewedConfirmationValue" : xs:string , [0..1] ?
"viewedConfirmationStatus" : ViewedConfirmationStatus , [0..1] ?
}
Schema Component Representation
<xs:complexType name="DocumentSignature">
<xs:sequence>
<xs:element name="documentSignatureType" type="DocumentSignatureType" minOccurs="0" maxOccurs="1"/>
<xs:element name="signaturePurpose" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="signatureArtifactId" type="artifact:ArtifactId" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentSignedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="signaturePartyId" type="common:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="signedWithIpAddress" type="common:IpAddress" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentDigitalFingerprint" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentDigitalAlgorithm" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentDigitalCertificate" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="usersPublicKey" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="viewedConfirmationValue" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="viewedConfirmationStatus" type="ViewedConfirmationStatus" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: DocumentSignatureList

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

Complex Type: DocumentSignatureTypeList

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

Complex Type: DocumentStatusList

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

Complex Type: DocumentSubTypeList

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

Complex Type: DocumentTitleList

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

Complex Type: DocumentTypeList

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

Complex Type: Witness

Name Witness
Abstract no
Documentation Collection of document witness(es) associated with a document. There can be multiple witnesses for a single document.
JSON Instance Representation
{
"witnessId" : xs:string , [0..1] ?
"witnessIdType" : WitnessIdType , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Witness">
<xs:sequence>
<xs:element name="witnessId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="witnessIdType" type="WitnessIdType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: WitnessList

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

Simple Type: DocumentId

Name DocumentId
Content
  • Base XSD Type: string
Documentation The document ID is a persistent and unique identifier for the document not related to the party, relationship or accounts that the document is for. It should be unique for all documents across the institution and remain the same over the life of the document within the financial institution.
Schema Component Representation
<xs:simpleType name="DocumentId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: DocumentSignatureType

Name DocumentSignatureType
Content
  • Base XSD Type: string
  • value comes from list: {'Unsigned'|'ElectronicSignature'|'SingleClickAcceptance'|'WetSignature'}
Documentation If the document has been signed, how it was signed.
Schema Component Representation
<xs:simpleType name="DocumentSignatureType">
<xs:restriction base="xs:string">
<xs:enumeration value="Unsigned"/>
<xs:enumeration value="ElectronicSignature"/>
<xs:enumeration value="SingleClickAcceptance"/>
<xs:enumeration value="WetSignature"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DocumentStatus

Name DocumentStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Template'|'Sent'|'Viewed'|'Returned'|'Recent'}
Documentation Current status of the document, i.e. in the process of being sent, viewed, returned, etc. (see signature type to determine if it was returned signed or not)
Schema Component Representation
<xs:simpleType name="DocumentStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Template"/>
<xs:enumeration value="Sent"/>
<xs:enumeration value="Viewed"/>
<xs:enumeration value="Returned"/>
<xs:enumeration value="Recent"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DocumentSubType

Name DocumentSubType
Content
  • Base XSD Type: string
Documentation A further drill-down into the type of document that it is, i.e. a category within a Type. These are defined by the financial institution based on the institution's needs.
Schema Component Representation
<xs:simpleType name="DocumentSubType">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: DocumentTitle

Name DocumentTitle
Content
  • Base XSD Type: string
Documentation Each document has a title which is determined by the financial institution. Examples are: Loan Dislosure, Savings Disclosure, Checking Disclosure, Membership Disclosure, etc.
Schema Component Representation
<xs:simpleType name="DocumentTitle">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: DocumentType

Name DocumentType
Content
  • Base XSD Type: string
  • value comes from list: {'CheckImage'|'Disclosure'|'IdentificationDocument'|'LoanDocument'|'MembershipDocument'|'Notice'|'Receipt'|'Statement'|'Report'|'SignatureCard'|'TaxForm'|'Other'}
Documentation The type of document or document template, such as Notice, Statement, Disclosure, etc.
Schema Component Representation
<xs:simpleType name="DocumentType">
<xs:restriction base="xs:string">
<xs:enumeration value="CheckImage"/>
<xs:enumeration value="Disclosure"/>
<xs:enumeration value="IdentificationDocument"/>
<xs:enumeration value="LoanDocument"/>
<xs:enumeration value="MembershipDocument"/>
<xs:enumeration value="Notice"/>
<xs:enumeration value="Receipt"/>
<xs:enumeration value="Statement"/>
<xs:enumeration value="Report"/>
<xs:enumeration value="SignatureCard"/>
<xs:enumeration value="TaxForm"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DocumentVersion

Name DocumentVersion
Content
  • Base XSD Type: string
Documentation A description that identifies the version of this document so that multiple versions of the same document can be managed.
Schema Component Representation
<xs:simpleType name="DocumentVersion">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: ViewedConfirmationStatus

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

Simple Type: WitnessIdType

Name WitnessIdType
Content
  • Base XSD Type: string
  • value comes from list: {'WitnessId'|'VendorEmployeeId'|'SystemAccountId'|'NotaryId'|'Custom'}
Schema Component Representation
<xs:simpleType name="WitnessIdType">
<xs:restriction base="xs:string">
<xs:enumeration value="WitnessId"/>
<xs:enumeration value="VendorEmployeeId"/>
<xs:enumeration value="SystemAccountId"/>
<xs:enumeration value="NotaryId"/>
<xs:enumeration value="Custom"/>
</xs:restriction>
</xs:simpleType>
top