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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/SecureMessage.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/Party.xsd (at Party.xsd)
    • http://cufxstandards.com/v4/Artifact.xsd (at Artifact.xsd)
    • http://cufxstandards.com/v4/Relationship.xsd (at Relationship.xsd)
    • http://cufxstandards.com/v4/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v4/Document.xsd (at Document.xsd)
    • http://cufxstandards.com/v4/User.xsd (at User.xsd)
    • http://cufxstandards.com/v4/Card.xsd (at Card.xsd)
    • http://cufxstandards.com/v4/ProductServiceRequest.xsd (at ProductServiceRequest.xsd)
    • http://cufxstandards.com/v4/AccessProfile.xsd (at AccessProfile.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/SecureMessage.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v4/Common.xsd
party http://cufxstandards.com/v4/Party.xsd
relationship http://cufxstandards.com/v4/Relationship.xsd
account http://cufxstandards.com/v4/Account.xsd
card http://cufxstandards.com/v4/Card.xsd
document http://cufxstandards.com/v4/Document.xsd
artifact http://cufxstandards.com/v4/Artifact.xsd
user http://cufxstandards.com/v4/User.xsd
productServiceRequest http://cufxstandards.com/v4/ProductServiceRequest.xsd
accessProfile http://cufxstandards.com/v4/AccessProfile.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/SecureMessage.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/Party.xsd" schemaLocation="Party.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Artifact.xsd" schemaLocation="Artifact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Relationship.xsd" schemaLocation="Relationship.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Account.xsd" schemaLocation="Account.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Document.xsd" schemaLocation="Document.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/User.xsd" schemaLocation="User.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Card.xsd" schemaLocation="Card.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/ProductServiceRequest.xsd" schemaLocation="ProductServiceRequest.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/AccessProfile.xsd" schemaLocation="AccessProfile.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: secureMessageList

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

Global Definitions

Complex Type: BodyContainsList

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

Complex Type: SecureMessage

Name SecureMessage
Abstract no
Documentation The secure message defines the information sent and then received by two or more parties. It also relates secure messages to the sending and receiving party(ies), and potentially to the relationship and/or account(s) to which the secure message is bound.
JSON Instance Representation
{
"secureMessageId" : SecureMessageId , [0..1] ?
"previousSecureMessageId" : SecureMessageId , [0..1] ?
"threadId" : ThreadId , [0..1] ?
"subjectLine" : SubjectLine , [0..1] ?
"messageFromList" : SecureMessageUserList , [0..1] ?
"messageToList" : SecureMessageUserList , [0..1] ?
"carbonCopyList" : SecureMessageUserList , [0..1] ?
"blindCarbonCopyList" : SecureMessageUserList , [0..1] ?
"replyToList" : SecureMessageUserList , [0..1] ?
"type" : SecureMessageType , [0..1] ?
"currentStatus" : SecureMessageStatus , [0..1] ?
"statusLog" : StatusLog , [0..1] ?
"body" : xs:string , [0..1] ?
"bodyFormat" : BodyFormat , [0..1] ?
"documentIdList" : document:DocumentIdList , [0..1] ?
"doNotDeliverBeforeDateTime" : xs:dateTime , [0..1] ?
"expirationDateTime" : xs:dateTime , [0..1] ?
"requestId" : productServiceRequest:RequestId , [0..1] ?
"allowReply" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="SecureMessage">
<xs:sequence>
<xs:element name="secureMessageId" type="SecureMessageId" minOccurs="0" maxOccurs="1"/>
<xs:element name="previousSecureMessageId" type="SecureMessageId" minOccurs="0" maxOccurs="1"/>
<xs:element name="threadId" type="ThreadId" minOccurs="0" maxOccurs="1"/>
<xs:element name="subjectLine" type="SubjectLine" minOccurs="0" maxOccurs="1"/>
<xs:element name="messageFromList" type="SecureMessageUserList" minOccurs="0" maxOccurs="1"/>
<xs:element name="messageToList" type="SecureMessageUserList" minOccurs="0" maxOccurs="1"/>
<xs:element name="carbonCopyList" type="SecureMessageUserList" minOccurs="0" maxOccurs="1"/>
<xs:element name="blindCarbonCopyList" type="SecureMessageUserList" minOccurs="0" maxOccurs="1"/>
<xs:element name="replyToList" type="SecureMessageUserList" minOccurs="0" maxOccurs="1"/>
<xs:element name="type" type="SecureMessageType" minOccurs="0" maxOccurs="1"/>
<xs:element name="currentStatus" type="SecureMessageStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="statusLog" type="StatusLog" minOccurs="0" maxOccurs="1"/>
<xs:element name="body" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="bodyFormat" type="BodyFormat" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentIdList" type="document:DocumentIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="doNotDeliverBeforeDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="expirationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestId" type="productServiceRequest:RequestId" minOccurs="0" maxOccurs="1"/>
<xs:element name="allowReply" 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: SecureMessageIdList

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

Complex Type: SecureMessageList

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

Complex Type: SecureMessageStatusList

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

Complex Type: SecureMessageTypeList

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

Complex Type: SecureMessageUser

Name SecureMessageUser
Abstract no
JSON Instance Representation
{
<!-- 'user:User' super type was not found in this schema. Some elements and attributes may be missing. -->
"relationshipId" : relationship:RelationshipId , [0..1] ?
"accountId" : account:AccountId , [0..1] ?
"cardId" : card:CardId , [0..1] ?
}
Schema Component Representation
<xs:complexType name="SecureMessageUser">
<xs:complexContent>
<xs:extension base="user:User">
<xs:sequence>
<xs:element name="relationshipId" type="relationship:RelationshipId" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountId" type="account:AccountId" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardId" type="card:CardId" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SecureMessageUserList

Name SecureMessageUserList
Abstract no
Documentation Can serve as a list of users that either receive or send a message. Can also serve as a list of secure message users that should have their associated secure messages returned or affected by a read, update or delete request when filtering.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"secureMessageUser" : SecureMessageUser , [0..*] ?
}
Schema Component Representation
<xs:complexType name="SecureMessageUserList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="secureMessageUser" type="SecureMessageUser" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: StatusLog

Name StatusLog
Abstract no
Documentation The dates and times corresponding to the secure message's statuses, i.e. drafted, sent, read, replied, forwarded, etc.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"statusLogEntry" : StatusLogEntry , [0..*] ?
}
Schema Component Representation
<xs:complexType name="StatusLog">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="statusLogEntry" type="StatusLogEntry" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: StatusLogEntry

Name StatusLogEntry
Abstract no
Documentation The dates and times that the secureMessage changed status to drafted, sent, read, replied, forwarded, etc.
JSON Instance Representation
{
"status" : SecureMessageStatus , [0..1] ?
"messageAccessProfileId" : accessProfile:AccessProfileId , [0..1] ?
"statusDateTime" : xs:dateTime , [0..1] ?
}
Schema Component Representation
<xs:complexType name="StatusLogEntry">
<xs:sequence>
<xs:element name="status" type="SecureMessageStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="messageAccessProfileId" type="accessProfile:AccessProfileId" minOccurs="0" maxOccurs="1"/>
<xs:element name="statusDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: SubjectLineContainsList

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

Complex Type: ThreadIdList

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

Simple Type: BodyFormat

Name BodyFormat
Content
  • Base XSD Type: string
  • value comes from list: {'Html'|'Text'}
Documentation The format of the body content.
Schema Component Representation
<xs:simpleType name="BodyFormat">
<xs:restriction base="xs:string">
<xs:enumeration value="Html"/>
<xs:enumeration value="Text"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: SecureMessageId

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

Simple Type: SecureMessageStatus

Name SecureMessageStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Template'|'Draft'|'Outbox'|'Sent'|'Read'|'Replied'|'Forwarded'|'Archived'|'Unread'|'Failed'|'Expired'}
Documentation Current status of the secure message, i.e. a template or in the process of being sent, viewed, returned (see signature type to determine if it was signed or not when returned), etc.
Schema Component Representation
<xs:simpleType name="SecureMessageStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Template"/>
<xs:enumeration value="Draft"/>
<xs:enumeration value="Outbox"/>
<xs:enumeration value="Sent"/>
<xs:enumeration value="Read"/>
<xs:enumeration value="Replied"/>
<xs:enumeration value="Forwarded"/>
<xs:enumeration value="Archived"/>
<xs:enumeration value="Unread"/>
<xs:enumeration value="Failed"/>
<xs:enumeration value="Expired"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: SecureMessageType

Name SecureMessageType
Content
  • Base XSD Type: string
  • value comes from list: {'Alert'|'GeneralMessage'|'Notice'|'ProductOffering'|'ScheduleMeeting'|'ServiceUpdate'|'SignatureRequired'|'Other'}
Documentation Type of secure message or secure message template, such as Product Offer, Notice, etc.
Schema Component Representation
<xs:simpleType name="SecureMessageType">
<xs:restriction base="xs:string">
<xs:enumeration value="Alert"/>
<xs:enumeration value="GeneralMessage"/>
<xs:enumeration value="Notice"/>
<xs:enumeration value="ProductOffering"/>
<xs:enumeration value="ScheduleMeeting"/>
<xs:enumeration value="ServiceUpdate"/>
<xs:enumeration value="SignatureRequired"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: SubjectLine

Name SubjectLine
Content
  • Base XSD Type: string
Documentation Each secure message has a subject line supplied by the creator of the secure message.
Schema Component Representation
<xs:simpleType name="SubjectLine">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: ThreadId

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