OASIS Openopen access

Biometric Identity Assurance Services (BIAS) SOAP Profile Version 1.0 (2012-05-25)

OASIS Open · OASIS Open

OASIS Open · Standards · License: Open Access

bias biometric identity os profile soap v1 v1.0

oasis, standard, oasis open, specification, open standard, oasis_biasprofile-v1.0-os, biometric, identity, assurance, services, bias, soap, profile, version, 1.0, biasprofile-v1.0-os, biasprofile, v1, os

Biometric Identity Assurance Services (BIAS) SOAP Profile Version 1.0 OASIS Standard 24 May 2012 Specification URIs This version: http://docs.oasis-open.org/bias/soap-profile/v1.0/os/biasprofile-v1.0-os.doc (Authoritative) http://docs.oasis-open.org/bias/soap-profile/v1.0/os/biasprofile-v1.0-os.html http://docs.oasis-open.org/bias/soap-profile/v1.0/os/biasprofile-v1.0-os.pdf Previous version: http://docs.oasis-open.org/bias/soap-profile/v1.0/csprd02/biasprofile-v1.0-csprd02.doc (Authoritative) http://docs.oasis-open.org/bias/soap-profile/v1.0/csprd02/biasprofile-v1.0-csprd02.html http://docs.oasis-open.org/bias/soap-profile/v1.0/csprd02/biasprofile-v1.0-csprd02.pdf Latest version: http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0.doc (Authoritative) http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0.html http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0.pdf Technical Committee: OASIS Biometric Identity Assurance Services (BIAS) Integration TC Chair: Cathy Tilton ( [email protected] ), Daon Editors: Kevin Mangold ( [email protected] ), NIST Matthew Swayze ( [email protected] ), Daon Cathy Tilton ( [email protected] ), Daon Additional artifacts: This prose specification is one component of a Work Product which also includes: � XML schema: http://docs.oasis-open.org/bias/soap-profile/v1.0/os/cbeff.xsd � WSDL: http://docs.oasis-open.org/bias/soap-profile/v1.0/os/BIAS.wsdl Related work: This specification is related to: � A NSI INCITS 442-2010, Biometric Identity Assurance Services (BIAS) Declared XML namespaces: http://docs.oasis-open.org/bias/ns/bias-1.0/ http://docs.oasis-open.org/bias/ns/biaspatronformat-1.0/ Abstract: This document specifies a SOAP profile that implements the BIAS abstract operations specified in INCITS 442 as SOAP messages. Status: This document was last revised or approved by the membership of OASIS on the above date. The level of approval is also listed above. Check the �Latest version� location noted above for possible later revisions of this document. Technical Committee members should send comments on this specification to the Technical Committee�s email list. Others should send comments to the Technical Committee by using the � Send A Comment � button on the Technical Committee�s web page at http://www.oasis-open.org/committees/bias/ . For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page ( http://www.oasis-open.org/committees/bias/ipr.php ). Citation format: When referencing this specification the following citation format should be used: [BIASPROFILE] Biometric Identity Assurance Services (BIAS) SOAP Profile Version 1.0 . 24 May 2012. OASIS Standard. http://docs.oasis-open.org/bias/soap-profile/v1.0/os/biasprofile-v1.0-os.html . Notices Copyright � OASIS Open 2012. All Rights Reserved. All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so. OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims. The name "OASIS" is a trademark of OASIS , the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/policies-guidelines/trademark for above guidance. Table of Contents 1 �� Introduction . 8 1.1 Purpose/Scope . 8 1.2 Overview . 8 1.3 Background . 8 1.4 Relationship to Other Standards . 9 1.5 Terminology . 9 1.6 References . 10 1.6.1 Normative References . 10 1.6.2 Non-Normative References . 11 2 �� Design Concepts and Architecture (non-normative) 13 2.1 Philosophy . 13 2.2 Context 13 2.3 Architecture . 13 3 �� Data dictionary . 16 3.1 �� Documentation Conventions . 16 3.2 Common Elements . 17 3.2.1 ApplicationIdentifier 17 3.2.2 ApplicationUserIdentifier 17 3.2.3 BaseBIRType . 17 3.2.4 BIASBiometricDataType . 17 3.2.5 BIASFaultCode . 18 3.2.6 BIASFaultDetail 18 3.2.7 BIASIdentity . 19 3.2.8 BIASIDType . 19 3.2.9 BinaryBIR . 19 3.2.10 BiographicDataItemType . 20 3.2.11 BiographicDataSetType . 20 3.2.12 BiographicDataType . 21 3.2.13 BiometricDataElementType . 21 3.2.14 BiometricDataListType . 22 3.2.15 CandidateListResultType . 22 3.2.16 CandidateListType . 22 3.2.17 CandidateType . 23 3.2.18 CapabilityListType . 23 3.2.19 CapabilityName . 23 3.2.20 CapabilityType . 24 3.2.21 CBEFF_BIR_ListType . 24 3.2.22 CBEFF_BIR_Type . 24 3.2.23 Classification . 25 3.2.24 ClassificationAlgorithmType . 25 3.2.25 ClassificationData . 25 3.2.26 EncounterListType . 26 3.2.27 FusionDecision . 26 3.2.28 FusionInformationListType . 26 3.2.29 FusionInformationType . 26 3.2.30 FusionResult 27 3.2.31 FusionScore . 27 3.2.32 GenericRequestParameters . 27 3.2.33 IdentifySubjectResultType . 27 3.2.34 InformationType . 27 3.2.35 ListFilterType . 28 3.2.36 MatchType . 28 3.2.37 ProcessingOptionsType . 28 3.2.38 ProductID .. 28 3.2.39 QualityData . 28 3.2.40 ResponseStatus . 29 3.2.41 ReturnCode . 29 3.2.42 Score . 29 3.2.43 TokenResultType . 29 3.2.44 TokenType . 30 3.2.45 URI_BIR . 30 3.2.46 VendorIdentifier 30 3.2.47 Version . 30 3.2.48 VersionType . 30 3.2.49 XML_BIR . 30 4 �� BIAS Messages . 32 4.1 Primitive Operations . 32 4.1.1 AddSubjectToGallery . 32 4.1.2 CheckQuality . 33 4.1.3 ClassifyBiometricData . 35 4.1.4 CreateSubject 37 4.1.5 DeleteBiographicData . 38 4.1.6 DeleteBiometricData . 39 4.1.7 DeleteSubject 40 4.1.8 DeleteSubjectFromGallery . 41 4.1.9 GetIdentifySubjectResults . 43 4.1.10 IdentifySubject 45 4.1.11 ListBiographicData . 47 4.1.12 ListBiometricData . 50 4.1.13 PerformFusion . 54 4.1.14 QueryCapabilities . 56 4.1.15 RetrieveBiographicInformation . 57 4.1.16 RetrieveBiometricInformation . 59 4.1.17 SetBiographicData . 61 4.1.18 SetBiometricData . 63 4.1.19 TransformBiometricData . 64 4.1.20 UpdateBiographicData . 66 4.1.21 UpdateBiometricData . 68 4.1.22 VerifySubject 69 4.2 Aggregate Operations . 71 4.2.1 Enroll 71 4.2.2 GetEnrollResults . 72 4.2.3 GetIdentifyResults . 74 4.2.4 GetVerifyResults . 75 4.2.5 Identify . 77 4.2.6 RetrieveInformation . 78 4.2.7 Verify . 79 5 �� Message structure and rules . 82 5.1� Purpose and constraints . 82 5.2 Message requirements . 83 5.3 Handling binary data . 84 5.3.1 Base64 encoding . 84 5.3.2 Use of XOP . 84 5.4 Discovery . 85 5.5 Identifying operations . 85 5.5.1 Operation name element 85 5.5.2 WS-Addressing Action . 86 5.6 Security . 87 5.6.1 Use of SSL 3.0 or TLS 1.0 . 87 5.6.2 Data Origin Authentication . 87 5.6.3 Message Integrity . 87 5.6.4 Message Confidentiality . 87 5.6.5 CBEFF BIR security features . 87 5.6.6 Security Considerations . 88 5.6.7 Security of Stored Data . 88 5.6.8 Key Management 88 5.7 Use with other WS* standards . 88 5.8 Tailoring . 88 6 �� Error handling . 90 6.1 BIAS operation return codes . 90 6.2 SOAP fault codes . 90 7 �� Conformance . 91 Annex A. �� XML Schema . 92 Annex B. �� BIAS Patron format specification . 174 B.1 Patron . 174 B.2 Patron identifier 174 B.3 Patron format name . 174 B.4 Patron format identifier 174 B.5 ASN.1 object identifier for this patron format 174 B.6 Domain of use . 174 B.7 Version identifier 174 B.8 CBEFF version . 174 B.9 General 175 B.10 Specification . 175 B.11 Element <BIR> . 176 B.11.1 Syntax . 176 B.11.2 Semantics . 176 B.12 Element <Version> . 177 B.12.1 Syntax . 177 B.12.2 Semantics . 177 B.13 Element <CBEFFVersion> . 178 B.13.1 Syntax . 178 B.13.2 �� Semantics . 178 B.14 Element <BIRInfo> . 178 B.14.1 Syntax . 178 B.14.2 Semantics . 179 B.15 Element <BDBInfo> . 180 B.15.1 Syntax . 180 B.15.2 Semantics . 182 B.16 Element <SBInfo> . 186 B.16.1 Syntax . 186 B.16.2 Semantics . 187 B.17 Representation of Integers . 187 B.18 Representation of Octet Strings . 187 B.19 Representation of Date and Time of the Day . 188 B.20 Representation of Universally Unique Identifiers . 189 B.21 Patron format conformance statement 189 B.21.1 Identifying information . 189 B.21.2 ISO/IEC 19785-1:2006/Amd 1:2010 to Patron Format Mapping . 189 B.22 XML schema of the BIAS patron format 191 B.23 Sample BIR encoding . 194 Annex C. �� Use Cases (non-normative) 196 C.1 Verification Use Case . 196 C.2 Asynchronous Verification Use Case . 197 C.3 Primitive Verification Use Case . 198 C.4 Identification Use Case . 199 C.5 Biometric Enrollment Use Case . 200 C.6 Primitive Enrollment Use Case . 201 Annex D. �� Samples (non-normative) 202 D.1 Create Subject Request/Response Example . 202 D.2 Set Biographic Data Request/Response Example . 204 D.3 Set Biometric Data Request/Response Example . 205 Annex E. �� Acknowledgements . 208 Annex F. �� Revision History . 209 1 Introduction 1.1 Purpose/Scope This Organization for the Advancement of Structured Information Standards (OASIS) Biometric Identity Assurance Services (BIAS) profile specifies how to use the eXtensible Markup Language (XML) [ XML10 ] defined in ANSI INCITS 442-2010 � Biometric Identity Assurance Services [ INCITS-BIAS ] to invoke Simple Object Access Protocol (SOAP) -based services that implement BIAS operations.� These SOAP-based services enable an application to invoke biometric identity assurance operations remotely in a Services Oriented Architecture (SOA) infrastructure. Not included in the scope of BIAS is the incorporation of biometric authentication as an integral component of an authentication or security protocol.� (However, BIAS services may be leveraged to implement biometric authentication in the future.) 1.2 Overview In addition to this introduction, this standard includes the following: � Clause 2 presents the design concepts and architecture for invoking SOAP-based services that implement BIAS operations. � Clause 3 presents the namespaces necessary to implement this profile, INCITS BIAS data elements, and identifies relationships to external data definitions. � Clause 4 specifies the content of the BIAS messages. � Clause 5 presents the BIAS message structure, as well as rules and considerations for its application. � Clause 6 presents information on error handling. � Clause 7 specifies conformance requirements. � Annexes include the OASIS BIAS XML schema/sample Web Service Definition Language (WSDL), BIAS CBEFF Patron Format, use cases, sample code, acknowledgements, and the revision history of this profile. 1.3 Background In late 2005/early 2006, a gap was identified in the existing biometric standards portfolio with respect to biometric services.� The Biometric Identity Assurance Services standard proposal was for a collaborative effort between government and private industry to provide a services-based framework for delivering identity assurance capabilities, allowing for platform and application independence.� This standard proposal required the attention of two major technical disciplines: biometrics and service architectures.� The expertise of both disciplines was required to ensure the standard was technically sound, market relevant, and achieved widespread adoption.� The International Committee for Information Technology Standards (INCITS) M1 provided the standards leadership relevant to biometrics, defining the �taxonomy� of biometric operations and data elements.� OASIS provided the standards leadership relevant to service architectures with an initial focus on web services, defining the schema and SOAP messaging. The driving requirements of the BIAS standard proposal were to provide the ability to remotely invoke biometric operations across an SOA infrastructure; to provide business level operations without constraining the application/business logic that implements those operations; to be as generic as possible � technology, framework, & application domain independent; and to provide basic capabilities that can be used to construct higher level, aggregate/composite operations. 1.4 Relationship to Other Standards This OASIS BIAS profile comprises a companion standard to ANSI INCITS 442-2010 � Biometric Identity Assurance Services, which defines the BIAS requirements and taxonomy, specifying the identity assurance operations and the associated data elements. This OASIS BIAS profile specifies the design concepts and architecture, data model and data dictionary, message structure and rules, and error handling necessary to invoke SOAP-based services that implement BIAS operations. Together, the BIAS standard and the BIAS profile provide an open framework for deploying and remotely invoking biometric-based identity assurance capabilities that can be readily accessed across an SOA infrastructure. This relationship allows the leveraging of the biometrics and web services expertise of the two standards development organizations. Existing standards are available in both domains and many of these standards will provide the foundation and underlying capabilities upon which the biometric services depend. 1.5 Terminology The key words �MUST�, �MUST NOT�, �REQUIRED�, �SHALL�, �SHALL NOT�, �SHOULD�, �SHOULD NOT�, �RECOMMENDED�, �MAY�, and �OPTIONAL� in this document are to be interpreted as described in [RFC2119]. The following additional terms and definitions are used: Note:� The terms and definitions specified in INCITS (InterNational Committee for Information Technology Standards) (Project 1823-D) also apply to this Standard. BIAS operation and data element names are not defined here, but in their respective sections. BIAS Biometric Identity Assurance Services BIR Biometric Information Record ESB Enterprise Service Bus HTTP HyperText Transfer Protocol HTTPS HyperText Transfer Protocol over SSL or HTTP Secure IRI Internationalized Resource Identifier SOA Service-Oriented Architecture SOAP Simple Object Access Protocol SSL Secure Sockets Layer TLS Transport Layer Security UDDI Universal Description, Discovery, and Integration URI Uniform Resource Identifier VPN Virtual Private Network WSDL Web Services Description Language WSS Web Services Security XML eXtensible Markup Language CBEFF Common Biometric Exchange Formats Framework - data elements and BIR formats specified in ISO/IEC 19785-1 BIAS implementation software entity that is capable of creating, processing, sending, and receiving BIAS messages BIAS endpoint runtime entity, identified by an endpoint URI/IRI, capable of sending and receiving BIAS messages, and containing a running BIAS implementation BIAS message message that can be sent from a BIAS endpoint to another BIAS endpoint through a BIAS link channel BIAS request message BIAS message conveying a request for an action to be performed by the receiving BIAS endpoint BIAS response message BIAS message conveying a response to a prior BIAS requestmessage 1.6 References 1.6.1 Normative References [RFC2119] �� S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, IETF RFC 2119, March 1997 http://www.ietf.org/rfc/rfc2119.txt [CBEFF] � ISO/IEC19785-1:2006, Information technology � Common Biometric Exchange Formats Framework � Part 1: Data element specification, with Amendment 1:2010 http://www.iso.org [DATE-TIME] � ISO 8601:2004, Data elements and interchange formats � Information interchange � Representation of dates and times http://www.iso.org [INCITS-BIAS] � ANSI INCITS 442-2010, Biometric Identity Assurance Services (BIAS), July 2010 http://www.incits.org [IRI] �� M. Duerst, et al, Internationalized Resouce Identifiers, RFC3987, January 2005 http://www.ietf.org/rfc/rfc3987.txt [SOAP11] �� Simple Object Access Protocol (SOAP) 1.1, 8 May 2000 http://www.w3.org/TR/2000/NOTE-SOAP-20000508/ [URI] �� T. Berners-Lee, R. Fielding, L. Masinter, Uniform Resource Identifiers (URI): Generic Syntax , RFC 3986, MIT/LCS, U.C. Irvine, Xerox Corporation, January 2005. http://ietf.org/rfc/rfc3986 [UTF-8] � ISO/IEC 10646:2003, Information technology � Universal Multiple-Octet Coded Character Set (UCS) http://www.iso.org [WS-Addr] � W3C Recommendation,Web Services Addressing 1.0 - Core,� and Web Services Addressing 1.0 - SOAP Binding, 9 May 2006 http://www.w3.org/2002/ws/addr/ [WS-I-Basic] � Basic Profile Version 1.1, 10 April 2006 http://www.ws-i.org/Profiles/BasicProfile-1.1-2006-04-10.html [WS-I-Bind] � Web Services-Interoperability Organization (WS-I) Simple SOAP Binding Profile Version 1.0, 24 August 2004 http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0-2004-08-24.html [WSDL11] �� Web Services Description Language (WSDL) 1.1, 15 March 2001 http://www.w3.org/TR/2001/NOTE-wsdl-20010315 [XML 10] � Extensible Markup Language (XML) 1.0, 16 August 2006 http://www.w3.org/TR/2006/REC-xml-20060816/ [XOP] �� XML-binary Optimized Packaging, W3C Recommendation, 25 January 2005 http://www.w3.org/TR/2005/REC-xop10-20050125/ 1.6.2 Non-Normative References [BioAPI] �� ISO/IEC 19784-1:2006, Information technology � Biometric Application Programming Interface � Part 1: BioAPI Specification http://www.iso.org [CBEFF-3] �� ISO/IEC19785-3:2007, Information technology � Common Biometric Exchange Formats Framework � Part 3: Patron format specifications, with Amendment 1:2010 http://www.iso.org [BIO SEC] �� ISO 19092 Financial services -- Biometrics -- Security framework http://www.iso.org [EBTS-DOD] �� Department of DefenseElectronic Biometric TransmissionSpecification, Version 2.0, 27 March 2009 http://www.biometrics.dod.mil/CurrentInitiatives/Standards/dodebts.aspx [EBTS-FBI] IAFIS-DOC-01078-8.1,� �Electronic Biometric Transmission Specification (EBTS)�, Version 8.1, November 19, 2008, Federal Bureau of Investigation, Criminal Justice Information Services Division https://www.fbibiospecs.org [EFTS] � IAFIS-DOC-01078-7,� �Electronic Fingerprint Transmission Specification (EFTS)�, Version 7.1, May 2, 2005, Federal Bureau of Investigation, Criminal Justice Information Services Division https://www.fbibiospecs.org [HR-XML] �� HR-XML Consortium Library, 2007 April 15 http://www.hr-xml.org [INT-I] �� Interpol Implementation of ANSI/NIST ITL1-2000, Ver 4.22b, October 28, 2005, The Interpol AFIS Expert Group http://www.interpol.int [NIEM] � National Information Exchange Model (NIEM), Ver 2.0, June 2007, US DOJ/DHS http://www.niem.gov [RFC2246] �� T. Dierks & C. Allen, The TLS Protocol, Version 1.0 , January 1999 http://www.ietf.org/rfc/rfc2246.txt [RFC2617] �� J. Franks, et al, HTTP Authentication: Basic and Digest Access Authentication , June 1999 http://www.ietf.org/rfc/rfc2617.txt [RFC3280] �� R. Housley, et al, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, April 2002 http://www.ietf.org/rfc/rfc3280.txt [SAML] Security Assertion Markup Language (SAML), Oasis Standard, March 2005 http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf [SAML SEC] �� Security and Privacy Considerations for the OASIS Security Assertion Markup Language (SAML) V2.0, Oasis Standard, 15 March 2005 http://docs.oasis-open.org/security/saml/v2.0/saml-sec-consider-2.0-os.pdf [SSL3] � SSL 3.0 Specification http://www.freesoft.org/CIE/Topics/ssl-draft/3-SPEC.HTM [WSS] �� Web Services Security: SOAP Message Security 1.1, (WS-Security 2004), OASIS Standard Specification, 1 February 2006 http://www.oasis-open.org/committees/download.php/16790/wss-v1.1-spec-os-SOAPMessageSecurity.pdf [X509] �� X.509: Information technology - Open Systems Interconnection - The Directory: Public-key and attribute certificate frameworks, ITU-T, August 2005 http://www.itu.int/rec/T-REC-X.509-200508-I [xNAL] �� Customer Information Quality Specifications Version 3.0: Name (xNL), Address (xAL), Name and Address (xNAL) and Party (xPIL), Committee Specification 02, 20 September 2008 http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=ciq 2 Design Concepts and Architecture (non-normative) 2.1 Philosophy Rather than define a totally new and unique messaging protocol for biometric services, this specification instead defines a method for using existing biometric and Web services standards to exchange biometric data and perform biometric operations.� 2.2 Context Today, biometric systems are being developed which collect, process, store and match biometric data for a variety of purposes.� In many cases, data and/or capabilities need to be shared between systems or systems serve a number of different client stakeholders.� As architectures move towards services-based frameworks, access to these biometric databases and services is via a Web services front-end.� However, lack of standardization in this area has led implementers to develop customized services for each system/application. BIAS is intended to provide a common, yet flexible, Web services interface that can be used within both closed and open SOA systems.� Figure 1, below, depicts the context in which the BIAS messages will be implemented. Figure 1.� BIAS Context The clients (requesters) may use standard discovery mechanisms (i.e., UDDI directories) to discover the BIAS service provider (implementation) or, particularly in closed systems, the URI/IRI and WSDL for the service provider may be known a priori by the client BIAS application developer. 2.3 Architecture BIAS Web services are intended to be used within systems employing a services framework, such as a services-oriented architecture (SOA) (although implementations are not limited to this environment).� As such, it is recognized that the clients may interact directly with the BIAS service provider or layers may exist between the client and the service provider, for example as an ESB or other application layer. The BIAS Architecture as shown in Figure 2, in which: � A Client request to the BIAS Web services may be triggered by a human interaction OR any proxy system such as an ESB. � Client sends and receives SOAP messages that conform to the BIAS schemas � Calls to the BIAS Implementation use OASIS Service Interfaces and Bindings (via WSDL) � The BIAS implementation maps the service call to the appropriate internal API or set of APIs and returns data according to the service interface. Note that services are represented as circles. Figure 2. Representative BIAS Architecture NOTE:� It is possible that BIAS may also be used between the service provider and the managed resource (e.g., a biometric matcher). At the heart of the BIAS SOAP Profile are the concepts of BIAS messages and endpoints. BIAS implementation A BIAS implementation is a software entity that is capable of creating, processing, sending, and receiving BIAS messages.� This standard does not define requirements for the BIAS implementation other than defining the messages and protocols used by the endpoints. BIAS messages A BIAS message is a one that can be sent from a BIAS endpoint to another BIAS endpoint over a TCP/IP link. BIAS endpoints A BIAS endpoint is a runtime entity, uniquely identified and accessed by an endpoint URI/IRI [ URI] [ IRI] , capable of sending and receiving BIAS messages. NOTE:� When not publicly and directly exposed, the endpoints for purposes of this specification are the BIAS service provider exposing BIAS services and the component that directly interacts with that service provider, e.g., the business application or ESB, rather than the ultimate end client requester. 3 Data dictionary This section describes the BIAS data elements used within BIAS messages (as defined in Clause 4). Common data elements are defined for use in one or more operations. These include common data types or return codes. BIAS data elements are defined in ANSI INCITS 442-2010. The elements, complex types and simple types described for the BIAS messages belong to the following namespace: http://docs.oasis-open.org/bias/ns/bias-1.0/ .� See Annex A for the XML schema. NOTE:� Biographic and biometric data included in a native XML format MAY contain elements referencing external namespaces (e.g., ansi-nist). 3.1 Documentation Conventions Each common element has a section describing its content.� Likewise, each operation has a section describing the request and response messages and the associated input and output parameters. The input and output of each message and the comment elements are detailed in a table as described in the figure below. Each field that forms part of the message request/response is detailed in the table. Header Name Description Values Value Meaning Field The name of the field. Type The XML schema type of the field. # The cardinality of the field 1 One occurrence 0..1 Zero or one occurrence 0..* Zero or more occurrences 1..* One or more occurrences ? Defines if the field must be present. Y Yes � is always required N No � is not always required, an optional field. C Conditional � requirement is dependent on system or message conditions. Meaning Gives a short description of the field�s use Figure 3. BIAS Message Input/Output Dictionary Table Headings Fields Hierarchy Explained: To denote the field hierarchy the symbol �is used to denote the child-of relationship. All string types/elements MUST consist of ISO/IEC 10646 (Unicode) characters encoded in UTF-8 [ UTF-8 ] (see ISO/IEC 10646:2003, Annex D). 3.2 Common Elements 3.2.1 ApplicationIdentifier Type: string Description: Identifies an application. Min Length: 1 Max Length: 255 3.2.2 ApplicationUserIdentifier Type: string Description: Identifies an application user or instance. Min Length: 1 Max Length: 255 3.2.3 BaseBIRType Type: Schema complexType Description: Base type for all BIR subtypes; see BinaryBIR , URI_BIR , and XML_BIR for currently available types. 3.2.4 BIASBiometricDataType Field Type # ? Meaning BIASBiometricDataType Y Wraps the various BIAS biometric types. The operations that use this type specify which elements are required. �� BIRList CBEFF_BIR_ListType 0..1 N A list of CBEFF-BIR elements. �� BIR CBEFF_BIR_Type 0..1 N Contains biometric information in either a non-XML or an XML representation. �� InputBIR CBEFF_BIR_Type 0..1 N Maps to specific INCITS BIAS elements as required by that specification. �� ReferenceBIR CBEFF_BIR_Type 0..1 N Maps to specific INCITS BIAS elements as required by that specification. �� BiometricDataList BiometricDataListType 0..1 N A list of biometric data elements. 3.2.5 BIASFaultCode Type: String Description: Error code referenced in a SOAP fault. BIASFaultCode Enumeration Values Value Description UNKNOWN_ERROR The service failed for an unknown reason. UNSUPPORTED_CAPABILITY A requested capability is not supported by the service implementation. INVALID_INPUT The data in a service input parameter is invalid. BIR_QUALITY_ERROR Biometric sample quality is too poor for the service to succeed. INVALID_BIR The input BIR is empty or in an invalid or unrecognized format. BIR_SIGNATURE_FAILURE The service could not validate the signature, if used, on the input BIR. BIR_DECRYPTION_FAILURE The service could not decrypt an encrypted input BIR. INVALID_ENCOUNTER_ID The input encounter ID is empty or in an invalid format. INVALID_SUBJECT_ID The input subject ID is empty or in an invalid format. UNKNOWN_SUBJECT The subject referenced by the input subject ID does not exist. UNKNOWN_GALLERY The gallery referenced by the input gallery ID does not exist. UNKNOWN_ENCOUNTER The encounter referenced by the input encounter ID does not exist. UNKNOWN_BIOGRAPHIC_FORMAT The biographic data format is not known or not supported. UNKNOWN_IDENTITY_CLAIM The identity referenced by the input identity claim does not exist. INVALID_IDENTITY_CLAIM The identity claim requested is already in use. NONEXISTANT_DATA The data requested for deletion does not exist. NOTES:� (1) See Clause 6 (Error handling) for an explanation of BIAS faults and return codes. (2) Service provider MAY define additional values specific to their service implementation. (3) See section 5.5 for additional information on BIAS security. 3.2.6 BIASFaultDetail Field Type # ? Meaning BIASFaultDetail Y Defines the error information associated with a SOAP fault. �� BIASFaultType BIASFaultCode 1 Y References an error code. �� BIASFaultMessage string 1 Y Provides a brief explanation of the fault. �� BIASFaultDescription string 0..1 N Provides detailed information about a BIAS fault, such as trace details. 3.2.7 BIASIdentity Field Type # ? Meaning BIASIdentity Y Defines a single element for encapsulating the data associated with an Identity. Includes the Identity�s reference identifiers, biographic data, and biometric data. The operations that use this type specify which elements are required. �� SubjectID BIASIDType 0..1 C A system unique identifier for a subject. Required as input to many operations. �� IdentityClaim BIASIDType 0..1 N An identifier by which a subject is known to a particular gallery or population group. �� EncounterID BIASIDType 0..1 C The identifier of an encounter associated with the subject. Required for encounter-centric models. �� EncounterList EncounterListType 0..1 N A list of encounters associated with a subject. �� BiographicData BiographicDataType 0..1 N An Identity�s biographic data. �� BiographicDataElements BiographicDataType 0..1 N An Identity�s biographic data elements that are stored in the implementing system. �� BiometricData BIASBiometricDataType 0..1 N An Identity�s biometric data. 3.2.8 BIASIDType Type: string Description: A BIAS Identifier. 3.2.9 BinaryBIR Field Type # ? Meaning BinaryBIR BaseBIRType Y Defines a BIR type of Binary �� Binary base64Binary 1 Y BIR information in base64 binary format 3.2.10 BiographicDataItemType Field Type # ? Meaning BiographicDataItemType Y Defines a single biographic data element. �� Name string 1 Y The name of the biographic data item. �� Type string 1 Y The data type for the biographic data item. �� Value string 0..1 N The value assigned to the biographic data item. NOTE:� This element can be used to transmit scanned identity documents or document information (e.g., passports, driver�s license, birth certificates, utility bills, etc. required to establish an identity). 3.2.11 BiographicDataSetType Field Type # ? Meaning BiographicDataSetType Y Defines a set of biographic data that is formatted according to the specified format. �� name string 1 Y The name of the biographic data format. Use these names for common formats: FBI-EFTS [ EFTS] , FBI-EBTS [ EBTS-FBI] , DOD-EBTS [ EBTS-DOD] , INT-I [INT-I] , NIEM [ NIEM] , xNAL [ xNAL] , HR-XML [ HR-XML ]. �� version string 0..1 N The version of the biographic data format (e.g., �7.1� for FBI-EFTS or �2.0� for NIEM). �� source string 1 Y Reference to a URI/IRI describing the biographic data format. For example: (FBI-EFTS and FBI-EBTS) www.fbibiospecs.org, (DOD-EBTS) www.biometrics.dod.mil, (INT-I) www.interpol.int, (NIEM) www.niem.gov, (xNAL) www.oasis-open.org, (HR-XML) www.hr-xml.org. �� type string 1 Y The biographic data format type. Use these types for common formats: ASCII (e.g., for non-XML versions of FBI-EFTS, FBI-EBTS, DOD-EBTS, or INT-I), XML (e.g., for NIEM, xNAL, and HR-XML or future versions of FBI-EBTS). �� unspecified any 0..* N Biographic data formatted according to a specific format. NOTE:� Biographic data formats are not limited to those listed.� The string value is not enumerated.� If one of the common types are used, it MUSTbe indicated by the specified name values; however, the service provider MAY offer other formats.� See INCITS 442 for further information. 3.2.12 BiographicDataType Field Type # ? Meaning BiographicDataType Y Defines a set of biographic data elements, utilizing either the BiographicDataItemType to represent a list of elements or the BiographicDataSetType to represent a complete, formatted set of biographic information. One of the following elements must be present. �� LastName string 0..1 N The last name of a subject. �� FirstName string 0..1 N The first name of a subject. �� BiographicDataItems BiographicDataItemType 0..1 N A list of biographic data elements. �� BiographicDataItems BiographicDataItemType 1..* N A single biographic data element. �� BiographicDataSet BiographicDataSetType 0..1 N A set of biographic data information. NOTE:� The implementer is given three choices for encoding biographic data: � Encode only first and last name using the defined fields within BiographicDataType � Define a list of biographic data elements using the BiographicDataItemType � Use a pre-defined set of biographic data (e.g., as specified in another standard) using the BiographicDataSetType. See also INCITS 442, section 8.1 for further information. 3.2.13 BiometricDataElementType Field Type # ? Meaning BiometricDataElementType Y Provides descriptive information about biometric data, such as the biometric type, subtype, and format, contained in the BDB of the CBEFF-BIR. �� BiometricType oasis_cbeff:MultipleTypesType 1 Y The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. �� BiometricTypeCount positiveInteger 0..1 N The number of biometric records having the biometric type recorded in the biometric type field. �� BiometricSubType oasis_cbeff:SubtypeType 0..1 N More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF. �� BDBFormatOwner positiveInteger 1 Y Identifies the standards body, working group, industry consortium, or other CBEFF biometric organization that has defined the format for the biometric data. �� BDBFormatType positiveInteger 1 Y Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field. 3.2.14 BiometricDataListType Field Type # ? Meaning BiometricDataListType Y A list of biometric data elements. �� BiometricDataElement 3.2.13 BiometricDataElementType 0..* N Data structure containing information about a biometric record. 3.2.15 CandidateListResultType Field Type # ? Meaning CandidateListResultType Y Defines a set of candidates, utilizing the CandidateType to represent each element in the set. �� CandidateList 3.2.16 CandidateListType 1 Y The candidate list. 3.2.16 CandidateListType Field Type # ? Meaning CandidateListType Y Defines a set of candidates, utilizing the CandidateType to represent each element in the set. �� Candidate CandidateType 0..* N A single candidate. 3.2.17 CandidateType Field Type # ? Meaning CandidateType Y Defines a single candidate as a possible match in response to a biometric identification request. �� Score Score 0..1 N The match score. �� Rank integer 1 Y The rank of the candidate in relation to other candidates for the same biometric identification operation. �� BiographicData BiographicDataType 0..1 N Biographic data associated with the candidate match. �� BIRList CBEFF_BIR_ListType 1 Y Biometric data associated with the candidate match. 3.2.18 CapabilityListType Field Type # ? Meaning CapabilityListType Y Defines a set of capabilities. �� Capability CapabilityType 0..* N A single capability. 3.2.19 CapabilityName Type: string Description: A list of capability items. CapabilityName Enumeration Values Value Description AggregateInputDataOptional A data element accepted as optional input by the implementing system for the aggregate services. AggregateInputDataRequired A data element required as input by the implementing system for the aggregate services. AggregateProcessingOption A processing option supported by the implementing system for the aggregate services. AggregateReturnData A data element returned by the implementing system for the aggregate services. AggregateServiceDescription Describes the processing logic of an aggregate service supported by the implementing system. BiographicDataSet Identifies a biographic data set supported by the implementing system. CBEFFPatronFormat A patron format supported by the implementing system. ClassificationAlgorithmType A classification algorithm type supported by the implementing system. ConformanceClass Identifies the conformance class of the BIAS implementation. Gallery A gallery or population group supported by the implementing system. IdentityModel Identifies whether the implementing system is person-centric or encounter-centric based. MatchScore Identifies the use of match scores returned by the implementing system. QualityAlgorithm A quality algorithm vendor and algorithm vendor product ID supported by the implementing system. SupportedBiometric A biometric type supported by the implementing system. TransformOperation A transform operation type supported by the implementing system. 3.2.20 CapabilityType Field Type # ? Meaning CapabilityType Y Defines a single capability supported by an implementing system. �� CapabilityName CapabilityName 1 Y The name of the capability. �� CapabilityID string 0..1 N An identifier assigned to the capability by the implementing system. �� CapabilityDescription string 0..1 N A description of the capability. �� CapabilityValue string 0..1 N A value assigned to the capability. �� CapabilitySupportingValue string 0..1 N A secondary value supporting the capability. �� CapabilityAdditionalInfo string 0..1 N Contains additional information for the supported capability. 3.2.21 CBEFF_BIR_ListType Field Type # ? Meaning CBEFF_BIR_ListType Y A list of CBEFF-BIR elements. �� BIR CBEFF_BIR_Type 0..* N CBEFF structure containing information about a biometric sample. 3.2.22 CBEFF_BIR_Type Field Type # ? Meaning CBEFF_BIR_Type Y Represents biometric information, with either a non-XML or XML representation. �� FormatOwner positiveInteger 1 Y Identifies the Patron format owner. �� FormatType positiveInteger 1 Y Identifies the Patron format type. �� BIR_Information 0..1 N Describes what is contained in a BIR. �� BIR_Info oasis_cbeff:BIRInfoType 0..1 N Contains information about the CBEFF-BIR. �� BDB_Info oasis_cbeff:BDBInfoType 0..1 N Contains information about the BDB in a simple CBEFF-BIR. �� SB_Info oasis_cbeff:SBInfoType 0..1 N Contains information about the security block, if used, in a simple CBEFF-BIR. �� BIR BaseBIRType 1 Y One of the following sub-elements must be present: BinaryBIR , URI_BIR , or XML_BIR . NOTE:� The implementer is given three choices for encoding a BIR: As an XML BIR (following the XML Patron format as specified in Annex B) As a reference to a URI (from which the receiver would retrieve the actual BIR) As a complete Base64 encoded binary (non-XML) BIR. The latter two alternatives can use any CBEFF Patron Format.� The optional BIR_Information provides a mechanism for exposing metadata associated with a BIR format that is not easily decoded (i.e., a non-XML BIR).� See section 5.3 for more information on handling of binary data within BIAS and INCITS 442, Clause 8.2, for more information on representing biometric data. NOTE:� (1) XML BIRs MUST conform to the XML patron format in Annex B; however, non-XML (binary) and URI BIRs MAY implement any CBEFF patron format. (2) It is RECOMMENDED that only registered CBEFF patron formats be used; however, in closed systems, this may not be required. 3.2.23 Classification Type: string Description: The result of a classification. 3.2.24 ClassificationAlgorithmType Type: string Description: Type of classification algorithm that was used to perform the classification. 3.2.25 ClassificationData Field Type # ? Meaning ClassificationData Y Contains information on classification results and the algorithm used to determine the classification. �� Classification Classification 1 Y The result of the classification. �� ClassificationAlgorithmType ClassificationAlgorithmType 1 Y Identifies the type of classification algorithm that was used to perform the classification. 3.2.26 EncounterListType Field Type # ? Meaning EncounterListType Y Defines a set of encounters. �� EncounterID BIASIDType 0..* N The identifier of an encounter. 3.2.27 FusionDecision Type: string Description: The match decision assigned by the matching algorithm 3.2.28 FusionInformationListType Field Type # ? Meaning FusionInformationListType Y Contains at a minimum two sets of fusion input elements, as input to the PerformFusion operation. �� FusionElement FusionInformationType 2..* Y A set of fusion information. 3.2.29 FusionInformationType Field Type # ? Meaning FusionInformationType Y Represents the information necessary to perform a fusion operation. �� BiometricType oasis_cbeff:MultipleTypesType 1 Y The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. �� BiometricSubType oasis_cbeff: SubtypeType 0..1 N More specifically defines the type of biometric data stored in the biometric record. �� AlgorithmOwner string 1 Y The owner or vendor of the algorithm used to determine the score or decision. �� AlgorithmType string 1 Y The Algorithm Owner�s identifier for the specific algorithm product and version used to determine the score or decision. �� FusionResult FusionResult 0..1 C Either FusionScore or a FusionDecision element MUST be used. 3.2.30 FusionResult Type: complexType Description: The base type for any resulting types which indicate the status of a Fusion operation 3.2.31 FusionScore Type: Score Description: The similarity score assigned by the matching algorithm. 3.2.32 GenericRequestParameters Field Type # ? Meaning GenericRequestParameters Y Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested. NOTE:� See section 5.4 for alternatives for identifying the requested BIAS operation in a BIAS SOAP message. 3.2.33 IdentifySubjectResultType Description: A base type for all types that could be returned from the IdentifySubject operation 3.2.34 InformationType Field Type # ? Meaning InformationType Y Allows for an unlimited number of data element types, and it does not specify nor require any particular data element. �� unspecified any 0..* N 3.2.35 ListFilterType Field Type # ? Meaning ListFilterType Y Provides a method to filter the amount of information returned in a search of biometric data. �� BiometricTypeFilters 1 Y �� BiometricTypeFilter oasis_cbeff:MultipleTypesType 1..* Y Limits the returned information to a specific type of biometric, as defined by CBEFF. �� IncludeBiometricSubType boolean 1 Y A Boolean flag indicating if biometric subtype information should be returned. 3.2.36 MatchType Type: boolean Description: The result of a fusion method. 3.2.37 ProcessingOptionsType Field Type # ? Meaning ProcessingOptionsType Y BIAS aggregate operations support the ability to include various processing options which direct and possibly control the business logic for that operation. The ProcessingOptionsType provides a method to represent those options. Processing options SHOULD be defined by the implementing system. �� Option string 0..* N An option supported by the implementing system. 3.2.38 ProductID Type: string Description: The vendor�s ID for a particular product. 3.2.39 QualityData Field Type # ? Meaning QualityData Y Contains information about a biometric sample�s quality and the algorithm used to compute the quality. �� QualityScore oasis_cbeff:QualityType 0..1 N The quality of a biometric sample. �� AlgorithmVendor VendorIdentifier 1 Y The vendor of the quality algorithm used to determine the quality score. �� AlgorithmVendorProductID ProductID 1 Y The vendor�s ID for the algorithm used to determine the quality. �� AlgorithmVersion VersionType 0..1 N The version of the algorithm used to determine the quality. 3.2.40 ResponseStatus Field Type # ? Meaning ResponseStatus Y �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 3.2.41 ReturnCode Type: unsignedLong Description: Return value specifying success or other condition. ReturnCode Enumeration Values Value Description 0 Success 3.2.42 Score Type: float Description: Match result or quality score. NOTE:� Matching scores MAY be in a standardized or proprietary form in terms of value range and interpretation.� Quality scores, however, follow the definition found in Annex B. 3.2.43 TokenResultType Field Type # ? Meaning TokenResultType Y Defines a token that is returned for asynchronous processing. �� TokenType TokenType 1 Y Defines a token that is returned for asynchronous processing. 3.2.44 TokenType Field Type # ? Meaning TokenType Y Defines a token that is returned for asynchronous processing. �� TokenValue string 1 Y A value returned by the implementing system that is used to retrieve the results to an operation at a later time. �� Expiration date 1 Y A date and time at which point the token expires and the operation results are no longer guaranteed to be available. NOTE:� Date/time format is defined in INCITS 442 and is consistent with the date format specified in Annex B and ISO 8601 [ DATE-TIME] .See also Annex A for schema definition. 3.2.45 URI_BIR Field Type # ? Meaning URI_BIR BaseBIRType Y Defines a BIR type of Binary �� URI anyURI 1 Y The URI of the BIR 3.2.46 VendorIdentifier Type: string Description: Identifies a vendor. NOTE:� Vendor identifiers are registered with IBIA as the CBEFF registration authority (see ISO/IEC 19785-2).� Registered biometric organizations are listed at: http://www.ibia.org/cbeff/_biometric_org.php . 3.2.47 Version Field Type # ? Meaning Version Y For a description or definition of each data element, see the referenced CBEFF standards in the 3.2.22 CBEFF_BIR_Type schema. �� major nonNegativeInteger 1 Y �� minor nonNegativeInteger 1 Y 3.2.48 VersionType Type: string Description: The version of a component. 3.2.49 XML_BIR Field Type # ? Meaning XML_BIR BaseBIRType Y Defines a BIR type of Binary �� XML Oasis_cbeff:BIRType 1 Y BIR information in XML format 4 BIAS Messages This section describes the BIAS messages implementing BIAS operations as defined in ANSI INCITS 442-2010.� The operations are listed alphabetically, with each operation containing a request and a response message.� The tables follow the conventions described in section 3.1. 4.1 Primitive Operations 4.1.1 AddSubjectToGallery AddSubjectToGalleryRequest AddSubjectToGalleryResponse The AddSubjectToGallery operation registers a subject to a given gallery or population group. As an OPTIONAL parameter, the value of the claim to identity by which the subject is known to the gallery MAY be specified. This claim to identity MUST be unique across the gallery. If no claim to identity is specified, the subject ID (assigned with the CreateSubject operation) will be used as the claim to identity. Additionally, in the encounter-centric model, the encounter ID associated with the subject�s biometrics that will be added to the gallery MUST be specified. Request Message Field Type # ? Meaning AddSubjectToGallery Y Register a subject to a given gallery or population group. AddSubjectToGalleryRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �AddSubjectToGallery�. �� GalleryID BIASIDType 1 Y The identifier of the gallery or population group to which the subject will be added. �� Identity BIASIdentity 1 Y The identity to add to the gallery. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� IdentityClaim BIASIDType 0..1 N An identifier by which a subject is known to a particular gallery or population group. (This could be a username or account number, for example.) �� EncounterID BIASIDType 0..1 C The identifier of an encounter associated with the subject. Required for encounter-centric models. Response Message Field Type # ? Meaning AddSubjectToGalleryResponse Y The response to an AddSubjectToGallery operation. AddSubjectToGalleryResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 4.1.2 CheckQuality CheckQualityRequest CheckQualityResponse The CheckQuality operation returns a quality score for a given biometric. The biometric input is provided in a CBEFF basic structure or CBEFF record, which in this specification is called a CBEFF-BIR. The algorithm vendor and algorithm vendor product ID MAY be optionally provided in order to request a particular algorithm�s use in calculating the biometric quality. If an algorithm vendor is provided then the algorithm vendor product ID is REQUIRED. If no algorithm vendor is provided, the implementing system will provide the algorithm vendor and algorithm vendor product ID that were used to calculate the biometric quality as output parameters. Request Message Field Type # ? Meaning CheckQuality Y Calculate a quality score for a given biometric. CheckQualityRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �CheckQuality�. �� BiometricData BIASBiometricDataType 1 Y Data structure containing a single biometric sample for which a quality score is to be determined. �� BIR CBEFF_BIR_Type 1 Y The biometric sample. �� Quality QualityData 0..1 N Specifies a particular algorithm vendor and vender product ID. �� AlgorithmVendor VendorIdentifier 1 Y The vendor of the quality algorithm used to determine the quality score. �� AlgorithmVendorProductID ProductID 1 Y The vendor�s ID for the algorithm used to determine the quality. Response Message Field Type # ? Meaning CheckQualityResponse Y The response to a CheckQuality operation. CheckQualityResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� QualityInfo QualityData 1 Y Contains the quality information for the submitted biometric sample. �� QualityScore oasis_cbeff:QualityType 0..1 N The quality of a biometric sample. �� AlgorithmVendor VendorIdentifier 1 Y The vendor of the quality algorithm used to determine the quality score. �� AlgorithmVendorProductID ProductID 1 Y The vendor�s ID for the algorithm used to determine the quality. �� AlgorithmVersion VersionType 1 Y The version of the algorithm used to determine the quality. 4.1.3 ClassifyBiometricData ClassifyBiometricDataRequest ClassifyBiometricDataResponse The ClassifyBiometricData operation attempts to classify a biometric sample. For example, a fingerprint biometric sample may be classified as a whorl, loop, or arch (or other classification classes and sub-classes). To obtain the types of classification algorithms and classes, see the QueryCapabilities operation. Request Message Field Type # ? Meaning ClassifyBiometricData Y Classifies a biometric sample. ClassifyBiometricDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �ClassifyBiometricData�. �� BiometricData BIASBiometricDataType 1 Y Data structure containing a single biometric sample for which the classification is to be determined. �� BIR CBEFF_BIR_Type 1 Y The biometric sample. Response Message Field Type # ? Meaning ClassifyBiometricDataResponse Y The response to a ClassifyBiometricData operation, containing the classification of a biometric sample. ClassifyBiometricDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ClassificationData ClassificationData 1 Y Information on the results and type of classification performed. �� Classification Classification 1 Y The result of the classification. �� ClassificationAlgorithmType ClassificationAlgorithmType 1 Y Identifies the type of classification algorithm that was used to perform the classification. 4.1.4 CreateSubject CreateSubjectRequest CreateSubjectResponse The CreateSubject operation creates a new subject record and associates a subject ID to that record. As an optional parameter, the subject ID MAY be specified by the caller. If no subject ID is specified, the CreateSubject operation will generate one. Request Message Field Type # ? Meaning CreateSubject Y CreateSubjectRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �CreateSubject�. Response Message Field Type # ? Meaning CreateSubjectResponse Y The response to a CreateSubject operation, containing the subject ID of the new subject record. CreateSubjectResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Identity BIASIdentity 1 Y �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. 4.1.5 DeleteBiographicData DeleteBiographicDataRequest DeleteBiographicDataResponse The DeleteBiographicData operation erases all of the biographic data associated with a given subject record. In the encounter-centric model the operation erases all of the biographic data associated with a given encounter, and therefore the encounter ID MUST be specified. When deleting data, BIAS implementations MAY completely erase the information in order to prevent the ability to reconstruct a record in whole or in part, or they MAY track and record the deleted information for auditing and/or quality control purposes. Request Message Field Type # ? Meaning DeleteBiographicData Y Erase all of the biographic data associated with a given subject record or, in the encounter-centric model, with a given encounter. DeleteBiographicDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �DeleteBiographicData�. �� Identity BIASIdentity 1 Y �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 C The identifier of an encounter associated with the subject. Required for encounter-centric models. Response Message Field Type # ? Meaning DeleteBiographicDataResponse Y The response to a DeleteBiographicData operation. DeleteBiographicDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 4.1.6 DeleteBiometricData DeleteBiometricDataRequest DeleteBiometricDataResponse The DeleteBiometricData operation erases all of the biometric data associated with a given subject record. In the encounter-centric model the operation erases all of the biometric data associated with a given encounter, and therefore the encounter ID MUST be specified. When deleting data, BIAS implementations MAY completely erase the information in order to prevent the ability to reconstruct a record in whole or in part, or they MAY track and record the deleted information for auditing and/or quality control purposes. Request Message Field Type # ? Meaning DeleteBiometricData Y Erase all of the biometric data associated with a given subject record or, in the encounter-centric model, with a given encounter. DeleteBiometricDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �DeleteBiometricData�. �� Identity BIASIdentity 1 Y �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 C The identifier of an encounter associated with the subject. Required for encounter-centric models. Response Message Field Type # ? Meaning DeleteBiometricDataResponse Y The response to a DeleteBiometricData operation. DeleteBiometricDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 4.1.7 DeleteSubject DeleteSubjectRequest DeleteSubjectResponse The DeleteSubject operation deletes an existing subject record and, in an encounter-centric model, any associated encounter information from the system. This operation also removes the subject from any registered galleries. When deleting a subject, BIAS implementations MAY completely erase the subject information in order to prevent the ability to reconstruct a record or records in whole or in part, or they MAY track and record the deleted information for auditing and/or quality control purposes. Request Message Field Type # ? Meaning DeleteSubject Y Delete an existing subject record and, in an encounter-centric model, any associated encounter information. DeleteSubjectRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �DeleteSubject�. �� Identity BIASIdentity 1 Y The identity of the subject to delete. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. Response Message Field Type # ? Meaning DeleteSubjectResponse Y The response to a DeleteSubject operation. DeleteSubjectResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 4.1.8 DeleteSubjectFromGallery DeleteSubjectFromGalleryRequest DeleteSubjectFromGalleryResponse The DeleteSubjectFromGallery operation removes the registration of a subject from a gallery or population group. The subject is identified by either the subject ID or the claim to identity that was specified in the AddSubjectToGallery operation. Request Message Field Type # ? Meaning DeleteSubjectFromGallery Y Remove the registration of a subject from a gallery or population group. DeleteSubjectFromGalleryRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �DeleteSubjectFromGallery�. �� GalleryID BIASIDType 1 Y The identifier of the gallery or population group from which the subject will be deleted. �� Identity BIASIdentity 1 Y The identity to remove from the gallery. �� SubjectID BIASIDType 0..1 C A system unique identifier for a subject. Required if an Identity Claim is not provided. �� IdentityClaim BIASIDType 0..1 C An identifier by which a subject is known to a particular gallery or population group. Required if a Subject ID is not provided. Response Message Field Type # ? Meaning DeleteSubjectFromGalleryResponse Y The response to a DeleteSubjectFromGallery operation. DeleteSubjectFromGalleryResponsePackage �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 4.1.9 GetIdentifySubjectResults GetIdentifyResultsRequest GetIdentifySubjectResultsResponse The GetIdentifySubjectResults operation retrieves the identification results for the specified token. This opereation is used in conjunction with the IdentifySubject operation. If the IdentifySubject operation is implemented as an asynchronous service, the implementing system returns a token and the GetIdentifySubjectResults operation is used to poll for the results of the original IdentifySubject request. Request Message Field Type # ? Meaning GetIdentifySubjectResults Y Retrieve the identification results for a specified token, which was returned by the IdentifySubject operation. GetIdentifySubjectResultsRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �GetIdentifySubjectResults�. �� Token TokenType 1 Y A value used to retrieve the results of an IdentifySubject request. �� TokenValue string 1 Y A value returned by the implementing system that is used to retrieve the results to an operation at a later time. �� Expiration date 1 Y A date and time at which point the token expires and the operation results are no longer guaranteed to be available. Response Message Field Type # ? Meaning GetIdentifySubjectResultsResponse Y The response to a GetIdentifySubjectResults operation, which includes a candidate list. GetIdentifySubjectResultsResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� CandidateList CandidateListType 1 Y A rank-ordered list of candidates that have a likelihood of matching the input biometric sample. �� Candidate CandidateType 0..* N A single candidate. �� Score Score 0..1 N The match score. �� BiographicData BiographicDataType 0..1 N Biographic data associated with the candidate match. �� BIRList CBEFF_BIR_ListType 1 Y Biometric data associated with the candidate match. �� BIR CBEFF_BIR_Type 0..* N CBEFF structure containing information about a biometric sample. 4.1.10 IdentifySubject IdentifySubjectRequest IdentifySubjectResponse The IdentifySubject operation performs an identification search against a given gallery for a given biometric, returning a rank-ordered candidate list of a given maximum size. If the IdentifySubject operation is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the candidate list. If the IdentifySubject operation is implemented as an asynchronous service, the implementing system returns a token, which is an indication that the request is being handled asynchronously. In this case, the GetIdentifySubjectResults operation is used to poll for the results of the IdentifySubject request. Request Message Field Type # ? Meaning IdentifySubject Y Perform an identification search against a given gallery for a given biometric. IdentifySubjectRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �IdentifySubject�. �� GalleryID BIASIDType 1 Y The identifier of the gallery or population group which will be searched. �� Identity BIASIdentity 1 Y Contains the BIR, a data structure containing the biometric sample for the search. �� BiometricData BIASBiometricDataType 1 Y An Identity�s biometric data. �� BIR CBEFF_BIR_Type 1 Y Contains biometric information in either a non-XML or an XML representation. �� MaxListSize positiveInteger 1 Y The maximum size of the candidate list that should be returned. Response Message Field Type # ? Meaning IdentifySubjectResponse Y The response to an IdentifySubject operation, returning a rank-ordered candidate list. IdentifySubjectResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� CandidateList CandidateListResultType (see IdentifySubjectResultType ) 0..1 C A rank-ordered list of candidates that have a likelihood of matching the input biometric sample (i.e., exceed the system threshold). Rank ordering is from highest to lowest match score. Returned with successful synchronous request processing. �� Candidate CandidateType 0..* N A single candidate. �� Score string 0..1 N The match score. �� BiographicData BiographicDataType 0..1 N Biographic data associated with the candidate match. �� BIRList CBEFF_BIR_ListType 1 Y Biometric data associated with the candidate match. �� BIR CBEFF_BIR_Type 0..* N CBEFF structure containing information about a biometric sample. �� Token TokenResultType (see IdentifySubjectResultType ) 0..1 C A token used to retrieve the results of the IdentifySubject operation. Returned with asynchronous request processing. �� TokenValue string 1 Y A value returned by the implementing system that is used to retrieve the results to an operation at a later time. �� Expiration date 1 Y A date and time at which point the token expires and the operation results are no longer guaranteed to be available. NOTES:� (1) In the event that the number of candidates exceeding the threshold exceeds the MaxListSize, the system will determine which candidate is included in the last position of the rank ordered candidate list (i.e., in the event of a tie). (2) Requesters MAY NOT change the system thresholds. 4.1.11 ListBiographicData ListBiographicDataRequest ListBiographicDataResponse The ListBiographicData operation lists the biographic data elements stored for a subject using the Biographic Data Elements output parameter. Note that no actual biographic data is returned by this operation (see the RetrieveBiographicInformation operation to obtain the biographic data). In the encounter-centric model, an encounter ID MAY be specified to indicate that only the biographic data elements stored for that encounter should be returned. If an encounter ID is not specified and encounter data exists for the subject, the operation returns the list of encounter IDs which contain biographic data using the Encounter List output parameter, and the Biographic Data Elements output parameter is empty. Request Message Field Type # ? Meaning ListBiographicData Y Lists the biographic data elements stored for a subject. ListBiographicDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �ListBiographicData�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 N The identifier of an encounter associated with the subject. Response Message Field Type # ? Meaning ListBiographicDataResponse Y The response to a ListBiographicData request, containing a list of biographic data elements stored for a subject. In the encounter-centric model, the biographic data elements for a specific encounter are returned. If an encounter ID is not specified and encounter data exists for the subject, the list of encounter IDs which contain biographic data is returned. ListBiographicDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Identity BIASIdentity 1 Y Contains a list of biographic data elements associated with a subject or encounter; non-empty if the service was successful, biographic data exists, and either (a) the person-centric model is being used or (b) the encounter-centric model is being used and an encounter identifier was specified. �� BiographicDataElements BiographicDataType 0..1 C An Identity�s biographic data elements that are stored in the implementing system. �� BiographicDataItem BiographicDataItemType 0..* N A single biographic data element. �� Name string 1 Y The name of the biographic data item. �� Type string 1 Y The data type for the biographic data item. �� EncounterList EncounterListType 0..1 C A list of encounter ID�s associated with a subject and which contain biographic data; non-empty if the service was successful, biographic data exists, the encounter-centric model is being used, and an encounter identifier was not specified. �� EncounterID BIASIDType 0..* N The identifier of an encounter. 4.1.12 ListBiometricData ListBiometricDataRequest ListBiometricDataResponse The ListBiometricData operation lists the biometric data elements stored for a subject using the Biometric Data List output parameter. Note that no actual biometric data is returned by this operation (see the RetrieveBiometricInformation operation to obtain the biometric data). In the encounter-centric model, an encounter ID MAY be specified to indicate that only the biometric data elements stored for that encounter should be returned. If an encounter ID is not specified and encounter data exists for the subject, the operation returns the list of encounter IDs which contain biometric data using the Encounter List output parameter, and the Biometric Data List output parameter is empty. An optional parameter MAY be used to indicate a filter on the list of returned data. Such a filter may indicate that only biometric types should be listed (e.g., face, finger, iris, etc.) or that only biometric subtypes for a particular biometric type should be listed (e.g., all fingerprints: left slap, right index, etc.). If a filter is not specified, all biometric type and biometric subtype information are listed (e.g., left index finger, right iris, face frontal, etc.). Request Message Field Type # ? Meaning ListBiometricData Y Lists the biometric data elements stored for a subject. ListBiometricDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �ListBiometricData�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 N The identifier of an encounter associated with the subject. �� ListFilterType ListFilterType 0..1 N Indicates what biometric information should be returned. �� BiometricTypeFilter oasis_cbeff:MultipleTypesType 1..* Y Limits the returned information to a specific type of biometric, as defined by CBEFF. �� IncludeBiometricSubType boolean 1 Y A Boolean flag indicating if biometric subtype information should be returned. Response Message Field Type # ? Meaning ListBiometricDataResponse Y The response to a ListBiometricData operation, containing a list of biometric data elements stored for a subject. In the encounter-centric model, the biometric data elements for a specific encounter are returned. If an encounter ID is not specified and encounter data exists for the subject, the list of encounter IDs which contain biometric data is returned. ListBiometricDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Identity BIASIdentity 0..1 N Includes a list of biometric data elements associated with a subject or encounter or a list of encounter ID�s associated with a subject and which contain biometric data. �� BiometricData BIASBiometricDataType 0..1 C An Identity�s biometric data. �� BiometricDataList BiometricDataListType 0..1 N A list of biometric data elements. �� BiometricDataElement BiometricDataElementType 1..* Y Data structure containing information about a biometric record. �� BiometricType oasis_cbeff:MultipleTypesType 1 Y The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. �� BiometricTypeCount positiveInteger 0..1 N The number of biometric records having the biometric type recorded in the biometric type field. �� BiometricSubType oasis_cbeff:SubtypeType 0..1 N More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF. �� BDBFormatOwner positiveInteger 1 Y Identifies the standards body, working group, industry consortium, or other CBEFF biometric organization that has defined the format for the biometric data. �� BDBFormatType positiveInteger 1 Y Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field. �� EncounterList EncounterListType 0..1 C A list of encounter ID�s associated with a subject and which contain biometric data; non-empty if the service was successful, biometric data exists, the encounter-centric model is being used, and an encounter identifier was not specified. �� EncounterID BIASIDType 1..* Y The identifier of an encounter. 4.1.13 PerformFusion PerformFusionRequest PerformFusionResponse The PerformFusion operation accepts either match score or match decision information and creates a fused match result. The FusionInformationListType , through the FusionInformationType , provides specific elements for match score input and match decision input. The fusion method and processes are left to the implementing system. Request Message Field Type # ? Meaning PerformFusion Y Accepts either match score or match decision information and creates a fused match result. PerformFusionRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �PerformFusion�. �� FusionInput FusionInformationListType 1 Y Score or decision input information to the fusion method. �� FusionElement FusionInformationType 2..* Y A set of fusion information. �� BiometricType oasis_cbeff:MultipleTypesType 1 Y The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. �� BiometricSubType oasis_cbeff:SubtypeType 0..1 N More specifically defines the type of biometric data stored in the biometric record. �� AlgorithmOwner string 1 Y The owner or vendor of the algorithm used to determine the score or decision. �� AlgorithmType string 1 Y The Algorithm Owner�s identifier for the specific algorithm product and version used to determine the score or decision. �� FusionResult FusionResult 0..1 C Either FusionScore �or a FusionDecision element MUST be used. Response Message Field Type # ? Meaning PerformFusionResponse Y The response to the PerformFusion operation. PerformFusionResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Match MatchType 1 1 Indicates the result of the fusion method. 4.1.14 QueryCapabilities QueryCapabilitiesRequest QueryCapabilitiesResponse The QueryCapabilities operation returns a list of the capabilities, options, galleries, etc. that are supported by the BIAS implementation. Refer to Annex A in the INCITS BIAS standard [ INCITS-BIAS ] for conformance requirements regarding which capability names an implementation must use in the QueryCapabilities operation. Request Message Field Type # ? Meaning QueryCapabilities Y Returns a list of the capabilities, options, galleries, etc. that are supported by the BIAS implementation. QueryCapabilitiesRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �QueryCapabilities�. Response Message Field Type # ? Meaning QueryCapabilitiesResponse Y The response to a QueryCapabilities operation. QueryCapabilitiesResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� CapabilityList CapabilityListType 1 Y A list of capabilities supported by the BIAS implementation. �� Capability CapabilityType 0..* N A single capability. �� CapabilityName CapabilityName 1 Y The name of the capability. �� CapabilityID string 0..1 N An identifier assigned to the capability by the implementing system. �� CapabilityDescription string 0..1 N A description of the capability. �� CapabilityValue string 0..1 N A value assigned to the capability. �� CapabilitySupportingValue string 0..1 N A secondary value supporting the capability. �� CapabilityAdditionalInfo string 0..1 N Contains additional information for the supported capability. 4.1.15 RetrieveBiographicInformation RetrieveBiographicInformationRequest RetrieveBiographicInformationResponse The RetrieveBiographicInformation operation retrieves the biographic data associated with a subject ID. In the encounter-centric model, the encounter ID MAY be specified and the operationwill return the biographic data associated with that encounter. If the encounter ID is not specified in the encounter-centric model, the operation returns the biographic information associated with the most recent encounter. Request Message Field Type # ? Meaning RetrieveBiographicInformation Y Retrieves the biographic data associated with a subject ID. RetrieveBiographicInformationRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �RetrieveBiographicInformation�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 N The identifier of an encounter associated with the subject. Response Message Field Type # ? Meaning RetrieveBiographicInformationResponse Y The response to a RetrieveBiographicInformation operation. RetrieveBiographicInformationResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Identity BIASIdentity 1 Y Includes the set of biographic data associated with a subject. �� BiographicData BiographicDataType 1 Y An Identity�s biographic data. One of the following elements MUST be present. �� LastName string 0..1 C The last name of a subject. �� FirstName string 0..1 C The first name of a subject. �� BiographicDataItem BiographicDataItemType 0..* C A single biographic data element. �� BiographicDataSet BiographicDataItemType 0..1 C A set of biographic data information. 4.1.16 RetrieveBiometricInformation RetrieveBiometricInformationRequest RetrieveBiometricInformationResponse The RetrieveBiometricInformation operation retrieves the biometric data associated with a subject ID. In the encounter-centric model, the encounter ID MAY be specified and the operationwill return the biometric data associated with that encounter. If the encounter ID is not specified in the encounter-centric model, the operation returns the biometric information associated with the most recent encounter.The operation provides an OPTIONAL input parameter to specify that only biometric data of a certain type should be retrieved. Request Message Field Type # ? Meaning RetrieveBiometricInformation Y Retrieves the biometric data associated with a subject ID. RetrieveBiometricInformationRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �RetrieveBiometricInformation�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 N The identifier of an encounter associated with the subject. �� BiometricType oasis_cbeff:MultipleTypesType 0..1 N The type of biological or behavioral data to retrieve. Response Message Field Type # ? Meaning RetrieveBiometricInformationResponse Y The response to a RetrieveBiometricInformation operation. RetrieveBiometricInformationResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Identity BIASIdentity 1 Y Includes the biometric data associated with a subject. �� BiometricData BIASBiometricDataType 1 Y An Identity�s biometric data. �� BIRList CBEFF_BIR_ListType 1 Y A list of CBEFF-BIR elements. �� BIR CBEFF_BIR_Type 0..* N CBEFF structure containing information about a biometric sample. 4.1.17 SetBiographicData SetBiographicDataRequest SetBiometricDataResponse The SetBiographicData operation associates biographic data to a given subject record. The identity model of the system determines whether the biographic information should replace any existing biographic information (person-centric model) or if a new encounter should be created and associated with the subject (encounter-centric model). For encounter-centric models, the encounter ID MAY be specified by the caller in order to link biographic and biometric information (assuming biometric information was previously associated using the SetBiometricData operation). If the encounter ID is omitted for the encounter-centric model, the operation returns a system-assigned encounter ID. Request Message Field Type # ? Meaning SetBiographicData Y Associates biographic data to a given subject record. SetBiographicDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �SetBiographicData�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to store. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 N The identifier of an encounter associated with the subject. �� BiographicData BiographicDataType 1 Y An Identity�s biographic data. One of the following elements MUST be present. �� LastName string 0..1 C The last name of a subject. �� FirstName string 0..1 C The first name of a subject. �� BiographicDataItem BiographicDataItemType 0..* C A single biographic data element. �� BiographicDataSet BiographicDataSetType 0..1 C A set of biographic data information. Response Message Field Type # ? Meaning SetBiographicDataResponse Y The response to a SetBiographicData operation. SetBiographicDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Identity BIASIdentity 0..1 C In an encounter-centric model, identifies the encounter ID assigned to a new encounter. �� EncounterID BIASIDType 1 Y The identifier of an encounter associated with the subject. 4.1.18 SetBiometricData SetBiometricDataRequest SetBiometricDataResponse The SetBiometricData operation associates biometric data to a given subject record. The identity model of the system determines whether the biometric information should replace any existing biometric information (person-centric model) or if a new encounter should be created and associated with the subject (encounter-centric model). For encounter-centric models, the encounter ID MAY be specified by the caller in order to link biographic and biometric information (assuming biographic information was previously associated using the SetBiographicData operation). If the encounter ID is omitted for the encounter-centric model, the operation returns a system-assigned encounter ID. Request Message Field Type # ? Meaning SetBiometricData Y Associates biometric data to a given subject record. SetBiometricDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �SetBiometricData�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to store. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 N The identifier of an encounter associated with the subject. �� BiometricData BIASBiometricDataType 1 Y An Identity�s biometric data. �� BIRList CBEFF_BIR_ListType 1 Y A list of CBEFF-BIR elements. �� BIR CBEFF_BIR_Type 1..* Y CBEFF structure containing information about a biometric sample. Response Message Field Type # ? Meaning SetBiometricDataResponse Y The response to a SetBiometricData operation. SetBiometricDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Identity BIASIdentity 0..1 C In an encounter-centric model, identifies the encounter ID assigned to a new encounter. �� EncounterID BIASIDType 1 Y The identifier of an encounter associated with the subject. 4.1.19 TransformBiometricData TransformBiometricDataRequest TransformBiometricDataResponse The TransformBiometricData operation transforms or processes a given biometric in one format into a new target format. Request Message Field Type # ? Meaning TransformBiometricData Y Transforms or processes a given biometric in one format into a new target format. TransformBiometricDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �TransformBiometricData�. �� InputBIR CBEFF_BIR_Type 1 Y Data structure containing the biometric information to be transformed. �� TransformOperation unsignedLong 1 Y Value indicating the type of transformation to perform. �� TransformControl string 0..1 N Specifies controls for the requested transform operation. Note: This could be a compression ratio, target data format, etc. NOTE:� The values for TransformOperation and TransformControl are implementation specific. Response Message Field Type # ? Meaning TransformBiometricDataResponse Y The response to a TransformBiometricData operation. TransformBiometricDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� OutputBIR CBEFF_BIR_Type 0..1 N Data structure containing the new, transformed biometric information. 4.1.20 UpdateBiographicData UpdateBiographicDataRequest UpdateBiographicDataResponse The UpdateBiographicData operation updates the biographic data for an existing subject record. The operation replaces any existing biographic data with the new biographic data. In the encounter-centric model, the encounter ID MUST be specified. Request Message Field Type # ? Meaning UpdateBiographicData Y Updates the biographic data for a given subject record. UpdateBiographicDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �UpdateBiographicData�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to update. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 C The identifier of an encounter associated with the subject. Required for encounter-centric models. �� BiographicData BiographicDataType 1 Y An Identity�s biographic data. One of the following elements MUST be present. �� LastName string 0..1 C The last name of a subject. �� FirstName string 0..1 C The first name of a subject. �� BiographicDataItem BiographicDataItemType 0..* C A single biographic data element. �� BiographicDataSet BiographicDataSetType 0..1 C A set of biographic data information. Response Message Field Type # ? Meaning UpdateBiographicDataResponse Y The response to an UpdateBiographicData operation. UpdateBiographicDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 4.1.21 UpdateBiometricData UpdateBiometricDataRequest UpdateBiometricDataResponse The UpdateBiometricData operation updates the biometric data for an existing subject record. The operation includes an OPTIONAL parameter indicating if the new biometric sample should be merged with the existing biometric sample. If this parameter is set to �False� or is not used in the request, the operation replaces the existing biometric sample with the new biometric sample. In the encounter-centric model, the encounter ID MUST be specified. Request Message Field Type # ? Meaning UpdateBiometricData Y Updates a single biometric sample for a given subject record. UpdateBiometricDataRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �UpdateBiometricData�. �� Identity BIASIdentity 1 Y Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to update. �� SubjectID BIASIDType 1 Y A system unique identifier for a subject. �� EncounterID BIASIDType 0..1 C The identifier of an encounter associated with the subject. Required for encounter-centric models. �� BiometricData BIASBiometricDataType 1 Y An Identity�s biometric data. �� BIR CBEFF_BIR_Type 1 Y Contains biometric information in either a non-XML or an XML representation. �� Merge boolean 0..1 N Value indicating if the input biometric sample should be merged with any existing biometric information. Response Message Field Type # ? Meaning UpdateBiometricDataResponse Y The response to an UpdateBiometricData operation. UpdateBiometricDataResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. 4.1.22 VerifySubject VerifySubjectRequest VerifySubjectResponse The VerifySubject operation performs a 1:1 verification match between a given biometric and either a claim to identity in a given gallery or another given biometric. As such either the Identity Claim or Reference BIR input parameters are REQUIRED. Request Message Field Type # ? Meaning VerifySubject Y Performs a 1:1 verification match between a given biometric and either a claim to identity in a given gallery or another given biometric. VerifySubjectRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �VerifySubject�. �� GalleryID BIASIDType 0..1 C The identifier of the gallery or population group of which the subject must be a member. Required if an Identity Claim is provided. �� Identity BIASIdentity 1 Y Includes the identifying information and/or input and reference biometric samples. �� IdentityClaim BIASIDType 0..1 C An identifier by which a subject is known to a particular gallery or population group. Required if a Reference BIR is not provided. �� BiometricData BIASBiometricDataType 1 Y An Identity�s biometric data. �� InputBIR CBEFF_BIR_Type 1 Y Maps to specific INCITS BIAS elements as required by that specification. �� ReferenceBIR CBEFF_BIR_Type 0..1 C Maps to specific INCITS BIAS elements as required by that specification. Required if an Identity Claim is not provided. Response Message Field Type # ? Meaning VerifySubjectResponse Y The response to a VerifySubject operation. VerifySubjectResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� Match boolean 0..1 N Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR. �� Score Score 0..1 N The score if the biometric information matched. 4.2 Aggregate Operations 4.2.1 Enroll EnrollRequest EnrollResponse The Enroll operation adds a new subject or, in an encounter-centric model, a new encounter to the system. This may be accomplished in a number of different ways according to system requirements and/or resources.If the Enroll operation is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the Return Data parameter. If the Enroll operation is implemented as an asynchronous service, the implementing system returns a token in the Return Data parameter, which is an indication that the request is being handled asynchronously. In this case, the GetEnrollResults operationis used to poll for the results of the Enroll request. Request Message Field Type # ? Meaning Enroll Y Adds a new subject or, in an encounter-centric model, a new encounter to the system. EnrollRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �Enroll�. �� ProcessingOptions ProcessingOptionsType 1 Y Options that guide how the aggregate service request is processed. �� Option string 0..* N An option supported by the implementing system. �� InputData InformationType 1 Y Contains the input data for the operation, as required by the implementing system. Response Message Field Type # ? Meaning EnrollResponse Y The response to an Enroll operation. EnrollResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ReturnData InformationType 0..1 N Contains the output data for the response. 4.2.2 GetEnrollResults GetEnrollResultsRequest GetEnrollResultsResponse The GetEnrollResults operation retrieves the enrollment results for the specified token. This operation is used in conjunction with the Enroll operation. If the Enroll operation is implemented as an asynchronous service, the implementing system returns a token and the GetEnrollResults operation is used to poll for the results of the original Enroll request. If the service provider implements an asynchronous Enroll operation, then it MUST also implement the GetEnrollResults operation. Request Message Field Type # ? Meaning GetEnrollResults Y Retrieves the enrollment results for the specified token. GetEnrollResultsRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �GetEnrollResults�. �� Token TokenType 1 Y A value used to retrieve the results of the Enroll request. �� TokenValue string 1 Y A value returned by the implementing system that is used to retrieve the results to an operation at a later time. �� Expiration date 1 Y A date and time at which point the token expires and the operation results are no longer guaranteed to be available. Response Message Field Type # ? Meaning GetEnrollResultsResponse Y The response to a GetEnrollResults operation. GetEnrollResultsResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ReturnData InformationType 0..1 N Contains the output data for the response. 4.2.3 GetIdentifyResults GetIdentifyResultsRequest GetIdentifyResultsResponse The GetIdentifyResults operation retrieves the identification results for the specified token. This operation is used in conjunction with the Identify operation. If the Identify operation is implemented as an asynchronous service, the implementing system returns a token and the GetIdentifyResults operation is used to poll for the results of the original Identify request. If the service provider implements an asynchronous Identify operation, then it MUST also implement the GetIdentifyResults operation. Request Message Field Type # ? Meaning GetIdentifyResults Y Retrieves the identification results for the specified token GetIdentifyResultsRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �GetIdentifyResults�. �� Token TokenType 1 Y A value used to retrieve the results of the Identify request. �� TokenValue string 1 Y A value returned by the implementing system that is used to retrieve the results to an operation at a later time. �� Expiration date 1 Y A date and time at which point the token expires and the operation results are no longer guaranteed to be available. Response Message Field Type # ? Meaning GetIdentifyResultsResponse Y The response to a GetIdentifyResults operation. GetIdentifyResultsResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ReturnData InformationType 0..1 N Contains the output data for the response. 4.2.4 GetVerifyResults GetVerifyResultsRequest GetVerifyResultsResponse The GetVerifyResults operation retrieves the verification results for the specified token. This operation is used in conjunction with the Verify operation. If the Verify operation is implemented as an asynchronous service, the implementing system returns a token and the GetVerifyResults operation is used to poll for the results of the original Verify request. If the service provider implements an asynchronous Verifyoperation, then it MUST also implement the GetVerifyResults operation. Request Message Field Type # ? Meaning GetVerifyResults Y Retrieves the verification results for the specified token GetVerifyResultsRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �GetVerifyResults�. �� Token TokenType 1 Y A value used to retrieve the results of the Verify request. �� TokenValue string 1 Y A value returned by the implementing system that is used to retrieve the results to an operation at a later time. �� Expiration date 1 Y A date and time at which point the token expires and the operation results are no longer guaranteed to be available. Response Message Field Type # ? Meaning GetVerifyResultsResponse Y The response to a GetVerifyResults operation. GetVerifyResultsResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ReturnData InformationType 0..1 N Contains the output data for the response. �� Match boolean 0..1 N Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR. �� Score Score 0..1 N The score if the biometric information matched. 4.2.5 Identify IdentifyRequest IdentifyResponse The Identify operation performs an identification function according to system requirements and/or resources.If the Identify operation is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the Return Data parameter. If the Identify operation is implemented as an asynchronous service, the implementing system returns a token in the Return Data parameter, which is an indication that the request is being handled asynchronously. In this case, the GetIdentifyResults operation is used to poll for the results of the Identify request. Request Message Field Type # ? Meaning Identify Y Performs an identification function. IdentifyRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �Identify�. �� ProcessingOptions ProcessingOptionsType 1 Y Options that guide how the aggregate service request is processed. �� Option string 0..* N An option supported by the implementing system. �� InputData InformationType 1 Y Contains the input data for the aggregate services. Response Message Field Type # ? Meaning IdentifyResponse Y The response to an Identify operation. IdentifyResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ReturnData InformationType 0..1 N Contains the output data for the response. 4.2.6 RetrieveInformation RetrieveInformationRequest RetrieveInformationResponse The RetrieveInformation operation retrieves requested information about a subject, or in an encounter-centric model about an encounter. In a person-centric model, this operation can be used to retrieve both biographic and biometric information for a subject record. In an encounter-centric model, this operation can be used to retrieve biographic and/or biometric information for either a single encounter or all encounters. Either a subject ID or encounter ID MUST be specified. Request Message Field Type # ? Meaning RetrieveInformation Y Retrieves requested information about a subject or encounter. RetrieveInformationRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �RetrieveInformation�. �� ProcessingOptions ProcessingOptionsType 1 Y Options that guide how the aggregate service request is processed, and MAY identify what type(s) of information should be returned. �� Option string 0..* N An option supported by the implementing system. �� Identity BIASIdentity 1 Y Includes the identifier of the subject or encounter. �� SubjectID BIASIDType 0..1 C A system unique identifier for a subject. Required if an Encounter ID is not provided. �� EncounterID BIASIDType 0..1 C The identifier of an encounter associated with the subject. Required if a Subject ID is not provided. Response Message Field Type # ? Meaning RetrieveInformationResponse Y Response to a RetrieveInformation operation. RetrieveInformationResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ReturnData InformationType 0..1 N Contains the output data for the response. 4.2.7 Verify VerifyRequest VerifyResponse The Verify operation performs a 1:1 verification function according to system requirements and/or resources. Either the Identity Claim or Reference BIR input parameters are REQUIRED.If the Verify operation is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the Return Data parameter. If the Verify operation is implemented as an asynchronous service, the implementing system returns a token in the Return Data parameter, which is an indication that the request is being handled asynchronously. In this case, the GetVerifyResults operation is used to poll for the results of the Verify request. Request Message Field Type # ? Meaning Verify Y Performs a 1:1 verification function. VerifyRequest 1 Y �� GenericRequestParameters GenericRequestParameters 0..1 N Common request parameters that can be used to identify the requester. �� Application ApplicationIdentifier 0..1 N Identifies the requesting application. �� ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or instance of the requesting application. �� BIASOperationName string 0..1 N Identifies the BIAS operation that is being requested: �Verify�. �� ProcessingOptions ProcessingOptionsType 1 Y Options that guide how the aggregate service request is processed. �� Option string 0..* N An option supported by the implementing system. �� InputData InformationType 1 Y Contains the input data for the aggregate services. �� Identity BIASIdentity 1 Y Includes either the Identity Claim or Reference BIR. �� IdentityClaim BIASIDType 0..1 C An identifier by which a subject is known to a particular gallery or population group. Required if a Reference BIR is not provided. �� BiometricData BIASBiometricDataType 0..1 N An Identity�s biometric data. �� ReferenceBIR CBEFF_BIR_Type 0..1 C Maps to specific INCITS BIAS elements as required by that specification. Required if an Identity Claim is not provided. �� GalleryID BIASIDType 0..1 C The identifier of the gallery or population group of which the subject must be a member. Required if an Identity Claim is provided. Response Message Field Type # ? Meaning VerifyResponse Y The response to a Verify operation. VerifyResponsePackage 1 Y �� ResponseStatus ResponseStatus 1 Y Returned status for the operation. �� Return ReturnCode 1 Y The return code indicates the return status of the operation. �� Message string 0..1 N A short message corresponding to the return code. �� ReturnData InformationType 0..1 N Contains the output data for the response. �� Match boolean 0..1 N Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR. �� Score Score 0..1 N The score if the biometric information matched. 5 Message structure and rules BIAS operations and data elements are defined in XML in the INCITS 422 BIAS standard. This OASIS standard further specifies the full XML schema (see AnnexA) and specifies how this XML is packaged and exchanged as SOAP messages. Annex A provides a WSDL of operations and structures aggregated from all the conformance classes, both synchronous and asynchronous.� A specific implementation�s WSDL must only expose its respective operations and structures. For example, for a Class 5-only conformant implementation, all of the primitive operations must not be exposed as operations (with the exception of QueryCapabilities) unless that functionality is supported. Additionally, the WSDL exposed by an implementation shall not contain instances of xsd:any, xsd:anyType, or xsd:anyAttribute; these instances must be replaced with explicit schema contents. An example is the XML complex type, InformationType, which has xsd:any as its only child. This type is used to represent implementation-specific input data and return data. The children of InformationType must be replaced with explicit content. Doing so removes the ability to transmit unexpected or arbitrary data. Also, it provides a clear definition of information that a client needs to provide to the server,or expect to receive,to optimally perform an operation. SOAP 1.1 messages consist of three elements: an envelope, header data, and a message body.� BIAS request-response elements MUST be enclosed within the SOAP message body.� The general structure of the BIAS SOAP message is shown in Figure 4, below. The data model for BIAS is addressed in Section3 and BIAS messages in Section 4. Figure 4. BIAS SOAP Structure Biometric data, regardless of native format, is carried as a binary structure. As such, options exist on how this data is carried within the SOAP structure. It can be carried as embedded Base-64 objects or [ XOP] can be used � this standard allows for either method (See section 5.3). 5.1� Purpose and constraints This document defines a SOAP profile describing how the XML elements defined in INCITS 442 are to be used as the payload of a SOAP message and the rules for structuring and exchanging such messages.� Philosophical tenets include: � SOAP messages will carry BIAS XML [ XML 10] payloads. � SOAP messages will follow WS-I and will deviate only when absolutely necessary. � Message structures and interchanges will be kept as simple as possible � �nice to have� features will be addressed in future revisions. � XML schemas will be produced based on INCITS 442. � BIAS will support a broad range of application domains. � BIAS will allow for a variety of biometric and biographic data formats to be used � Only the SOAP messaging will be defined � no message protocols or client/server agents will be defined. � Basic usage/formatting rules (beyond WS-I) will be defined. � Existing biometric and Web services standards will be leveraged wherever possible. � Sample WSDL and use cases will be provided as an aid in implementation. � Use of basic SOAP will allow all other compatible WS* standards (and discovery mechanisms) to be used in conjunction with BIAS messaging. � BIAS will support both secure (i.e., using existing security mechanisms such as WS-Security, SAML, etc,) and non-secure implementations. � Generic biometric operations will be defined � use of biometrics within a Web services authentication protocol is not addressed. � OASIS namespace rules will be followed, though some external schemas MAY also be referenced. 5.2 Message requirements BIAS SOAP messages MUST conform to [ WS-I-Basic] and [ WS-I-Bind] .� A single BIAS SOAP message MUST contain only one BIAS service request (or single BIAS service response).� Binary components of BIAS messages are already Base-64 encoded and therefore do not need to be conveyed as SOAP attachments (though XOP MAY be utilized). The system model used for BIAS conversations over SOAP is a simple request-response model.� BIAS comprises both synchronous and asynchronous operations, with the majority being of the former type. Asynchronous operations are implemented through message pairs. That is, there are separate messages to request the operation and to request the results of the operation. These have been defined for those operations that are likely to take significant time to complete. For example, an identify operation can be implemented as either a synchronous or asynchronous service as follows: Figure 5. Example of Synchronous and Asynchronous BIAS Operations The basic process for using SOAP for BIAS operations is: A system entity acting as a BIAS requester transmits a BIAS request element within the body of a SOAP message to a system entity acting as a BIAS responder. The BIAS requester MUST NOT include more than one BIAS request per SOAP message or include any additional XML elements in the SOAP body. The BIAS responder MUST return either a BIAS response element within the body of another SOAP message or generate a SOAP fault. The BIAS responder MUST NOT include more than one BIAS response per SOAP message or include any additional XML elements in the SOAP body. If a BIAS responder cannot, for some reason, process a BIAS request, it MUST generate a SOAP fault.� (SOAP 1.1 faults and fault codes are discussed in [ SOAP11] section 5.1.) On receiving a BIAS response in a SOAP message, the BIAS requester MUST NOT send a fault code or other error messages to the BIAS responder. Since the format for the message interchange is a simple request-response pattern, adding additional items such as error conditions would needlessly complicate the protocol. SOAP 1.1 also defines an optional data encoding system. This system is not used within the BIAS SOAP binding. This means that BIAS messages can be transported using SOAP without re-encoding from the �standard� BIAS schema to one based on the SOAP encoding. NOTE: [ SOAP11] references an early draft of the XML Schema specification including an obsolete namespace. BIAS requesters SHOULD generate SOAP documents referencing only the final XML schema namespace. BIAS responders MUST be able to process both the XML schema namespace used in [ SOAP11] as well as the final XML schema namespace. 5.3 Handling binary data BIAS messages frequently contain binary data (e.g., biometric data, scanned identity documents, etc.).� Two methods are provided for dealing with this: Embedded Base64 encoding XOP [ XOP] Use of SOAP with Attachments (SWA) is deprecated. 5.3.1 Base64 encoding This method is the default method for including binary data.� Binary data is Base64 encoded and included between the tags in the XML SOAP body for the appropriate data elements.� Data elements using this method are indicated as such in the schema.� As an example, the CBEFF_BIR_Type includes, as one of the BIR types, BinaryBIR of type base64binary. <xsd:element name="BinaryBIR" type="xs:base64Binary" /> However, even an XML_BIR as defined within [ CBEFF3 ], contains a biometric data block (BDB) which may be entirely binary (most common), <xs:element name="bdb" type="xs:base64Binary" minOccurs="0"/> or contain an element which is binary (e.g., an image within an XML BDB). 5.3.2 Use of XOP When XOP is used, the binary content is replaced with a reference (URI) to an attachment (i.e., MIME) which contains that �stripped� content via an xop:include.� The advantage of this method is overall message size during transmission since the overhead of the embedded Base64 is not present (since the MIME attachment contains the native binary format). Use of XOP is generally transparent to the developer, other than in how they configure their toolset.� Most frameworks support this; however, there is a possibility of mismatch if the transmitter supports and uses XOP but the receiver does not. 5.4 Discovery BIAS implementers (service providers) MUST provide WSDL [ WSDL11 ] to describe their implementations.� This WSDL MAY or may not be made public via a standard discovery mechanism (such as UDDI) or other method. In addition, it is REQUIRED that the BIAS implementation include the QueryCapabilities operation to provide dynamic information regarding BIAS capabilities, options, galleries, etc. that are supported. 5.5 Identifying operations Receivers of BIAS SOAP messages require a method of easily identifying the operation being requested (or response being provided).� This SHOULD be possible without the receiver needing to infer it from the sum of the elements provided within the body of the SOAP message.� The BIAS SOAP profile allows for two methods of identifying BIAS operations: Explicit named element in body of the SOAP message Use of WS-Addressing Action element 5.5.1 Operation name element The BIAS message sender (requester) will include within the body of the BIAS SOAP message an XML element <BIASOperationName>.� The receiver (service provider) can search for this tag within a received BIAS SOAP message to determine what operation is being requested.� There is no requirement related to the ordering of this element within the message, though it is RECOMMENDED that it be included early in the message to aid in human readability. An example of this method for the CreateSubject operation is shown below: POST /bias HTTP/1.1 Host: www.acme.com Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn SOAPAction: �� <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> <soap:Body> <tns:CreateSubjectRequest xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> <tns:GenericRequestParameters> <tns:Application>BIAS Application</tns:Application> <tns:ApplicationUser>BIAS User</tns:ApplicationUser> <tns:BIASOperationName>CreateSubject</tns:BIASOperationName> </tns:GenericRequestParameters> <tns:Identity> <tns:SubjectID>123456789</tns:SubjectID> </tns:Identity> </tns:CreateSubjectRequest> </soap:Body> </soap:Envelope> 5.5.2 WS-Addressing Action WS-Addressing [ WS-Addr] provides a mechanism for including action information inside any SOAP message. The information is in the SOAP Header. The WS-Addressing �Action� element is used to indicate the intent of the message. The value is a URI/IRI identifying that intent; however, there are no restrictions on the format or specificity of the URI/IRInor a requirement that it can be resolved. Adoption of this option also requires that the WS-Addressing �To�, �ReplyTo�, and �MessageID� elements are supplied, as they are mandatory elements in a request-reply message pattern as used within BIAS. Response messages would also need to use WS-Addressing, requiring the �To� (matching the �ReplyTo� element in the request), �RelatesTo� (matching the �MessageID� element in the request), and �RelationshipType� (default value to �wsa:Reply�) elements. Use of WS-Addressing is OPTIONAL in this profile as is this method of using the �Action� field for this purpose.� However, when BIAS is used within an environment using WS-Addressing, it is RECOMMENDED that this approach for use of the �Action� field to carry the BIAS operation name is employed, either alone or in combination with the BIASOperationName approach described in section 5.5.1. An example for a message request for the CreateSubject operation would look likethe following: POST /bias HTTP/1.1 Host: www.acme.com Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn SOAPAction: �� <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope� xmlns:wsa=�http://schemas.xmlsoap.org/ws/2004/08/addressing�> <soap:Header> <wsa:MessageID>some-ID</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>response-URI</wsa:Address> </wsa:ReplyTo> <wsa:To>destination-URI</wsa:To> <wsa:Action>CreateSubject</wsa:Action> </soap:Header> <soap:Body> <tns:CreateSubjectRequest xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/� /> </soap:Body> </soap:Envelope> 5.6 Security The end-points that exchange SOAP messages (or handle the contents of the BIAS operations) are expected to be protected and trusted such that message-level security mechanisms may not be required.� The use of SSL (HTTPS) or VPN technology that provides end-point to end-point security is RECOMMENDED and MAY be sufficient in some cases.�� Other mechanisms such as Signed XML or WSS [ WSS] could also be implemented. Unless stated otherwise, the following security statements apply to all BIAS bindings.� 5.6.1 Use of SSL 3.0 or TLS 1.0 Unless otherwise specified, in any BIAS binding�s use of SSL 3.0 [ SSL3] or TLS1.0 [ RFC2246] , servers MUST authenticate clients using a X.509 v3 certificate [ X509] .� The client MUST establish server identity based on contents of the certificate (typically through examination of the certificate�s subject DN field, subjectAltName attribute, etc.). Use of transport level security in the form of SSL or TLS is OPTIONAL but highly RECOMMENDED.� Use of these mechanisms alone may not be sufficient for end-to-end integrity and confidentiality, however (see 5.6.3 and 5.6.4 below). 5.6.2 Data Origin Authentication Authentication of both the BIAS requester and the BIAS responder associated with a message is OPTIONAL and depends on the environment of use:� Authentication mechanisms available at the SOAP message exchange layer or from the underlying substrate protocol (for example, in many bindings the SSL/TLS or HTTP protocol) MAY be utilized to provide data origin authentication. Transport authentication will not meet end-to-end origin authentication requirements in bindings where the BIAS SOAP message passes through an intermediary � in this case, message authentication is RECOMMENDED. Note that SAML [ SAML] MAY be used as the mechanism for parties to authenticate to one another. 5.6.3 Message Integrity Message integrity of both BIAS requests and BIAS responses is OPTIONAL and depends on the environment of use.� The security layer in the underlying substrate protocol or a mechanism at the SOAP message exchange layer MAY be used to ensure message integrity. Transport integrity will not meet end-to-end integrity requirements in bindings where the BIAS SOAP message passes through an intermediary � in this case, message integrity is RECOMMENDED. 5.6.4 Message Confidentiality Message confidentiality of both BIAS requests and BIAS responses is OPTIONAL and depends on the environment of use.� The security layer in the underlying substrate protocol or a mechanism at the SOAP message exchange layer MAY be used to ensure message confidentiality. Transport confidentiality will not meet end-to-end confidentiality requirements in bindings where the BIAS SOAP message passes through an intermediary. NOTE:� Biometric and biographic data is likely to contain personal information the confidentiality of which SHOULD be protected accordingly.� See INCITS 442, section 6.3 for further discussion. 5.6.5 CBEFF BIR security features Within BIAS, biometric data is transferred within a CBEFF BIR (as defined in ISO/IEC 19785-1).� CBEFF provides for the optional encryption of the Biometric Data Block (BDB) of the BIR and for the integrity of the entire BIR.� If implemented, this is indicated in the BIR header. The BIR structure defines an optional Security Block which MAY contain a digital signature (or message authentication code), encryption parameters (e.g., key name, algorithm, etc.), and/or other security related data.� Such protections are associated with an individual BIR and are separate from any other protections provided at the message level. 5.6.6 Security Considerations Before deployment, each combination of authentication, message integrity, and confidentiality mechanisms SHOULD be analyzed for vulnerability in the context of the specific protocol exchange and the deployment environment. Special care should be given to the impact of possible caching on security. IETF RFC 2617 [ RFC2617] describes possible attacks in the HTTP environment when basic or message digest authentication schemes are used. Many of the security considerations identified in [ SAML SEC] MAY also apply. ISO/IEC 19092 [ BIO SEC] describes a security framework for biometric systems including a minimum set of security requirements addressing integrity, authenticity, and confidentiality of biometric information during transmission and storage.� These SHOULD be considered as part of an overall risk management approach. NOTE:� The requirements of ISO/IEC 19092, though useful across many application domains, are required for most biometric system implementations in the financial services environment.� Application of this standard would make the requirements of sections 5.5.3 through 5.5.5 mandatory rather than optional.� This is highly RECOMMENDED for any high security environment or where privacy concerns exist. 5.6.7 Security of Stored Data This specification does not address security considerations for stored data.� It is the purview of the BIAS service provider to implement security mechanisms and protect data at rest as per their own security policies. 5.6.8 Key Management This specification does not address key management considerations with respect to implementation of cryptographic security mechanisms (e.g., for authenticity, integrity, or confidentiality). 5.7 Use with other WS* standards The intent of specifying SOAP bindings for BIAS messages is to enable the full range of existing Web services standards to be able to be applied. Some may be normative while others can be optionally applied (i.e., WS-Security, WS-Addressing). Still others may require additional profiling to be used in an interoperable manner (e.g., WS-Notification); this is left to a future revision. However, the intent is to avoid specifying anything in the first, base version that would preclude the use of such standards in the future. 5.8 Tailoring This standard provides for a common method of implementing biometric Web services; however, it does not guarantee interoperability in a specific application.� In some cases further tailoring or profiling of this standard may be required in order to further constrain the implementation options available. NOTE:� As an example, BIAS allows for a number of different biographic and biometric data formats to be used, whereas a given application/domain MAY wish to limit this to a small set or just one of each type.� Other examples (not comprehensive) include: � Identification of a subset of BIAS operations to be used � Specification of security features to be implemented (e.g., SSL, CBEFF BIR encryption, etc.) � Choice of operation name identification method � Choice of BIR type to be used (XML, non-XML, or URI) � Further definition of aggregate operations � Use (or not) of the encounter model � Use (or not) of asynchronous operations � Process sequences � Implementation specific values (e.g., Transform operations/controls) 6 Error handling There are two levels of errors that can be returned in an error response: system and service errors.� System-level errors occur when the implementing system cannot service a request. They could result due to an internal logic error or because the implementing system does not support a particular request. Service-level errors occur when there is a problem transmitting or representing the service request. They could result due to an invalid service request or because of a communications error. The INCITS BIAS standard defines the error condition codes for system-level errors. If successful, a response message (containing a return code) will be generated. If unsuccessful, a SOAP fault message (containing a fault code) will be generated. 6.1 BIAS operation return codes If a BIAS operation is successful, a response (service output) will be sent to the requester by the service provider.� Each response message contains a response status (see section 3.2.37) and return code (see section 3.2.38) along with any response data as defined for that operation, if any.� A response code of �0� indicates success. 6.2 SOAP fault codes If a BIAS operation is unsuccessful, no BIAS response message is sent.� Instead a SOAP fault message is returned. Every Web service (operation) described in the BIAS WSDL may result in a fault message that will be returned in the response by the service provider in the event of an error. The fault message contains a FaultCode element as defined by the SOAP 1.1 specification (see section 3.2.5).� The fault message MUST contain a Detail element in a common format, as described by the BIASFault element (see section 3.2.6). The schema provided in Annex A defines �BIASFaultCode� and �BIASFaultDetail� types as well as �BIASFault�, �BIASFaultType�, �BIASFaultMessage� and �BIASFaultDescription� elements. The list of defined BIAS fault codes is provided in section 3.2.5.� Note that BIAS service providers MAY define additional fault codes unique to their service. NOTE:� See also section 5.2 for additional information on message returns and faults. 7 Conformance Implementations claiming conformance to this standard, MUST implement, at a minimum, all mandatory requirements and provisions set forth in Clauses 3, 4, 5 and 6. If such implementations claim conformance to any OPTIONAL requirements and provisions stated in Clauses 3, 4, 5 and 6, these requirements and provisions MUST be implemented as set forth in these Clauses. INCITS 442 [ INCITS-BIAS] (Annex A) specifies five BIAS conformance classes.� For each class, a set of mandatory BIAS operations is identified in order for implementations (BIAS service providers) to claim conformance.� These categories are: Class 1: Full Primitive Services Implementation Class 2: Full Aggregate Services Implementation Class 3: Limited Primitive Services Implementation Class 4: Minimum Primitive Services Implementation Class 5: Minimum Aggregate Services Implementation In addition, the minimum capability information to be returned in response to a Query Capabilities request (the only mandatory BIAS operation across all 5 classes) is specified for each class. These conformance classes and their associated requirements apply to this BIAS SOAP Profile. There are no minimum set of operations required to be implemented by BIAS requesters; however, any operations implemented must conform to the requirements of Clauses 3 and 4 and those requirements within Clause 5 that are mandatory and are not specific to BIAS responders. Annex A. XML Schema <?xml version="1.0" encoding="UTF-8"?>  <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:oasis_cbeff=" http://docs.oasis-open.org/bias/ns/biaspatronformat-1.0/" xmlns:tns="http://docs.oasis-open.org/bias/ns/bias-1.0/" targetNamespace="http://docs.oasis-open.org/bias/ns/bias-1.0/"> <wsdl:types> <xsd:schema elementFormDefault="qualified" targetNamespace="http://docs.oasis-open.org/bias/ns/bias-1.0/"> <xsd:import namespace=" http://docs.oasis-open.org/bias/ns/biaspatronformat-1.0/" schemaLocation="cbeff.xsd" /> <xsd:complexType name="AggregateRequestTemplate"> <xsd:annotation> <xsd:documentation>Base template for BIAS aggregate service requests.</xsd:documentation> </xsd:annotation> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="ProcessingOptions" type="tns:ProcessingOptionsType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Options that guide how the aggregate service request is processed.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="InputData" type="tns:InformationType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains the input data for the aggregate service request.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="AggregateResponseTemplate"> <xsd:annotation> <xsd:documentation>Base template for BIAS aggregate service responses.</xsd:documentation> </xsd:annotation> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="ReturnData" type="tns:InformationType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains the output data for the aggregate service response.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:simpleType name="ApplicationIdentifier"> <xsd:annotation> <xsd:documentation>Identifies an application.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"> <xsd:minLength value="1"/> <xsd:maxLength value="255"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType name="ApplicationUserIdentifier"> <xsd:annotation> <xsd:documentation>Identifies an application user or instance.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"> <xsd:minLength value="1"/> <xsd:maxLength value="255"/> </xsd:restriction> </xsd:simpleType> <xsd:complexType name="BIASBiometricDataType"> <xsd:annotation> <xsd:documentation>Wraps the various BIAS biometric types.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="BIRList" type="tns:CBEFF_BIR_ListType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A list of CBEFF-BIR elements.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains biometric information in either a non-XML and an XML representation.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="InputBIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Maps to specific INCITS BIAS elements as required by that specification.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ReferenceBIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Maps to specific INCITS BIAS elements as required by that specification.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiometricDataList" type="tns:BiometricDataListType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A list of biometric data elements.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="BIASFaultCode"> <xsd:annotation> <xsd:documentation></xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"> <xsd:enumeration value="UNKNOWN_ERROR"> <xsd:annotation> <xsd:documentation>The service failed for an unknown reason.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="UNSUPPORTED_CAPABILITY"> <xsd:annotation> <xsd:documentation>A requested capability is not supported by the service implementation.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="INVALID_INPUT"> <xsd:annotation> <xsd:documentation>The data in a service input parameter is invalid.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="BIR_QUALITY_ERROR"> <xsd:annotation> <xsd:documentation>Biometric sample quality is too poor for the service to succeed.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="INVALID_BIR"> <xsd:annotation> <xsd:documentation>The input BIR is empty or in an invalid or unrecognized format.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="BIR_SIGNATURE_FAILURE"> <xsd:annotation> <xsd:documentation>The service could not validate the signature, if used, on the input BIR.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="BIR_DECRYPTION_FAILURE"> <xsd:annotation> <xsd:documentation>The service could not decrypt an encrypted input BIR.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="INVALID_ENCOUNTER_ID"> <xsd:annotation> <xsd:documentation>The input encounter ID is empty or in an invalid format.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="INVALID_SUBJECT_ID"> <xsd:annotation> <xsd:documentation>The input subject ID is empty or in an invalid format.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="UNKNOWN_SUBJECT"> <xsd:annotation> <xsd:documentation>The subject referenced by the input subject ID does not exist.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="UNKNOWN_GALLERY"> <xsd:annotation> <xsd:documentation>The gallery referenced by the input gallery ID does not exist.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="UNKNOWN_ENCOUNTER"> <xsd:annotation> <xsd:documentation>The encounter referenced by the input encounter ID does not exist.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="UNKNOWN_BIOGRAPHIC_FORMAT"> <xsd:annotation> <xsd:documentation>The biographic data format is not known or not supported.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="UNKNOWN_IDENTITY_CLAIM"> <xsd:annotation> <xsd:documentation>The identity referenced by the input identity claim does not exist.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="INVALID_IDENTITY_CLAIM"> <xsd:annotation> <xsd:documentation>The identity claim requested is already in use.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="NONEXISTANT_DATA"> <xsd:annotation> <xsd:documentation>The data requested for deletion does not exist.</xsd:documentation> </xsd:annotation> </xsd:enumeration> </xsd:restriction> </xsd:simpleType> <xsd:complexType name="BIASFaultDetail"> <xsd:annotation> <xsd:documentation>Defines the error information associated with a SOAP fault.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element minOccurs="1" maxOccurs="1" name="BIASFaultType" type="tns:BIASFaultCode"> <xsd:annotation> <xsd:documentation>References an error code.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="1" maxOccurs="1" name="BIASFaultMessage" type="xsd:string"> <xsd:annotation> <xsd:documentation>Provides an explanation of the fault.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" maxOccurs="1" name="BIASFaultDescription" type="xsd:string"> <xsd:annotation> <xsd:documentation>Provides detailed information about a BIAS fault, such as trace details.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="BIASIdentity"> <xsd:annotation> <xsd:documentation> Defines a single element for encapsulating the data associated with an Identity.� Includes the Identity's reference identifiers, biographic data, and biometric data. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="SubjectID" type="tns:BIASIDType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A system unique identifier for a subject.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="IdentityClaim" type="tns:BIASIDType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>An identifier by which a subject is known to a particular gallery or population group.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="EncounterID" type="tns:BIASIDType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identifier of an encounter associated with the subject, required for encounter-centric models.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="EncounterList" type="tns:EncounterListType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A list of encounters associated with a subject.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiographicData" type="tns:BiographicDataType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>An Identity's biographic data.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiographicDataElements" type="tns:BiographicDataType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>An Identity's biographic data elements that are stored in the implementing system.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiometricData" type="tns:BIASBiometricDataType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>An Identity's biometric data.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="BIASIDType"> <xsd:annotation> <xsd:documentation>A BIAS identifier</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"/> </xsd:simpleType> <xsd:complexType name="BiographicDataItemType"> <xsd:annotation> <xsd:documentation>Defines a single biographic data element.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="Name" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The name of the biographic data item.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Type" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The data type for the biographic data item.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Value" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The value assigned to the biographic data item.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="BiographicDataSetType"> <xsd:annotation> <xsd:documentation>Defines a set of biographic data that is formatted according to the specified format.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The name of the biographic data format. Use these names for common formats: FBI-EFTS, FBI-EBTS, DOD-EBTS, INT-I, NIEM, xNAL, HR-XML.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="version" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The version of the biographic data format (e.g., �7.1" for FBI-EFTS or �2.0" for NIEM).</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="source" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Reference to a URI/IRI describing the biographic data format. For example: (FBI-EFTS) www.fbibiospecs.org, (DOD-EBTS) www.biometrics.dod.mil, (INT-I) www.interpol.int, (NIEM) www.niem.gov, (xNAL) www.oasis-open.org, (HR-XML) www.hr-xml.org.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="type" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The biographic data format type. Use these types for common formats: ASCII (e.g., for non-XML versions of FBI-EFTS, FBI-EBTS, DOD-EFTS, or INT-I), XML (e.g., for NIEM, xNAL, and HR-XML or future version of FBI-EBTS).</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:any namespace="##any"> <xsd:annotation> <xsd:documentation>Biographic data formatted according to a specific format.</xsd:documentation> </xsd:annotation> </xsd:any> </xsd:sequence> </xsd:complexType> <xsd:complexType name="BiographicDataType"> <xsd:annotation> <xsd:documentation> Defines a set of biographic data elements, utilizing either the BiographicDataItemType to represent a list of elements or the BiographicDataSetType to represent a complete, formatted set of biographic information. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="LastName" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The last name of a subject.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="FirstName" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The first name of a subject.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiographicDataItems" minOccurs="0"> <xsd:complexType> <xsd:sequence> <xsd:element name="BiographicDataItem" type="tns:BiographicDataItemType" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>A single biographic data element.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="BiographicDataSet" type="tns:BiographicDataSetType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A set of biographic data information.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="BiometricDataElementType"> <xsd:annotation> <xsd:documentation> Provides descriptive information about biometric data, such as the biometric type, subtype, and format, contained in the BDB of the CBEFF-BIR. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="BiometricType" type="oasis_cbeff:MultipleTypesType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiometricTypeCount" type="xsd:positiveInteger" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The number of biometric records having the biometric type recorded in the biometric type field.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiometricSubType" type="oasis_cbeff:SubtypeType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BDBFormatOwner" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the standards body, working group, industry consortium, or other CBEFF biometric organization that has defined the format for the biometric data.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BDBFormatType" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="BiometricDataListType"> <xsd:annotation> <xsd:documentation>A list of biometric data elements.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="BiometricDataElement" type="tns:BiometricDataElementType" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Data structure containing information about a biometric record.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CandidateListType"> <xsd:annotation> <xsd:documentation> Defines a set of candidates, utilizing the Candidate Type to represent each element in the set. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="Candidate" type="tns:CandidateType" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>A single candidate.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CandidateType"> <xsd:annotation> <xsd:documentation> Defines a single candidate as a possible match in response to a biometric identification request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="Score" type="tns:Score" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The match score.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Rank" type="xsd:integer" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The rank of the candidate in relation to other candidates for the same biometric identification operation.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiographicData" type="tns:BiographicDataType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Biographic data associated with the candidate match.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BIRList" type="tns:CBEFF_BIR_ListType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Biometric data associated with the candidate match.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CapabilityListType"> <xsd:annotation> <xsd:documentation>Defines a set of capabilities.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="Capability" type="tns:CapabilityType" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>A single capability.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="CapabilityName"> <xsd:annotation> <xsd:documentation>A list of capability items.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"> <xsd:enumeration value="AggregateInputDataOptional"> <xsd:annotation> <xsd:documentation>A data element accepted as optional input by the implementing system for the aggregate services.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="AggregateInputDataRequired"> <xsd:annotation> <xsd:documentation>A data element required as input by the implementing system for the aggregate services.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="AggregateProcessingOption"> <xsd:annotation> <xsd:documentation>A processing option supported by the implementing system for the aggregate services.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="AggregateReturnData"> <xsd:annotation> <xsd:documentation>A data element returned by the implementing system for the aggregate services.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="AggregateServiceDescription"> <xsd:annotation> <xsd:documentation>Describes the processing logic of an aggregate service supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="BiographicDataSet"> <xsd:annotation> <xsd:documentation>Identifies a biographic data set supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="CBEFFPatronFormat"> <xsd:annotation> <xsd:documentation>A patron format supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="ClassificationAlgorithmType"> <xsd:annotation> <xsd:documentation>A classification algorithm type supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="ConformanceClass"> <xsd:annotation> <xsd:documentation>Identifies the conformance class of the BIAS implementation.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="Gallery"> <xsd:annotation> <xsd:documentation>A gallery or population group supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="IdentityModel"> <xsd:annotation> <xsd:documentation>Identifies whether the implementing system is person-centric or encounter-centric based.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="MatchScore"> <xsd:annotation> <xsd:documentation> Identifies the use of match scores returned by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="QualityAlgorithm"> <xsd:annotation> <xsd:documentation>A quality algorithm vendor and algorithm vendor product ID supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="SupportedBiometric"> <xsd:annotation> <xsd:documentation>A biometric type supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="TransformOperation"> <xsd:annotation> <xsd:documentation>A transform operation type supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:enumeration> </xsd:restriction> </xsd:simpleType> <xsd:complexType name="CapabilityType"> <xsd:annotation> <xsd:documentation>Defines a single capability supported by an implementing system.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="CapabilityName" type="tns:CapabilityName" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The name of the capability.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="CapabilityID" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>An identifier assigned to the capability by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="CapabilityDescription" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A description of the capability.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="CapabilityValue" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A value assigned to the capability.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="CapabilitySupportingValue" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A secondary value supporting the capability.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="CapabilityAdditionalInfo" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation> Contains additional information for the supported capability.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CBEFF_BIR_ListType"> <xsd:annotation> <xsd:documentation>A list of CBEFF-BIR elements.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="BIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>CBEFF structure containing information about a biometric sample.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CBEFF_BIR_Type"> <xsd:annotation> <xsd:documentation>Represents biometric information, with either a non-XML or XML representation.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="FormatOwner" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1" /> <xsd:element name="FormatType" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1" /> <xsd:element name="BIR_Information" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:element name="BIR_Info" type="oasis_cbeff:BIRInfoType" minOccurs="0" maxOccurs="1"/> <xsd:element name="BDB_Info" type="oasis_cbeff:BDBInfoType" minOccurs="0" maxOccurs="1"/> <xsd:element name="SB_Info" type="oasis_cbeff:SBInfoType" minOccurs="0" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="BIR" type="tns:BaseBIRType" /> </xsd:sequence> </xsd:complexType> <xsd:complexType name="BaseBIRType"> </xsd:complexType> <xsd:complexType name="BinaryBIR"> <xsd:complexContent> <xsd:extension base="tns:BaseBIRType"> <xsd:sequence> <xsd:element name="Binary" type="xsd:base64Binary" /> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="URI_BIR"> <xsd:complexContent> <xsd:extension base="tns:BaseBIRType"> <xsd:sequence> <xsd:element name="URI" type="xsd:anyURI" /> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="XML_BIR"> <xsd:complexContent> <xsd:extension base="tns:BaseBIRType"> <xsd:sequence> <xsd:element name="XML" type="oasis_cbeff:BIRType" /> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:simpleType name="Classification"> <xsd:annotation> <xsd:documentation>The result of a classification.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"/> </xsd:simpleType> <xsd:simpleType name="ClassificationAlgorithmType"> <xsd:annotation> <xsd:documentation>Type of classification algorithm that was used to perform the classification.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"/> </xsd:simpleType> <xsd:complexType name="ClassificationData"> <xsd:annotation> <xsd:documentation>Contains information on classification results and the algorithm used to determine the classification.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="Classification" type="tns:Classification" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The result of the classification.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ClassificationAlgorithmType" type="tns:ClassificationAlgorithmType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the type of classification algorithm that was used to perform the classification.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="EncounterListType"> <xsd:annotation> <xsd:documentation>Defines a set of encounters.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="EncounterID" type="tns:BIASIDType" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>The identifier of an encounter.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="FusionInformationListType"> <xsd:annotation> <xsd:documentation> Contains at a minimum two sets of fusion input elements, as input to the PerformFusion request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="FusionElement" type="tns:FusionInformationType" minOccurs="2" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>A set of fusion information.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="FusionInformationType"> <xsd:annotation> <xsd:documentation>Represents the information necessary to perform a fusion operation.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="BiometricType" type="oasis_cbeff:MultipleTypesType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiometricSubType" type="oasis_cbeff:SubtypeType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>More specifically defines the type of biometric data stored in the biometric record.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="AlgorithmOwner" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The owner or vendor of the algorithm used to determine the score or decision.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="AlgorithmType" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The Algorithm Owner's identifier for the specific algorithm product and version used to determine the score or decision.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="FusionResult" type="tns:FusionResult" /> </xsd:sequence> </xsd:complexType> <xsd:complexType name="FusionResult"> <xsd:sequence /> </xsd:complexType> <xsd:complexType name="FusionScore"> <xsd:complexContent> <xsd:extension base="tns:FusionResult"> <xsd:sequence> <xsd:element name="Score" type="tns:Score"> <xsd:annotation> <xsd:documentation>The similarity score assigned by the matching algorithm.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="FusionDecision"> <xsd:complexContent> <xsd:extension base="tns:FusionResult"> <xsd:sequence> <xsd:element name="Decision" type="xsd:string"> <xsd:annotation> <xsd:documentation>The match decision assigned by the matching algorithm.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="GenericRequestParameters"> <xsd:annotation> <xsd:documentation>Common request paramters that can be used to identify the requester.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="Application" type="tns:ApplicationIdentifier" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the requesting application.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ApplicationUser" type="tns:ApplicationUserIdentifier" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifers the user or instance of the requesting application.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BIASOperationName" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifers the BIAS operation name that is being requested.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="InformationType"> <xsd:annotation> <xsd:documentation> Allows for an unlimited number of data element types, and it does not specify nor require any particular data element. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="ListFilterType"> <xsd:annotation> <xsd:documentation> Provides a method to filter the amount of information returned in a search of biometric data. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="BiometricTypeFilters"> <xsd:complexType> <xsd:sequence> <xsd:element name="BiometricTypeFilter" type="oasis_cbeff:MultipleTypesType" minOccurs="1" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Limits the returned information to a specific type of biometric, as defined by CBEFF.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="IncludeBiometricSubtype" type="xsd:boolean" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A Boolean flag indicating if biometric subtype information should be returned.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="MatchType"> <xsd:annotation> <xsd:documentation>The result of a fusion method.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:boolean"/> </xsd:simpleType> <xsd:complexType name="ProcessingOptionsType"> <xsd:annotation> <xsd:documentation> BIAS aggregate services support the ability to include various processing options which direct and possibly control the business logic for that service. The ProcessingOptionsType provides a method to represent those options. Processing options should be defined by the implementing system. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="Option" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>An option supported by the implementing system.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="ProductID"> <xsd:annotation> <xsd:documentation>The vendor's ID for a particular product.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"/> </xsd:simpleType> <xsd:complexType name="QualityData"> <xsd:annotation> <xsd:documentation>Contains information about a biometric sample's quality and the algorithm used to compute the quality.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="QualityScore" type="oasis_cbeff:QualityType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The quality of a biometric sample.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="AlgorithmVendor" type="tns:VendorIdentifier" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The vendor of the qualilty algorithm used to determine the quality score.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="AlgorithmVendorProductID" type="tns:ProductID" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The vendor's ID for the algorithm used to determine the quality.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="AlgorithmVersion" type="tns:VersionType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The version of the algorithm used to determine the quality.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="RequestTemplate"> <xsd:annotation> <xsd:documentation>Base template for BIAS primitive service requests.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GenericRequestParameters" type="tns:GenericRequestParameters" minOccurs="0" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="ResponseStatus"> <xsd:sequence> <xsd:element name="Return" type="tns:ReturnCode" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The return code indicates the return status of the operation.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Message" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A short message corresponding to the return code.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="ResponseTemplate"> <xsd:annotation> <xsd:documentation>Base template for BIAS responses.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="ResponseStatus" type="tns:ResponseStatus" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Returned status for the operation.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="ReturnCode"> <xsd:annotation> <xsd:documentation>BIAS Operation Return Codes</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:unsignedLong"> <xsd:enumeration value="0"> <xsd:annotation> <xsd:documentation>Success</xsd:documentation> </xsd:annotation> </xsd:enumeration> </xsd:restriction> </xsd:simpleType> <xsd:simpleType name="Score"> <xsd:annotation> <xsd:documentation>Match result or quality score.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:float"/> </xsd:simpleType> <xsd:complexType name="TokenType"> <xsd:annotation> <xsd:documentation>Defines a token that is returned for asynchronous processing.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="TokenValue" type="xsd:string" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A value returned by the implementing system that is used to retrieve the results to a service at a later time.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Expiration" type="xsd:date" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A date and time at which point the token expires and the service results are no longer guaranteed to be available.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="VendorIdentifier"> <xsd:annotation> <xsd:documentation>Identifies a vendor.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"/> </xsd:simpleType> <xsd:complexType name="Version"> <xsd:annotation> <xsd:documentation> For a description or definition of each data element, see the referenced CBEFF standards in the CBEFF_XML_BIR_Type schema. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="major" type="xsd:nonNegativeInteger" minOccurs="1" maxOccurs="1"/> <xsd:element name="minor" type="xsd:nonNegativeInteger" minOccurs="1" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="VersionType"> <xsd:annotation> <xsd:documentation>The version of a component.</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"/> </xsd:simpleType> <xsd:element name="AddSubjectToGallery"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Register a subject to a given gallery or population group. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="AddSubjectToGalleryRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="GalleryID" type="tns:BIASIDType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identifier of the gallery or population group to which the subject will be added.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identity to add to the gallery.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="AddSubjectToGalleryResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to an AddSubjectToGallery request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="AddSubjectToGalleryResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="CheckQuality"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Calculate a quality score for a given biometric. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="CheckQualityRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="BiometricData" type="tns:BIASBiometricDataType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Data structure containing a single biometric sample for which a quality score is to be determined.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Quality" type="tns:QualityData" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Specifies a particular algorithm vendor and vender product ID.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="CheckQualityResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a CheckQuality request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="CheckQualityResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="QualityInfo" type="tns:QualityData" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains the quality information for the submitted biometric sample.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="ClassifyBiometricData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Classifies a biometric sample. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="ClassifyBiometricDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="BiometricData" type="tns:BIASBiometricDataType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Data structure containing a single biometric sample for which the classification is to be determined.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="ClassifyBiometricDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a ClassifyBiometricData request, containing the classification of a biometric sample. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="ClassifyBiometricDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="ClassificationData" type="tns:ClassificationData" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Information on the results and type of classification performed.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="CreateSubject"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Create a new subject record. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="CreateSubjectRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="CreateSubjectResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a CreateSubject request, containing the subject ID of the new subject record. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="CreateSubjectResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains the subject ID of the new subject record.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteBiographicData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Erase all of the biographic data associated with a given subject record or, in the encounter-centric model, with a given encounter. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteBiographicDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains either the subject ID or encounter ID reference.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteBiographicDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a DeleteBiographicData request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteBiographicDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteBiometricData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Erase all of the biometric data associated with a given subject record or, in the encounter-centric model, with a given encounter. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteBiometricDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains either the subject ID or encounter ID reference.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteBiometricDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a DeleteBiometricData request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteBiometricDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteSubject"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Delete an existing subject record and, in an encounter-centric model, any associated encounter information. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteSubjectRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Subject ID of the identity to delete.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteSubjectResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a DeleteSubject request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteSubjectResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteSubjectFromGallery"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Remove the registration of a subject from a gallery or population group. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteSubjectFromGalleryRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="GalleryID" type="tns:BIASIDType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identifier of the gallery or population group from which the subject will be deleted.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identity to remove from the gallery.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DeleteSubjectFromGalleryResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a DeleteSubjectFromGallery request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="DeleteSubjectFromGalleryResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetIdentifySubjectResults"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Retrieve the identification results for a specified token, which was returned by the Identify Subject service. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetIdentifySubjectResultsRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Token" type="tns:TokenType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A value used to retrieve the results of an IdentifySubject request.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetIdentifySubjectResultsResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a GetIdentifySubjectResults request, which includes a candidate list. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetIdentifySubjectResultsResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="CandidateList" type="tns:CandidateListType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A rank-ordered list of candidates that have a likelihood of matching the input biometric sample.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="IdentifySubject"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Perform an identification search against a given gallery for a given biometric. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="IdentifySubjectRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="GalleryID" type="tns:BIASIDType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identifier of the gallery or population group which will be searched.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Contains the BIR, a data structure containing the biometric sample for the search.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="MaxListSize" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The maximum size of the candidate list that should be returned.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="IdentifySubjectResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to an IdentifySubject request, returning a rank-ordered candidate list. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="IdentifySubjectResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="IdentifySubjectResult" type="tns:IdentifySubjectResultType" /> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:complexType name="IdentifySubjectResultType"> <xsd:sequence /> </xsd:complexType> <xsd:complexType name="CandidateListResultType"> <xsd:complexContent> <xsd:extension base="tns:IdentifySubjectResultType"> <xsd:sequence> <xsd:element name="CandidateList" type="tns:CandidateListType"> <xsd:annotation> <xsd:documentation>A rank-ordered list of candidates that have a likelihood of matching the input biometric sample; returned with successful synchronous request processing.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="TokenResultType"> <xsd:complexContent> <xsd:extension base="tns:IdentifySubjectResultType"> <xsd:sequence> <xsd:element name="Token" type="tns:TokenType"> <xsd:annotation> <xsd:documentation>A token used to retrieve the results of the IdentifySubject request; returned with asynchronous request processing.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:element name="ListBiographicData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Lists the biographic data elements stored for a subject. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="ListBiographicDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="ListBiographicDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a ListBiographicData request, containing a list of biographic data elements stored for a subject.� In the encounter-centric model, the biographic data elements for a specific encounter are returned.� If an encounter ID is not specified and encounter data exists for the subject, the list of encounter IDs which contain biographic data is returned. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="ListBiographicDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation> Contains a list of biographic data elements associated with a subject or encounter; non-empty if the service was successful, biographic data exists, and either (a) the person-centric model is being used or (b) the encounter-centric model is being used and an encounter identifier was specified. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="EncounterList" type="tns:EncounterListType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation> A list of encounter ID's associated with a subject and which contain biographic data; non-empty if the service was successful, biographic data exists, the encounter-centric model is being used, and an encounter identifier was not specified. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="ListBiometricData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Lists the biometric data elements stored for a subject. Note that no actual biometric data is returned by this service (see the RetrieveBiometricInformation service to obtain the biometric data). </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="ListBiometricDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ListFilter" type="tns:ListFilterType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Indicates what biometric information should be returned.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="ListBiometricDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a ListBiometricData request, containing a list of biometric data elements stored for a subject.� In the encounter-centric model, the biometric data elements for a specific encounter are returned.� If an encounter ID is not specified and encounter data exists for the subject, the list of encounter IDs which contain biometric data is returned. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="ListBiometricDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity"> <xsd:annotation> <xsd:documentation> Includes a list of biometric data elements associated with a subject or encounter or a list of encounter ID's associated with a subject and which contain biometric data. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="PerformFusion"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Accepts either match score or match decision information and creates a fused match result. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="PerformFusionRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="FusionInput" type="tns:FusionInformationListType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Score or decision input information to the fusion method.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="PerformFusionResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to the PerformFusion request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="PerformFusionResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Match" type="tns:MatchType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Indicates the result of the fusion method</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="QueryCapabilities"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Returns a list of the capabilities, options, galleries, etc. that are supported by the BIAS implementation. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="QueryCapabilitiesRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="QueryCapabilitiesResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a QueryCapabilities request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="QueryCapabilitiesResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="CapabilityList" type="tns:CapabilityListType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A list of capabilities supported by the BIAS implementation.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RetrieveBiographicInformation"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Retrieves the biographic data associated with a subject ID. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="RetrieveBiographicInformationRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RetrieveBiographicInformationResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a RetrieveBiographicInformation request, containing the biographic data associated with a subject ID. In the encounter-centric model, the biographic data associated with a specified encounter is returned. If the encounter ID is not specified in the encounter-centric model, the biographic information associated with the most recent encounter is returned. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="RetrieveBiographicInformationResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Includes the set of biographic data associated with a subject.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RetrieveBiometricInformation"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Retrieves the biometric data associated with a subject ID. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="RetrieveBiometricInformationRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="BiometricType" type="oasis_cbeff:MultipleTypesType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The type of biological or behavioral data to retrieve.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RetrieveBiometricInformationResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a RetrieveBiometricInformation request, containing the biometric data associated with a subject ID. In the encounter-centric model, the biometric data associated with a specified encounter is returned. If the encounter ID is not specified in the encounter-centric model, the biometric information associated with the most recent encounter is returned. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="RetrieveBiometricInformationResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Includes the biometric data associated with a subject.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="SetBiographicData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Associates biographic data to a given subject record. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="SetBiographicDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to store.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="SetBiographicDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a SetBiographicData request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="SetBiographicDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>In an encounter-centric model, identifies the encounter ID assigned to a new encounter.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="SetBiometricData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Associates biometric data to a given subject record. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="SetBiometricDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to store.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="SetBiometricDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a SetBiometricData request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="SetBiometricDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>In an encounter-centric model, identifies the encounter ID assigned to a new encounter.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="TransformBiometricData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Transforms or processes a given biometric in one format into a new target format. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="TransformBiometricDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="InputBIR" type="tns:CBEFF_BIR_Type" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Data structure containing the biometric information to be transformed.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="TransformOperation" type="xsd:unsignedLong" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Value indicating the type of transformation to perform.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="TransformControl" type="xsd:string" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation> Specifies controls for the requested transform operation.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="TransformBiometricDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a TransformBiometricData request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="TransformBiometricDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="OutputBIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Data structure containing the new, transformed biometric information.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="UpdateBiographicData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Updates the biographic data for a given subject record. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="UpdateBiographicDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to update.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="UpdateBiographicDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to an UpdateBiographicData request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="UpdateBiographicDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="UpdateBiometricData"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Updates a single biometric sample for a given subject record. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="UpdateBiometricDataRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to update.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Merge" type="xsd:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Value indicating if the input biometric sample should be merged with any existing biometric information.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="UpdateBiometricDataResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to an UpdateBiometricData request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="UpdateBiometricDataResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="VerifySubject"> <xsd:complexType> <xsd:annotation> <xsd:documentation> Performs a 1:1 verification match between a given biometric and either a claim to identity in a given gallery or another given biometric. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="VerifySubjectRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="GalleryID" type="tns:BIASIDType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identifier of the gallery or population group of which the subject must be a member.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Includes the identifying information and/or input and reference biometric samples.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="VerifySubjectResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The response to a VerifySubject request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="VerifySubjectResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:ResponseTemplate"> <xsd:sequence> <xsd:element name="Match" type="xsd:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Score" type="tns:Score" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The score if the biometric information matched.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="Enroll"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The Enroll aggregate service adds a new subject or, in an encounter-centric model, a new encounter to the system. This may be accomplished in a number of different ways according to system requirements and/or resources. If the Enroll aggregate service is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the ReturnData parameter. If the Enroll aggregate service is implemented as an asynchronous service, the implementing system returns a token in the ReturnData parameter, which is an indication that the request is being handled asynchronously. In this case, the GetEnrollResults service is used to poll for the results of the Enroll request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="EnrollRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateRequestTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="EnrollResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation>The response to an Enroll request.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="EnrollResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetEnrollResults"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The GetEnrollResults aggregate service retrieves the enrollment results for the specified token. This service is used in conjunction with the Enroll aggregate service. If the Enroll aggregate service is implemented as an asynchronous service, the implementing system returns a token, and the GetEnrollResults service is used to poll for the results of the original Enroll request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetEnrollResultsRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Token" type="tns:TokenType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A value used to retrieve the results of the Enroll request.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetEnrollResultsResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation>The response to a GetEnrollResults request.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetEnrollResultsResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetIdentifyResults"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The GetIdentifyResults aggregate service retrieves the identification results for the specified token. This service is used in conjunction with the Identify aggregate service. If the Identify aggregate service is implemented as an asynchronous service, the implementing system returns a token, and the GetIdentifyResults service is used to poll for the results of the original Identify request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetIdentifyResultsRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Token" type="tns:TokenType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A value used to retrieve the results of the Identify request.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetIdentifyResultsResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation>The response to a GetIdentifyResults request.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetIdentifyResultsResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetVerifyResults"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The GetVerifyResults aggregate service retrieves the verification results for the specified token. This service is used in conjunction with the Verify aggregate service. If the Verify aggregate service is implemented as an asynchronous service, the implementing system returns a token, and the GetVerifyResults service is used to poll for the results of the original Verify request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetVerifyResultsRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="Token" type="tns:TokenType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>A value used to retrieve the results of the Verify request.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="GetVerifyResultsResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation>The response to a GetVerifyResults request.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="GetVerifyResultsResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateResponseTemplate"> <xsd:sequence> <xsd:element name="Match" type="xsd:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Score" type="tns:Score" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The score if the biometric information matched.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="Identify"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The Identify aggregate service performs an identification function according to system requirements and/or resources. If the Identify aggregate service is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the ReturnData parameter. If the Identify aggregate service is implemented as an asynchronous service, the implementing system returns a token in the ReturnData parameter, which is an indication that the request is being handled asynchronously. In this case, the GetIdentifyResults service is used to poll for the results of the Identify request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="IdentifyRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateRequestTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="IdentifyResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation>The response to an Identify request.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="IdentifyResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RetrieveInformation"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The RetrieveInformation aggregate service retrieves requested information about a subject, or in an encounter-centric model about an encounter. In a person-centric model, this aggregate service may be used to retrieve both biographic and biometric information for a subject record. In an encounter-centric model, this aggregate service may be used to retrieve biographic and/or biometric information for either a single encounter or all encounters. Either a SubjectID or EncounterID must be specified in the Identify parameter. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="RetrieveInformationRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:RequestTemplate"> <xsd:sequence> <xsd:element name="ProcessingOptions" type="tns:ProcessingOptionsType" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Options that guide how the service request is processed, and may identify what type(s) of information should be returned.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Includes the identifier of the subject or encounter.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RetrieveInformationResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation>The response to a RetrieveInformation request.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="RetrieveInformationResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateResponseTemplate"/> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="Verify"> <xsd:complexType> <xsd:annotation> <xsd:documentation> The Verify aggregate service performs a 1:1 verification function according to system requirements and/or resources. Either the IdentityClaim or ReferenceBIR input data elements in the Identity parameter are required. If the Verify aggregate service is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the ReturnData parameter. If the Verify aggregate service is implemented as an asynchronous service, the implementing system returns a token in the ReturnData parameter, which is an indication that the request is being handled asynchronously. In this case, the GetVerifyResults service is used to poll for the results of the Verify request. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="VerifyRequest" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateRequestTemplate"> <xsd:sequence> <xsd:element name="Identity" type="tns:BIASIdentity" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Includes either the IdentityClaim or ReferenceBIR.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="GalleryID" type="tns:BIASIDType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The identifier of the gallery or population group of which the subject must be a member.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="VerifyResponse"> <xsd:complexType> <xsd:annotation> <xsd:documentation>The response to a Verify request.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element name="VerifyResponsePackage" nillable="true"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="tns:AggregateResponseTemplate"> <xsd:sequence> <xsd:element name="Match" type="xsd:boolean" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Score" type="tns:Score" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>The score if the biometric information matched.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="BIASFault" type="tns:BIASFaultDetail"/> </xsd:schema> </wsdl:types> <wsdl:message name="BIASFaultMessage"> <wsdl:part name="parameters" element="tns:BIASFault"/> </wsdl:message> <wsdl:message name="AddSubjectToGalleryRequestMessage"> <wsdl:part name="parameters" element="tns:AddSubjectToGallery"/> </wsdl:message> <wsdl:message name="AddSubjectToGalleryResponseMessage"> <wsdl:part name="parameters" element="tns:AddSubjectToGalleryResponse"/> </wsdl:message> <wsdl:message name="CheckQualityRequestMessage"> <wsdl:part name="parameters" element="tns:CheckQuality"/> </wsdl:message> <wsdl:message name="CheckQualityResponseMessage"> <wsdl:part name="parameters" element="tns:CheckQualityResponse"/> </wsdl:message> <wsdl:message name="ClassifyBiometricDataRequestMessage"> <wsdl:part name="parameters" element="tns:ClassifyBiometricData"/> </wsdl:message> <wsdl:message name="ClassifyBiometricDataResponseMessage"> <wsdl:part name="parameters" element="tns:ClassifyBiometricDataResponse"/> </wsdl:message> <wsdl:message name="CreateSubjectRequestMessage"> <wsdl:part name="parameters" element="tns:CreateSubject"/> </wsdl:message> <wsdl:message name="CreateSubjectResponseMessage"> <wsdl:part name="parameters" element="tns:CreateSubjectResponse"/> </wsdl:message> <wsdl:message name="DeleteBiographicDataRequestMessage"> <wsdl:part name="parameters" element="tns:DeleteBiographicData"/> </wsdl:message> <wsdl:message name="DeleteBiographicDataResponseMessage"> <wsdl:part name="parameters" element="tns:DeleteBiographicDataResponse"/> </wsdl:message> <wsdl:message name="DeleteBiometricDataRequestMessage"> <wsdl:part name="parameters" element="tns:DeleteBiometricData"/> </wsdl:message> <wsdl:message name="DeleteBiometricDataResponseMessage"> <wsdl:part name="parameters" element="tns:DeleteBiometricDataResponse"/> </wsdl:message> <wsdl:message name="DeleteSubjectRequestMessage"> <wsdl:part name="parameters" element="tns:DeleteSubject"/> </wsdl:message> <wsdl:message name="DeleteSubjectResponseMessage"> <wsdl:part name="parameters" element="tns:DeleteSubjectResponse"/> </wsdl:message> <wsdl:message name="DeleteSubjectFromGalleryRequestMessage"> <wsdl:part name="parameters" element="tns:DeleteSubjectFromGallery"/> </wsdl:message> <wsdl:message name="DeleteSubjectFromGalleryResponseMessage"> <wsdl:part name="parameters" element="tns:DeleteSubjectFromGalleryResponse"/> </wsdl:message> <wsdl:message name="GetIdentifySubjectResultsRequestMessage"> <wsdl:part name="parameters" element="tns:GetIdentifySubjectResults"/> </wsdl:message> <wsdl:message name="GetIdentifySubjectResultsResponseMessage"> <wsdl:part name="parameters" element="tns:GetIdentifySubjectResultsResponse"/> </wsdl:message> <wsdl:message name="IdentifySubjectRequestMessage"> <wsdl:part name="parameters" element="tns:IdentifySubject"/> </wsdl:message> <wsdl:message name="IdentifySubjectResponseMessage"> <wsdl:part name="parameters" element="tns:IdentifySubjectResponse"/> </wsdl:message> <wsdl:message name="ListBiographicDataRequestMessage"> <wsdl:part name="parameters" element="tns:ListBiographicData"/> </wsdl:message> <wsdl:message name="ListBiographicDataResponseMessage"> <wsdl:part name="parameters" element="tns:ListBiographicDataResponse"/> </wsdl:message> <wsdl:message name="ListBiometricDataRequestMessage"> <wsdl:part name="parameters" element="tns:ListBiometricData"/> </wsdl:message> <wsdl:message name="ListBiometricDataResponseMessage"> <wsdl:part name="parameters" element="tns:ListBiometricDataResponse"/> </wsdl:message> <wsdl:message name="PerformFusionRequestMessage"> <wsdl:part name="parameters" element="tns:PerformFusion"/> </wsdl:message> <wsdl:message name="PerformFusionResponseMessage"> <wsdl:part name="parameters" element="tns:PerformFusionResponse"/> </wsdl:message> <wsdl:message name="QueryCapabilitiesRequestMessage"> <wsdl:part name="parameters" element="tns:QueryCapabilities"/> </wsdl:message> <wsdl:message name="QueryCapabilitiesResponseMessage"> <wsdl:part name="parameters" element="tns:QueryCapabilitiesResponse"/> </wsdl:message> <wsdl:message name="RetrieveBiographicInformationRequestMessage"> <wsdl:part name="parameters" element="tns:RetrieveBiographicInformation"/> </wsdl:message> <wsdl:message name="RetrieveBiographicInformationResponseMessage"> <wsdl:part name="parameters" element="tns:RetrieveBiographicInformationResponse"/> </wsdl:message> <wsdl:message name="RetrieveBiometricInformationRequestMessage"> <wsdl:part name="parameters" element="tns:RetrieveBiometricInformation"/> </wsdl:message> <wsdl:message name="RetrieveBiometricInformationResponseMessage"> <wsdl:part name="parameters" element="tns:RetrieveBiometricInformationResponse"/> </wsdl:message> <wsdl:message name="SetBiographicDataRequestMessage"> <wsdl:part name="parameters" element="tns:SetBiographicData"/> </wsdl:message> <wsdl:message name="SetBiographicDataResponseMessage"> <wsdl:part name="parameters" element="tns:SetBiographicDataResponse"/> </wsdl:message> <wsdl:message name="SetBiometricDataRequestMessage"> <wsdl:part name="parameters" element="tns:SetBiometricData"/> </wsdl:message> <wsdl:message name="SetBiometricDataResponseMessage"> <wsdl:part name="parameters" element="tns:SetBiometricDataResponse"/> </wsdl:message> <wsdl:message name="TransformBiometricDataRequestMessage"> <wsdl:part name="parameters" element="tns:TransformBiometricData"/> </wsdl:message> <wsdl:message name="TransformBiometricDataResponseMessage"> <wsdl:part name="parameters" element="tns:TransformBiometricDataResponse"/> </wsdl:message> <wsdl:message name="UpdateBiographicDataRequestMessage"> <wsdl:part name="parameters" element="tns:UpdateBiographicData"/> </wsdl:message> <wsdl:message name="UpdateBiographicDataResponseMessage"> <wsdl:part name="parameters" element="tns:UpdateBiographicDataResponse"/> </wsdl:message> <wsdl:message name="UpdateBiometricDataRequestMessage"> <wsdl:part name="parameters" element="tns:UpdateBiometricData"/> </wsdl:message> <wsdl:message name="UpdateBiometricDataResponseMessage"> <wsdl:part name="parameters" element="tns:UpdateBiometricDataResponse"/> </wsdl:message> <wsdl:message name="VerifySubjectRequestMessage"> <wsdl:part name="parameters" element="tns:VerifySubject"/> </wsdl:message> <wsdl:message name="VerifySubjectResponseMessage"> <wsdl:part name="parameters" element="tns:VerifySubjectResponse"/> </wsdl:message> <wsdl:message name="EnrollRequestMessage"> <wsdl:part name="parameters" element="tns:Enroll"/> </wsdl:message> <wsdl:message name="EnrollResponseMessage"> <wsdl:part name="parameters" element="tns:EnrollResponse"/> </wsdl:message> <wsdl:message name="GetEnrollResultsRequestMessage"> <wsdl:part name="parameters" element="tns:GetEnrollResults"/> </wsdl:message> <wsdl:message name="GetEnrollResultsResponseMessage"> <wsdl:part name="parameters" element="tns:GetEnrollResultsResponse"/> </wsdl:message> <wsdl:message name="GetIdentifyResultsRequestMessage"> <wsdl:part name="parameters" element="tns:GetIdentifyResults"/> </wsdl:message> <wsdl:message name="GetIdentifyResultsResponseMessage"> <wsdl:part name="parameters" element="tns:GetIdentifyResultsResponse"/> </wsdl:message> <wsdl:message name="GetVerifyResultsRequestMessage"> <wsdl:part name="parameters" element="tns:GetVerifyResults"/> </wsdl:message> <wsdl:message name="GetVerifyResultsResponseMessage"> <wsdl:part name="parameters" element="tns:GetVerifyResultsResponse"/> </wsdl:message> <wsdl:message name="IdentifyRequestMessage"> <wsdl:part name="parameters" element="tns:Identify"/> </wsdl:message> <wsdl:message name="IdentifyResponseMessage"> <wsdl:part name="parameters" element="tns:IdentifyResponse"/> </wsdl:message> <wsdl:message name="RetrieveInformationRequestMessage"> <wsdl:part name="parameters" element="tns:RetrieveInformation"/> </wsdl:message> <wsdl:message name="RetrieveInformationResponseMessage"> <wsdl:part name="parameters" element="tns:RetrieveInformationResponse"/> </wsdl:message> <wsdl:message name="VerifyRequestMessage"> <wsdl:part name="parameters" element="tns:Verify"/> </wsdl:message> <wsdl:message name="VerifyResponseMessage"> <wsdl:part name="parameters" element="tns:VerifyResponse"/> </wsdl:message> <wsdl:portType name="BIAS_v1"> <wsdl:operation name="AddSubjectToGallery"> <wsdl:input name="AddSubjectToGallery" message="tns:AddSubjectToGalleryRequestMessage"/> <wsdl:output name="AddSubjectToGalleryResponse" message="tns:AddSubjectToGalleryResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="CheckQuality"> <wsdl:input name="CheckQuality" message="tns:CheckQualityRequestMessage"/> <wsdl:output name="CheckQualityResponse" message="tns:CheckQualityResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="ClassifyBiometricData"> <wsdl:input name="ClassifyBiometricData" message="tns:ClassifyBiometricDataRequestMessage"/> <wsdl:output name="ClassifyBiometricDataResponse" message="tns:ClassifyBiometricDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="CreateSubject"> <wsdl:input name="CreateSubject" message="tns:CreateSubjectRequestMessage"/> <wsdl:output name="CreateSubjectResponse" message="tns:CreateSubjectResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="DeleteBiographicData"> <wsdl:input name="DeleteBiographicData" message="tns:DeleteBiographicDataRequestMessage"/> <wsdl:output name="DeleteBiographicDataResponse" message="tns:DeleteBiographicDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="DeleteBiometricData"> <wsdl:input name="DeleteBiometricData" message="tns:DeleteBiometricDataRequestMessage"/> <wsdl:output name="DeleteBiometricDataResponse" message="tns:DeleteBiometricDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="DeleteSubject"> <wsdl:input name="DeleteSubject" message="tns:DeleteSubjectRequestMessage"/> <wsdl:output name="DeleteSubjectResponse" message="tns:DeleteSubjectResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="DeleteSubjectFromGallery"> <wsdl:input name="DeleteSubjectFromGallery" message="tns:DeleteSubjectFromGalleryRequestMessage"/> <wsdl:output name="DeleteSubjectFromGalleryResponse" message="tns:DeleteSubjectFromGalleryResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="GetIdentifySubjectResults"> <wsdl:input name="GetIdentifySubjectResults" message="tns:GetIdentifySubjectResultsRequestMessage"/> <wsdl:output name="GetIdentifySubjectResultsResponse" message="tns:GetIdentifySubjectResultsResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="IdentifySubject"> <wsdl:input name="IdentifySubject" message="tns:IdentifySubjectRequestMessage"/> <wsdl:output name="IdentifySubjectResponse" message="tns:IdentifySubjectResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="ListBiographicData"> <wsdl:input name="ListBiographicData" message="tns:ListBiographicDataRequestMessage"/> <wsdl:output name="ListBiographicDataResponse" message="tns:ListBiographicDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="ListBiometricData"> <wsdl:input name="ListBiometricData" message="tns:ListBiometricDataRequestMessage"/> <wsdl:output name="ListBiometricDataResponse" message="tns:ListBiometricDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="PerformFusion"> <wsdl:input name="PerformFusion" message="tns:PerformFusionRequestMessage"/> <wsdl:output name="PerformFusionResponse" message="tns:PerformFusionResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="QueryCapabilities"> <wsdl:input name="QueryCapabilities" message="tns:QueryCapabilitiesRequestMessage"/> <wsdl:output name="QueryCapabilitiesResponse" message="tns:QueryCapabilitiesResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="RetrieveBiographicInformation"> <wsdl:input name="RetrieveBiographicInformation" message="tns:RetrieveBiographicInformationRequestMessage"/> <wsdl:output name="RetrieveBiographicInformationResponse" message="tns:RetrieveBiographicInformationResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="RetrieveBiometricInformation"> <wsdl:input name="RetrieveBiometricInformation" message="tns:RetrieveBiometricInformationRequestMessage"/> <wsdl:output name="RetrieveBiometricInformationResponse" message="tns:RetrieveBiometricInformationResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="SetBiographicData"> <wsdl:input name="SetBiographicData" message="tns:SetBiographicDataRequestMessage"/> <wsdl:output name="SetBiographicDataResponse" message="tns:SetBiographicDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="SetBiometricData"> <wsdl:input name="SetBiometricData" message="tns:SetBiometricDataRequestMessage"/> <wsdl:output name="SetBiometricDataResponse" message="tns:SetBiometricDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="TransformBiometricData"> <wsdl:input name="TransformBiometricData" message="tns:TransformBiometricDataRequestMessage"/> <wsdl:output name="TransformBiometricDataResponse" message="tns:TransformBiometricDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="UpdateBiographicData"> <wsdl:input name="UpdateBiographicData" message="tns:UpdateBiographicDataRequestMessage"/> <wsdl:output name="UpdateBiographicDataResponse" message="tns:UpdateBiographicDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="UpdateBiometricData"> <wsdl:input name="UpdateBiometricData" message="tns:UpdateBiometricDataRequestMessage"/> <wsdl:output name="UpdateBiometricDataResponse" message="tns:UpdateBiometricDataResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="VerifySubject"> <wsdl:input name="VerifySubject" message="tns:VerifySubjectRequestMessage"/> <wsdl:output name="VerifySubjectResponse" message="tns:VerifySubjectResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="Enroll"> <wsdl:input name="Enroll" message="tns:EnrollRequestMessage"/> <wsdl:output name="EnrollResponse" message="tns:EnrollResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="GetEnrollResults"> <wsdl:input name="GetEnrollResults" message="tns:GetEnrollResultsRequestMessage"/> <wsdl:output name="GetEnrollResultsResponse" message="tns:GetEnrollResultsResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="GetIdentifyResults"> <wsdl:input name="GetIdentifyResults" message="tns:GetIdentifyResultsRequestMessage"/> <wsdl:output name="GetIdentifyResultsResponse" message="tns:GetIdentifyResultsResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="GetVerifyResults"> <wsdl:input name="GetVerifyResults" message="tns:GetVerifyResultsRequestMessage"/> <wsdl:output name="GetVerifyResultsResponse" message="tns:GetVerifyResultsResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="Identify"> <wsdl:input name="Identify" message="tns:IdentifyRequestMessage"/> <wsdl:output name="IdentifyResponse" message="tns:IdentifyResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="RetrieveInformation"> <wsdl:input name="RetrieveInformation" message="tns:RetrieveInformationRequestMessage"/> <wsdl:output name="RetrieveInformationResponse" message="tns:RetrieveInformationResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> <wsdl:operation name="Verify"> <wsdl:input name="Verify" message="tns:VerifyRequestMessage"/> <wsdl:output name="VerifyResponse" message="tns:VerifyResponseMessage"/> <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/> </wsdl:operation> </wsdl:portType> <wsdl:binding name="BIAS_v1HttpBinding" type="tns:BIAS_v1"> <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> <wsdl:operation name="AddSubjectToGallery"> <soap:operation soapAction="AddSubjectToGallery"/> <wsdl:input name="AddSubjectToGallery"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="AddSubjectToGalleryResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="CheckQuality"> <soap:operation soapAction="CheckQuality"/> <wsdl:input name="CheckQuality"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="CheckQualityResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="ClassifyBiometricData"> <soap:operation soapAction="ClassifyBiometricData"/> <wsdl:input name="ClassifyBiometricData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="ClassifyBiometricDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="CreateSubject"> <soap:operation soapAction="CreateSubject"/> <wsdl:input name="CreateSubject"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="CreateSubjectResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="DeleteBiographicData"> <soap:operation soapAction="DeleteBiographicData"/> <wsdl:input name="DeleteBiographicData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="DeleteBiographicDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="DeleteBiometricData"> <soap:operation soapAction="DeleteBiometricData"/> <wsdl:input name="DeleteBiometricData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="DeleteBiometricDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="DeleteSubject"> <soap:operation soapAction="DeleteSubject"/> <wsdl:input name="DeleteSubject"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="DeleteSubjectResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="DeleteSubjectFromGallery"> <soap:operation soapAction="DeleteSubjectFromGallery"/> <wsdl:input name="DeleteSubjectFromGallery"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="DeleteSubjectFromGalleryResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="GetIdentifySubjectResults"> <soap:operation soapAction="GetIdentifySubjectResults"/> <wsdl:input name="GetIdentifySubjectResults"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="GetIdentifySubjectResultsResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="IdentifySubject"> <soap:operation soapAction="IdentifySubject"/> <wsdl:input name="IdentifySubject"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="IdentifySubjectResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="ListBiographicData"> <soap:operation soapAction="ListBiographicData"/> <wsdl:input name="ListBiographicData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="ListBiographicDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="ListBiometricData"> <soap:operation soapAction="ListBiometricData"/> <wsdl:input name="ListBiometricData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="ListBiometricDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="PerformFusion"> <soap:operation soapAction="PerformFusion"/> <wsdl:input name="PerformFusion"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="PerformFusionResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="QueryCapabilities"> <soap:operation soapAction="QueryCapabilities"/> <wsdl:input name="QueryCapabilities"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="QueryCapabilitiesResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="RetrieveBiographicInformation"> <soap:operation soapAction="RetrieveBiographicInformation"/> <wsdl:input name="RetrieveBiographicInformation"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="RetrieveBiographicInformationResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="RetrieveBiometricInformation"> <soap:operation soapAction="RetrieveBiometricInformation"/> <wsdl:input name="RetrieveBiometricInformation"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="RetrieveBiometricInformationResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="SetBiographicData"> <soap:operation soapAction="SetBiographicData"/> <wsdl:input name="SetBiographicData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="SetBiographicDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="SetBiometricData"> <soap:operation soapAction="SetBiometricData"/> <wsdl:input name="SetBiometricData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="SetBiometricDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="TransformBiometricData"> <soap:operation soapAction="TransformBiometricData"/> <wsdl:input name="TransformBiometricData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="TransformBiometricDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="UpdateBiographicData"> <soap:operation soapAction="UpdateBiographicData"/> <wsdl:input name="UpdateBiographicData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="UpdateBiographicDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="UpdateBiometricData"> <soap:operation soapAction="UpdateBiometricData"/> <wsdl:input name="UpdateBiometricData"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="UpdateBiometricDataResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="VerifySubject"> <soap:operation soapAction="VerifySubject"/> <wsdl:input name="VerifySubject"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="VerifySubjectResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="Enroll"> <soap:operation soapAction="Enroll"/> <wsdl:input name="Enroll"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="EnrollResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="GetEnrollResults"> <soap:operation soapAction="GetEnrollResults"/> <wsdl:input name="GetEnrollResults"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="GetEnrollResultsResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="GetIdentifyResults"> <soap:operation soapAction="GetIdentifyResults"/> <wsdl:input name="GetIdentifyResults"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="GetIdentifyResultsResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="GetVerifyResults"> <soap:operation soapAction="GetVerifyResults"/> <wsdl:input name="GetVerifyResults"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="GetVerifyResultsResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="Identify"> <soap:operation soapAction="Identify"/> <wsdl:input name="Identify"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="IdentifyResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="RetrieveInformation"> <soap:operation soapAction="RetrieveInformation"/> <wsdl:input name="RetrieveInformation"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="RetrieveInformationResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="Verify"> <soap:operation soapAction="Verify"/> <wsdl:input name="Verify"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="VerifyResponse"> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="BIASFault"> <soap:fault name="BIASFault" use="literal"/> </wsdl:fault> </wsdl:operation> </wsdl:binding> <wsdl:service name="BIAS_v1"> <wsdl:port name="BIAS_v1HttpBindingPort" binding="tns:BIAS_v1HttpBinding"> <soap:address location="http://your_URI/IRI_to_your_BIAS_implementation"/> </wsdl:port> </wsdl:service> </wsdl:definitions> Annex B. BIAS Patron format specification The BIAS SOAP Profile defines an XML CBEFF Patron Format based on, but tailored from, Clause 13/15 of ISO/IEC 19785-3 [ CBEFF3 ] as specified below. B.1 � Patron Organization for the Advancement of Structured Information Standards (OASIS) B.2 � Patron identifier 82 (0052 Hex) .� This has been allocated by the Registration Authority for ISO/IEC 19785-2. B.3 � Patron format name OASIS BIAS CBEFF XML Patron Format B.4 � Patron format identifier 01 (0001 Hex) .� This has been registered in accordance with ISO/IEC 19785-2. B.5 � ASN.1 object identifier for this patron format No ASN.1 object identifiers are assigned to this patron format B.6 � Domain of use This clause specifies a patron format based on XML that is designed to be friendly with code generation tools. It defines a CBEFF structure that allows for the creation of simple, complex, and multi-modal BIRs for use within BIAS transactions. B.7 � Version identifier This patron format specification has a version identifier of (major 1, minor 0). B.8 � CBEFF version This specification conforms to CBEFF version (major 2, minor 0). B.9 � General B.9.1 �� This patron format is based on W3C XML 1.0.� It supports all the mandatory and optional data elements specified in ISO/IEC 19785-1.� It can support either a simple BIR or a complex BIR structure where each intermediate node or leaf of the structure is itself a BIR (called a "child BIR").� B.9.2 �� Most fields in this patron format are optional.� Some mandatory and optional fields are represented by XML elements, others are represented by attributes of XML elements.� The presence of an optional field in a BIR is signaled by simply including the corresponding element or attribute, and its absence is signaled by simply omitting the corresponding element or attribute. B.9.3 �� Special encodings are specified for integers (see B.17), octet strings (see B.18), and date and time-of-the-day abstract values (see B.19). B.9.4 �� An instance of a BIR or child BIR contains either a BDB or one or more BIR children, but never contains both. B.9.5 �� An extension mechanism is specified, which enables the inclusion of application-specific data (not standardized) within a BIR or child BIR (see B.11.1.6). B.10 � Specification B.10.1 �� In the rest of this clause, the terms "element" and "attribute" are used with the meaning of "XML element" and "XML attribute", respectively. B.10.2 �� The namespace with the name " http://docs.oasis-open.org/bias/ns/biaspatronformat-1.0/ " is called the patron format namespace of this patron format. B.10.3 �� All elements defined in this patron format have the patron format namespace name.� All attribute names are unqualified. B.10.4 �� An instance of a BIR shall be represented as a <BIR> element (see B.11). B.10.5 �� The <BIR> element may be the root of an XML document, but this is not required. B.10.6 �� The portion of the XML document consisting of the <BIR> element and its whole content shall be valid according to the XML schema provided in B.22. NOTE 1 � Validity according to that XML schema does not imply that the <BIR> element satisfies all the requirements in the normative text of this specification, as there are some requirements that cannot be (or are not) formally expressed in the XML schema. NOTE 2 � When the <BIR> element is the root of an XML document, the UTF-8 character encoding is recommended for the XML document, because it will usually produce a smaller encoding. B.10.7 �� The abstract value NO VALUE AVAILABLE, for any CBEFF data element that supports this abstract value, shall be encoded as the omission of the corresponding element or attribute both in the <BIR> element and in all of its ancestor <BIR> elements. NOTE � The inheritance mechanism specified in B.14.2.1, B.15.2.1 and B.16.2.1 causes a data element of a BIR to inherit an abstract value (different from NO VALUE AVAILABLE) from its closest ancestor <BIR> element that contains that element or attribute when the <BIR> element in question does not contain it.� If any <BIR> element in a hierarchy of <BIR> elements specifies an abstract value for a given data element, that abstract value can be overridden by a different abstract value in any of its descendant <BIR> elements, but the overriding abstract value can never be NO VALUE AVAILABLE. B.11 � Element <BIR> B.11.1 � Syntax B.11.1.1 �� This element shall have no attributes, and shall have a content consisting of the following (in order): a) an optional <Version> element (see B.12); b) an optional <CBEFFVersion> element (see B.13); c) zero or more application-specific elements; d) a mandatory <BIRInfo> element (see B.14); e) an optional <BDBInfo> element (see B.15); f) an optional <SBInfo> element (see B.16); g) zero or more <BIR> elements (see B.11); h) either an optional <BDB> element that shall contain a valid representation of an octect string (see B.18), or an optional <bdbX> element that shall contain a valid XML string; i) an optional <SB> element � the content of this element shall be a valid representation of an octet string. B.11.1.2 �� The <BDB> or <bdbX> element shall not be present if one or more child < BIR> elements are present, and shall be present if no child < BIR> elements are present. B.11.1.3 �� The <SB> element shall be absent unless its presence is required by F.14.2.2 or permitted by F.15.2.3. B.11.1.4 �� If the <BDB> or <bdbX> element is present, then the <BDBInfo> element shall also be present. B.11.1.5 �� If the <SB> element is present, then the <SBInfo> element shall also be present. B.11.1.6 �� The number of application-specific elements and their name, namespace name, attributes, and content are not defined in this patron format specification.� However, the namespace name of those elements shall be different from the patron format namespace name (see B.10.2). B.11.2 � Semantics B.11.2.1 �� This element is either a complex or a simple BIR, depending on which child elements are present.� If a child <BDB> or <bdbX> element is present, this element is a simple BIR.� If one or more child <BIR> elements are present, this element is a complex BIR. B.11.2.2 �� The elements <Version> , <CBEFFVersion> , <BIRInfo> , <BDBInfo> , and <SBInfo> and their content form the standard biometric header of the BIR. B.11.2.3 �� The <Version> element (if present) carries the major and minor version number of this patron format. B.11.2.4 �� The <CBEFFVersion> element (if present) carries the major and minor version number of the CBEFF standard. B.11.2.5 �� Each� <BIR> element is a whole BIR (of the same patron format) that is a child BIR of the BIR. B.11.2.6 �� The <BDB> or <bdbX> element (if present) carries the biometric data block (BDB) of the BIR. NOTE � A <BDB> or <bdbX> element and a <BIR> element cannot coexist as children of the same <BIR> element (see B.11.1.2). B.11.2.7 �� The <SB> element (if present) carries the security block (SB) of the BIR. NOTE � A <SB> element can coexist with either a <BIR> element or a <BDB> or <bdbX> element that is a child of the same <BIR> element. B.11.2.8 �� The <BIRInfo> element carries information about both the BIR and (possibly) about its descendant BIRs (if the <BIR> element has one or more child <BIR> elements), as specified in B.14.2.1. B.11.2.9 �� The <BDBInfo> element (if present) carries information about either the BDB of the BIR (if the <BIR> element has a child <BDB> or <bdbX> element) or about the BDBs of the descendant BIRs that have a child <BDB> or <bdbX> element (if the <BIR> element has one or more child <BIR> elements), as specified in B.15.2.1. B.11.2.10 �� The <SBInfo> element (if present) carries information about either the SB of the BIR (if the <BIR> element has a child <SB> element) or about the SBs of the descendant BIRs that have a child <SB> element (if the <BIR> element has one or more child <BIR> elements but no child <SB> element), as specified in B.16.2.1. B.12 � Element <Version> B.12.1 � Syntax This element shall have contents consisting of the following (in order): a)� a required <Major> element � the value of this element shall be a valid representation of a non-negative integer. b)� a required <Minor> element � the value of this element shall be a valid representation of a non-negative integer. B.12.2 � Semantics B.12.2.1 �� This element represents the data element CBEFF_patron_header_version, and carries the (major and minor) version number of the patron format.� The number assigned to this version of the patron format is major 1, minor 0. B.12.2.2 �� The < Major> element represents the major version number (1 in this version). B.12.2.3 �� The < Minor> element represents the minor version number (0 in this version). B.12.2.4 �� If this element is not present, the values Major="1" Minor="0" are implied. B.12.2.5 �� A child <BIR> element shall have the same (major and minor) version number as its parent <BIR> element. NOTE � This implies that the <Version> element, if present in a child <BIR> element, has to carry the same values as the <Version> element in the parent <BIR> element.� This is equivalent to omitting the <Version> element.� Therefore, this element is normally omitted in child <BIR> elements. B.13 � Element <CBEFFVersion> B.13.1 � Syntax This element shall have content consisting of the following (in order): a)� a required <Major> element � the value of this element shall be a valid representation of a non-negative integer (see B.17); b)� a required <Minor> element � the value of this element shall be a valid representation of a non-negative integer. B.13.2� Semantics B.13.2.1 �� This element represents the data element CBEFF_version, and carries the version number of the CBEFF standard supported by this patron format.� The number assigned to the version of CBEFF supported by this patron format is Major=2, Minor=0. B.13.2.2 �� The < Major> element represents the major version number (2 in this version). B.13.2.3 �� The < Minor> element represents the minor version number (0 in this version). B.13.2.4 �� If this element is not present, the values Major="2" Minor="0" are implied. B.13.2.5 �� A child <BIR> element shall have the same CBEFF version number (major and minor) as its parent <BIR> element. NOTE � Thus, the <CBEFFVersion> element is normally omitted from all child <BIR> elements, as it would be redundant. B.14 � Element <BIRInfo> B.14.1 � Syntax B.14.1.1 �� This element shall have a content consisting of the following (in order): a)� an optional <Creator> element � the content of this element shall be a string of ISO/IEC 10646 characters; b)� an optional <Index> element � the content of this element shall be a valid representation of a universally unique identifier (see B.20), and shall not inherit its value from any other level BIR; c)� an optional <Payload> element � the content of this element shall be a valid representation of an octet string, and shall not inherit its value from any other level BIR. d)� a required <Integrity> element � the value of this element shall be one of the character strings in the third cell of the corresponding row of Table B.1; e)� an optional <CreationDate> element � the value of this element shall be a valid representation of a date and time of the day (see B.19); f)�� an optional <NotValidBefore> element � the value of this element shall be a valid representation of a date and time of the day; g)� an optional <NotValidAfter> element � the value of this element shall be a valid representation of a date and time of the day. B.14.2 � Semantics B.14.2.1 �� The <BIRInfo> element carries information about the BIR.�� In addition, if the BIR has one or more child BIRs (the <BIR> element has one or more child <BIR> elements), the information carried by the attributes and child elements of the <BIRInfo> element is inherited by those child BIRs except where overridden by a corresponding attribute or child element of the <BIRInfo> element of a child BIR.� The information inherited by a BIR applies to that BIR, and (if the BIR has itself child BIRs) is further inherited by its child BIRs in the same way (and so on recursively). NOTE � Since the Integrity element is required and the <BIRInfo> element is mandatory in all <BIR> elements, inheritance of the Integrity element can never occur. B.14.2.2 �� The Integrity element indicates whether integrity information about this BIR is provided within the security block (SB) of the BIR (the child <SB> element of the parent <BIR> element of this <BIRInfo> element).� NOTE � This information may consist of a digital signature or MAC, a reference to a key or certificate, an encrypted key (with or without a reference to the key used to encrypt that key), or other parameters of the digital signing (or MAC) process. B.14.2.3 �� If the value of the <Integrity> element is " true ", then the parent <BIR> element of this <BIRInfo> element shall have a child <SB> element. B.14.2.4 �� Table B.1 specifies the correspondence between the attributes and child elements of this element and CBEFF data elements, and specifies the supported abstract values and their encodings (see also B.10.7). NOTE - This element represents all CBEFF data elements whose name begins with "CBEFF_BIR_". Table B.1 � BIR information CBEFF data element name XML element Supported abstract values and encodings Reference CBEFF_BIR_creator <Creator> All ISO/IEC 10646 character strings are supported.� The character string shall be encoded as the string itself. CBEFF_BIR_index <Index> All well-formed UUIDs are supported. The UUIDs shall be encoded as specified in B.20.� Shall not inherit its value from any other BIR level. CBEFF_BIR_payload <Payload> All octet strings are supported. The octet strings shall be encoded as specified in B.18. Shall not inherit its value from any other BIR level. CBEFF_BIR_integrity_options <Integrity> The following abstract values are supported. The abstract values shall be encoded as shown below. NO INTEGRITY: " false " INTEGRITY: " true " CBEFF_BIR_creation_date <CreationDate> All date and time-of-the-day abstract values permitted by CBEFF are supported. The abstract values shall be encoded as specified in B.19. CBEFF_BIR_validity_period (lower end) <NotValidBefore> All date and time-of-the-day abstract values permitted by CBEFF are supported. The abstract values shall be encoded as specified in B.19. CBEFF_BIR_validity_period (upper end) <NotValidAfter> All date and time-of-the-day abstract values permitted by CBEFF are supported. The abstract values shall be encoded as specified in B.19. B.15 � Element <BDBInfo> B.15.1 � Syntax B.15.1.1 �� This element shall have a content consisting of the following (in order): a) an optional <ChallengeResponse> element � the content of this element shall be a valid representation of an octet string (see B.18); b) an optional <Index> element � the content of this element shall be a valid representation of a universally unique identifier (see B.20). c) an optional <FormatOwner> element � the value of this element shall be a valid representation of an integer in the range 1 to 65535 (see B.17); d) an optional <FormatType> element � the value of this element shall be a valid representation of an integer in the range 1 to 65535; e) an optional <Encryption> element � the value of this element shall be one of the character strings in the third cell of the corresponding row of Table B.2; f) an optional <CreationDate> element � the value of this element shall be a valid representation of a date and time of the day (see B.19); g) an optional <NotValidBefore> element � the value of this element shall be a valid representation of a date and time of the day; h) an optional <NotValidAfter> element � the value of this element shall be a valid representation of a date and time of the day; i) an optional <Type> element � the value of this element shall be one of the character strings in the third cell of the corresponding row of Table B.2; j) an optional <Subtype> element � the value of this element shall be one of the character strings in the third cell of the corresponding row of Table B.2; k) an optional <Level> element � the value of this element shall be one of the character strings in the third cell of the corresponding row of Table B.2; l) an optional <ProductOwner> element � the value of this element shall be a valid representation of an integer in the range 1..65535 (see B.17); m) an optional <ProductType> element � the value of this element shall be a valid representation of an integer in the range 1..65535; n) an optional <CaptureDeviceOwner> element � the value of this element shall be a valid representation of an integer in the range 1..65535 (see B.17); o) an optional <CaptureDeviceType> element � the value of this element shall be a valid representation of an integer in the range 1..65535; p) an optional <FeatureExtractionAlgorithmOwner> element � the value of this element shall be a valid representation of an integer in the range 1..65535 (see B.17); q) an optional <FeatureExtractionAlgorithmType> element � the value of this element shall be a valid representation of an integer in the range 1..65535; r) an optional <ComparisonAlgorithmOwner> element � the value of this element shall be a valid representation of an integer in the range 1..65535 (see B.17); s) an optional <ComparisonAlgorithmType> element � the value of this element shall be a valid representation of an integer in the range 1..65535; t) an optional <QualityAlgorithmOwner> element � the value of this element shall be a valid representation of an integer in the range 1..65535 (see B.17); u) an optional <QualityAlgorithmType> element � the value of this element shall be a valid representation of an integer in the range 1..65535; v) an optional <CompressionAlgorithmOwner> element � the value of this element shall be a valid representation of an integer in the range 1..65535 (see B.17); w) an optional <CompressionAlgorithmType> element � the value of this element shall be a valid representation of an integer in the range 1..65535; x) an optional <Purpose> element � the value of this element shall be one of the character strings in the third cell of the corresponding row of Table B.2; y) an optional <Quality> element � the value of this element shall be a valid representation of an integer in the range � 2..100 (see B.17), as specified in the third cell of the corresponding row of Table B.2. B.15.1.3 �� If the parent <BIR> element has a child <BDB> element, then the <Encryption> element shall be present in this <BDBInfo> element unless it is present in the child <BDBInfo> element of an ancestor <BIR> element (see also B.11.1.4). B.15.1.4 �� If the parent <BIR> element has a child <BDB> element, then the <FormatOwner> element shall be present in this <BDBInfo> element unless it is present in the child <BDBInfo> element of an ancestor <BIR> element (see also B.11.1.4). B.15.1.5 �� If the parent <BIR> element has a child <BDB> element, then the <FormatType> element shall be present in this <BDBInfo> element unless it is present in the child <BDBInfo> element of an ancestor <BIR> element (see also B.11.1.4). NOTE � The ancestor <BIR> elements mentioned in the last three subclauses above need not be the same. B.15.2 � Semantics B.15.2.1 �� If the BIR has a BDB (the <BIR> element has a child <BDB> element), then the <BDBInfo> element carries information about that BDB.� Otherwise, the information carried by the attributes and child elements of the <BDBInfo> element is inherited by all the BIRs that are children of the BIR except where overridden by a corresponding attribute or child element of the <BDBInfo> element of a child BIR.� The information inherited by a BIR with a BDB applies to that BDB, whereas the information inherited by a BIR that has itself child BIRs is further inherited by all the BIRs that are children of the BIR in the same way (and so on recursively). B.15.2.2 �� If the BIR has a BDB and encryption is applied to that BDB (either by including the encryption attribute with the value " true " in the <BDBInfo> element or by having the BIR inherit that attribute value from its parent BIR), then the BDB in the <BDB> element shall be encrypted. B.15.2.3 �� If the BDB of a BIR is encrypted, information about the encryption process may be provided within the security block (SB) of that BIR (the child <SB> element of the parent <BIR> element of this <BIRInfo> element). NOTE � This information may consist of a reference to an encryption key, an encrypted key (with or without a reference to the key used to encrypt that key), or other parameters of the encryption process. B.15.2.4 �� Table B.2 specifies the correspondence between the attributes and child elements of this element and CBEFF data elements, and specifies the supported abstract values and their encodings (see also F.10.7). NOTE � This element represents all CBEFF data elements whose name begins with "CBEFF_BDB_". Table B.2 � BDB information CBEFF data element name XML element Supported abstract values and encodings Reference CBEFF_BDB_format_owner <FormatOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_format_type <FormatType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_encryption_options <Encryption> The following abstract values are supported. The abstract values shall be encoded as shown below. NO ENCRYPTION: " false " ENCRYPTION: " true " CBEFF_BDB_creation_date <CreationDate> All date and time-of-the-day abstract values permitted by CBEFF are supported. The abstract values shall be encoded as specified in B.19. CBEFF_BDB_validity_period (lower end) <NotValidBefore> All date and time-of-the-day abstract values permitted by CBEFF are supported. The abstract values shall be encoded as specified in B.19. CBEFF_BDB_challenge_response <ChallengeResponse> All octet strings are supported.� The octet strings shall be encoded as specified in B.18. Shall appear only in BIRs that have a BDB. CBEFF_BDB_index <Index> All well-formed UUIDs are supported. The UUIDs shall be encoded as specified in B.20 Shall appear only in BIRs that have a BDB. CBEFF_BDB_validity_period (upper end) <NotValidAfter> All date and time-of-the-day abstract values permitted by CBEFF are supported. The abstract values shall be encoded as specified in B.19. CBEFF_BDB_biometric_type <Type> The following abstract values and all their unordered combinations are supported. A single abstract value shall be encoded as the corresponding string shown below.� A combination of two or more abstract values shall be encoded as the concatenation of the corresponding strings, using a single space as separator. SCENT: " Scent " DNA: " DNA " EAR: " Ear " FACE: " Face " FINGER: " Finger " FOOT: " Foot " VEIN: " Vein " HAND GEOMETRY: " HandGeometry " IRIS: " Iris " RETINA: " Retina " VOICE: " Voice " GAIT: " Gait " KEYSTROKE: " Keystroke " LIP MOVEMENT: " LipMovement " SIGNATURE OR SIGN: " SignatureSign " CBEFF_BDB_biometric_subtype <Subtype> The following abstract values are supported. The abstract values shall be encoded as shown below. A combination of two or more abstract values shall be encoded as the concatenation of the corresponding strings, using a single space as separator. LEFT: " Left " RIGHT: " Right " THUMB: " Thumb " INDEX FINGER: " IndexFinger " MIDDLE FINGER: " MiddleFinger " RING FINGER: " RingFinger " LITTLE FINGER: " LittleFinger " CBEFF_BDB_processed_level <Level> The following abstract values are supported. The abstract values shall be encoded as shown below. RAW: " Raw " INTERMEDIATE: " Intermediate " PROCESSED: " Processed " CBEFF_BDB_product_owner <ProductOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_product_type <ProductType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_capture_device_owner <CaptureDeviceOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_capture_device_type <CaptureDeviceType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_feature_extraction_algorithm_owner <FeatureExtractionAlgorithmOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_feature_extraction_algorithm_type <FeatureExtractionAlgorithmType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_comparison_algorithm_owner <ComparisonAlgorithmOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_comparison_algorithm_type <ComparisonAlgorithmType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_quality_algorithm_owner <QualityAlgorithmOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_quality_algorithm_type <QualityAlgorithmType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_compression_algorithm_owner <CompressionAlgorithmOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_compression_algorithm_type <CompressionAlgorithmType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_BDB_purpose <Purpose> The following abstract values are supported. The abstract values shall be encoded as shown below. VERIFY: " Verify " IDENTIFY: " Identify " ENROLL: " Enroll " ENROLL FOR VERIFICATION ONLY: " EnrollVerify " ENROLL FOR IDENTIFICATION ONLY: " EnrollIdentify " AUDIT: " Audit " CBEFF_BDB_quality <Quality> The following abstract values are supported. The integers shall be encoded as specified in B.17.� The other abstract values shall be encoded as shown below.� INTEGER QUALITY NOT SUPPORTED BY BDB CREATOR: " -2 " QUALITY SUPPORTED BY BDB CREATOR BUT NOT SET: " -1 " B.16 � Element <SBInfo> B.16.1 � Syntax B.16.1.1 �� This element shall have content consisting of the following (in order): a)� an optional <FormatOwner> element � the value of this element shall be a valid representation of an integer in the range 1 to 65535 (see B.17); b)� an optional <FormatType> element � the value of this element shall be a valid representation of an integer in the range 1 to 65535 B.16.1.2 �� If the parent <BIR> element has a child <SB> element, then the <FormatOwner> element shall be present in this <SBInfo> element unless it is present in the child <SBInfo> element of an ancestor <BIR> element (see also B.11.1.5). B.16.1.3 �� If the parent <BIR> element has a child <SB> element, then the <FormatType> element shall be present in this <SBInfo> element unless it is present in the child <SBInfo> element of an ancestor <BIR> element (see also B.11.1.5). NOTE 1 � The ancestor <BIR> elements mentioned in the last two subclauses above need not be the same. NOTE 2 � When the parent <BIR> element has a child <SB> element and one omits both children of the <SBInfo> element, the <SBInfo> element will have no attributes and an empty content.� Omission of the <SBInfo> element is not allowed in this case (see B.11.1.5). B.16.2 � Semantics B.16.2.1 �� If the BIR has an SB (the <BIR> element has a child <SB> element), then the <SBInfo> element carries information about that SB.� In addition, if the BIR has one or more child BIRs (the <BIR> element has one or more child <BIR> elements), the information carried by the child element of the <SBInfo> element is inherited by those child BIRs except where overridden by a corresponding child element of the <SBInfo> element of a child BIR.� The information inherited by a BIR with an SB applies to that SB, and (if the BIR has itself child BIRs) is further inherited by its child BIRs in the same way (and so on recursively).�� B.16.2.2 �� Table B.3 specifies the correspondence between the attributes and child elements of this element and CBEFF data elements, and specifies the supported abstract values and their encodings (see also B.10.7). NOTE � This element represents all CBEFF data elements whose name begins with "CBEFF_SB_". Table B.3 � SB information CBEFF data element name XML element Supported abstract values and encodings Reference CBEFF_SB_format_owner <FormatOwner> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. CBEFF_SB_format_type <FormatType> All integers in the range 1 to 65535 are supported. The integers shall be encoded as specified in B.17. B.17 � Representation of Integers B.17.1 �� A non-negative integer shall be represented as a string of one or more ISO/IEC 10646 characters in the range DIGIT ZERO to DIGIT NINE (" 0 " to " 9 ") in decimal notation. B.17.2 �� A negative integer shall be represented as the corresponding positive integer, preceded by a HYPHEN-MINUS character (" ‑ "). B.17.3 �� Arbitrary whitespace is allowed before and after the encoding, but is forbidden inside the encoding. B.18 � Representation of Octet Strings B.18.1 �� An octet string shall be represented as a string of the following ISO/IEC 10646 characters: a)� LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z; b)� LATIN SMALL LETTER A to LATIN SMALL LETTER Z; c)� DIGIT ZERO to DIGIT NINE; d)� PLUS SIGN; e)� SOLIDUS; f)�� EQUALS SIGN. forming the Base64 encoding of the octet string (see IETF RFC 2045), with all whitespace removed. B.18.2 �� Arbitrary whitespace is allowed before and after the encoding, but is forbidden inside the encoding. B.19 � Representation of Date and Time of the Day B.19.1 �� A date and time of the day shall be represented as a string of ISO/IEC 10646 characters in the following format, which conforms to ISO 8601.� B.19.2 �� The encoding shall be the concatenation of all the following components (in order): a)� the "year" component, consisting of the year encoded in four digits (" 2000 " to " 2999 ") ; b) the hyphen character �-� c)� the "month" component, consisting of the month encoded in two digits (" 01 " to " 12 "); d) the hyphen character �-� e)� the "day" component, consisting of the day encoded in two digits (" 01 " to " 31 "); f)�� the letter " T "; g) the "hour" component, consisting of the hour encoded in two digits (" 00 " to " 23 "); h)� the colon character �:� i) � the "minute" component, consisting of the minute encoded in two digits (" 00 " to " 59 "); j)�� the colon character �:� k)� the "second" component, consisting of the second encoded in two digits (" 00 " to " 59 "); l)�� the letter " Z ". B.19.3 �� The "year", "month", "day", �hour�, �minute�, and �second� components shall be present.� B.19.4 �� The letter " T " shall be present. B.19.5 �� The letter " Z " shall be present whether or not the "hour" component is present. NOTE�� This letter indicates that the date and time of the day are UTC. B.19.6 �� Arbitrary whitespace is allowed before and after the encoding, but is forbidden inside the encoding. B.20 � Representation of Universally Unique Identifiers NOTE: The following subclauses describe the same representation of a UUID as is specified in ISO/IEC 9834-8, clause 8. An example of such a representation is:� f81d4fae-7dec-11d0-a765-00a0c91e6bf6 B.20.1 �� A universally unique identifier (UUID) shall be represented as a string of ISO/IEC 10646 characters.� Each string shall contain exactly 36 characters from the union of the following sets: a)� DIGIT ZERO to DIGIT NINE (" 0 " to " 9 "), each representing a hexadecimal digit 0 through 9; b)� LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER F (" A " to " F "), each representing a hexadecimal digit A through F; c)� LATIN SMALL LETTER A to LATIN SMALL LETTER F (" a " to " f "), each representing a hexadecimal digit A through F; and d)� HYPHEN-MINUS (" - "). B.20.2 �� Each of the positions 9, 14, 19, and 24 of an encoding shall contain a character from set (d).� The other 32 positions shall contain characters from sets (a) through (c). B.20.3 �� Arbitrary whitespace is allowed before and after the encoding, but is forbidden inside the encoding. B.21 � Patron format conformance statement B.21.1 � Identifying information Required Information Patron format reference Patron name See B.1 Patron identifier See B.2 Patron format name See B.3 Patron format identifier See B.4 Patron format ASN.1 object identifier See B.5 Domain of use description See B.6 Patron format version See B.7 CBEFF version See B.8 B.21.2 � ISO/IEC 19785-1:2006/Amd 1:2010 to Patron Format Mapping CBEFF data element name Mandatory/ optional Patron format field name Abstract values specified? Encodings specified? CBEFF_BDB_format_owner Mandatory (specified or inherited) if a BDB is present <FormatOwner> child of <BDBInfo> Yes Yes CBEFF_BDB_format_type Mandatory (specified or inherited) if a BDB is present <FormatType> child of <BDBInfo> Yes Yes CBEFF_BDB_encryption_options Mandatory (specified or inherited) if a BDB is present <Encryption> child of <BDBInfo> Yes Yes CBEFF_BIR_integrity_options Mandatory <Integrity> child of <BIRInfo> Yes Yes CBEFF_BDB_subheader_count Mandatory implied in the number of occurrences of the child <BIR> element No (implied) No (implied) CBEFF_BDB_biometric_type Optional <Type> child of <BDBInfo> Yes Yes CBEFF_BDB_biometric_subtype Optional <Subtype> child of <BDBInfo> Yes Yes CBEFF_BDB_challenge_response Optional <ChallengeResponse> child of <BDBInfo> Yes Yes CBEFF_BDB_creation_date Optional <CreationDate> child of <BDBInfo> Yes Yes CBEFF_BDB_index Optional <Index> child of <BDBInfo> Yes Yes CBEFF_BDB_product_owner Optional <ProductOwner> child of <BDBInfo> Yes Yes CBEFF_BDB_product_type Optional <ProductType> child of <BDBInfo> Yes Yes CBEFF_BDB_capture_device_owner Optional <CaptureDeviceOwner> child of <BDBInfo> Yes Yes CBEFF_BDB_capture_device_type Optional <CaptureDeviceType> child of <BDBInfo> Yes Yes CBEFF_BDB_feature_extraction_algorithm_owner Optional <FeatureExtractionAlgorithm Owner> child of <BDBInfo> Yes Yes CBEFF_BDB_feature_extraction_algorithm_type Optional <FeatureExtractionAlgorithm Type> child of <BDBInfo> Yes Yes CBEFF_BDB_comparison_algorithm_owner Optional <ComparisonAlgorithmOwner> child of <BDBInfo> Yes Yes CBEFF_BDB_comparison_algorithm_type Optional <ComparisonAlgorithmType> child of <BDBInfo> Yes Yes CBEFF_BDB_quality_algorithm_owner Optional <QualityAlgorithmOwner> child of <BDBInfo> Yes Yes CBEFF_BDB_quality_algorithm_type Optional <QualityAlgorithmType> child of <BDBInfo> Yes Yes CBEFF_BDB_compression_algorithm_owner Optional <CompressionAlgorithmOwner> child of <BDBInfo> Yes Yes CBEFF_BDB_compression_algorithm_type Optional <CompressionAlgorithmType> child of <BDBInfo> Yes Yes CBEFF_BDB_processed_level Optional <Level> child of <BDBInfo> Yes Yes CBEFF_BDB_purpose Optional <Purpose> child of <BDBInfo> Yes Yes CBEFF_BDB_quality Optional <Quality> child of <BDBInfo> Yes Yes CBEFF_BDB_validity_period Optional <NotValidBefore> and < NotValidAfter> children of <BDBInfo> Yes Yes CBEFF_BIR_creation_date Optional <CreationDate> child of <BIRInfo> Yes Yes CBEFF_BIR_creator Optional <Creator> child of <BIRInfo> Yes Yes CBEFF_BIR_index Optional <Index> child of <BDBInfo> Yes Yes CBEFF_BIR_patron_format_owner N/A No No CBEFF_BIR_patron_format_type N/A No No CBEFF_BIR_payload Optional <Payload> child of <BDBInfo> Yes Yes CBEFF_SB_format_owner Optional <FormatOwner> child of <SBInfo> Yes Yes CBEFF_SB_format_type Optional <FormatType> child of <sb-info> Yes Yes CBEFF_BIR_validity_period Optional <NotValidBefore> and <NotValidAfter> attributes of <BIRInfo> Yes Yes patron_header_version Optional <Major > and� <Minor> children of <Version> Yes Yes CBEFF_version Optional <Major> and <Minor> children of <CBEFFVersion> Yes Yes BDB Optional <BDB> Yes Yes SB Optional <SB> Yes Yes B.22 � XML schema of the BIAS patron format �� <?xml version='1.0' encoding="utf-8"?> <xs:schema � xmlns:xs="http://www.w3.org/2001/XMLSchema" � xmlns=" http://docs.oasis-open.org/bias/ns/biaspatronformat-1.0/" � targetNamespace=" http://docs.oasis-open.org/bias/ns/biaspatronformat-1.0/" � elementFormDefault="qualified"> � � <xs:element name="BIR" type="BIRType"/> � � <xs:complexType name="BIRType"> �� <xs:sequence> �� <xs:element name="Version" type="VersionType" minOccurs="0"/> �� <xs:element name="CBEFFVersion" type="VersionType" minOccurs="0"/> �� <xs:any namespace="##other" processContents="skip" minOccurs="0" maxOccurs="unbounded"/> �� <xs:element name="BIRInfo" type="BIRInfoType"/> �� <xs:element name="BDBInfo" type="BDBInfoType" minOccurs="0"/> �� <xs:element name="SBInfo" type="SBInfoType" minOccurs="0"/> �� <xs:element name="BIR" type="BIRType" minOccurs="0" maxOccurs="unbounded"/> �� <xs:element name="BDB" type="xs:base64Binary" minOccurs="0"/> �� <xs:element name="SB" type="xs:base64Binary" minOccurs="0"/> �� </xs:sequence> � </xs:complexType> � � <xs:complexType name="VersionType"> �� <xs:sequence> �� <xs:element name="Major" type="xs:nonNegativeInteger" /> �� <xs:element name="Minor" type="xs:nonNegativeInteger" /> �� </xs:sequence> � </xs:complexType> � � <xs:complexType name="BIRInfoType"> �� <xs:sequence> �� <xs:element name="Creator" type="xs:string" minOccurs="0"/> �� <xs:element name="Index" type="UUIDType" minOccurs="0"/> �� <xs:element name="Payload" type="xs:base64Binary" minOccurs="0"/> �� <xs:element name="Integrity" type="xs:boolean" /> �� <xs:element name="CreationDate" type="xs:dateTime" minOccurs="0" /> �� <xs:element name="NotValidBefore" type="xs:dateTime" minOccurs="0" /> �� <xs:element name="NotValidAfter" type="xs:dateTime" minOccurs="0" /> �� </xs:sequence> � </xs:complexType> � � <xs:complexType name="BDBInfoType"> �� <xs:sequence> �� <xs:element name="ChallengeResponse" type="xs:base64Binary" minOccurs="0"/> �� <xs:element name="Index" type="UUIDType" minOccurs="0"/> �� <xs:element name="FormatOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="FormatType" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="Encryption" type="xs:boolean" minOccurs="0" /> �� <xs:element name="CreationDate" type="xs:dateTime" minOccurs="0" /> �� <xs:element name="NotValidBefore" type="xs:dateTime" minOccurs="0" /> �� <xs:element name="NotValidAfter" type="xs:dateTime" minOccurs="0" /> �� <xs:element name="Type" type="MultipleTypesType" minOccurs="0" /> �� <xs:element name="Subtype" type="SubtypeType" minOccurs="0" /> �� <xs:element name="Level" type="ProcessedLevelType" minOccurs="0" /> �� <xs:element name="ProductOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="ProductType" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="CaptureDeviceOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="CaptureDeviceType" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="FeatureAlgorithmOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="FeatureAlgorithmType" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="ComparisonAlgorithmOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="ComparisonAlgorithmType" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="QualityAlgorithmOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="QualityAlgorithmType" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="CompressionAlgorithmOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="CompressionAlgorithmType" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="Purpose" type="PurposeType" minOccurs="0" /> �� <xs:element name="Quality" type="QualityType" minOccurs="0" /> �� </xs:sequence> � </xs:complexType> � � <xs:complexType name="SBInfoType"> �� <xs:sequence> �� <xs:element name="FormatOwner" type="xs:positiveInteger" minOccurs="0" /> �� <xs:element name="FormatType" type="xs:positiveInteger" minOccurs="0" /> �� </xs:sequence> � </xs:complexType> � � <xs:simpleType name="QualityType"> �� <xs:restriction base="xs:integer"> �� <xs:minInclusive value="-2"/> �� <xs:maxInclusive value="100"/> �� </xs:restriction> � </xs:simpleType> � <xs:simpleType name="SingleTypeType"> �� <xs:restriction base="xs:string"> �� <xs:enumeration value="Scent"/> �� <xs:enumeration value="DNA"/> �� <xs:enumeration value="Ear "/> �� <xs:enumeration value="Face"/> �� <xs:enumeration value="Finger"/> �� <xs:enumeration value="Foot"/> �� <xs:enumeration value="HandGeometry"/> �� <xs:enumeration value="Vein"/> �� <xs:enumeration value="Iris"/> �� <xs:enumeration value="Retina"/> �� <xs:enumeration value="Voice"/> �� <xs:enumeration value="Gait"/> �� <xs:enumeration value="Keystroke"/> �� <xs:enumeration value="LipMovement"/> �� <xs:enumeration value="SignatureSign"/> �� </xs:restriction> � </xs:simpleType> � � <xs:simpleType name="MultipleTypesType"> �� <xs:list itemType="SingleTypeType"/> � </xs:simpleType> � � <xs:simpleType name="SingleAnySubtypeType"> �� <xs:restriction base="xs:string"> �� <xs:enumeration value="Left"/> �� <xs:enumeration value="Right"/> �� <xs:enumeration value="Thumb"/> �� <xs:enumeration value="IndexFinger"/> �� <xs:enumeration value="MiddleFinger"/> �� <xs:enumeration value="RingFinger"/> �� <xs:enumeration value="LittleFinger"/> �� </xs:restriction> � </xs:simpleType> � � <xs:simpleType name="SingleVeinOnlySubtypeType"> �� <xs:restriction base="xs:string"> �� <xs:enumeration value="LeftVein"/> �� <xs:enumeration value="RightVein"/> �� <xs:enumeration value="Palm"/> �� <xs:enumeration value="BackOfHand"/> �� <xs:enumeration value="Wrist"/> �� <xs:enumeration value="Reserved1"/> �� <xs:enumeration value="Reserved2"/> �� </xs:restriction> � </xs:simpleType> � � <xs:simpleType name="MultipleAnySubtypesType"> �� <xs:list itemType="SingleAnySubtypeType"/> � </xs:simpleType> � � <xs:simpleType name="MultipleVeinOnlySubtypesType"> �� <xs:list itemType="SingleVeinOnlySubtypeType"/> � </xs:simpleType> � � <xs:simpleType name="SubtypeType"> �� <xs:union memberTypes="MultipleAnySubtypesType MultipleVeinOnlySubtypesType"/> � </xs:simpleType> � � <xs:simpleType name="ProcessedLevelType"> �� <xs:restriction base="xs:string"> �� <xs:enumeration value="Raw"/> �� <xs:enumeration value="Intermediate"/> �� <xs:enumeration value="Processed"/> �� </xs:restriction> � </xs:simpleType> � � <xs:simpleType name="PurposeType"> �� <xs:restriction base="xs:string"> �� <xs:enumeration value="Verify"/> �� <xs:enumeration value="Identify"/> �� <xs:enumeration value="Enroll"/> �� <xs:enumeration value="EnrollVerify"/> �� <xs:enumeration value="EnrollIdentify"/> �� <xs:enumeration value="Audit"/> �� </xs:restriction> � </xs:simpleType> � <xs:simpleType name="UUIDType"> �� <xs:restriction base="xs:string"> �� <xs:pattern value="[a-fA-F0-9]{8}\-([a-fA-F0-9]{4}\-){3}[a-fA-F0-9]{12}"/> �� </xs:restriction> � </xs:simpleType> </xs:schema> NOTE�� NO VALUE AVAILABLE is encoded by the absence of optional fields in the XML encoding. There is little value in, for example, having the following string appear in a record: <level> no value available <level>. B.23 � Sample BIR encoding An example of a simple BIR in XML encoding (complying with the XSD schema and the normative textual description) follows. <?xml version="1.0" encoding="utf-8"?> <BIR xmlns=" http://docs.oasis-open.org/bias/ns/biaspatronformat-1.0/"> �� <Version> �� <Major>1</Major> �� <Minor>0</Minor> �� </Version> �� <CBEFFVersion> �� <Major>2</Major> �� <Minor>0</Minor> �� </CBEFFVersion> �� <BIRInfo> �� <Creator>ABCDE</Creator> �� <Index>86CA3100-43F3-0D23-A941-7871E519A00E</Index> �� <Payload>a2V2aW4ubWFuZ29sZEBuaXN0Lmdvdg==</Payload> �� <Integrity>true</Integrity> �� <CreationDate>2004-03-02T15:03:15Z</CreationDate> �� <NotValidBefore>2004-03-02T15:00:00Z</NotValidBefore> �� <NotValidAfter>2004-03-03T15:00:00Z</NotValidAfter> �� </BIRInfo> �� <BDBInfo> �� <ChallengeResponse>VmlzaXQgaHR0cDovL2J3cy5uaXN0LmdvdiBmb3Igc29tZSBhd2Vzb21lIGJpb21ldHJpY3Mvd2ViIHNlcnZpY2UgcHJvamVjdHMh</ChallengeResponse> �� <Index>86CA3100-43F3-0D23-A941-7871E519A00E</Index> �� <FormatOwner>51</FormatOwner> �� <FormatType>88</FormatType> �� <Encryption>true</Encryption> �� <CreationDate>2004-03-02T15:00:00Z</CreationDate> �� <NotValidBefore>2004-03-02T15:00:00Z</NotValidBefore> �� <NotValidAfter>2004-03-02T15:00:00Z</NotValidAfter> �� <Type>Iris</Type> �� <Subtype>Left</Subtype> �� <Level>Processed</Level> �� <ProductOwner>16</ProductOwner> �� <ProductType>2</ProductType> �� <Purpose>Verify</Purpose> �� <Quality>100</Quality> �� </BDBInfo> �� <SBInfo> �� <FormatOwner>51</FormatOwner> �� <FormatType>99</FormatType> �� </SBInfo> �� <BDB>a2V2aW4ubWFuZ29sZEBuaXN0Lmdvdg==</BDB> �� <SB>TmF0aW9uYWwgSW5zdGl0dXRlIG9mIFN0YW5kYXJkcyBhbmQgVGVjaG5vbG9neQ==</SB> </BIR> Annex C. Use Cases (non-normative) The intent of this annex is to provide operational sequence diagrams / flow charts that show how the higher level usage scenarios within [ INCITS-BIAS] could be implemented using the BIAS SOAP profile.� The following use cases are given: Verification (synchronous/aggregate) Verification (asynchronous/aggregate) Verification (primitive) Identification (primitive) Enrollment (aggregate) Enrollment (primitive) C.1 � Verification Use Case This use case uses the aggregate Verify operation in which a single request results in some set of operations (in this case, a series of primitive BIAS operations) being performed by the BIAS service provider. C.2 � Asynchronous Verification Use Case In this use case, the requester issues two requests � the BIAS Verify request to initiate the operation followed by a BIAS GetVerifyResult request to retrieve the results of that operation. C.3 � Primitive Verification Use Case In this use case, the verification operation is performed as a series of requests using the BIAS primitive operations.� In this case, the client rather than the service provider controls the workflow of the higher level operation. C.4 � Identification Use Case This use case uses the aggregate Identify operation in which a single request results in some set of operations (in this case, a series of primitive BIAS operations) being performed by the BIAS service provider. C.5 � Biometric Enrollment Use Case This use case uses the aggregate Enroll operation in which a single request results in some set of operations (in this case, a series of primitive BIAS operations) being performed by the BIAS service provider. Here, if the result of the IdentifySubject is no matches found, then the subject is added to the gallery.� If a match had been found then other logic may have been applied (e.g., return candidate list, add encounter for existing subject, etc.). C.6 � Primitive Enrollment Use Case In this use case, the enrollment operation is performed as a series of requests using the BIAS primitive operations.� In this case, the client rather than the service provider controls the workflow of the higher level operation. Annex D. Samples (non-normative) D.1 � Create Subject Request/Response Example INCITS BIAS Specification <interface name="CreateSubject"> �� <parameter name="SubjectID" type="xs:string" direction="inout"use=�optional� /> �� <parameter name="Return" type="xs:unsignedLong" direction="out" /> </interface> OASIS BIAS Examples Simple Create Subject Request: POST /bias HTTP/1.1 Host: www.acme.com Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn SOAPAction: �CreateSubject� <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:CreateSubject �� xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/� /> �� </soap:Body> </soap:Envelope> Create Subject Request with SubjectID Parameter: POST /bias HTTP/1.1 Host: www.acme.com Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn SOAPAction: �CreateSubject� <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:CreateSubject xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:Identity> �� <tns:SubjectID>123456789</tns:SubjectID> �� </tns:Identity> �� </tns:CreateSubject> �� </soap:Body> </soap:Envelope> Create Subject Request with Optional OASIS BIAS Content: POST /bias HTTP/1.1 Host: www.acme.com Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn SOAPAction: �CreateSubject� <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:CreateSubject xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:GenericRequestParameters> �� <tns:Application>BIAS Application</tns:Application> �� <tns:ApplicationUser>BIAS User</tns:ApplicationUser> �� </tns:GenericRequestParameters> �� <tns:Identity> �� <tns:SubjectID>123456789</tns:SubjectID> �� </tns:Identity> �� </tns:CreateSubject> �� </soap:Body> </soap:Envelope> Simple Create Subject Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:CreateSubjectResponse xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:ResponseStatus> �� <tns:Return>0</tns:Return> �� </tns:ResponseStatus> �� <tns:Identity> �� <tns:SubjectID>123456789</tns:SubjectID> �� </tns:Identity> �� </tns:CreateSubjectResponse> �� </soap:Body> </soap:Envelope> Create Subject Response with Optional OASIS BIAS Content: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:CreateSubjectResponse xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:ResponseStatus> �� <tns:Return>0</tns:Return> �� <tns:Message>Subject ID 123456789 successfully created.</tns:Message> �� </tns:ResponseStatus> �� <tns:Identity> �� <tns:SubjectID>123456789</tns:SubjectID> �� </tns:Identity> �� </tns:CreateSubjectResponse> �� </soap:Body> </soap:Envelope> D.2 � Set Biographic Data Request/Response Example INCITS BIAS Specification <interface name="SetBiographicData"> �� <parameter name="SubjectID" type="xs:string" direction="in" /> �� <parameter name="IdentityModel" type="IdentityModelType"direction="in" /> �� <parameter name="EncounterID"type="xs:string" direction="inout" use="optional" /> �� <parameter name="BiographicData" type="BiographicDataType"direction="in" /> �� <parameter name="Return" type="xs:unsignedLong" direction="out" /> </interface> OASIS BIAS Examples Set Biographic Data Request: POST /bias HTTP/1.1 Host: www.acme.com Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn SOAPAction: �SetBiographicData� <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:SetBiographicData �� xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:Identity> �� <tns:SubjectID>123456789></tns:SubjectID> �� <tns:BiographicData> �� <tns:BiographicDataItem> �� <tns:Name>Last</tns:Name> �� <tns:Type>string</tns:Type> �� <tns:Value>Doe</tns:Value> �� </tns:BiographicDataItem> �� </tns:BiographicData> �� </tns:Identity> �� <tns:IdentityModel>person</tns:IdentityModel> �� </tns:SetBiographicData> �� </soap:Body> </soap:Envelope> Set Biographic Data Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:SetBiographicDataResponse �� xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:ResponseStatus> �� <tns:Return>0</tns:Return> �� </tns:ResponseStatus> �� </tns:SetBiographicDataResponse> �� </soap:Body> </soap:Envelope> D.3 � Set Biometric Data Request/Response Example INCITS BIAS Specification <interface name="SetBiometricData"> �� <parameter name="SubjectID" type="xs:string" direction="in" /> �� <parameter name="IdentityModel" type="IdentityModelType"direction="in" /> �� <parameter name="EncounterID"type="xs:string" direction="inout" use="optional" /> �� <parameter name="BIRList"type="CBEFF_BIR_ListType" direction="in" /> �� <parameter name="Return" type="xs:unsignedLong" direction="out" /> </interface> OASIS BIAS Examples Set Biometric Data Request: POST /bias HTTP/1.1 Host: www.acme.com Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn SOAPAction: �SetBiometricData� <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:SetBiometricData �� xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:Identity> �� <tns:SubjectID>123456789></tns:SubjectID> �� <tns:BiometricData> �� <tns:BIRList> �� <tns:BIR> biometric data </tns:BIR> �� </tns:BIRList> �� </tns:BiometricData> �� </tns:Identity> �� <tns:IdentityModel>person</tns:IdentityModel> �� </tns:SetBiometricData> �� </soap:Body> </soap:Envelope> Set Biometric Data Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=�utf-8� Content-Length: nnnn <?xml version=�1.0�?> <soap:Envelope xmlns:soap=�http://www.w3.org/2003/05/soap-envelope�> �� <soap:Body> �� <tns:SetBiometricDataResponse �� xmlns:tns=�http://docs.oasis ‐ open.org/bias/bias ‐ 1.0/�> �� <tns:ResponseStatus> �� <tns:Return>0</tns:Return> �� </tns:ResponseStatus> �� </tns:SetBiometricDataResponse> �� </soap:Body> </soap:Envelope> Annex E. Acknowledgements The following individuals have participated in the creation of this specification and are gratefully acknowledged: Participants: Name Affiliation Mr. Young Bang Booz Allen Hamilton Mr. Ed. Clay Sun Mr. Murty Gurajada * Raining Data Corporation Mr. Dale Hapeman US Department of Defense Dr. Charles Li Raytheon Mr. Kevin Mangold NIST Mr. John Mayer-Splain US Department of Homeland Security Dr. Ross Michaels NIST Mr. Ramesh Nagappan Sun Mr. Ash Parikh * Raining Data Corporation Mr. Matthew Swayze Daon Mr. Guy Swope* Raytheon Mrs. Catherine Tilton Daon Mr. Alessandro Triglia* OSS Nokalva Mr. Matthew Young US Department of Defense Mr. Brad Wing NIST (formerly DHS) Mr. Michael Wittman* Raytheon Mr. Gregory Zektser Booz Allen Hamilton * Though no longer members of the BIAS TC at time of publication, these individuals contributed in the early stages of the development of this standard. In addition, the inputs from the INCITS technical committee M1 are also gratefully appreciated. Annex F. Revision History Revision Date Editor Changes Made 0.01 2008-05-23 TBD Initial draft 0.02 2008-07-23 TBD Inserted data dictionary Added normative references Updated sec 3 & 5 + Annex B 0.03 2008-08-19 TBD WSDL updated 0.04 2008-09-11 TBD Updated references Added security requirements Corrected Fig. 3 0.05 2008-09-29 TBD SSL/TLS requirement clarified Reordered material in 5.3 & App C/D Updated references 2 new use cases added (App C) Updated examples in App D 0.06 2008-11-17 TBD Added BIAS operation name methods (new 5.3 + 4.2.27 & App B) 0.06a 2008-11-20 TBD Updated references 0.07 2008-11-27 TBD Revised fault structures and error handling 0.08 2009-06-22 TBD Incorporated comments from informal public review. 0.09 2009-07-24 Tilton/Swayze Incorporated comments from June review/meeting.� Major changes included: - Breaking Clause 3 into 2 clauses for data elements and operations - Specification of URI & IRI - Clarifications and formatting 0.10 2009-10-19 Tilton/Swayze Expansion of conformance clause 0.11 2009-11-16 Tilton/Swayze Miscellaneous edits and clarifications [Also published as CD01] 0.12 2010-11-04 Mangold/Tilton/Swayze Incorporation of public review comments Update WSDL 0.13 2011-01-03 Tilton/Mangold Clarification regarding xsd:any Updated WSDL 0.14 2011-06-15 Mangold/Tilton Inserted new Annex B � CBEFF Patron Format miscellaneous editorial changes 0.15 2011-07-18 Mangold/Tilton Updated namespace for CBEFF Patron Format + corrected finger subtype name in schema 0.16 2011-08-02 Mangold/Tilton Changed BIAS CBEFF XML Patron Format Identifier to 0x0052 (line 4377).

Biometric Identity Assurance Services (BIAS) SOAP Profile Version 1.0 (2012-05-25)

Related documents