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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/CredentialGroup.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/User.xsd (at User.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/CredentialGroup.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v5/Common.xsd
user http://cufxstandards.com/v5/User.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/CredentialGroup.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/User.xsd" schemaLocation="User.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: credentialGroupList

Name credentialGroupList
Type CredentialGroupList
Nillable no
Abstract no
Documentation This is a list of credentials that the party uses to access systems.
JSON Instance Representation
{credentialGroupList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"credentialGroup" : CredentialGroup , [0..*] ?
credentialGroupList}
Schema Component Representation
<xs:element name="credentialGroupList" type="CredentialGroupList"/>
top

Global Definitions

Complex Type: AttributeList

Name AttributeList
Abstract no
Documentation List of credential attribute pairs. A verifiable credential can possess any number of associated attributes pairs as defined by the issuing institution.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"attribute" : common:ValuePair , [1..*] ?
}
Schema Component Representation
<xs:complexType name="AttributeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="attribute" type="common:ValuePair" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ConnectionProtocol

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

Complex Type: Credential

Name Credential
Abstract no
JSON Instance Representation
{
"credentialId" : CredentialId , [0..1] ?
"relatedCredentialId" : CredentialId , [0..1] ?
"credentialType" : CredentialType , [1] ?
"credentialSubType" : xs:string , [0..1] ?
"encrypted" : xs:boolean , [0..1] ?
"value" : xs:string , [0..1] ?
"expirationDateTime" : xs:dateTime , [0..1] ?
"temporary" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"didValidation" : DidValidation , [0..1] ?
"verifiedCredential" : VerifiedCredential , [0..1] ?
"connectionProtocol" : ConnectionProtocol , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Credential">
<xs:sequence>
<xs:element name="credentialId" type="CredentialId" minOccurs="0" maxOccurs="1"/>
<xs:element name="relatedCredentialId" type="CredentialId" minOccurs="0" maxOccurs="1"/>
<xs:element name="credentialType" type="CredentialType" minOccurs="1" maxOccurs="1"/>
<xs:element name="credentialSubType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="encrypted" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="expirationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="temporary" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="didValidation" type="DidValidation" minOccurs="0" maxOccurs="1"/>
<xs:element name="verifiedCredential" type="VerifiedCredential" minOccurs="0" maxOccurs="1"/>
<xs:element name="connectionProtocol" type="ConnectionProtocol" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CredentialGroup

Name CredentialGroup
Abstract no
JSON Instance Representation
{
"fiUserId" : FiUserId , [0..1] ?
"userId" : common:UserId , [0..1] ?
"userIdType" : user:UserIdType , [0..1] ?
"credentialList" : CredentialList , [0..1] ?
"deliveryChannelList" : DeliveryChannelList , [0..1] ?
"verifiedCredentialGroupToken" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="CredentialGroup">
<xs:sequence>
<xs:element name="fiUserId" type="FiUserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="userId" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="userIdType" type="user:UserIdType" minOccurs="0" maxOccurs="1"/>
<xs:element name="credentialList" type="CredentialList" minOccurs="0" maxOccurs="1"/>
<xs:element name="deliveryChannelList" type="DeliveryChannelList" minOccurs="0" maxOccurs="1"/>
<xs:element name="verifiedCredentialGroupToken" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CredentialGroupList

Name CredentialGroupList
Abstract no
Documentation Collection of credential groups for the party to use to access different systems.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"credentialGroup" : CredentialGroup , [0..*] ?
}
Schema Component Representation
<xs:complexType name="CredentialGroupList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="credentialGroup" type="CredentialGroup" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CredentialList

Name CredentialList
Abstract no
Documentation Credential list is a combination of credentials that the user must know in order to access the system.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"credential" : Credential , [0..*] ?
}
Schema Component Representation
<xs:complexType name="CredentialList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="credential" type="Credential" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CredentialTypeList

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

Complex Type: DeliveryChannelList

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

Complex Type: DidValidation

Name DidValidation
Abstract no
Documentation The population of data when credentialType is DID. When presented a verifiable DID credential may or may not be validated at the time of presentation. The following elements are necessary to determine the status of the credential and or provide the ability to execute a verification of the credential. The following map to the w3.org Verifiable Credentials Data Model v1.0. https://www.w3.org/TR/did-core/
JSON Instance Representation
{
"id" : xs:string , [0..1] ?
"controller" : xs:string , [0..1] ?
"type" : xs:string , [0..1] ?
"publicKeyJwk" : xs:string , [0..1] ?
"publicKeyBase58" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="DidValidation">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="controller" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="type" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="publicKeyJwk" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="publicKeyBase58" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: FiUserIdList

Name FiUserIdList
Abstract no
Documentation FiUserId list is used for making a filtered request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fiUserId" : FiUserId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FiUserIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fiUserId" type="FiUserId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: VerifiedCredential

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

Simple Type: CredentialId

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

Simple Type: CredentialType

Name CredentialType
Content
  • Base XSD Type: string
  • value comes from list: {'Username'|'Password'|'AtmPin'|'Codeword'|'Token'|'SecurityQuestion'|'SecurityAnswer'|'ChallengeQuestion'|'ChallengeAnswer'|'AntiphishingPhrase'|'AntiphishingImageUrl'|'AntiphishingImageArtifactId'|'AuthorizationCode'|'Other'|'DidValidation'|'VerifiedCredential'|'ConnectionProtocol'}
Documentation Type of the credentials being used.
Schema Component Representation
<xs:simpleType name="CredentialType">
<xs:restriction base="xs:string">
<xs:enumeration value="Username"/>
<xs:enumeration value="Password"/>
<xs:enumeration value="AtmPin"/>
<xs:enumeration value="Codeword"/>
<xs:enumeration value="Token"/>
<xs:enumeration value="SecurityQuestion"/>
<xs:enumeration value="SecurityAnswer"/>
<xs:enumeration value="ChallengeQuestion"/>
<xs:enumeration value="ChallengeAnswer"/>
<xs:enumeration value="AntiphishingPhrase"/>
<xs:enumeration value="AntiphishingImageUrl"/>
<xs:enumeration value="AntiphishingImageArtifactId"/>
<xs:enumeration value="AuthorizationCode"/>
<xs:enumeration value="Other"/>
<xs:enumeration value="DidValidation"/>
<xs:enumeration value="VerifiedCredential"/>
<xs:enumeration value="ConnectionProtocol"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DeliveryChannel

Name DeliveryChannel
Content
  • Base XSD Type: string
  • value comes from list: {'LiveSupport'|'ATM'|'Email'|'IVR'|'Kiosk'|'Mail'|'Mobile'|'OnlineBanking'|'Other'|'Phone'|'SMS'}
Schema Component Representation
<xs:simpleType name="DeliveryChannel">
<xs:restriction base="xs:string">
<xs:enumeration value="LiveSupport"/>
<xs:enumeration value="ATM"/>
<xs:enumeration value="Email"/>
<xs:enumeration value="IVR"/>
<xs:enumeration value="Kiosk"/>
<xs:enumeration value="Mail"/>
<xs:enumeration value="Mobile"/>
<xs:enumeration value="OnlineBanking"/>
<xs:enumeration value="Other"/>
<xs:enumeration value="Phone"/>
<xs:enumeration value="SMS"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: FiUserId

Name FiUserId
Content
  • Base XSD Type: string
Documentation FiUserId is a unique identifier for the credential group and is readable by the person. The person types this into systems to gain access, also using their password, PIN or whatever else is required to gain access.
Schema Component Representation
<xs:simpleType name="FiUserId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top