BIAS-v2 0

1 Biometric Identity Assurance Services
2 (BIAS) Soap Profile Version 2.0

3 Committee Specification 01
4 11 July 2017
5 Specification URIs
6 This version:
7 http://docs.oasis-open.org/bioserv/BIAS/v2.0/cs01/BIAS-v2.0-cs01.pdf (Authoritative)
8 http://docs.oasis-open.org/bioserv/BIAS/v2.0/cs01/BIAS-v2.0-cs01.html
9 http://docs.oasis-open.org/bioserv/BIAS/v2.0/cs01/BIAS-v2.0-cs01.docx
10 Previous version:
11 http://docs.oasis-open.org/bioserv/BIAS/v2.0/csprd01/BIAS-v2.0-csprd01.pdf (Authoritative)
12 http://docs.oasis-open.org/bioserv/BIAS/v2.0/csprd01/BIAS-v2.0-csprd01.html
13 http://docs.oasis-open.org/bioserv/BIAS/v2.0/csprd01/BIAS-v2.0-csprd01.docx
14 Latest version:
15 http://docs.oasis-open.org/bioserv/BIAS/v2.0/BIAS-v2.0.pdf (Authoritative)
16 http://docs.oasis-open.org/bioserv/BIAS/v2.0/BIAS-v2.0.html
17 http://docs.oasis-open.org/bioserv/BIAS/v2.0/BIAS-v2.0.docx
18 Technical Committee:
19 OASIS Biometric Services (BIOSERV) TC
20 Chair:
21 Kevin Mangold (kevin.mangold@nist.gov), NIST
22 Editors:
23 Kevin Mangold (kevin.mangold@nist.gov), NIST
24 Karen Marshall (karen.marshall@nist.gov), NIST
25 Additional artifacts:
26 This prose specification is one component of a Work Product that also includes:
27  XML schemas: http://docs.oasis-open.org/bioserv/BIAS/v2.0/cs01/schemas/
28 Related work:
29 This specification replaces or supersedes:
30  Biometric Identity Assurance Services (BIAS) SOAP Profile Version 1.0 Plus Errata 02.
31 Edited by Kevin Mangold, Matthew Swayze, and Cathy Tilton. 06 May 2014. OASIS Standard
32 incorporating Approved Errata 02.
33 http://docs.oasis-open.org/bias/soap-profile/v1.0/errata02/os/biasprofile-v1.0-errata02-os-
34 complete.html.
35 This specification is related to:
36  ISO/IEC 30108-1:2015, Biometric Identity Assurance Services (BIAS).
37 http://www.iso.org/iso/catalogue_detail.htm?csnumber=53228
38 Declared XML namespace:
39  http://docs.oasis-open.org/bioserv/ns/bias-2.0
BIAS-v2.0-cs01 11 July 2017

Standards Track Work Product Copyright © OASIS Open 2017. All Rights Reserved. Page 1 of 266
40 Abstract:
41 BIAS defines biometric services used for identity assurance that are invoked over a services-
42 based framework. It is intended to provide a generic set of biometric and identity-related functions
43 and associated data definitions to allow remote access to biometric services.
44 Status:
45 This document was last revised or approved by the OASIS Biometric Services (BIOSERV) TC on
46 the above date. The level of approval is also listed above. Check the “Latest version” location
47 noted above for possible later revisions of this document. Any other numbered Versions and
48 other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-
49 open.org/committees/tc_home.php?wg_abbrev=bioserv#technical.
50 TC members should send comments on this specification to the TC’s email list. Others should
51 send comments to the TC’s public comment list, after subscribing to it by following the
52 instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-
53 open.org/committees/bioserv/.
54 This Committee Specification is provided under the RAND Mode of the OASIS IPR Policy, the
55 mode chosen when the Technical Committee was established. For information on whether any
56 patents have been disclosed that may be essential to implementing this specification, and any
57 offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s
58 web page (https://www.oasis-open.org/committees/bioserv/ipr.php).
59 Note that any machine-readable content (Computer Language Definitions) declared Normative for
60 this Work Product is provided in separate plain text files. In the event of a discrepancy between
61 any such plain text file and display content in the Work Product's prose narrative document(s), the
62 content in the separate plain text file prevails.
63 Citation format:
64 When referencing this specification the following citation format should be used:
65 [BIAS-Profile-v2.0]
66 Biometric Identity Assurance Services (BIAS) Soap Profile Version 2.0. Edited by Kevin Mangold
67 and Karen Marshall. 11 July 2017. OASIS Committee Specification 01. http://docs.oasis-
68 open.org/bioserv/BIAS/v2.0/cs01/BIAS-v2.0-cs01.html. Latest version: http://docs.oasis-
69 open.org/bioserv/BIAS/v2.0/BIAS-v2.0.html.

70 Notices
71 Copyright © OASIS Open 2017. All Rights Reserved.
72 All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual
73 Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
74 This document and translations of it may be copied and furnished to others, and derivative works that
75 comment on or otherwise explain it or assist in its implementation may be prepared, copied, published,
76 and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice
77 and this section are included on all such copies and derivative works. However, this document itself may
78 not be modified in any way, including by removing the copyright notice or references to OASIS, except as
79 needed for the purpose of developing any document or deliverable produced by an OASIS Technical
80 Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must
81 be followed) or as required to translate it into languages other than English.
82 The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors
83 or assigns.
84 This document and the information contained herein is provided on an "AS IS" basis and OASIS
85 DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY
86 WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
87 OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
88 PARTICULAR PURPOSE.
89 OASIS requests that any OASIS Party or any other party that believes it has patent claims that would
90 necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard,
91 to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to
92 such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that
93 produced this specification.
94 OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of
95 any patent claims that would necessarily be infringed by implementations of this specification by a patent
96 holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR
97 Mode of the OASIS Technical Committee that produced this specification. OASIS may include such
98 claims on its website, but disclaims any obligation to do so.
99 OASIS takes no position regarding the validity or scope of any intellectual property or other rights that
100 might be claimed to pertain to the implementation or use of the technology described in this document or
101 the extent to which any license under such rights might or might not be available; neither does it represent
102 that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to
103 rights in any document or deliverable produced by an OASIS Technical Committee can be found on the
104 OASIS website. Copies of claims of rights made available for publication and any assurances of licenses
105 to be made available, or the result of an attempt made to obtain a general license or permission for the
106 use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS
107 Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any
108 information or list of intellectual property rights will at any time be complete, or that any claims in such list
109 are, in fact, Essential Claims.
110 The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be
111 used only to refer to the organization and its official outputs. OASIS welcomes reference to, and
112 implementation and use of, specifications, while reserving the right to enforce its marks against
113 misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above
114 guidance.

115 Table of Contents
116 1 Introduction......................................................................................................................................... 8
117 1.0 IPR Policy.......................................................................................................................................... 8
118 1.1 Purpose/Scope.................................................................................................................................. 8
119 1.2 Overview........................................................................................................................................... 8
120 1.3 Background....................................................................................................................................... 8
121 1.4 Relationship to Other Standards....................................................................................................... 9
122 1.5 Terminology....................................................................................................................................... 9
123 1.6 References...................................................................................................................................... 10
124 1.6.1 Normative References............................................................................................................. 10
125 1.6.2 Non-Normative References...................................................................................................... 12
126 2 Design Concepts and Architecture (non-normative)..........................................................................14
127 2.1 Philosophy....................................................................................................................................... 14
128 2.2 Context............................................................................................................................................ 14
129 2.3 Architecture..................................................................................................................................... 14
130 3 Data Dictionary.................................................................................................................................. 17
131 3.1 Documentation Conventions........................................................................................................... 17
132 3.2 Common Elements.......................................................................................................................... 18
133 3.2.1 ApplicationIdentifier.................................................................................................................. 18
134 3.2.2 ApplicationUserIdentifier.......................................................................................................... 18
135 3.2.3 BaseBIRType........................................................................................................................... 18
136 3.2.4 BIASBiometricDataType........................................................................................................... 18
137 3.2.5 BIASFaultCode........................................................................................................................ 19
138 3.2.6 BIASFaultDetail........................................................................................................................ 20
139 3.2.7 BIASIdentity............................................................................................................................. 20
140 3.2.8 BIASIDType............................................................................................................................. 21
141 3.2.9 BinaryBIR................................................................................................................................. 21
142 3.2.10 BiographicDataItemType........................................................................................................ 21
143 3.2.11 BiographicDataItemListType.................................................................................................. 21
144 3.2.12 BiographicDataListType......................................................................................................... 21
145 3.2.13 BiographicDataSetType......................................................................................................... 21
146 3.2.14 BiographicDataType............................................................................................................... 22
147 3.2.15 BiometricDataType................................................................................................................. 23
148 3.2.16 BiometricDataListType........................................................................................................... 23
149 3.2.17 CandidateListResultType....................................................................................................... 24
150 3.2.18 CandidateListType................................................................................................................. 24
151 3.2.19 CandidateType....................................................................................................................... 24
152 3.2.20 CapabilityListType.................................................................................................................. 24
153 3.2.21 CapabilityName...................................................................................................................... 25
154 3.2.22 CapabilityType....................................................................................................................... 30
155 3.2.23 CBEFF_BIR_ListType............................................................................................................ 30
156 3.2.24 CBEFF_BIR_Type................................................................................................................. 30
157 3.2.25 Classification.......................................................................................................................... 31
158 3.2.26 ClassificationAlgorithmType................................................................................................... 31

159 3.2.27 ClassificationData.................................................................................................................. 32
160 3.2.28 DocumentDataType............................................................................................................... 32
161 3.2.29 DocumentDataListType.......................................................................................................... 33
162 3.2.30 EncounterCategoryType........................................................................................................ 34
163 3.2.31 EncounterListType................................................................................................................. 34
164 3.2.32 FusionDecision....................................................................................................................... 34
165 3.2.33 FusionIdentityListType........................................................................................................... 34
166 3.2.34 FusionInformationListType..................................................................................................... 35
167 3.2.35 FusionInformationType........................................................................................................... 35
168 3.2.36 FusionResult.......................................................................................................................... 35
169 3.2.37 FusionScore........................................................................................................................... 35
170 3.2.38 GenericRequestParameters................................................................................................... 36
171 3.2.39 IdentifySubjectResultType...................................................................................................... 36
172 3.2.40 InformationType..................................................................................................................... 36
173 3.2.41 ListFilterType.......................................................................................................................... 36
174 3.2.42 MatchType............................................................................................................................. 37
175 3.2.43 OptionType............................................................................................................................. 37
176 3.2.44 ProcessingOptionsType......................................................................................................... 37
177 3.2.45 ProductID............................................................................................................................... 37
178 3.2.46 QualityData............................................................................................................................ 37
179 3.2.47 ResponseStatus..................................................................................................................... 38
180 3.2.48 ReturnCode............................................................................................................................ 38
181 3.2.49 ScoreType.............................................................................................................................. 38
182 3.2.50 TokenResultType................................................................................................................... 39
183 3.2.51 TokenType............................................................................................................................. 39
184 3.2.52 URI_BIR................................................................................................................................. 39
185 3.2.53 VendorIdentifier...................................................................................................................... 39
186 3.2.54 Version................................................................................................................................... 39
187 3.2.55 VersionType........................................................................................................................... 40
188 3.2.56 XML_BIR................................................................................................................................ 40
189 4 BIAS Messages................................................................................................................................. 41
190 4.1 Primitive Operations........................................................................................................................ 41
191 4.1.1 AddSubjectToGallery............................................................................................................... 41
192 4.1.2 CheckQuality............................................................................................................................ 42
193 4.1.3 ClassifyBiometricData.............................................................................................................. 45
194 4.1.4 CreateEncounter...................................................................................................................... 47
195 4.1.5 CreateSubject.......................................................................................................................... 48
196 4.1.6 DeleteBiographicData.............................................................................................................. 49
197 4.1.7 DeleteBiometricData................................................................................................................ 51
198 4.1.8 DeleteDocumentData............................................................................................................... 52
199 4.1.9 DeleteEncounter...................................................................................................................... 54
200 4.1.10 DeleteSubject......................................................................................................................... 55
201 4.1.11 DeleteSubjectFromGallery..................................................................................................... 56
202 4.1.12 GetIdentifySubjectResults...................................................................................................... 58
203 4.1.13 IdentifySubject........................................................................................................................ 60

204 4.1.14 ListBiographicData................................................................................................................. 62
205 4.1.15 ListBiometricData................................................................................................................... 65
206 4.1.16 ListDocumentData.................................................................................................................. 70
207 4.1.17 PerformFusion........................................................................................................................ 72
208 4.1.18 QueryCapabilities................................................................................................................... 74
209 4.1.19 RetrieveBiographicData......................................................................................................... 76
210 4.1.20 RetrieveBiometricData........................................................................................................... 78
211 4.1.21 RetrieveDocumentData.......................................................................................................... 80
212 4.1.22 SetBiographicData................................................................................................................. 82
213 4.1.23 SetBiometricData................................................................................................................... 84
214 4.1.24 SetDocumentData.................................................................................................................. 86
215 4.1.25 TransformBiometricData........................................................................................................ 87
216 4.1.26 UpdateBiographicData........................................................................................................... 89
217 4.1.27 UpdateBiometricData............................................................................................................. 91
218 4.1.28 UpdateDocumentData............................................................................................................ 93
219 4.1.29 VerifySubject.......................................................................................................................... 94
220 4.2 Aggregate Operations..................................................................................................................... 96
221 4.2.1 Delete....................................................................................................................................... 96
222 4.2.2 Enrol......................................................................................................................................... 98
223 4.2.3 GetDeletionResults................................................................................................................ 100
224 4.2.4 GetEnrolResults..................................................................................................................... 102
225 4.2.5 GetIdentifyResults.................................................................................................................. 103
226 4.2.6 GetUpdateResults.................................................................................................................. 105
227 4.2.7 GetVerifyResults.................................................................................................................... 106
228 4.2.8 Identify................................................................................................................................... 108
229 4.2.9 RetrieveData.......................................................................................................................... 110
230 4.2.10 Update.................................................................................................................................. 112
231 4.2.11 Verify.................................................................................................................................... 114
232 5 Message structure and rules........................................................................................................... 118
233 5.1 Purpose and constraints................................................................................................................ 118
234 5.2 Message requirements.................................................................................................................. 119
235 5.3 Handling binary data...................................................................................................................... 120
236 5.3.1 Base64 encoding................................................................................................................... 121
237 5.3.2 Use of XOP............................................................................................................................ 121
238 5.4 Discovery....................................................................................................................................... 121
239 5.5 Identifying operations.................................................................................................................... 121
240 5.5.1 Operation name element........................................................................................................ 121
241 5.5.2 WS-Addressing Action........................................................................................................... 122
242 5.6 Security......................................................................................................................................... 123
243 5.6.1 Use of SSL 3.0 or TLS 1.0..................................................................................................... 123
244 5.6.2 Data Origin Authentication..................................................................................................... 123
245 5.6.3 Message Integrity................................................................................................................... 123
246 5.6.4 Message Confidentiality......................................................................................................... 124
247 5.6.5 CBEFF BIR security features................................................................................................. 124
248 5.6.6 Security Considerations......................................................................................................... 124

249 5.6.7 Security of Stored Data.......................................................................................................... 124
250 5.6.8 Key Management................................................................................................................... 124
251 5.7 Use with other WS* standards....................................................................................................... 125
252 5.8 Tailoring......................................................................................................................................... 125
253 6 Error handling.................................................................................................................................. 126
254 6.1 BIAS operation return codes......................................................................................................... 126
255 6.2 SOAP fault codes.......................................................................................................................... 126
256 7 Conformance................................................................................................................................... 127
257 Appendix A. XML Schema....................................................................................................................... 130
258 Appendix B. Use Cases (non-normative)................................................................................................. 255
259 B.1 Verification Use Case.................................................................................................................... 255
260 B.2 Asynchronous Verification Use Case............................................................................................256
261 B.3 Primitive Verification Use Case..................................................................................................... 257
262 B.4 Identification Use Case................................................................................................................. 258
263 B.5 Biometric Enrolment Use Case..................................................................................................... 259
264 B.6 Primitive Enrolment Use Case...................................................................................................... 260
265 Appendix C. Samples (non-normative).................................................................................................... 261
266 C.1 Create Subject Request/Response Example................................................................................261
267 C.2 Set Biographic Data Request/Response Example........................................................................263
268 C.3 Set Biometric Data Request/Response Example..........................................................................264
269 Appendix D. Acknowledgements............................................................................................................. 266
270 Appendix E. Revision History.................................................................................................................. 267
271
272

273 1 Introduction
274 1.1 IPR Policy
275 This Committee Specification is provided under the RAND Mode of the OASIS IPR Policy, the mode
276 chosen when the Technical Committee was established.
277 For information on whether any patents have been disclosed that may be essential to implementing this
278 specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights
279 section of the TC’s web page (https://www.oasis-open.org/committees/bioserv/ipr.php).
280 1.2 Purpose/Scope

281 This Organization for the Advancement of Structured Information Standards (OASIS) Biometric Identity
282 Assurance Services (BIAS) profile specifies how to use the eXtensible Markup Language (XML) [XML10]
283 defined in ISO/IEC 30108-1:2015, Information technology — Biometric Identity Assurance Services
284 [ISO/IEC-BIAS] to invoke Simple Object Access Protocol (SOAP) -based services that implement BIAS
285 operations. These SOAP-based services enable an application to invoke biometric identity assurance
286 operations remotely in a Services Oriented Architecture (SOA) infrastructure.
287 Not included in the scope of BIAS is the incorporation of biometric authentication as an integral
288 component of an authentication or security protocol. (However, BIAS services may be leveraged to
289 implement biometric authentication in the future.)
290 1.3 Overview

291 In addition to this introduction, this standard includes the following:
292  Clause 2 presents the design concepts and architecture for invoking SOAP-based services that
293 implement BIAS operations.
294  Clause 3 presents the namespaces necessary to implement this profile, ISO/IEC BIAS data
295 elements, and identifies relationships to external data definitions.
296  Clause 4 specifies the content of the BIAS messages.
297  Clause 5 presents the BIAS message structure, as well as rules and considerations for its
298 application.
299  Clause 6 presents information on error handling.
300  Clause 7 specifies conformance requirements.
301  Annexes include the OASIS BIAS XML schema/sample Web Service Definition Language
302 (WSDL), use cases, sample code, acknowledgements, and the revision history of this profile.
303 1.4 Background

304 In late 2005/early 2006, a gap was identified in the existing biometric standards portfolio with respect to
305 biometric services. The Biometric Identity Assurance Services standard proposal was for a collaborative
306 effort between government and private industry to provide a services-based framework for delivering
307 identity assurance capabilities, allowing for platform and application independence. This standard
308 proposal required the attention of two major technical disciplines: biometrics and service architectures.
309 The expertise of both disciplines was required to ensure the standard was technically sound, market
310 relevant, and achieved widespread adoption. The International Standards Organization and the
311 International Electrotechnical Commission (ISO/IEC) provided the standards leadership relevant to
312 biometrics, defining the “taxonomy” of biometric operations and data elements. OASIS provided the
313 standards leadership relevant to service architectures with an initial focus on web services, defining the
314 schema and SOAP messaging.

315
316 The driving requirements of the BIAS standard proposal were to provide the ability to remotely invoke
317 biometric operations across an SOA infrastructure; to provide business level operations without
318 constraining the application/business logic that implements those operations; to be as generic as possible
319 – technology, framework, & application domain independent; and to provide basic capabilities that can be
320 used to construct higher level, aggregate/composite operations.
321 1.5 Relationship to Other Standards

322 This OASIS BIAS profile comprises a companion standard to ISO/IEC 30108-1:2015, Information
323 technology — Biometric Identity Assurance Services, which defines the BIAS requirements and
324 taxonomy, specifying the identity assurance operations and the associated data elements. This OASIS
325 BIAS profile specifies the design concepts and architecture, data model and data dictionary, message
326 structure and rules, and error handling necessary to invoke SOAP-based services that implement BIAS
327 operations.
328 Together, the BIAS standard and the BIAS profile provide an open framework for deploying and remotely
329 invoking biometric-based identity assurance capabilities that can be readily accessed across an SOA
330 infrastructure.
331 This relationship allows the leveraging of the biometrics and web services expertise of the two standards
332 development organizations. Existing standards are available in both domains and many of these
333 standards will provide the foundation and underlying capabilities upon which the biometric services
334 depend.
335 1.6 Terminology

336 The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD
337 NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described
338 in [RFC2119].
339 The following additional terms and definitions are used:
340 Note: The terms and definitions specified in ISO/IEC 30801-1 [ISO/IEC-BIAS] also apply to this Standard.
341
342 BIAS operation and data element names are not defined here, but in their respective sections.
343
344 BIAS
345 Biometric Identity Assurance Services
346 BIR
347 Biometric Information Record
348 ESB
349 Enterprise Service Bus
350 HTTP
351 HyperText Transfer Protocol
352 HTTPS
353 HyperText Transfer Protocol over SSL or HTTP Secure
354 IRI
355 Internationalized Resource Identifier
356 SOA
357 Service-Oriented Architecture
358 SOAP
359 Simple Object Access Protocol
360 SSL
361 Secure Sockets Layer
362 TLS
363 Transport Layer Security
364 UDDI
365 Universal Description, Discovery, and Integration
366 URI
367 Uniform Resource Identifier
368 VPN
369 Virtual Private Network
370 WSDL
371 Web Services Description Language
372 WSS
373 Web Services Security
374 XML
375 eXtensible Markup Language
376 CBEFF
377 Common Biometric Exchange Formats Framework - data elements and BIR formats specified in
378 ISO/IEC 19785-1
379 BIAS implementation
380 software entity that is capable of creating, processing, sending, and receiving BIAS messages
381 BIAS endpoint
382 runtime entity, identified by an endpoint URI/IRI, capable of sending and receiving BIAS
383 messages, and containing a running BIAS implementation
384 BIAS message
385 message that can be sent from a BIAS endpoint to another BIAS endpoint through a BIAS link
386 channel
387 BIAS request message
388 BIAS message conveying a request for an action to be performed by the receiving BIAS endpoint
389 BIAS response message
390 BIAS message conveying a response to a prior BIAS requestmessage
391 1.7 References

392 1.7.1 Normative References
393 [RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, IETF RFC 2119,
394 March 1997
395 http://www.ietf.org/rfc/rfc2119.txt
396
397 [CBEFF] ISO/IEC19785-1:2006, Information technology – Common Biometric Exchange Formats
398 Framework – Part 1: Data element specification, with Amendment 1:2010
399 http://www.iso.org
400

401 [CBEFF-3] ISO/IEC19785-3:2015, Information technology – Common Biometric Exchange Formats
402 Framework – Part 3: Patron format specifications
404
405 [DATE-TIME] ISO 8601:2004, Data elements and interchange formats — Information interchange —
406 Representation of dates and times
408
409 [INCITS-BIAS] ANSI INCITS 442-2010, Biometric Identity Assurance Services (BIAS), July 2010
410 http://www.incits.org
411
412 [IRI] M. Duerst, et al, Internationalized Resouce Identifiers, RFC3987, January 2005
414
415 [ISO/IEC-BIAS] ISO/IEC 30108-1:2015, Information technology — Biometric Identity Assurance
416 Services — Part 1: BIAS Services
418 [SOAP11] Simple Object Access Protocol (SOAP) 1.1, 8 May 2000
419 http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
420 [URI] T. Berners-Lee, R. Fielding, L. Masinter, Uniform Resource Identifiers (URI): Generic Syntax,
421 RFC 3986, MIT/LCS, U.C. Irvine, Xerox Corporation, January 2005.
422 http://ietf.org/rfc/rfc3986
423 [UTF-8] ISO/IEC 10646:2003, Information technology — Universal Multiple-Octet Coded Character
424 Set (UCS)
426 [WS-Addr] W3C Recommendation,Web Services Addressing 1.0 - Core, and Web Services
427 Addressing 1.0 - SOAP Binding, 9 May 2006
428 http://www.w3.org/2002/ws/addr/
429 [WS-I-Basic] Basic Profile Version 1.1, 10 April 2006

430 http://www.ws-i.org/Profiles/BasicProfile-1.1-2006-04-10.html
431 [WS-I-Bind] Web Services-Interoperability Organization (WS-I) Simple SOAP Binding Profile Version
432 1.0, 24 August 2004
433 http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0-2004-08-24.html
434 [WSDL11] Web Services Description Language (WSDL) 1.1, 15 March 2001
435 http://www.w3.org/TR/2001/NOTE-wsdl-20010315
436 [XML 10] Extensible Markup Language (XML) 1.0, 16 August 2006
437 http://www.w3.org/TR/2006/REC-xml-20060816/
438 [XOP] XML-binary Optimized Packaging, W3C Recommendation, 25 January 2005

439 http://www.w3.org/TR/2005/REC-xop10-20050125/
440 1.7.2 Non-Normative References

441 [BioAPI] ISO/IEC 19784-1:2006, Information technology – Biometric Application Programming
442 Interface – Part 1: BioAPI Specification

444 [BIO SEC] ISO 19092 Financial services -- Biometrics -- Security framework
446 [EBTS-DOD] Department of DefenseElectronic Biometric TransmissionSpecification, Version 2.0,

447 27 March 2009
448 http://www.biometrics.dod.mil/CurrentInitiatives/Standards/dodebts.aspx
449 [EBTS-FBI] IAFIS-DOC-01078-8.1, “Electronic Biometric Transmission Specification (EBTS)”,
450 Version 8.1, November 19, 2008, Federal Bureau of Investigation, Criminal Justice
451 Information Services Division
452 https://www.fbibiospecs.org
453 [EFTS] IAFIS-DOC-01078-7, “Electronic Fingerprint Transmission Specification (EFTS)”, Version
454 7.1, May 2, 2005, Federal Bureau of Investigation, Criminal Justice Information Services
455 Division
456 https://www.fbibiospecs.org
457 [HR-XML] HR-XML Consortium Library, 2007 April 15
458 http://www.hr-xml.org
459 [INT-I] Interpol Implementation of ANSI/NIST ITL1-2000, Ver 4.22b, October 28, 2005, The Interpol
460 AFIS Expert Group
461 http://www.interpol.int
462 [NIEM] National Information Exchange Model (NIEM), Ver 2.0, June 2007, US DOJ/DHS
463 BIAS-v2.0-csprd01.docx
464 [RFC2246] T. Dierks & C. Allen,The TLS Protocol, Version 1.0, January 1999
466 [RFC2617] J. Franks, et al, HTTP Authentication: Basic and Digest Access Authentication, June
467 1999
469 [RFC3280] R. Housley, et al, Internet X.509 Public Key Infrastructure Certificate and Certificate
470 Revocation List (CRL) Profile, April 2002
472 [SAML] Security Assertion Markup Language (SAML), Oasis Standard, March 2005
473 http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
474 [SAML SEC] Security and Privacy Considerations for the OASIS Security Assertion Markup
475 Language (SAML) V2.0, Oasis Standard, 15 March 2005
476 http://docs.oasis-open.org/security/saml/v2.0/saml-sec-consider-2.0-os.pdf
477 [SSL3] SSL 3.0 Specification

478 http://www.freesoft.org/CIE/Topics/ssl-draft/3-SPEC.HTM
479 [WSS] Web Services Security: SOAP Message Security 1.1, (WS-Security 2004), OASIS Standard
480 Specification, 1 February 2006
481 http://www.oasis-open.org/committees/download.php/16790/wss-v1.1-spec-os-
482 SOAPMessageSecurity.pdf
483 [X509] X.509: Information technology - Open Systems Interconnection - The Directory: Public-key
484 and attribute certificate frameworks, ITU-T, August 2005
485 http://www.itu.int/rec/T-REC-X.509-200508-I
486 [xNAL] Customer Information Quality Specifications Version 3.0: Name (xNL), Address (xAL), Name
487 and Address (xNAL) and Party (xPIL), Committee Specification 02, 20 September 2008
488 http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=ciq

489 2 Design Concepts and Architecture (non-normative)
490 2.1 Philosophy
491 Rather than define a totally new and unique messaging protocol for biometric services, this specification
492 instead defines a method for using existing biometric and Web services standards to exchange biometric
493 data and perform biometric operations.
494 2.2 Context

495 Today, biometric systems are being developed which collect, process, store and match biometric data for
496 a variety of purposes. In many cases, data and/or capabilities need to be shared between systems or
497 systems serve a number of different client stakeholders. As architectures move towards services-based
498 frameworks, access to these biometric databases and services is via a Web services front-end. However,
499 lack of standardization in this area has led implementers to develop customized services for each
500 system/application.
501 BIAS is intended to provide a common, yet flexible, Web services interface that can be used within both
502 closed and open SOA systems. Figure 1, below, depicts the context in which the BIAS messages will be
503 implemented.
504
505
Biometric
Subject Client
Resources
(Requester)
System/
Application
A BIAS
BIAS Messages Service
Provider
Subject Client
(Requester)
System/
Application
N
Administrator
506
507
508 Figure 1. BIAS Context
509
510 The clients (requesters) may use standard discovery mechanisms (i.e., UDDI directories) to discover the
511 BIAS service provider (implementation) or, particularly in closed systems, the URI/IRI and WSDL for the
512 service provider may be known a priori by the client BIAS application developer.
513 2.3 Architecture

514 BIAS Web services are intended to be used within systems employing a services framework, such as a
515 services-oriented architecture (SOA) (although implementations are not limited to this environment). As
516 such, it is recognized that the clients may interact directly with the BIAS service provider or layers may
517 exist between the client and the service provider, for example as an ESB or other application layer.
518 The BIAS Architecture as shown in Figure 2, in which:
519  A Client request to the BIAS Web services may be triggered by a human interaction OR any
520 proxy system such as an ESB.
521  Client sends and receives SOAP messages that conform to the BIAS schemas
522  Calls to the BIAS Implementation use OASIS Service Interfaces and Bindings (via WSDL)
523  The BIAS implementation maps the service call to the appropriate internal API or set of APIs
524 and returns data according to the service interface.
525 Note that services are represented as circles.
526
527
528
529 Figure 2. Representative BIAS Architecture
530
531 NOTE: It is possible that BIAS may also be used between the service provider and the managed
532 resource (e.g., a biometric matcher).
533
534 At the heart of the BIAS SOAP Profile are the concepts of BIAS messages and endpoints.
535
536 BIAS implementation
537 A BIAS implementation is a software entity that is capable of creating, processing, sending, and receiving
538 BIAS messages. This standard does not define requirements for the BIAS implementation other than
539 defining the messages and protocols used by the endpoints.
540 BIAS messages
541 A BIAS message is a one that can be sent from a BIAS endpoint to another BIAS endpoint over a TCP/IP
542 link.
543 BIAS endpoints
544 A BIAS endpoint is a runtime entity, uniquely identified and accessed by an endpoint URI/IRI [URI] [IRI],
545 capable of sending and receiving BIAS messages.
546 NOTE: When not publicly and directly exposed, the endpoints for purposes of this specification are
547 the BIAS service provider exposing BIAS services and the component that directly interacts with that
548 service provider, e.g., the business application or ESB, rather than the ultimate end client requester.

549 3 Data Dictionary
550 This section describes the BIAS data elements used within BIAS messages (as defined in Clause 4).
551 Common data elements are defined for use in one or more operations. These include common data types
552 or return codes. BIAS data elements are defined in ISO/IEC 30108-1. The elements, complex types and
553 simple types described for the BIAS messages belong to the following namespace: http://docs.oasis-
554 open.org/bias/ns/bias-2.0/. See Annex A for the XML schema.
555 NOTE: Biographic and biometric data included in a native XML format MAY contain elements
556 referencing external namespaces (e.g., ansi-nist).
557 3.1 Documentation Conventions

558 Each common element has a section describing its content. Likewise, each operation has a section
559 describing the request and response messages and the associated input and output parameters. The
560 input and output of each message and the comment elements are detailed in a table as described in the
561 figure below. Each field that forms part of the message request/response is detailed in the table.
562
Header Description Values Value Meaning
Name
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
563 Figure 3. BIAS Message Input/Output Dictionary Table Headings
564 Fields Hierarchy Explained:

565 To denote the field hierarchy the symbol is used to denote the child-of relationship.
566 All string types/elements MUST consist of ISO/IEC 10646 (Unicode) characters encoded in UTF-8 [UTF-
567 8] (see ISO/IEC 10646:2003, Annex D).
568

569 3.2 Common Elements
570 3.2.1 ApplicationIdentifier
Type: string
Description: Identifies an application.
Min Length: 1
Max Length: 255
571 3.2.2 ApplicationUserIdentifier

Type: string
Description: Identifies an application user or instance.
Min Length: 1
Max Length: 255
572 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.
573 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 ISO/IEC BIAS

elements as required by that
specification.
ReferenceBIR CBEFF_BIR_Type 0..1 N Maps to specific ISO/IEC BIAS

elements as required by that
specification.
BiometricDataListType 0..1 N A list of biometric data elements.
BiometricDataList

574 3.2.5 BIASFaultCode
Type: String
Description: Error code referenced in a SOAP fault.
575 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.
UNKNOWN_DOCUMENT_CATEGORY The data requested does not exist.
INVALID_TOKEN The data requested does not exist.
TOKEN_EXPIRED The data requested does not exist.
DUPLICATE_ENCOUNTER The input encounter ID for a new encounter

already exists for that subject.

Value Description
IDENTIFICATION_RESULT_NOT_YET_AVAILABLE The result of an asynchronous identification

process is not yet available.
576 3.2.6 BIASFaultDetail

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.
string 0..1 N Provides detailed information about a

BIASFaultDescription BIAS fault, such as trace details.
577 3.2.7 BIASIdentity

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.
BiometricData BIASBiometricDataType 0..1 N An Identity’s biometric data.

578 3.2.8 BIASIDType
Type: string
Description: A BIAS Identifier.
579 3.2.9 BinaryBIR

BinaryBIR BaseBIRType Y Defines a BIR type of Binary
Binary base64Binary 1 Y BIR information in base64 binary format
580 3.2.10 BiographicDataItemType

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.
581 NOTE: This element can be used to transmit scanned identity documents or document information
582 (e.g., passports, driver’s license, birth certificates, utility bills, etc. required to establish an identity).
583 3.2.11 BiographicDataItemListType

BiographicDataItemListType Y Defines a list of biographic data
elements.
BiographicDataItemType 1..* Y Data structure containing information
BiographicDataItem about a biographic record.
584 3.2.12 BiographicDataListType

BiographicDataListType Y Defines a list of biographic data.
BiographicDataType 0..* N Data structure containing information about a
BiographicData biographic record.
585 3.2.13 BiographicDataSetType

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.
586 NOTE: Biographic data formats are not limited to those listed. The string value is not enumerated.
587 If one of the common types are used, it MUST be indicated by the specified name values; however,
588 the service provider MAY offer other formats. See ISO/IEC 30108 for further information.
589 3.2.14 BiographicDataType

BiographicDataType Y Defines a set of biographic data
elements, utilizing either the
BiographicDataItemListType 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.. N The last name of a subject.

1
FirstName string 0.. N The first name of a subject.

1
BiographicDataItemListType 0.. N A list of biographic data elements.
BiographicDataItemList 1
BiographicDataItemType 1..* Y A single biographic data element.
BiographicDataItem
BiographicDataSetType 0.. N A set of biographic data
BiographicDataSet 1 information.
590 NOTE: The implementer is given three choices for encoding biographic data:
591  Encode only first and last name using the defined fields within BiographicDataType

592  Define a list of biographic data elements using the BiographicDataItemListType
593  Use a pre-defined set of biographic data (e.g., as specified in another standard) using
594 the BiographicDataSetType.
595 See also ISO/IEC 30108-1, section 8.1 for further information.
596 3.2.15 BiometricDataType

BiometricDataType 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.
positiveInteger 0.. N The number of biometric records
BiometricTypeCount 1 having the biometric type
recorded in the biometric type
field.
oasis_cbeff:SubtypeType 0.. N More specifically defines the type
BiometricSubType 1 of biometric data stored in the
CBEFF.
positiveInteger 1 Y Identifies the standards body,
BDBFormatOwner working group, industry
consortium, or other CBEFF
biometric organization that has
defined the format for the
biometric data.
positiveInteger 1 Y Identifies the specific biometric
BDBFormatType data format specified by the
CBEFF biometric organization
recorded in the BDB Format
Owner field.
597 3.2.16 BiometricDataListType

BiometricDataListType Y A list of biometric data
elements.
BiometricDataRecord BiometricDataType 0..* N Data structure containing

information about a biometric
record.

598 3.2.17 CandidateListResultType
CandidateListResultType Y Defines a set of candidates, utilizing the
CandidateType to represent each element in
the set.
CandidateList CandidateListType 1 Y The candidate list.
599 3.2.18 CandidateListType

CandidateListType Y Defines a set of candidates, utilizing the
CandidateType to represent each element in the set.
CandidateType 0..* N A single candidate.
Candidate
600 3.2.19 CandidateType

CandidateType Y Defines a single candidate as a possible
match in response to a biometric
identification request.
ScoreList 0..1 N A list of comparison(s) scores and

optionally the type and subtype of the
relating biometric
Score ScoreType 1 Y The match score.
Rank integer 1 Y The rank of the candidate in relation to

other candidates for the same biometric
identification operation.
Identity
BIASIDType 0..1 Y The identifier of the subject.
SubjectID
BiographicDataType 0..1 N Biographic data associated with the
BiographicData candidate match.
CBEFF_BIR_ListType 1 Y Biometric data associated with the
BIRList candidate match.
601 3.2.20 CapabilityListType

CapabilityListType Y Defines a set of capabilities.
Capability CapabilityType 0..* N A single capability.

602 3.2.21 CapabilityName
Type: string
Description: A list of capability items.
603 CapabilityName Enumeration Values
Value Description
AggregateInputDataOptional A data element accepted as optional input by the implementing system for
the aggregate services.
The Capability Value should be set to the name of the data element that
will be accepted by the aggregate services.
The Capability Supporting Value that indicates the which services support
the data element, using one or more of the following values, each
separated by a comma:
“Delete”
“Enrol”
“Identify”
“Verify”
“All”
AggregateInputDataRequired A data element required as input by the implementing system for the
aggregate services.
will be accepted by the aggregate services.
“Delete”
“Enrol”
“Identify”
“Verify”
“All”

Value Description
AggregateProcessingOption A processing option supported by the implementing system for the

aggregate services.
The Capability Value should be set to the option identifier, or “key” field,
for the Processing Option parameter in the aggregate services.
The Capability Supporting Value that indicates the option value, or “value”
field, for the Processing Option parameter in the aggregate services, if
applicable.
The Capability Additional Info should indicate which aggreagate services

support the processing option, using one or more of the following values,
each separated by a comma:
“Delete”
“Enrol”
“Identify”
“Verify”
“Retrieve”
“All”
AggregateReturnData A data element returned by the implementing system for the aggregate
services.
will be returned by the aggregate services.
The Capability Supporting Value that indicates which services support the
data element, using one or more of the following values, each separated
by a comma:
“Delete”
“Enrol”
“Identify”
“Verify”
“Retrieve”
“All”

Value Description
AggregateServiceDescription Describes the processing logic of an aggregate service supported by the

implementing system.
describes the aggregate services.
“Delete”
“Enrol”
“Identify”
“Verify”
“Retrieve”
BiographicDataSet Identifies a biographic data set supported by the implementing system.
The Capability Value should contain the name of the biographic data
format supported by the implementing system (e.g. “EBTS” or “NIEM”).
The Capability Supporting Value should contain the version of the

biographic data format supported by the implementing system.
The Capability Additional Info should contain the biographic data format
type supported by the implementing system (e.g. ASCII or XML).
CBEFFPatronFormat A patron format supported by the implementing system.
The Capability Value should contain the format owner.
The Capability Supporting Value should contain the format type.
ClassificationAlgorithmType A classification algorithm type supported by the implementing system.
The Capability Value should contain the name of classification alogorithm

type supported by the implementing system.

Value Description
ConformanceClass Identifies the conformance class of the BIAS implementation.
The Capability Value should be set to one of the following:
1 – (Class 1 conformance)
Gallery A gallery or population group supported by the implementing system.
The Capability Value should be the same as the value used for the Gallery
ID parameter in the Add Subject to Gallery, Delete Biographic Data, Delete
Biometric Data, Delete Subject From Gallery, Identify Subject, Retrieve
Biographic Data Retrieve Biometric Data, Retrieve Document Data, Set
Biographic Data, Set Biometric Data, Set Document Data, and Verify
Subject Services.
IdentityModel Identifies whether the implementing system is person-centric or encounter-

centric based.
The Capability Value shall be set to one of the following:
“person”
“encounter”
MatchAlgorithm A match algorithm vendor and algorithm vendor product ID supported by

the implementing system.
The Capability Value shall contain the algorighm vendor.
The Capability Supporting Value shall contain the algorithm vendor product
ID.
The Capability Additional Info shall be set to the biometric type (defined by
the XML Patron Format in ISO/IEC 19785-3) that corresponds to the match
algorithm.
The Capability Description shall contain the software version of the match
algorithm.

Value Description
MatchScore Identifies the use of match scores returned by the implementing system.
The Capability Value shall be set to the end-of-score-range that signifies a

match.
The Capability Supporting Value shall be set to the end-of-score-range that

signifies a no-match.
the XML Patron Format in ISO/IEC 19785-3) that corresponds to the match
score range.
QualityAlgorithm A quality algorithm vendor and algorithm vendor product ID supported by

the implementing system.
The Capability Value shall contain the algorighm vendor.
The Capability Supporting Value shall contain the algorithm vendor product
ID.
the XML Patron Format in ISO/IEC 19785-3) that corresponds to the quality
algorithm.
The Capability Description shall contain the software version of the quality
algorithm.
SupportedBiometric A biometric type supported by the implementing system.
The Capability Value shall be set to the biometric type, as defined by the
ZML Patron Format in ISO/IEC 19785-3 (for example, the biometric type for
face is represented a “face”).
The Capability Supporting Value shall indicate if the implementing system

supports matching for the biometric type, using one of he following values:
“1” (identification)
“2” (verification)
“3” (identification and verification)
“4” (no comparison supported)

Value Description
TransformOperation A transform operation type supported by the implementing system.
The Capability Value shall be equal to the value for the Transform
Operation parameter in the Transform Biometric Data service.
The Capability Supporting Value shall specify the value of the Transform
Control parameter in the Transform Biometric Data service. The value
returned may be either a single value or a range of values. If a range of
values is returned, the Capability Description shall specify additional
information for the value of the Transform Control parameter. If the
Transform Operation does not support a Transform Control, the Capability
Supporting value shall be set to “NotApplicable”.
604 3.2.22 CapabilityType

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.
string 0..1 N A secondary value supporting the

CapabilitySupportingValue capability.
CapabilityAdditionalInfo string 0..1 N Contains additional information for

the supported capability.
605 3.2.23 CBEFF_BIR_ListType

CBEFF_BIR_ListType Y A list of CBEFF-BIR elements.
BIR CBEFF_BIR_Type 0..* N CBEFF structure containing information about a

biometric sample.
606 3.2.24 CBEFF_BIR_Type

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.
0..1 N Describes what is contained in a

BIR_Information BIR.
oasis_cbeff:BIRInfoType 0..1 N Contains information about the
BIR_Info CBEFF-BIR.
oasis_cbeff:BDBInfoType 0..1 N Contains information about the BDB
BDB_Info 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.
607 NOTE: The implementer is given three choices for encoding a BIR:
608  As an XML BIR (following the XML Patron format as specified in Annex B)
609  As a reference to a URI (from which the receiver would retrieve the actual BIR)
610  As a complete Base64 encoded binary (non-XML) BIR.
611 The latter two alternatives can use any CBEFF Patron Format.
612 The optional BIR_Information provides a mechanism for
613 exposing metadata associated with a BIR format that is not easily
614 decoded (i.e., a non-XML BIR). See section 5.3 for more
615 information on handling of binary data within BIAS and ISO/IEC
616 30108, Clause 8.2, for more information on representing
617 biometric data.
618 NOTE:
619 (1) XML BIRs MUST conform to the XML patron format in
620 Annex B; however, non-XML (binary) and URI BIRs
621 MAY implement any CBEFF patron format.
622 (2) It is RECOMMENDED that only registered CBEFF
623 patron formats be used; however, in closed systems,
624 this may not be required.
625 3.2.25 Classification

Type: string
Description: The result of a classification.
626 3.2.26 ClassificationAlgorithmType

Type: string
Description: Type of classification algorithm that was used to perform the classification.

627 3.2.27 ClassificationData
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 1 Y Identifies the type of
ClassificationAlgorithmType classification algorithm
that was used to perform
the classification.
628 3.2.28 DocumentDataType

DocumentDataType Y Defines a set of
document data
elements providing
information about
the presented
identity document.
DocumentCategory string 1 Y The type of identity

document
presented (e.g.
passport).
DocumentIDNumber string 0..1 N The number

associated with the
identity document
(e.g. passport
number)
iso_3166_1:CountryAlpha2CodeType 0..1 N The ISO 2-character
DocumentIssuanceCountryCode code for the country
which issued the
document or from
within which it was
issued.
string 0..1 N The entity which
DocumentIssuingOrganization issued the identity
document.
datetime 0..1 N The date upon
DocumentIssuanceDate which the identity
document was
issued.

datetime 0..1 N The date upon
DocumentExpirationDate which the identity
document is no
longer valid
(expires).
DocumentLastName string 0..1 N The family name of

the person to whom
the identity
document was
issued, as
contained within the
document itself.
DocumentFirstName string 0..1 N The first given name

of the person to
whom the identity
document was
issued, as
document itself.
string 0..1 N The second given
DocumentMiddleName name of the person
to whom the identity
document was
issued, as
document itself.
DocumentValidity boolean 0..1 N The assessed

validity of the
identity document
(e.g. as the result of
local or online
validity checks).
DocumentValidityText string 0..1 N Details or remarks

associated with the
assessed validity
(e.g. description of
validity issue).
DocumentImage xsd:base64binary 0..1 N A scanned image of

the subject
document (e.g.
passport picture
page).
629 3.2.29 DocumentDataListType

DocumentDataListType Y Provides a list of documents.

DocumentData DocumentDataType 0..* Y Data structure containing information

about a document and optionally an
image of that document.
630 3.2.30 EncounterCategoryType

Type: String
Description: Identifies the type of encounter (interaction) during which the identity (biographic,
biometric, and/or document) data was collected from the subject as determined by the
requester.
631 EncounterCategoryType Enumeration Values
Value Description
Enrolment The encounter is created during an enrolment interaction.
Recognition The encounter is created during a recognition interaction.
Unspecified The type of encounter is unknown.
632 3.2.31 EncounterListType

EncounterListType Y Defines a set of encounters.
EncounterID BIASIDType 0..* N The identifier of an encounter.
633 3.2.32 FusionDecision

Type: string
Description: The match decision assigned by the matching algorithm
634 3.2.33 FusionIdentityListType

FusionIdentityListType Y Contains fusion input elements for one
or more identities, utilizing the
FusionInformationListType to
represent a single set of fusion
information for each identity.
FusionIdentity FusionInformationListType 0..* Y A set of fusion information for a single

identity.

635 3.2.34 FusionInformationListType
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.
636 3.2.35 FusionInformationType

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
CBEFF.
oasis_cbeff: SubtypeType 0..1 N More specifically defines the
BiometricSubType 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.
637 3.2.36 FusionResult

Type: complexType
Description: The base type for any resulting types which indicate the status of a Fusion operation
638 3.2.37 FusionScore

Type: ScoreType
Description: The similarity score assigned by the matching algorithm.

639 3.2.38 GenericRequestParameters
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.
string 0..1 N Identifies the BIAS operation that
BIASOperationName is being requested.
640 NOTE: See section 5.4 for alternatives for identifying the
641 requested BIAS operation in a BIAS SOAP message.
642 3.2.39 IdentifySubjectResultType

Description: A base type for all types that could be returned from the IdentifySubject operation
643 3.2.40 InformationType

InformationType Y Allows for an unlimited number of data element types, and
it does not specify nor require any particular data element.
any 0..* N
unspecified
644 3.2.41 ListFilterType

ListFilterType Y Provides a method to
filter the amount of
information returned in
a search of biometric
data.
BiometricTypeFilters 1 Y
oasis_cbeff:MultipleTypesType 1..* Y Limits the returned

BiometricTypeFilter information to a specific
type of biometric, as
defined by CBEFF.
boolean 1 Y A Boolean flag
IncludeBiometricSubType indicating if biometric
subtype information
should be returned.
645 3.2.42 MatchType

Type: boolean
Description: The result of a fusion method.
646 3.2.43 OptionType

OptionType Y BIAS aggregate operations support the ability to include
various processing options which direct and possibly
control the business logic for that operation. Together
with the ProcessingOptionsType, The OptionType
provides a method to represent those options.
Processing options SHOULD be defined by the
Key string 1 Y The identifier of an option supported by the

Value string 0..1 N The value for an option supported by the implementing
system.
647 3.2.44 ProcessingOptionsType

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 OptionType 0..* N An option supported by the implementing system.
648 3.2.45 ProductID

Type: string
Description: The vendor’s ID for a particular product.
649 3.2.46 QualityData

QualityData Y Contains information about a
biometric sample’s quality and
the algorithm used to compute
the quality.
QualityScore oasis_cbeff:QualityType 0.. N The quality of a biometric

1 sample.
AlgorithmVendor VendorIdentifier 1 Y The vendor of the quality

algorithm used to determine the
quality score.

ProductID 1 Y The vendor’s ID for the algorithm
AlgorithmVendorProductID used to determine the quality.
AlgorithmVersion VersionType 0.. N The version of the algorithm

1 used to determine the quality.
650
651 3.2.47 ResponseStatus

ResponseStatus Y
Return ReturnCode 1 Y The return code indicates the return status of the
operation.
string 0..1 N A short message corresponding to the return code.
Message
652 3.2.48 ReturnCode

Type: unsignedLong
Description: Return value specifying success or other condition.
653 ReturnCode Enumeration Values
Value Description
0 Success
654 3.2.49 ScoreType

ScoreType Y
Value float 1 Y Defines a match result or quality score.
oasis_cbeff:MultipleTypesType 0..1 N The type of biological or behavioral

BiometricType data stored in the biometric record, as
defined by CBEFF.
oasis_cbeff:SubTypesType 0..1 N More specifically defines the type of
BiometricSubType biometric data stored in the biometric
record.
655 NOTE: Matching scores MAY be in a standardized or proprietary form in terms of value range and
656 interpretation. Quality scores, however, follow the definition found in Annex
657 3.2.50 TokenResultType

TokenResultType Y Defines a token that is returned for asynchronous
processing.

TokenType TokenType 1 Y Defines a token that is returned for asynchronous

processing.
658 3.2.51 TokenType

TokenType Y Defines a token that is returned for asynchronous
processing.
string 1 Y A value returned by the implementing system that is
TokenValue 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.
659 NOTE: Date/time format is defined in ISO/IEC 30108 and is

660 consistent with the date format specified in Annex B and ISO
661 8601[DATE-TIME].See also Annex A for schema definition.
662 3.2.52 URI_BIR

URI_BIR BaseBIRType Y Defines a BIR type of Binary
URI anyURI 1 Y The URI of the BIR
663 3.2.53 VendorIdentifier

Type: string
Description: Identifies a vendor.
664 NOTE: Vendor identifiers are registered with IBIA as the CBEFF
665 registration authority (see ISO/IEC 19785-2). Registered biometric
666 organizations are listed at:
667 http://www.ibia.org/cbeff/_biometric_org.php.
668 3.2.54 Version

Version Y For a description or definition of each data element,
see the referenced CBEFF standards in the
nonNegativeInteger 1 Y CBEFF_BIR_TYPE schema.
major
nonNegativeInteger 1 Y
minor
669 3.2.55 VersionType

Type: string

Description: The version of a component.
670 3.2.56 XML_BIR

XML_BIR BaseBIRType Y Defines a BIR type of Binary
XML Oasis_cbeff:BIRType 1 Y BIR information in XML format
671

672 4 BIAS Messages
673 This section describes the BIAS messages implementing BIAS operations as defined in ISO/IEC 30108-
674 1:2015. The operations are listed alphabetically, with each operation containing a request and a
675 response message. The tables follow the conventions described in section 3.1.
676 4.1 Primitive Operations

677 4.1.1 AddSubjectToGallery
678 AddSubjectToGalleryRequest
679 AddSubjectToGalleryResponse
680 The AddSubjectToGallery operation registers a subject to a given gallery or population group. As an
681 OPTIONAL parameter, the value of the claim to identity by which the subject is known to the gallery MAY
682 be specified. This claim to identity MUST be unique across the gallery. If no claim to identity is specified,
683 the subject ID (assigned with the CreateSubject operation) will be used as the claim to identity. In the
684 encounter-centric model, the encounter ID associated with the subject’s biometrics that will be added to
685 the gallery MUST be specified. Additionally, the service provider implementation is responsible for the
686 creation and management of galleries. For this purpose, services are not exposed to the requester.
687 Request Message

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:
“AddSubjectToGa
llery”.

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.
688 Response Message

AddSubjectToGalleryResponse Y The response to an

AddSubjectToGallery operation.
AddSubjectToGalleryResponsePacka 1 Y
ge
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.
689 4.1.2 CheckQuality

690 CheckQualityRequest
691 CheckQualityResponse

692 The CheckQuality operation returns a quality score for a given biometric or a specified subject. Either a
693 biometric sample or a subject ID MUST be provided. The biometric input is provided in a CBEFF basic
694 structure or CBEFF record, which in this specification is called a CBEFF-BIR. The algorithm vendor and
695 algorithm vendor product ID MAY be optionally provided in order to request a particular algorithm’s use in
696 calculating the biometric quality. If an algorithm vendor is provided, then the algorithm vendor product ID
697 is REQUIRED. If no algorithm vendor is provided, the implementing system will provide the algorithm
698 vendor and algorithm vendor product ID that were used to calculate the biometric quality as output
699 parameters.
700 Algorithm Vendors are registered with the ISO Biometric Registration Authority. They are assigned unique
701 identifiers as outlined in ISO/IEC 19785-2. Algorithm Product IDs are assigned by the registered algorithm
702 vendor.
703 Request Message

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.

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 0..1 C Data structure

containing a
single biometric
sample for
which a quality
score is to be
determined;
required if no
Subject ID is
provided.

BIR CBEFF_BIR_Type 1 Y The biometric

sample.
Identity BIASIdentity 0..1 C Required if no

BIR is provided.
SubjectID BIASIDType 1 Y Identifies the

subject;
required if no
BIR is provided.
Qualityinfo 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.
ProductID 1 C The vendor

AlgorithmVendorProductID assigned ID for
the algorithm
used to
determine the
quality; required
as input if
algorithm
vendor is
provided

CheckQualityResponse Y The response to a

CheckQuality operation.
CheckQualityResponsePackage 1 Y

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:Quali 0..1 N The quality of a biometric

tyType sample.
AlgorithmVendor VendorIdentifier 1 Y The vendor of the quality

algorithm used to determine
the quality score.
ProductID 1 Y The vendor’s ID for the

AlgorithmVendorProductID algorithm used to determine
the quality.
AlgorithmVersion VersionType 1 Y The version of the algorithm

used to determine the
quality.
705 4.1.3 ClassifyBiometricData

706 ClassifyBiometricDataRequest
707 ClassifyBiometricDataResponse
708 The ClassifyBiometricData operation attempts to classify a biometric sample. For example, a fingerprint
709 biometric sample may be classified as a whorl, loop, or arch (or other classification classes and sub-
710 classes). If no classification algorithm is input, then the BIAS service provider will make the selection.
711 To obtain the types of classification algorithms and classes, see the QueryCapabilities operation.
712 Request Message

ClassifyBiometricData Y Classifies a biometric

sample.
ClassifyBiometricDataRequest 1 Y
GenericRequestParameters 0..1 N Common request

GenericRequestParameters parameters that can
be used to identify the
requester.

requesting application.
ApplicationUser ApplicationUserIdentifier 0..1 N Identifies the user or

instance of the
string 0..1 N Identifies the BIAS

BIASOperationName operation that is being
requested:
“ClassifyBiometricDat
a”.

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.
ClassificationData 0..1 N Contains the algorithm

to be used to
determine the
classification.
1 Y Identifies the type of

ClassificationAlgorithmType ClassificationAlgorithmType classification algorithm
to be used to perform
the classification.

ClassifyBiometricDataResponse Y The response to a

ClassifyBiometricData
operation, containing the
classification of a
biometric sample.
ClassifyBiometricDataResponsePackage 1 Y

operation.

operation.

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.
ClassificationAlgor 1 Y Identifies the type of

ClassificationAlgorithmType ithmType classification algorithm
that was used to perform
the classification.
714 4.1.4 CreateEncounter

715 CreateEncounterRequest
716 CreateEncounterResponse
717 The CreateEncounter operation creates a new encounter record for a subject and associates an
718 encounter ID to that record. If an encounter ID is not supplied by the requester, the service generates an
719 encounter ID that uniquely identifies the encounter within the subject record. The CreateEncounter
720 operation is performed prior to a SetBiographicData, SetBiometricData, or SetDocumentData operation.
721 In encounter mode, for match operations, the BIAS service provider will create the encounter and will set
722 the encounter type to “recognition”. Normally the BIAS implementation will assign the encounter ID.
723 However, if a requester assigns the encounter ID, it should be used unless it duplicates an existing
724 encounter ID. If that happens an error should be returned.
725 Request Message

CreateEncounter Y Create a new

encounter record for
the specified subject
and associate an
encounter ID to that
record.
CreateEncounterRequest 1 Y

requester.


instance of the

requested:
“CreateEncounter”.
Identity BIASIdentity 1 Y

identifier for a subject
EncounterID BIASIDType 0..1 N The identifier of an

encounter associated
with the subject.
Required for
encounter-centric
models.
EncounterType EncounterCategoryType 1 Y Identifies the type of

encounter during
which data was
collected from the
subject, as determined
by the requester.

CreateEncounterResponse Y The response to a

CreateEncounter
operation, containing the
new encounterID
associated with the
specified subject.
CreateEncounterResponsePackage 1 Y

operation.

operation.

return code.
EncounterID BIASIDType 1 Y The identifier of an

encounter associated with
the subject.
centric models.
727 4.1.5 CreateSubject

728 CreateSubjectRequest
729 CreateSubjectResponse
730 The CreateSubject operation creates a new subject record and associates a subject ID to that record. As
731 an optional parameter, the subject ID MAY be specified by the caller. If no subject ID is specified, the
732 CreateSubject operation will generate one. UUIDs should be used for Subject IDs when universal
733 uniqueness is required.
734 Request Message

CreateSubject Y
CreateSubjectRequest 1 Y

requester.



instance of the

requested:
“CreateSubject”.

CreateSubjectResponse Y The response to a CreateSubject

operation, containing the subject ID of
the new subject record.
CreateSubjectRespons 1 Y
ePackage
ResponseStatus 1 Y Returned status for the operation.

ResponseStatus
Return ReturnCode 1 Y The return code indicates the return

status of the operation.
string 0..1 N A short message corresponding to the

Message return code.
BIASIDType 1 Y A system unique identifier for a subject.

SubjectID
736 4.1.6 DeleteBiographicData

737 DeleteBiographicDataRequest
738 DeleteBiographicDataResponse
739 The DeleteBiographicData operation erases all of the biographic data associated with a given subject
740 record. In the encounter-centric model the operation erases all of the biographic data associated with a
741 given encounter, and therefore the encounter ID MUST be specified. If no encounter ID is specified, or it
742 is null, biographic data will be removed from all encounters. If a gallery is specified, biographic data will be
743 deleted from that gallery only.
744 When deleting data, BIAS implementations MAY completely erase the information in order to prevent the
745 ability to reconstruct a record in whole or in part, or they MAY track and record the deleted information for
746 auditing and/or quality control purposes.

747 Request Message
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 parameters that can be
used to identify the
requester.


instance of the

requested:
“DeleteBiographicData”
.

identifier for a subject.
EncounterID BIASIDType 0..1 C The identifier of an

with the subject.
Required for
encounter-centric
models.
GalleryID BIASIDType 0..1 N The identifier of the

gallery or population
group from which the
biographic information
will be deleted.

DeleteBiographicDataResponse Y The response to a

DeleteBiographicData
operation.

DeleteBiographicDataResponsePackage 1 Y

operation.

operation.

code.
749 4.1.7 DeleteBiometricData

750 DeleteBiometricDataRequest
751 DeleteBiometricDataResponse
752 The DeleteBiometricData operation erases all of the biometric data associated with a given subject
753 record. In the encounter-centric model the operation erases all of the biometric data associated with a
754 given encounter, and therefore the encounter ID MUST be specified. If no encounter ID is specified, or it
755 is null, biometric data will be removed from all encounters. If a gallery is specified, biometric data will be
756 deleted from that gallery only. If a biometric type(s) is specified, then only biometric data of that type will
757 be deleted.
759 ability to reconstruct a record in whole or in part, or they MAY track and record the deleted information for
761 Request Message

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

requester.

application.

instance of the


requested:
“DeleteBiometricData”.


with the subject.
centric models.
BiometricType oasis_cbeff:MultipleTypesTy 0..1 N The type of biological or

pe behavioral data to
delete, as defined by
CBEFF.

biometric information
will be deleted.

DeleteBiometricDataResponse Y The response to a

DeleteBiometricData operation.
DeleteBiometricDataResponsePackag 1 Y
e

operation.

Message string 0.. N A short message corresponding

1 to the return code.
763 4.1.8 DeleteDocumentData

764 DeleteDocumentDataRequest
765 DeleteDocumentDataResponse
766 The DeleteDocumentData operation erases all of the document data of the specified category(ies)
767 associated with a given subject record. In the encounter-centric model the service erases all of the
768 document data associated with a given encounter, and therefore the encounter ID MUST be specified. If
769 no encounter ID is specified, or it is null, document data will be removed from all encounters. If no
770 categories are specified, then all categories (for the specified encounters) will be deleted.

772 ability to reconstruct a record in whole or in part, or they may track and record the deleted information for
774 Request Message

DeleteDocumentData Y Erase all of the

document data
associated with a
given subject record
or, in the encounter-
centric model, with a
given encounter.
DeleteDocumentDataRequest 1 Y

requester.


instance of the

requested:
“DeleteDocumentData”
.


with the subject.
Required for
encounter-centric
models.
DocumentData DocumentDataType 0..1 N Defines a set of

document data
elements providing
information about the
presented identity
document.
DocumentCategory string 1 Y The category(ies) of

the identity documents
to be deleted.

DeleteDocumentDataResponse Y The response to a

DeleteDocumentData
operation.
DeleteDocumentDataResponsePackage 1 Y

operation.

operation.

return code.
776 4.1.9 DeleteEncounter

777 DeleteEncounterRequest
778 DeleteEncounterResponse
779 The DeleteEncounter operation deletes an existing encounter record from the system. When deleting an
780 encounter, BIAS implementations MAY completely erase the information in order to prevent the ability to
781 reconstruct a record in whole or in part, or they MAY track and record the deleted information for auditing
782 and/or quality control purposes.
783 Request Message

DeleteEncounter Y Delete an existing

encounter record and,
any associated
encounter information.
DeleteEncounterRequest 1 Y

requester.


instance of the

requested:
“DeleteEncounter”.



with the subject.

DeleteEncounterResponse Y The response to a

DeleteEncounter
operation.
DeleteEncounterResponsePackage 1 Y

operation.

operation.

return code.
785 4.1.10 DeleteSubject

786 DeleteSubjectRequest
787 DeleteSubjectResponse
788 The DeleteSubject operation deletes an existing subject record and, in an encounter-centric model, any
789 associated encounter information from the system. This operation also removes the subject from any
790 registered galleries.
791 When deleting a subject, BIAS implementations MAY completely erase the subject information in order to
792 prevent the ability to reconstruct a record or records in whole or in part, or they MAY track and record the
793 deleted information for auditing and/or quality control purposes.
794 Request Message

DeleteSubject Y Delete an existing

subject record and, in
an encounter-centric
model, any associated
encounter information.
DeleteSubjectRequest 1 Y


requester.


instance of the

requested:
“DeleteSubject”.
Identity BIASIdentity 1 Y The identity of the

subject to delete.


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.

return code.
796 4.1.11 DeleteSubjectFromGallery

797 DeleteSubjectFromGalleryRequest
798 DeleteSubjectFromGalleryResponse
799 The DeleteSubjectFromGallery operation removes the registration of a subject from a gallery or
800 population group. The subject is identified by either the subject ID or the claim to identity that was
801 specified in the AddSubjectToGallery operation.

802 Request Message
DeleteSubjectFromGallery Y Remove the registration

of a subject from a
group.
DeleteSubjectFromGalleryRequest 1 Y

requester.

application.

instance of the

requested:
“DeleteSubjectFromGall
ery”.
GalleryID BIASIDType 1 Y The identifier of the

subject will be deleted.
Identity BIASIdentity 1 Y The identity to remove

from the gallery.
SubjectID BIASIDType 0..1 C A system unique

Required if an Identity
Claim is not provided.
IdentityClaim BIASIDType 0..1 C An identifier by which a

particular gallery or
population group.
Required if a Subject ID
is not provided.

DeleteSubjectFromGalleryResponse Y The response to a

DeleteSubjectFromGaller
y operation.

DeleteSubjectFromGalleryResponsePackag
e

operation.

operation.
Message string 0.. N A short message

1 corresponding to the
return code.
804 4.1.12 GetIdentifySubjectResults

805 GetIdentifySubjectResultsRequest
806 GetIdentifySubjectResultsResponse
807 The GetIdentifySubjectResults operation retrieves the identification results for the specified token. This
808 opereation is used in conjunction with the IdentifySubject operation. If the IdentifySubject operation is
809 implemented as an asynchronous service, the implementing system returns a token and the
810 GetIdentifySubjectResults operation is used to poll for the results of the original IdentifySubject request.
811 Request Message

GetIdentifySubjectResults Y Retrieve the

identification results for
a specified token, which
was returned by the
IdentifySubject
operation.
GetIdentifySubjectResultsRequest 1 Y
GenericRequestParameters GenericRequestParamet 0..1 N Common request

ers parameters that can be
requester.

application.

instance of the

requested:
“GetIdentifySubjectRes
ults”.

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.

GetIdentifySubjectResultsResponse Y The response to a

GetIdentifySubjectResults
operation, which includes a
candidate list.
GetIdentifySubjectResultsRespons 1 Y
ePackage

operation.

operation.

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 ScoreType 0..1 N The match score.
BiographicDataType 0..1 N Biographic data associated

BiographicData with the candidate match.
BIRList CBEFF_BIR_ListType 1 Y Biometric data associated

with the candidate match.

CBEFF_BIR_Type 0..* N CBEFF structure containing

BIR information about a
biometric sample.
813 4.1.13 IdentifySubject

814 IdentifySubjectRequest
815 IdentifySubjectResponse
816 The IdentifySubject operation performs an identification search against a given gallery for a given
817 biometric, returning a rank-ordered candidate list of a given maximum size. Note that multiple
818 scores/candidates is already incorporated as a score comes with a CandidateType which is a member of
819 CandidateList.
820 If the IdentifySubject operation is implemented as a synchronous service, the implementing system
821 immediately processes the request and returns the results in the candidate list. If the IdentifySubject
822 operation is implemented as an asynchronous service, the implementing system returns a token, which is
823 an indication that the request is being handled asynchronously. In this case, the
824 GetIdentifySubjectResults operation is used to poll for the results of the IdentifySubject request.
825 Gallery ID must not be used in conjunction with Gallery parameter. Gallery must not be used in
826 conjunction with Gallery ID parameter. However, Gallery ID or Gallery MUST be present.
827 Request Message

IdentifySubject Y Perform an
identification search
against a given gallery
for a given biometric.
IdentifySubjectRequest 1 Y

requester.


instance of the

requested:
“IdentifySubject”.
GalleryID BIASIDType 0..1 C The identifier of the

group which will be
searched. Must not be
used in conjunction
with Gallery parameter.

Gallery CandidateListType 0..1 C A list of BIRs that must

be used instead of a
stored gallery. Must not
be used in conjunction
with GalleryID
parameter.
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.

IdentifySubjectResponse Y The response to an

IdentifySubject operation,
returning a rank-ordered
candidate list.
IdentifySubjectResponsePackage 1 Y

operation.

operation.

code.

CandidateList CandidateListResultTy 0..1 C A rank-ordered list of

pe candidates that have a
(see likelihood of matching the
IdentifySubjectResultT input biometric sample (i.e.,
ype) 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 ScoreType 0..1 N The match score.
BiographicDataType 0..1 N Biographic data associated

BiographicData with the candidate match.
BIRList CBEFF_BIR_ListType 1 Y Biometric data associated

with the candidate match.
CBEFF_BIR_Type 0..* N CBEFF structure containing

BIR information about a
biometric sample.
Token TokenResultType 0..1 C A token used to retrieve the

(see results of the
IdentifySubjectResultT IdentifySubject operation.
ype) Returned with
asynchronous request
processing.

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.
829 NOTES:
830 (1) In the event that the number of candidates exceeding the threshold exceeds the
831 MaxListSize, the system will determine which candidate is included in the last position of
832 the rank ordered candidate list (i.e., in the event of a tie).
833 (2) Requesters MAY NOT change the system thresholds.
834 4.1.14 ListBiographicData

835 ListBiographicDataRequest
836 ListBiographicDataResponse
837 The ListBiographicData operation lists the biographic data elements stored for a subject using the
838 Biographic Data Elements output parameter. Note that no actual biographic data is returned by this
839 operation (see the RetrieveBiographicData operation to obtain the biographic data). In the encounter-
840 centric model, an encounter ID MAY be specified to indicate that only the biographic data elements stored
841 for that encounter should be returned. If an encounter ID is not specified and encounter data exists for the
842 subject, the operation returns the list of encounter IDs which contain biographic data using the Encounter
843 List output parameter, and the Biographic Data Element List output parameter is empty.
844 Request Message

ListBiographicData Y Lists the biographic

data elements stored
for a subject.
ListBiographicDataRequest 1 Y

requester.


instance of the

requested:
“ListBiographicData”.
Identity BIASIdentity 1 Y Identifies the subject

centric model, a
subject and an
encounter.


with the subject.

EncounterType EncounterCategoryType 0..1 C Identifies the category

of encounter. If an
encounter ID is not
specified and
encounter data exists
for the subject, the
operation returns the
list of encounter IDs of
a specific type which
contain biographic
data using the
Encounter List output
parameter, and the
Biographic Data
Elements output
parameter is empty.
Should not be used in
conjunction with
EncounterID.

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
for the subject, the list
of encounter IDs which
contain biographic data
is returned.
ListBiographicDataResponsePackage 1 Y

operation.


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.
BiographicData BiographicDataType 0..1 C An Identity’s biographic

data elements that are
stored in the
BiographicDataItemLis 0..1 N A list of biographic

BiographicDataItemList tType data elements.
BiographicDataItemTy 1..* Y A single biographic

BiographicDataItem pe data element.
string 1 Y The name of the

Name biographic data item.
string 1 Y The data type for the

Type biographic data item.
string 0..1 N The value assigned to

Value 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.
846 4.1.15 ListBiometricData

847 ListBiometricDataRequest

848 ListBiometricDataResponse
849 The ListBiometricData operation lists the biometric data elements stored for a subject using the Biometric
850 Data List output parameter. Note that no actual biometric data is returned by this operation (see the
851 RetrieveBiometricData operation to obtain the biometric data). In the encounter-centric model, an
852 encounter ID MAY be specified to indicate that only the biometric data elements stored for that encounter
853 should be returned. If an encounter ID is not specified and encounter data exists for the subject, the
854 operation returns the list of encounter IDs which contain biometric data using the Encounter List output
855 parameter, and the Biometric Data List output parameter is empty.
856 An optional parameter MAY be used to indicate a filter on the list of returned data. Such a filter may
857 indicate that only biometric types should be listed (e.g., face, finger, iris, etc.) or that only biometric
858 subtypes for a particular biometric type should be listed (e.g., all fingerprints: left slap, right index, etc.). If
859 a filter is not specified, all biometric type and biometric subtype information must both be listed (e.g., left
860 index finger, right iris, face frontal, etc.).
861 Request Message

ListBiometricData Y Lists the biometric
data elements
stored for a
subject.
ListBiometricDataRequest 1 Y

parameters that
can be used to
identify the
requester.

requesting
application.

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.

identifier for a
subject.


encounter
associated with
the subject.
EncounterType EncounterCategoryType 0..1 C Identifies the

category of
encounter. If an
encounter ID is not
specified and
encounter data
exists for the
subject, the
operation may
return the list of
encounter IDs of a
specific type which
contain biometric
data using the
Encounter List
output parameter,
and the Biometric
Data List output
parameter is
empty.
Should not be
used in
conjunction with
EncounterID.
ListFilterType ListFilterType 0..1 N Indicates what

biometric
information should
be returned.
BiometricTypeFilter oasis_cbeff:MultipleTypesT 1..* Y Limits the returned

ype information to a
specific type of
biometric, as
defined by CBEFF.
boolean 1 Y A Boolean flag

IncludeBiometricSubType indicating if
biometric subtype
information should
be returned.

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.

indicates the
return status of
the operation.

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.

BiometricDataListType 0..1 N A list of biometric

BiometricDataList data elements.
BiometricDataType 1..* Y Data structure

BiometricDataRecord containing
information about
a biometric
record.
oasis_cbeff:MultipleTypesTy 1 Y The type of

BiometricType pe biological or
behavioral data
stored in the
biometric record,
as defined by
CBEFF.
positiveInteger 0..1 N The number of

BiometricTypeCount biometric records
having the
biometric type
recorded in the
biometric type
field.
oasis_cbeff:SubtypeType 0..1 N More specifically

BiometricSubType defines the type
of biometric data
stored in the
biometric record,
as defined by
CBEFF.
positiveInteger 1 Y Identifies the

BDBFormatOwner standards body,
working group,
industry
consortium, or
other CBEFF
biometric
organization that
has defined the
format for the
biometric data.
positiveInteger 1 Y Identifies the

BDBFormatType 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.
863 4.1.16 ListDocumentData

864 ListDocumentDataRequest
865 ListDocumentDataResponse
866 The ListDocumentData operation lists the document categories stored for a subject using the Document
867 Data List output parameter. Note that no other document data is returned by this operation (see the
868 RetrieveDocumentData operation to obtain document data by category.) In the encounter-centric model,
869 an encounter ID may be specified to indicate that only the document data elements stored for that
870 encounter should be returned. If an encounter ID is not specified and encounter data exists for the
871 subject, the operation mustl return the list of encounter IDs which contain document data using the
872 Encounter List Output parameter, and the Document Data List output parameter must be empty.
873 Request Message

ListDocumentData Y
ListDocumentDataRequest 1 Y

requester.


instance of the


requested:
“ListDocumentData”.

centric model, a
subject and an
encounter.


with the subject.

of encounter. If an
encounter ID is not
specified and
for the subject, the
operation must return
the list of encounter
IDs which contain
document data using
the Encounter List
Output parameter, and
the Document Data
List output parameter
must be empty.
Should not be used in
conjunction with
EncounterID.

ListDocumentDataResponse Y The response to a

ListDocumentData
operation.
1 Y
ListDocumentDataResponsePackage

operation.

operation.


return code.
DocumentDataList DocumentDataListType 0..1 C A list of document

categories associated
with a subject or
encounter; non-empty if
the service was
successful, document
data exists, and either the
person-centric model is
being used or the
encounter-centric model
is being used and an
encounter identifier was
specified.
DocumentData DocumentDataType 1..* Y Defines a set of

document data elements
providing information
about the presented
identity document
string 1 Y The type of identity

DocumentCategory document presented (e.g.
passport).
Identity BIASIdentity 0..1 C
EncounterList EncounterListType 1 Y A list of encounter IDs

associated with a subject
and which contain
document data; non-
empty if the service was
successful, document
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.
875 4.1.17 PerformFusion

876 PerformFusionRequest
877 PerformFusionResponse
878 The PerformFusion operation accepts either match score or match decision information and creates a
879 fused match result. The FusionInformationListType, through the FusionInformationType, provides specific
880 elements for match score input and match decision input for a single identity, while the
881 FusionIdentityListType provides the ability to submit multiple identities to the Perform Fusion operation.
882 The fusion method and processes are left to the implementing system.

883 Request Message
PerformFusion Y Accepts either

match score or
match decision
information and
creates a fused
match result.
PerformFusionRequest 1 Y

parameters that
can be used to
identify the
requester.

requesting
application.

or instance of the
requesting
application.

operation that is
being requested:
“PerformFusion”.
FusionInput FusionIdentityListType 1 Y
FusionIdentity FusionInformationListType 1 Y Score or decision

input information to
the fusion method
for each identity.
FusionInformationType 2..* Y A set of fusion
FusionElement information.
oasis_cbeff:MultipleTypesT 1 Y The type of

BiometricType ype biological or
behavioral data
stored in the
biometric record, as
defined by CBEFF.
oasis_cbeff:SubtypeType 0..1 N More specifically

BiometricSubType defines the type of
biometric data
stored in the
biometric record.

string 1 Y The owner or

AlgorithmOwner 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.

PerformFusionResponse Y The response to the

PerformFusion operation.
PerformFusionResponsePackag 1 Y
e

operation.


1 corresponding to the return
code.
Match MatchType 1 Y Indicates the result of the

fusion method.
885 4.1.18 QueryCapabilities

886 QueryCapabilitiesRequest
887 QueryCapabilitiesResponse
888 The QueryCapabilities operation returns a list of the capabilities, options, galleries, etc. that are supported
889 by the BIAS implementation. Refer to Annex A in the ISO/IEC BIAS [ISO/IEC-BIAS] standard for
890 conformance requirements regarding which capability names an implementation must use in the
891 QueryCapabilities operation. If the implementing system does not support a capability item, the Capability
892 Value can be set to null in the response.
893 Proprietary and additional information may be returned by returning capabilities that are not part of those
894 capabilities enumerated in the Capability Name section 3.2.21. When returning capabilities not
895 enumerated in section 3.2.21, the Capability Description should describe the capability. For each
896 capability enumerated in section 3.2.21, the Capability Name should be set to the name in the value
897 column.
898 Request Message

QueryCapabilities Y Returns a list of the

capabilities, options,
galleries, etc. that are
supported by the BIAS
implementation.
QueryCapabilitiesRequest 1 Y

requester.


instance of the

requested:
“QueryCapabilities”.

QueryCapabilitiesResponse Y The response to a

QueryCapabilities
operation.
QueryCapabilitiesResponsePackage 1 Y

the operation.

status of the
operation.

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.
string 0..1 N A secondary value

CapabilitySupportingValue supporting the
capability.
string 0..1 N Contains additional

CapabilityAdditionalInfo information for the
supported capability.
900 4.1.19 RetrieveBiographicData

901 RetrieveBiographicDataRequest
902 RetrieveBiographicDataResponse
903 The RetrieveBiographicData operation retrieves the biographic data associated with a subject ID. In the
904 encounter-centric model, the encounter ID MAY be specified and the operation will return the set of
905 biographic data associated with that encounter (the list contains a single set). If the encounter ID is not
906 specified in the encounter-centric model, the operation returns the list of biographic information
907 associated with the most recent encounter. If no gallery ID is specified, a list of biographic information
908 from all galleries will be returned.
909 Request Message

RetrieveBiographicData Y Retrieves the

biographic data
associated with a
subject ID.
RetrieveBiographicDataRequest 1 Y

parameters that can
be used to identify
the requester.

requesting
application.


instance of the
requesting
application.

BIASOperationName operation that is
being requested:
“RetrieveBiographic
Data”.

centric model, a
subject and an
encounter.

identifier for a
subject.

encounter
associated with the
subject.
EncounterType EncounterCategoryType 0..1 N Identifies the type of

encounter during
which data was
collected from the
subject, as
determined by the
requester.

group from which
the biographic
information will be
retrieved.

RetrieveBiographicDataResponse Y The response to a

RetrieveBiographicD
ata operation.
RetrieveBiographicDataResponsePack 1 Y
age

the operation.


status of the
operation.

return code.
Identity BIASIdentity 1 Y Includes the set of

biographic data
associated with a
subject.
BiographicDataList BiographicDataListType 1 Y A list of biographic

data associated with
the subject or
encounter.
BiographicData BiographicDataType 0..* N An Identity’s

biographic data.
One of the following
elements MUST be
present
string 0..1 C The last name of a

LastName subject.
string 0..1 C The first name of a

FirstName subject.
BiographicDataItemListT 0..1 C A list of biographic

BiographicDataItemList ype data elements.
BiographicDataItemType 1..* Y A single biographic

BiographicDataItem data elelment.

Name biographic data item.
string 1 Y The data type for the

Type biographic data item.
string 0..1 N The value assigned

Value to the biographic data
item.
BiographicDataSetType 0..1 C A set of biographic

BiographicDataSet data information.
911 4.1.20 RetrieveBiometricData

912 RetrieveBiometricDataRequest
913 RetrieveBiometricDataResponse

914 The RetrieveBiometricData operation retrieves the biometric data associated with a subject ID. In the
915 encounter-centric model, the encounter ID MAY be specified and the operation will return the biometric
916 data associated with that encounter. If the encounter ID is not specified in the encounter-centric model,
917 the operation returns the biometric information associated with the most recent encounter.The operation
918 provides an OPTIONAL input parameter to specify that only biometric data of a certain type should be
919 retrieved.
920 Request Message

RetrieveBiometricData Y Retrieves the

biometric data
associated with a
subject ID.
RetrieveBiometricDataRequest 1 Y

requester.


instance of the

requested:
“RetrieveBiometricDat
a”.

centric model, a
subject and an
encounter.


with the subject.
EncounterType EncounterCategoryType 0..1 N Identifies the type of

encounter during
which data was
collected from the
subject, as determined
by the requester.


biometric information
will be retrieved.
BiometricType oasis_cbeff:MultipleTypesT 0..1 N The type of biological

ype or behavioral data to
retrieve.

RetrieveBiometricDataResponse Y The response to a

RetrieveBiometricData
operation.
RetrieveBiometricDataResponsePac 1 Y
kage

operation.

operation.

1 corresponding to the
return code.
Identity BIASIdentity 1 Y Includes the biometric

data associated with a
subject.

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.
922 4.1.21 RetrieveDocumentData

923 RetrieveDocumentDataRequest
924 RetrieveDocumentDataResponse
925 The RetrieveDocumentData operation retrieves the list of document data associated with a subject ID for
926 the category(ies) specified. In the encounter-centric model, the encounter ID MAY be specified and the
927 operation returns the list of document data associated with that encounter. If the encounter ID is not
928 specified in the encounter-centric model, the operation returns the list of document information associated
929 with the most recent encounter for which document data exist. If no gallery ID is specified, document data

930 from all galleries must be returned. If no document category is specified, all documents associated with
931 the subject (and encounter ID, if present) must be returned.
932 Request Message

RetrieveDocumentData Y
RetrieveDocumentDataRequest 1 Y

requester.


instance of the

requested:
“RetrieveDocumentDat
a”.


with the subject.

of encounter.
DocumentData DocumentDataType 0..1 N Defines a set of

document data
elements providing
information about the
requested identity
document.
DocumentCategory string 0..1 Y The category(ies) of

the identity documents
to be retrieved.

biographic information
will be retrieved.

RetrieveDocumentDataResponse Y The response to a

RetrieveDocumentDat
a operation.
1 Y
RetrieveDocumentDataResponsePackage

operation.


return code.
DocumentDataList DocumentDataListType 1 Y A list of document data

associated with a
subject or encounter.
934 4.1.22 SetBiographicData

935 SetBiographicDataRequest
936 SetBiographicDataResponse
937 The SetBiographicData operation associates biographic data to a given subject record. The identity model
938 of the system determines whether the biographic information should replace any existing biographic
939 information (person-centric model) or if a new encounter should be created and associated with the
940 subject (encounter-centric model). For encounter-centric models, the encounter ID MAY be specified by
941 the caller in order to link biographic with biometric and/or document information (assuming biometric
942 and/or document information was previously associated using the SetBiometricData and/or
943 SetDocumentData operations). If the encounter ID is omitted for the encounter-centric model, the
944 operation returns a system-assigned encounter ID.
945 For encounter-based systems, the Create Encounter operation should be called prior to Set Biographic
946 Data and/or Set Document Data. The Encounter ID assigned as a result should be used as input to this
947 operation.
948 Request Message

SetBiographicData Y Associates
biographic data to
a given subject
record.
SetBiographicDataRequest 1 Y


parameters that
can be used to
identify the
requester.

requesting
application.

or instance of the
requesting
application.

operation that is
being requested:
“SetBiographicDat
a”.

subject or, in the
encounter-centric
model, a subject
and an encounter,
and includes the
biographic data to
store.

identifier for a
subject.

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.
BiographicDataItemListTyp 0..1 C A list of biographic

BiographicDataItemList e data elements.


GalleryID BIASIDType 0..1 N The identifier of

the gallery or
population group
to which the
biographic will be
added.

SetBiographicDataResponse Y The response to a

SetBiographicData operation.
SetBiographicDataResponsePackage 1 Y

operation.


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.
950 4.1.23 SetBiometricData

951 SetBiometricDataRequest
952 SetBiometricDataResponse
953 The SetBiometricData operation associates biometric data to a given subject record. The identity model of
954 the system determines whether the biometric information should replace any existing biometric
955 information (person-centric model) or if a new encounter should be created and associated with the
956 subject (encounter-centric model). For encounter-centric models, the encounter ID MAY be specified by
957 the caller in order to link biometric with biographic and/or document information (assuming biographic
958 and/or document information was previously associated using the SetBiographicData and/or
959 SetDocumentData operation). If the encounter ID is omitted for the encounter-centric model, the operation
960 returns a system-assigned encounter ID.
961 For encounter-based systems, the Create Encounter operation should be called prior to Set Biometric
962 Data. The Encounter ID assigned as a result should be used as input to this operation.
963 Request Message

SetBiometricData Y Associates biometric

data to a given subject
record.
SetBiometricDataRequest 1 Y

requester.

application.

instance of the

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.


with the subject.

data.
BIRList CBEFF_BIR_ListType 1 Y A list of CBEFF-BIR

elements.
CBEFF_BIR_Type 1..* Y CBEFF structure

BIR containing information
about a biometric
sample.

group to which the
biometric will be added.

SetBiometricDataResponse Y The response to a

SetBiometricData operation.

SetBiometricDataResponsePackag 1 Y
e

operation.


code.
965 4.1.24 SetDocumentData

966 SetDocumentDataRequest
967 SetDocumentDataResponse
968 The SetDocumentData operation associates identity document data to a given subject record. The
969 identity model of the system determines whether the document information should replace any existing
970 document information for the same document category (person-centric model) or if a new encounter
971 should be created and associated with the subject (encounter-centric model). For encounter-centric
972 models, the encounter ID MAY be specified by the caller in order to link document with biographic and/or
973 biometric information (assuming biographic and/or biometric information was previously associated using
974 the SetBiographicData and/or SetBiometricData operation). If the encounter ID is omitted for the
975 encounter-centric model, the operation returns a system-assigned encounter ID.
976 Request Message

SetDocumentData Y
SetDocumentDataRequest 1 Y

requester.


instance of the

requested:
“SetDocumentData”.



with the subject.
DocumentDataList DocumentDataListType 1 Y A list of document

data to associate with
the subject or
encounter.

group to which the
document information
will be added.

SetDocumentDataResponse Y The response to a

SetDocumentData
operation.
SetDocumentDataResponsePackage 1 Y

the operation.

status of the
operation.

return code.

with the subject.
978 4.1.25 TransformBiometricData

979 TransformBiometricDataRequest
980 TransformBiometricDataResponse
981 The TransformBiometricData operation transforms or processes a given biometric in one format into a
982 new target format.

983 Request Message
TransformBiometricData Y Transforms or
processes a given
biometric in one format
into a new target
format.
TransformBiometricDataRequest 1 Y

requester.

application.

instance of the

requested:
“TransformBiometricDat
a”.
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.
984 NOTE: The values for TransformOperation and TransformControl are implementation specific.

TransformBiometricDataResponse Y The response to a

TransformBiometricData
operation.
TransformBiometricDataResponsePacka 1 Y
ge


operation.

operation.

code.
OutputBIR CBEFF_BIR_Type 1 Y Data structure containing

the new, transformed
biometric information.
986 4.1.26 UpdateBiographicData

987 UpdateBiographicDataRequest
988 UpdateBiographicDataResponse
989 The UpdateBiographicData operation updates the biographic data for an existing subject record. The
990 operation replaces any existing biographic data with the new biographic data. In the encounter-centric
991 model, the encounter ID MUST be specified.
992 Request Message

UpdateBiographicData Y Updates the

biographic data for
a given subject
record.
UpdateBiographicDataRequest 1 Y

parameters that
can be used to
identify the
requester.

requesting
application.

or instance of the
requesting
application.

operation that is
being requested:
“UpdateBiographic
Data”.


subject or, in the
encounter-centric
model, a subject
and an encounter,
and includes the
biographic data to
update.

identifier for a
subject.

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.
BiographicDataItemListTyp 0..1 C A list of biographic

BiographicDataItemList e data elements.
BiographicDataItemType 1..* Y A single

BiographicDataItem biographic data
element.

Name biographic data
item.
string 1 Y The data type for

Type the biographic
data item.
Value string 0..1 N The value

assigned to the
biographic data
item.


UpdateBiographicDataResponse Y The response to an

UpdateBiographicData
operation.
UpdateBiographicDataResponsePackag 1 Y
e

operation.


code.
994 4.1.27 UpdateBiometricData

995 UpdateBiometricDataRequest
996 UpdateBiometricDataResponse
997 The UpdateBiometricData operation updates the biometric data for an existing subject record. The
998 operation includes an OPTIONAL parameter indicating if the new biometric sample should be merged
999 with the existing biometric sample. If this parameter is set to “False” or is not used in the request, the
1000 operation replaces the existing biometric sample with the new biometric sample. The “merge” process is
1001 determined by the implementation. It may be accomplished by adding the sample to a multi-sample
1002 record or by performing some level of biometric fusion (for example, feature or sample level fusion). In the
1003 encounter-centric model, the encounter ID MUST be specified.
1004 Request Message

UpdateBiometricData Y Updates a single

biometric sample for a
given subject record.
UpdateBiometricDataRequest 1 Y

requester.

application.

instance of the


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.


with the subject.
centric models.

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.

UpdateBiometricDataResponse Y The response to an

UpdateBiometricData
operation.
UpdateBiometricDataResponsePackag 1 Y
e

operation.

operation.

code.

1006 4.1.28 UpdateDocumentData
1007 UpdateDocumentDataRequest
1008 UpdateDocumentDataResponse
1009 The UpdateDocumentData operation updates the document data for an existing subject record. The
1010 operation replaces any existing document data of the same category with the new document data. In the
1011 encounter-centric model, the encounter ID MUST be specified.

UpdateDocumentData Y Updates the

document data for
a given subject
record.
UpdateDocumentDataRequest 1 Y

parameters that
can be used to
identify the
requester.

requesting
application.

or instance of the
requesting
application.

operation that is
being requested:
“UpdateDocument
Data”.

subject or, in the
encounter-centric
model, a subject
and an encounter,
and includes the
document data to
update.

identifier for a
subject.


encounter
associated with
the subject.
Required for
encounter-centric
models.
DocumentDataList DocumentDataListType 1 Y A list of updated

document data.

UpdateDocumentDataResponse Y The response to an
UpdateDocumentData
operation.
UpdateDocumentDataResponsePackag 1 Y
e

operation.


code.
1014 4.1.29 VerifySubject

1015 VerifySubjectRequest
1016 VerifySubjectResponse
1017 The VerifySubject operation performs a 1:1 verification match between a given biometric and either a
1018 claim to identity in a given gallery or another provided biometric. As such either the Identity Claim or
1019 Reference BIR input parameters are REQUIRED.
1020 In the encounter-centric model, for match operations, it is not necessary to explicitly create an encounter.
1021 The BIAS service provider will create the encounter and will set the encounter type to “recognition”.

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

requester.


instance of the

requested:
“VerifySubject”.

group of which the
subject must be a
member.
Claim is provided.
Identity BIASIdentity 1 Y Includes the identifying

information and/or input
and reference biometric
samples.
IdentityClaim BIASIDType 0..1 C A unique identifier by

which a subject is
known to a particular
group. (e.g. Subject ID
or account number)
Required if a
Reference BIR is not
provided.

data.
InputBIR CBEFF_BIR_Type 1 Y Maps to specific

ISO/IEC BIAS
elements as required
by that specification.
When multiple samples
are included as input
(e.g. in a multimodal
operation), a complex
BIR is used.

CBEFF_BIR_Type 0..1 C Maps to specific

ReferenceBIR ISO/IEC BIAS

VerifySubjectResponse Y The response to a

VerifySubject operation.
VerifySubjectResponsePackage 1 Y

operation.


code.
Match boolean 0..1 Y Indicates if the Input BIR

matched either the biometric
information associated with
the Identity Claim or the
Reference BIR.
Score ScoreType 0..1 N The score if the biometric

information matched.
1024 4.2 Aggregate Operations

1025 4.2.1 Delete
1026 DeleteRequest
1027 DeleteResponse
1028 The Delete operation deletes an existing subject or, in an encounter-centric model, an existing encounter
1029 from the system. This may be accomplished in a number of different ways according to system
1030 requirements and/or resources. If the Delete operation is implemented as a synchronous service, the
1031 implementing system immediately processes the request and returns the results in the Return Data
1032 parameter. If the Delete operation is implemented as an asynchronous service, the implementing system
1033 returns a token in the Token parameter, which is an indication that the request is being handled
1034 asynchronously. In this case, the GetDeletionResults operation is used to poll for the results of the Delete
1035 request.

Delete Y Deletes a subject or, in

an encounter-centric
model, an existing
encounter from the
system.
DeleteRequest 1 Y

requester.

application.

instance of the

requested: “Delete”.
ProcessingOptions ProcessingOptionsType 1 Y Options that guide how

the aggregate service
request is processed.
Option OptionType 0..* N An option supported by

the implementing
system.
InputData InformationType 0..1 N Contains the input data

for the operation, as
required by the
Identity BIASIdentity 0..1 N The identifier for the

subject, or in
encounter-centric
model the encounter to
be deleted; required for
encounter-centric
models.
SubjectID BIASIDType 0..1 C The identifier assigned

to the subject.
EncounterID BIASIDType 0..1 C The identifier for the

encounter; required for
encounter-centric
models.

DeleteResponse Y The response to a Delete

operation.
DeleteResponsePackage 1 Y
ResponseStatus ResponseStatus 1 Y Returned status for the operation.


to the return code.
SubjectID BIASIDType 0..1 C The identifier assigned to the

subject.
EncounterID BIASIDType 0..1 C The identifier of the encounter;

required for encounter-centric
models.
ReturnData InformationType 0..1 N Contains the output data for the

response.
Token TokenType 0..1 C A token used to retrieve the

results of the Delete request;
returned with asynchronous
request processing. If set to zero,
operation is processed
synchronously. If set to a non-
zero value, operation is
processed asynchronously and
Get Deletion Results must be
used to retrieve the results.

implementing system that is used
by Get Deletion Results to
retrieve the results 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.
1038 4.2.2 Enrol

1039 EnrolRequest
1040 EnrolResponse
1041 The Enrol operation adds a new subject or, in an encounter-centric model, a new encounter to the
1042 system. This may be accomplished in a number of different ways according to system requirements
1043 and/or resources. If the Enrol operation is implemented as a synchronous service, the implementing
1044 system immediately processes the request and returns the results in the Return Data parameter. If the
1045 Enrol operation is implemented as an asynchronous service, the implementing system returns a non-zero
1046 token in the Token parameter, which is an indication that the request is being handled asynchronously. In
1047 this case, the GetEnrolResults operation is used to poll for the results of the Enrol request.
1048
1049 If the identity model is encounter-centric, the encounter ID may optionally be specified by the caller. If the
1050 encounter ID is omitted the operation returns a system-assigned encounter ID.

Enrol Y Adds a new subject or,

in an encounter-centric
model, a new
encounter to the
system.
EnrolRequest 1 Y

requester.

application.

instance of the

requested: “Enrol”.


the implementing
system.
InputData InformationType 1 Y Contains the input data

for the operation, as
required by the
Identity BIASIdentity 0..1 N
EncounterID BIASIDType 0..1 N The identifier for the

encounter; required for
encounter-centric
models.

EnrolResponse Y The response to an Enrol

operation.
EnrolResponsePackage 1 Y

operation.


to the return code.

subject.

required for encounter-centric
models.

response.
Token TokenType 0..1 C A token used to retrieve the

results of the Enrol request;
request processing. If set to
zero, operation is processed
Get Enrol Results must be used
to retrieve the results.

used by Get Enrol Results to
retrieve the results 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.
1053 4.2.3 GetDeletionResults

1054 GetDeletionResultsRequest
1055 GetDeletionResultsResponse
1056 The GetDeletionResults operation retrieves the deletion results for the specified token. This operation is
1057 used in conjunction with the Delete operation. If the Delete operation is implemented as an asynchronous

1058 service, the implementing system returns a token and the GetDeletionResults operation is used to poll for
1059 the results of the original Delete request.
1060 If the service provider implements an asynchronous Delete operation, then it MUST also implement the
1061 Get Deletion Results operation.

GetDeletionResults Y Retrieves the deletion

results for the
specified token.
GetDeletionResultsRequest 1 Y

requester.


instance of the

requested:
“GetDeletionResults”.
Token TokenType 1 Y A value used to

retrieve the results of
the Delete 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.

expires and the
operation results are
no longer guaranteed
to be available.

GetDeletionResultsResponse Y The response to a

GetDeletionResults operation.

GetDeletionResultsResponsePacka 1 Y
ge

operation.


code.
ReturnData InformationType 0..1 N Contains the output data for

the response.
1064 4.2.4 GetEnrolResults

1065 GetEnrolResultsRequest
1066 GetEnrolResultsResponse
1067 The GetEnrolResults operation retrieves the enrolment results for the specified token. This operation is
1068 used in conjunction with the Enrol operation. If the Enrol operation is implemented as an asynchronous
1069 service, the implementing system returns a token and the GetEnrolResults operation is used to poll for
1070 the results of the original Enrol request.
1071 If the service provider implements an asynchronous Enrol operation, then it MUST also implement the
1072 GetEnrolResults operation.

GetEnrolResults Y Retrieves the

enrolment results for
the specified token.
GetEnrolResultsRequest 1 Y

requester.


instance of the

requested:
“GetEnrolResults”.


the Enrol request.

the implementing
time.

expires and the
to be available.

GetEnrolResultsResponse Y The response to a

GetEnrolResults operation.
GetEnrolResultsResponsePackage 1 Y

operation.


code.

the response.

subject.

if assigned.
1075 4.2.5 GetIdentifyResults

1076 GetIdentifyResultsRequest
1077 GetIdentifyResultsResponse
1078 The GetIdentifyResults operation retrieves the identification results for the specified token. This operation
1079 is used in conjunction with the Identify operation. If the Identify operation is implemented as an
1080 asynchronous service, the implementing system returns a token and the GetIdentifyResults operation is
1081 used to poll for the results of the original Identify request.
1082 If the service provider implements an asynchronous Identify operation, then it MUST also implement the
1083 GetIdentifyResults operation.

GetIdentifyResults Y Retrieves the

identification results for
the specified token
GetIdentifyResultsRequest 1 Y

requester.


instance of the

requested:
“GetIdentifyResults”.

the Identify request.

the implementing
time.

expires and the
to be available.

GetIdentifyResultsResponse Y The response to a

GetIdentifyResults
operation.
GetIdentifyResultsResponsePackage 1 Y


operation.

operation.

code.
Identity BIASIdentity
EncounterID BIASIDType 0..1 C The identifier of the

encounter, if assigned.
CandidateList CandidateListType 0..1 C A rank-ordered list of

candidates that have a
likelihood of matching the
input biometric sample.
ReturnData InformationType 0..1 N Contains the output data

for the response.
1086 4.2.6 GetUpdateResults

1087 GetUpdateResultsRequest
1088 GetUpdateResultsResponse
1089 The GetUpdateResults operation retrieves the update results for the specified token. This operation is
1090 used in conjunction with the Update operation. If the Update operation is implemented as an
1091 asynchronous service, the implementing system returns a token and the GetUpdateResults operation is
1092 used to poll for the results of the original Update request.
1093 If the service provider implements an asynchronous Update operation, then it MUST also implement the
1094 GetUpdateResults operation.

GetUpdateResults Y Retrieves the Update

results for the
specified token
GetUpdateResultsRequest 1 Y

requester.


instance of the


requested:
“GetUpdateResults”.

the Update request.

the implementing
time.

expires and the
to be available.

GetUpdateResultsResponse Y The response to a

GetUpdateResults
operation.
GetUpdateResultsResponsePackage 1 Y

operation.

operation.

return code.

for the response.
1097 4.2.7 GetVerifyResults

1098 GetVerifyResultsRequest
1099 GetVerifyResultsResponse
1100 The GetVerifyResults operation retrieves the verification results for the specified token. This operation is
1101 used in conjunction with the Verify operation. If the Verify operation is implemented as an asynchronous
1102 service, the implementing system returns a non-zero token and the GetVerifyResults operation is used to
1103 poll for the results of the original Verify request.

1104 If the service provider implements an asynchronous Verifyoperation, then it MUST also implement the
1105 GetVerifyResults operation.

GetVerifyResults Y Retrieves the

verification results for
the specified token
GetVerifyResultsRequest 1 Y

requester.


instance of the

requested:
“GetVerifyResults”.

the Verify request.

the implementing
time.

expires and the
to be available.

GetVerifyResultsResponse Y The response to a

GetVerifyResults operation.
GetVerifyResultsResponsePackag 1 Y
e


operation.


code.

the response.
EncounterID BIASIDType 1 Y The identifier of the

encounter, if assigned.
Match boolean 1 Y Indicates if the Input BIR

information associated with
the Identity Claim or the
Reference BIR.

1108 4.2.8 Identify

1109 IdentifyRequest
1110 IdentifyResponse
1111 The Identify operation performs an identification function according to system requirements and/or
1112 resources.If the Identify operation is implemented as a synchronous service, the implementing system
1113 immediately processes the request and returns the results in the Return Data parameter. If the Identify
1114 operation is implemented as an asynchronous service, the implementing system returns a non-zero token
1115 in the Token parameter, which is an indication that the request is being handled asynchronously. In this
1116 case, the GetIdentifyResults operation is used to poll for the results of the Identify request.

Identify Y Performs an
identification function.
IdentifyRequest 1 Y

requester.

application.


instance of the

requested: “Identify”.


the implementing
system.

for the aggregate
services.

group which will be
searched; this
parameter may also be
used to identify an
external system where
the identification
request should be
forwarded, if this
capability is supported
by the implementing
system.
MaxListSize positiveInteger 1 Y The maximum size of

the candidate list that
should be returned.

IdentifyResponse Y The response to an Identify

operation.
IdentifyResponsePackage 1 Y

operation.

Message string 0.. N A short message corresponding

1 to the return code.

ReturnData InformationType 0.. N Contains the output data for the

1 response.
Identity BIASIdentity 0.. C

1
EncounterID BIASIDType 1 Y The identifier of the encounter, if

assigned.
CandidateList CandidateListType 0.. C A rank-ordered list of candidates

1 that have a likelihood of
matching the input biometric
sample; returned with
successful, synchronous
processing.
Token TokenType 0.. C A value used to retrieve the

1 results of the Identify request;
synchronously and candidate list
is returned. If set to a non-zero
value, operation is processed
asynchronously and Get Identify
Results must be used to retrieve
the results.

used to retrieve the results to an
operation at a later time.

1119 4.2.9 RetrieveData

1120 RetrieveDataRequest
1121 RetrieveDataResponse
1122 The RetrieveData operation retrieves requested information about a subject, or in an encounter-centric
1123 model about an encounter. In a person-centric model, this operation can be used to retrieve both
1124 biographic and biometric information for a subject record. In an encounter-centric model, this operation
1125 can be used to retrieve biographic and/or biometric information for either a single encounter or all
1126 encounters. Either a subject ID or encounter ID MUST be specified.

RetrieveData Y Retrieves requested

information about a

RetrieveDataRequest 1 Y

requester.


instance of the

requested:
“RetrieveData”.

request is processed,
and MAY identify what
type(s) of information
should be returned.

the implementing
system.
Identity BIASIdentity 1 Y Includes the identifier

of the subject or
encounter.
SubjectID BIASIDType 0..1 C A system unique

Required if an
Encounter ID is not
provided.

with the subject.
Required if a Subject
ID is not provided.

RetrieveDataResponse Y Response to a
RetrieveData operation.
RetrieveDataResponsePackage 1 Y


operation.

operation.

return code.

for the response.
1129 4.2.10 Update

1130 UpdateRequest
1131 UpdateResponse
1132 The Update operation updates specified information about a subject, or in an encounter-centric model
1133 about an encounter. In a person-centric model, this operation can be used to update both biographic,
1134 biometric and document information for a subject record. In an encounter-centric model, this operation
1135 can be used to update biographic, biometric and/or document information for either a single encounter or
1136 all encounters. Either a subject ID or encounter ID MUST be specified.

Update Y Updates requested

information about a
UpdateRequest 1 Y

requester.


instance of the

requested: “Update”.

request is processed,
and MAY identify what
type(s) of information
should be returned.


the implementing
system.
InputData InformationType 1 Y Contains the subject

data to update.
Identity BIASIdentity 1 Y Includes the identifier

of the subject or
encounter.
SubjectID BIASIDType 0..1 C The identifier of the

subject;
Required if an
Encounter ID is not
provided.

with the subject.
Required if a Subject
ID is not provided.

UpdateResponse Y Response to an Update

operation.
UpdateResponsePackage 1 Y

operation.

operation.

return code.

for the response.

Token TokenType 0..1 C A value used to retrieve

the results of the Update
request; returned with
asynchronous request
processing. If set to zero,
operation is processed
synchronously. If set to a
non-zero value, operation
is processed
asynchronously and Get
Update Results must be
used to retrieve the
results.

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.
1139 4.2.11 Verify

1140 VerifyRequest
1141 VerifyResponse
1142 The Verify operation performs a 1:1 verification function according to system requirements and/or
1143 resources. Either the Identity Claim or Reference BIR input parameters are REQUIRED.If the Verify
1144 operation is implemented as a synchronous service, the implementing system immediately processes the
1145 request and returns the results in the Return Data parameter. If the Verify operation is implemented as an
1146 asynchronous service, the implementing system returns a non-zero token in the Token parameter, which
1147 is an indication that the request is being handled asynchronously. In this case, the GetVerifyResults
1148 operation is used to poll for the results of the Verify request.
1149 In encounter mode, for match operations, the BIAS service provider will create the encounter and will set
1150 the encounter type to “recognition”. Additionally the encounter ID may optionally be specified by the caller.
1151 If the encounter ID is omitted for the encounter-centric model, the service should return a system-
1152 assigned encounter ID.

Verify Y Performs a 1:1

verification function.
VerifyRequest 1 Y


requester.


instance of the

requested: “Verify”.


the implementing
system.

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

particular gallery or
population group.
Required if a
Reference BIR is not
provided.
BiometricData BIASBiometricDataType 0..1 N An Identity’s biometric

data.
CBEFF_BIR_Type 0..1 C Maps to specific

ReferenceBIR ISO/IEC BIAS

GalleryID BIASIDType 0..1 C The identifier of the

group of which the
subject must be a
member.
Claim is provided.

VerifyResponse Y The response to a Verify

operation.
VerifyResponsePackage 1 Y

operation.


to the return code.

response.
Match boolean 0..1 N Indicates if the Input BIR

information associated with the
Identity Claim or the Reference
BIR.

EncounterID BIASIDType 1 Y The identifier of the encounter, if

assigned.
Token TokenType 0..1 C A value used to retrieve the

results of the Verify request;
Get Verify Results must be used
to retrieve the results.


used to retrieve the results to an
operation at a later time.

1155
1156
1157
1158
1159
1160
1161
1162

1163 5 Message structure and rules
1164 BIAS operations and data elements are defined in XML in the ISO/IEC 30108 BIAS standard. This OASIS
1165 standard further specifies the full XML schema (see Annex A) and specifies how this XML is packaged
1166 and exchanged as SOAP messages.
1167 Annex A provides a WSDL of operations and structures aggregated from all the conformance classes,
1168 both synchronous and asynchronous. A specific implementation’s WSDL must only expose its respective
1169 operations and structures. For example, for a Class 5-only conformant implementation, all of the primitive
1170 operations must not be exposed as operations (with the exception of QueryCapabilities) unless that
1171 functionality is supported. Additionally, the WSDL exposed by an implementation shall not contain
1172 instances of xsd:any, xsd:anyType, or xsd:anyAttribute; these instances must be replaced with explicit
1173 schema contents. An example is the XML complex type, InformationType, which has xsd:any as its only
1174 child. This type is used to represent implementation-specific input data and return data. The children of
1175 InformationType must be replaced with explicit content. Doing so removes the ability to transmit
1176 unexpected or arbitrary data. Also, it provides a clear definition of information that a client needs to
1177 provide to the server,or expect to receive,to optimally perform an operation.
1178 SOAP 1.1 messages consist of three elements: an envelope, header data, and a message body. BIAS
1179 request-response elements MUST be enclosed within the SOAP message body. The general structure of
1180 the BIAS SOAP message is shown in Figure 4, below. The data model for BIAS is addressed in Section3
1181 and BIAS messages in Section 4.
1182
SOAP Envelope
SOAP Header
SOAP Body
SOAP Payload
BIAS XML Elements
1183
1184 Figure 4. BIAS SOAP Structure
1185
1186 Biometric data, regardless of native format, is carried as a binary structure. As such, options exist on how
1187 this data is carried within the SOAP structure. It can be carried as embedded Base-64 objects or [XOP]
1188 can be used – this standard allows for either method (See section 5.3).
1189 5.1 Purpose and constraints

1190 This document defines a SOAP profile describing how the XML elements defined in ISO/IEC 30108 are to
1191 be used as the payload of a SOAP message and the rules for structuring and exchanging such
1192 messages. Philosophical tenets include:
1193  SOAP messages will carry BIAS XML [XML10] payloads.
1194  SOAP messages will follow WS-I and will deviate only when absolutely necessary.
1195  Message structures and interchanges will be kept as simple as possible – “nice to have”
1196 features will be addressed in future revisions.
1197  XML schemas will be produced based on ISO/IEC 30108.
1198  BIAS will support a broad range of application domains.
1199  BIAS will allow for a variety of biometric and biographic data formats to be used
1200  Only the SOAP messaging will be defined – no message protocols or client/server agents
1201 will be defined.
1202  Basic usage/formatting rules (beyond WS-I) will be defined.
1203  Existing biometric and Web services standards will be leveraged wherever possible.
1204  Sample WSDL and use cases will be provided as an aid in implementation.
1205  Use of basic SOAP will allow all other compatible WS* standards (and discovery
1206 mechanisms) to be used in conjunction with BIAS messaging.
1207  BIAS will support both secure (i.e., using existing security mechanisms such as WS-
1208 Security, SAML, etc,) and non-secure implementations.
1209  Generic biometric operations will be defined – use of biometrics within a Web services
1210 authentication protocol is not addressed.
1211  OASIS namespace rules will be followed, though some external schemas MAY also be
1212 referenced.
1213 5.2 Message requirements

1214 BIAS SOAP messages MUST conform to [WS-I-Basic] and [WS-I-Bind]. A single BIAS SOAP message
1215 MUST contain only one BIAS service request (or single BIAS service response). Binary components of
1216 BIAS messages are already Base-64 encoded and therefore do not need to be conveyed as SOAP
1217 attachments (though XOP MAY be utilized).
1218 The system model used for BIAS conversations over SOAP is a simple request-response model. BIAS
1219 comprises both synchronous and asynchronous operations, with the majority being of the former type.
1220 Asynchronous operations are implemented through message pairs. That is, there are separate messages
1221 to request the operation and to request the results of the operation. These have been defined for those
1222 operations that are likely to take significant time to complete. For example, an identify operation can be
1223 implemented as either a synchronous or asynchronous service as follows:
1224

service provider client service provider
client
IdentifySubject ()
IdentifySubject ()
Return, Token
Return, CandidateList
GetIdentifySubjectResults (Token)
Return, CandidateList
(a) Synchronous Operation (b) Asynchronous Operation

1225
1226 Figure 5. Example of Synchronous and Asynchronous BIAS Operations
1227
1228
1229 The basic process for using SOAP for BIAS operations is:
1230 1. A system entity acting as a BIAS requester transmits a BIAS request element within the body of a
1231 SOAP message to a system entity acting as a BIAS responder. The BIAS requester MUST NOT
1232 include more than one BIAS request per SOAP message or include any additional XML elements
1233 in the SOAP body.
1234 2. The BIAS responder MUST return either a BIAS response element within the body of another
1235 SOAP message or generate a SOAP fault. The BIAS responder MUST NOT include more than
1236 one BIAS response per SOAP message or include any additional XML elements in the SOAP
1237 body. If a BIAS responder cannot, for some reason, process a BIAS request, it MUST generate a
1238 SOAP fault. (SOAP 1.1 faults and fault codes are discussed in [SOAP11] section 5.1.)
1239 3. On receiving a BIAS response in a SOAP message, the BIAS requester MUST NOT send a fault
1240 code or other error messages to the BIAS responder. Since the format for the message
1241 interchange is a simple request-response pattern, adding additional items such as error
1242 conditions would needlessly complicate the protocol.
1243 SOAP 1.1 also defines an optional data encoding system. This system is not used within the BIAS SOAP
1244 binding. This means that BIAS messages can be transported using SOAP without re-encoding from the
1245 “standard” BIAS schema to one based on the SOAP encoding.
1246 NOTE: [SOAP11] references an early draft of the XML Schema specification including an obsolete
1247 namespace. BIAS requesters SHOULD generate SOAP documents referencing only the final XML
1248 schema namespace. BIAS responders MUST be able to process both the XML schema namespace used
1249 in [SOAP11] as well as the final XML schema namespace.
1250 5.3 Handling binary data

1251 BIAS messages frequently contain binary data (e.g., biometric data, scanned identity documents, etc.).
1252 Two methods are provided for dealing with this:
1253  Embedded Base64 encoding
1254  XOP [XOP]
1255 Use of SOAP with Attachments (SWA) is deprecated.

1256 5.3.1 Base64 encoding
1257 This method is the default method for including binary data. Binary data is Base64 encoded and included
1258 between the tags in the XML SOAP body for the appropriate data elements. Data elements using this
1259 method are indicated as such in the schema.
1260 As an example, the CBEFF_BIR_Type includes, as one of the BIR types, BinaryBIR of type
1261 base64binary.
1262
1263 <xsd:element name="BinaryBIR" type="xsd:base64Binary" />
1264
1265 However, even an XML_BIR as defined within [CBEFF3], contains a biometric data block (BDB) which
1266 may be entirely binary (most common),
1267
1268 <xsd:element name="bdb" type="xsd:base64Binary" minOccurs="0"/>
1269
1270 or contain an element which is binary (e.g., an image within an XML BDB).
1271 5.3.2 Use of XOP

1272 When XOP is used, the binary content is replaced with a reference (URI) to an attachment (i.e., MIME)
1273 which contains that “stripped” content via an xop:include. The advantage of this method is overall
1274 message size during transmission since the overhead of the embedded Base64 is not present (since the
1275 MIME attachment contains the native binary format).
1276 Use of XOP is generally transparent to the developer, other than in how they configure their toolset. Most
1277 frameworks support this; however, there is a possibility of mismatch if the transmitter supports and uses
1278 XOP but the receiver does not.
1279 5.4 Discovery

1280 BIAS implementers (service providers) MUST provide WSDL [WSDL11] to describe their
1281 implementations. This WSDL MAY or may not be made public via a standard discovery mechanism
1282 (such as UDDI) or other method.
1283 In addition, it is REQUIRED that the BIAS implementation include the QueryCapabilities operation to
1284 provide dynamic information regarding BIAS capabilities, options, galleries, etc. that are supported.
1285 5.5 Identifying operations

1286 Receivers of BIAS SOAP messages require a method of easily identifying the operation being requested
1287 (or response being provided). This SHOULD be possible without the receiver needing to infer it from the
1288 sum of the elements provided within the body of the SOAP message. The BIAS SOAP profile allows for
1289 two methods of identifying BIAS operations:
1290  Explicit named element in body of the SOAP message
1291  Use of WS-Addressing Action element
1292 5.5.1 Operation name element

1293 The BIAS message sender (requester) will include within the body of the BIAS SOAP message an XML
1294 element <BIASOperationName>. The receiver (service provider) can search for this tag within a received
1295 BIAS SOAP message to determine what operation is being requested. There is no requirement related to
1296 the ordering of this element within the message, though it is RECOMMENDED that it be included early in
1297 the message to aid in human readability.
1298 An example of this method for the CreateSubject operation is shown below:
1299
1300 POST /bias HTTP/1.1
1301 Host: www.acme.com
1302 Content-Type: application/soap+xml; charset=”utf-8”
1303 Content-Length: nnnn
1304 SOAPAction: “”
1305 <?xml version=”1.0”?>
1306 <soap:Envelope xmlns:soap=”http://www.w3.org/2003/05/soap-envelope”>
1307 <soap:Body>
1308 <tns:CreateSubjectRequest xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/”>
1309 <tns:GenericRequestParameters>
1310 <tns:Application>BIAS Application</tns:Application>
1311 <tns:ApplicationUser>BIAS User</tns:ApplicationUser>
1312 <tns:BIASOperationName>CreateSubject</tns:BIASOperationName>
1313 </tns:GenericRequestParameters>
1314 <tns:Identity>
1315 <tns:SubjectID>123456789</tns:SubjectID>
1316 </tns:Identity>
1317 </tns:CreateSubjectRequest>
1318 </soap:Body>
1319 </soap:Envelope>
1320 5.5.2 WS-Addressing Action

1321 WS-Addressing [WS-Addr] provides a mechanism for including action information inside any SOAP
1322 message. The information is in the SOAP Header. The WS-Addressing ‘Action’ element is used to
1323 indicate the intent of the message. The value is a URI/IRI identifying that intent; however, there are no
1324 restrictions on the format or specificity of the URI/IRInor a requirement that it can be resolved. Adoption
1325 of this option also requires that the WS-Addressing ‘To’, ‘ReplyTo’, and ‘MessageID’ elements are
1326 supplied, as they are mandatory elements in a request-reply message pattern as used within BIAS.
1327 Response messages would also need to use WS-Addressing, requiring the ‘To’ (matching the ‘ReplyTo’
1328 element in the request), ‘RelatesTo’ (matching the ‘MessageID’ element in the request), and
1329 ‘RelationshipType’ (default value to “wsa:Reply”) elements.
1330 Use of WS-Addressing is OPTIONAL in this profile as is this method of using the ‘Action’ field for this
1331 purpose. However, when BIAS is used within an environment using WS-Addressing, it is
1332 RECOMMENDED that this approach for use of the ‘Action’ field to carry the BIAS operation name is
1333 employed, either alone or in combination with the BIASOperationName approach described in section
1334 5.5.1.
1335 An example for a message request for the CreateSubject operation would look likethe following:
1336
1341 SOAPAction: “”
1342 <?xml version=”1.0”?>
1343 <soap:Envelope xmlns:soap=”http://www.w3.org/2003/05/soap-envelope”
1344 xmlns:wsa=”http://schemas.xmlsoap.org/ws/2004/08/addressing”>
1345 <soap:Header>
1346 <wsa:MessageID>some-ID</wsa:MessageID>
1347 <wsa:ReplyTo>
1348 <wsa:Address>response-URI</wsa:Address>
1349 </wsa:ReplyTo>
1350 <wsa:To>destination-URI</wsa:To>
1351 <wsa:Action>CreateSubject</wsa:Action>
1352 </soap:Header>
1353 <soap:Body>
1354 <tns:CreateSubjectRequest
1355 xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/” />
1356 </soap:Body>
1358
1359 5.6 Security

1360 The end-points that exchange SOAP messages (or handle the contents of the BIAS operations) are
1361 expected to be protected and trusted such that message-level security mechanisms may not be required.
1362 The use of SSL (HTTPS) or VPN technology that provides end-point to end-point security is
1363 RECOMMENDED and MAY be sufficient in some cases. Other mechanisms such as Signed XML or
1364 WSS [WSS] could also be implemented.
1365 Unless stated otherwise, the following security statements apply to all BIAS bindings.
1366 5.6.1 Use of SSL 3.0 or TLS 1.0

1367 Unless otherwise specified, in any BIAS binding’s use of SSL 3.0 [SSL3] or TLS1.0 [RFC2246], servers
1368 MUST authenticate clients using a X.509 v3 certificate [X509]. The client MUST establish server identity
1369 based on contents of the certificate (typically through examination of the certificate’s subject DN field,
1370 subjectAltName attribute, etc.).
1371 Use of transport level security in the form of SSL or TLS is OPTIONAL but highly RECOMMENDED. Use
1372 of these mechanisms alone may not be sufficient for end-to-end integrity and confidentiality, however (see
1373 5.6.3 and 5.6.4 below).
1374 5.6.2 Data Origin Authentication

1375 Authentication of both the BIAS requester and the BIAS responder associated with a message is
1376 OPTIONAL and depends on the environment of use: Authentication mechanisms available at the SOAP
1377 message exchange layer or from the underlying substrate protocol (for example, in many bindings the
1378 SSL/TLS or HTTP protocol) MAY be utilized to provide data origin authentication.
1379 Transport authentication will not meet end-to-end origin authentication requirements in bindings where the
1380 BIAS SOAP message passes through an intermediary – in this case, message authentication is
1381 RECOMMENDED.
1382 Note that SAML [SAML] MAY be used as the mechanism for parties to authenticate to one another.
1383 5.6.3 Message Integrity

1384 Message integrity of both BIAS requests and BIAS responses is OPTIONAL and depends on the
1385 environment of use. The security layer in the underlying substrate protocol or a mechanism at the SOAP
1386 message exchange layer MAY be used to ensure message integrity.

1387 Transport integrity will not meet end-to-end integrity requirements in bindings where the BIAS SOAP
1388 message passes through an intermediary – in this case, message integrity is RECOMMENDED.
1389 5.6.4 Message Confidentiality

1390 Message confidentiality of both BIAS requests and BIAS responses is OPTIONAL and depends on the
1391 environment of use. The security layer in the underlying substrate protocol or a mechanism at the SOAP
1392 message exchange layer MAY be used to ensure message confidentiality.
1393 Transport confidentiality will not meet end-to-end confidentiality requirements in bindings where the BIAS
1394 SOAP message passes through an intermediary.
1395 NOTE: Biometric and biographic data is likely to contain personal information the confidentiality of which
1396 SHOULD be protected accordingly. See ISO/IEC 30108, section 6.5 for further discussion.
1397 5.6.5 CBEFF BIR security features

1398 Within BIAS, biometric data is transferred within a CBEFF BIR (as defined in ISO/IEC 19785-1). CBEFF
1399 provides for the optional encryption of the Biometric Data Block (BDB) of the BIR and for the integrity of
1400 the entire BIR. If implemented, this is indicated in the BIR header. The BIR structure defines an optional
1401 Security Block which MAY contain a digital signature (or message authentication code), encryption
1402 parameters (e.g., key name, algorithm, etc.), and/or other security related data. Such protections are
1403 associated with an individual BIR and are separate from any other protections provided at the message
1404 level.
1405 5.6.6 Security Considerations

1406 Before deployment, each combination of authentication, message integrity, and confidentiality
1407 mechanisms SHOULD be analyzed for vulnerability in the context of the specific protocol exchange and
1408 the deployment environment.
1409 Special care should be given to the impact of possible caching on security.
1410 IETF RFC 2617 [RFC2617] describes possible attacks in the HTTP environment when basic or message
1411 digest authentication schemes are used.
1412 Many of the security considerations identified in [SAML SEC] MAY also apply.
1413 ISO/IEC 19092 [BIO SEC] describes a security framework for biometric systems including a minimum set
1414 of security requirements addressing integrity, authenticity, and confidentiality of biometric information
1415 during transmission and storage. These SHOULD be considered as part of an overall risk management
1416 approach.
1417 NOTE: The requirements of ISO/IEC 19092, though useful across many application domains, are
1418 required for most biometric system implementations in the financial services environment. Application of
1419 this standard would make the requirements of sections 5.5.3 through 5.5.5 mandatory rather than
1420 optional. This is highly RECOMMENDED for any high security environment or where privacy concerns
1421 exist.
1422 5.6.7 Security of Stored Data

1423 This specification does not address security considerations for stored data. It is the purview of the BIAS
1424 service provider to implement security mechanisms and protect data at rest as per their own security
1425 policies.
1426 5.6.8 Key Management

1427 This specification does not address key management considerations with respect to implementation of
1428 cryptographic security mechanisms (e.g., for authenticity, integrity, or confidentiality).

1429 5.7 Use with other WS* standards
1430 The intent of specifying SOAP bindings for BIAS messages is to enable the full range of existing Web
1431 services standards to be able to be applied. Some may be normative while others can be optionally
1432 applied (i.e., WS-Security, WS-Addressing). Still others may require additional profiling to be used in an
1433 interoperable manner (e.g., WS-Notification); this is left to a future revision. However, the intent is to avoid
1434 specifying anything in the first, base version that would preclude the use of such standards in the future.
1435 5.8 Tailoring

1436 This standard provides for a common method of implementing biometric Web services; however, it does
1437 not guarantee interoperability in a specific application. In some cases further tailoring or profiling of this
1438 standard may be required in order to further constrain the implementation options available.
1439 NOTE: As an example, BIAS allows for a number of different biographic and biometric data formats to be
1440 used, whereas a given application/domain MAY wish to limit this to a small set or just one of each type.
1441 Other examples (not comprehensive) include:
1442  Identification of a subset of BIAS operations to be used
1443  Specification of security features to be implemented (e.g., SSL, CBEFF BIR encryption, etc.)
1444  Choice of operation name identification method
1445  Choice of BIR type to be used (XML, non-XML, or URI)
1446  Further definition of aggregate operations
1447  Use (or not) of the encounter model
1448  Use (or not) of asynchronous operations
1449  Process sequences
1450  Implementation specific values (e.g., Transform operations/controls)
1451
1452

1453 6 Error handling
1454 There are two levels of errors that can be returned in an error response: system and service errors.
1455  System-level errors occur when the implementing system cannot service a request. They could
1456 result due to an internal logic error or because the implementing system does not support a
1457 particular request.
1458  Service-level errors occur when there is a problem transmitting or representing the service
1459 request. They could result due to an invalid service request or because of a communications
1460 error.
1461 The ISO/IEC BIAS standard defines the error condition codes for system-level errors.
1462  If successful, a response message (containing a return code) will be generated.
1463  If unsuccessful, a SOAP fault message (containing a fault code) will be generated.
1464 6.1 BIAS operation return codes

1465 If a BIAS operation is successful, a response (service output) will be sent to the requester by the service
1466 provider. Each response message contains a response status (see section 3.2.37) and return code (see
1467 section 3.2.38) along with any response data as defined for that operation, if any. A response code of ‘0’
1468 indicates success.
1469 6.2 SOAP fault codes

1470 If a BIAS operation is unsuccessful, no BIAS response message is sent. Instead a SOAP fault message
1471 is returned.
1472 Every Web service (operation) described in the BIAS WSDL may result in a fault message that will be
1473 returned in the response by the service provider in the event of an error. The fault message contains a
1474 FaultCode element as defined by the SOAP 1.1 specification (see section 3.2.5). The fault message
1475 MUST contain a Detail element in a common format, as described by the BIASFault element (see section
1476 3.2.6).
1477 The schema provided in Annex A defines “BIASFaultCode” and “BIASFaultDetail” types as well as
1478 “BIASFault”, “BIASFaultType”, “BIASFaultMessage” and “BIASFaultDescription” elements.
1479 The list of defined BIAS fault codes is provided in section 3.2.5. Note that BIAS service providers MAY
1480 define additional fault codes unique to their service.
1481 NOTE: See also section 5.2 for additional information on message returns and faults.
1482
1483
1484

1485 7 Conformance
1486 Implementations claiming conformance to this standard, MUST implement, at a minimum, all mandatory
1487 requirements and provisions set forth in sections 3, 4, 5 and 6 listed for the target conformance class(es).
1488 If such implementations claim conformance to any OPTIONAL requirements and provisions stated in
1489 sections 3, 4, 5 and 6, these requirements and provisions MUST be implemented as set forth in these
1490 sections.
1491 ISO/IEC 30108 [ISO/IEC-BIAS] (Annex A) specifies seven BIAS conformance classes. In this document,
1492 these classes are outlined at a high level; more detailed information can be found in ISO/IEC 30108
1493 [ISO/IEC-BIAS]. For each class, a set of mandatory BIAS operations is identified in order for
1494 implementations (BIAS service providers) to claim conformance. These categories are:
1495
1496  Class 1: Full Primitive Services Implementation
1497  Class 2: Full Aggregate Services Implementation
1498  Class 3: Limited Primitive Services Implementation
1499  Class 4: Minimum Primitive Services Implementation
1500  Class 5: Minimum Aggregate Services Implementation
1501  Class 6: Matcher Primitive Services Implementation
1502  Class 7: Matcher Aggregate Services Implementation
1503 Required operations and capabilities are described in Table 7.1 below.
1505 Table 7.1 – BIAS conformance classes
Service / Capability Class 1 Class 2 Class 3 Class 4 Class 5 Class 6 Class 7

Primitive Services
Add Subject to Gallery X X
Check Quality X
Classify Biometric Data X
Create Encounter C** C** C**
Create Subject X X X X
Delete Biographic Data X X X
Delete Biometric Data X X X X
Delete Document Data X X
Delete Encounter C** C** C**
Delete Subject X X X
Delete Subject from Gallery X X
Get Identify Subject Results C* C* C*

Identify Subject X X X
List Biographic Data X X X
List Biometric Data X X X X
List Document Data X X
Perform Fusion X
Query Capabilities X X X X X X X
Retrieve Biographic Data X X X
Retrieve Biometric Data X X X X
Retrieve Document Data X X
Set Biographic Data X X X
Set Biometric Data X X X X
Set Document Data X X
Transform Biometric Data X
Update Biographic Data X X X
Update Biometric Data X X X X
Update Document Data X X
Verify Subject X X X X
Aggregate Services
Delete X X
Enrol X X X
Get Delete Results C* C*
Get Enrol Results C* C* C*
Get Identify Results C* C*
Get Update Results C* C* C*
Get Verify Results C* C* C*
Identify X X
Retrieve Data X X
Update X X X
Verify X X X
Capability Information Items
AggregateInputDataOptional X X X
AggregateInputDataRequired X X X

AggregateProcessingOption X X X
AggregateReturnData X X X
AggregateServiceDescription X X X
BiographicDataSet X X X X X
CBEFFPatronFormat X X X X X X X
ClassificataionAlgorithmType X
ConformanceClass X X X X X X X
Gallery X X X
IdentityModel X X X X X
ComparisonAlgorithm X X X X X X X
ComparisonScore X X X X X X X
QualityAlgorithm X
SupportedBiometric X X X X X X X
TransformOperation X
X – Required
C* – Conditionally required if associated implementation is asynchronous
C** – Conditionally required if implementation uses encounter-centric model
1506
1507 In addition, the minimum capability information to be returned in response to a Query Capabilities request
1508 (the only mandatory BIAS operation across all 5 classes) is specified for each class.
1509 These conformance classes and their associated requirements apply to this BIAS SOAP Profile.
1510 There are no minimum set of operations required to be implemented by BIAS requesters; however, any
1511 operations implemented must conform to the requirements of sections 3 and 4 and those requirements
1512 within section 5 that are mandatory and are not specific to BIAS responders.
1513
1514

1515 Appendix A. XML Schema
1516
1517 <?xml version="1.0" encoding="UTF-8"?>
1518 
1523 
1530 <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
1531 xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
1532 xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
1533 xmlns:cbeff="http://standards.iso.org/iso-iec/19785/-3/ed-2/" xmlns:iso_3166_1="http://standards.iso.org/iso/3166/-1/ed-3/"
1534 xmlns:tns="http://docs.oasis-open.org/bias/ns/bias-2.0/" targetNamespace="http://docs.oasis-open.org/bias/ns/bias-2.0/">
1535 <wsdl:types>
1536 <xsd:schema elementFormDefault="qualified" targetNamespace="http://docs.oasis-open.org/bias/ns/bias-2.0/">
1537 <xsd:import namespace="http://standards.iso.org/iso-iec/19785/-3/ed-2/" schemaLocation="cbeff.xsd"/>
1538 <xsd:import namespace="http://standards.iso.org/iso/3166/-1/ed-3/" schemaLocation="iso_country_codes.xsd"/>
1539 <xsd:complexType name="AggregateRequestTemplate">
1540 <xsd:annotation>
1541 <xsd:documentation>Base template for BIAS aggregate service requests.</xsd:documentation>
1542 </xsd:annotation>
1543 <xsd:complexContent>
1544 <xsd:extension base="tns:RequestTemplate">
1545 <xsd:sequence>
1546 <xsd:element name="ProcessingOptions" type="tns:ProcessingOptionsType"
1547 minOccurs="1" maxOccurs="1">

Standards Track Work Product Copyright © OASIS Open 2017. All Right Reserved. Page 129 of 266
1549 <xsd:documentation>Options that guide how the aggregate service
1550 request is processed.</xsd:documentation>
1552 </xsd:element>
1553 <xsd:element name="InputData" type="tns:InformationType" minOccurs="1"
1554 maxOccurs="1">
1556 <xsd:documentation>Contains the input data for the aggregate
1557 service request.</xsd:documentation>
1559 </xsd:element>
1560 </xsd:sequence>
1561 </xsd:extension>
1562 </xsd:complexContent>
1563 </xsd:complexType>
1564 <xsd:complexType name="AggregateResponseTemplate">
1566 <xsd:documentation>Base template for BIAS aggregate service responses.</xsd:documentation>
1569 <xsd:extension base="tns:ResponseTemplate">
1570 <xsd:sequence>
1571 <xsd:element name="ReturnData" type="tns:InformationType" minOccurs="0"
1572 maxOccurs="1">
1574 <xsd:documentation>Contains the output data for the aggregate
1575 service response.</xsd:documentation>
1577 </xsd:element>
1582 <xsd:simpleType name="ApplicationIdentifier">
1584 <xsd:documentation>Identifies an application.</xsd:documentation>

1586 <xsd:restriction base="xsd:string">
1587 <xsd:minLength value="1"/>
1588 <xsd:maxLength value="255"/>
1589 </xsd:restriction>
1590 </xsd:simpleType>
1591 <xsd:simpleType name="ApplicationUserIdentifier">
1593 <xsd:documentation>Identifies an application user or instance.</xsd:documentation>
1596 <xsd:minLength value="1"/>
1597 <xsd:maxLength value="255"/>
1600 <xsd:complexType name="BIASBiometricDataType">
1602 <xsd:documentation>Wraps the various BIAS biometric types.</xsd:documentation>
1604 <xsd:sequence>
1605 <xsd:element name="BIRList" type="tns:CBEFF_BIR_ListType" minOccurs="0" maxOccurs="1">
1607 <xsd:documentation>A list of CBEFF-BIR elements.</xsd:documentation>
1609 </xsd:element>
1610 <xsd:element name="BIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="1">
1612 <xsd:documentation>Contains biometric information in either a non-XML and an XML
1613 representation.</xsd:documentation>
1615 </xsd:element>
1616 <xsd:element name="InputBIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="1">
1618 <xsd:documentation>Maps to specific INCITS BIAS elements as required by that
1619 specification.</xsd:documentation>
1621 </xsd:element>

1622 <xsd:element name="ReferenceBIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="1">
1624 <xsd:documentation>Maps to specific INCITS BIAS elements as required by that
1625 specification.</xsd:documentation>
1627 </xsd:element>
1628 <xsd:element name="BiometricDataList" type="tns:BiometricDataListType" minOccurs="0"
1629 maxOccurs="1">
1631 <xsd:documentation>A list of biometric data elements.</xsd:documentation>
1633 </xsd:element>
1636 <xsd:simpleType name="BIASFaultCode">
1638 <xsd:documentation>Error code referenced in a SOAP fault. </xsd:documentation>
1641 <xsd:enumeration value="UNKNOWN_ERROR">
1643 <xsd:documentation>The service failed for an unknown reason.</xsd:documentation>
1645 </xsd:enumeration>
1646 <xsd:enumeration value="UNSUPPORTED_CAPABILITY">
1648 <xsd:documentation>A requested capability is not supported by the service
1649 implementation.</xsd:documentation>
1652 <xsd:enumeration value="INVALID_INPUT">
1654 <xsd:documentation>The data in a service input parameter is
1655 invalid.</xsd:documentation>
1658 <xsd:enumeration value="BIR_QUALITY_ERROR">

1660 <xsd:documentation>Biometric sample quality is too poor for the service to
1661 succeed.</xsd:documentation>
1664 <xsd:enumeration value="INVALID_BIR">
1666 <xsd:documentation>The input BIR is empty or in an invalid or unrecognized
1667 format.</xsd:documentation>
1670 <xsd:enumeration value="BIR_SIGNATURE_FAILURE">
1672 <xsd:documentation>The service could not validate the signature, if used, on the
1673 input BIR.</xsd:documentation>
1676 <xsd:enumeration value="BIR_DECRYPTION_FAILURE">
1678 <xsd:documentation>The service could not decrypt an encrypted input
1679 BIR.</xsd:documentation>
1682 <xsd:enumeration value="INVALID_ENCOUNTER_ID">
1684 <xsd:documentation>The input encounter ID is empty or in an invalid
1688 <xsd:enumeration value="INVALID_SUBJECT_ID">
1690 <xsd:documentation>The input subject ID is empty or in an invalid
1694 <xsd:enumeration value="UNKNOWN_SUBJECT">

1696 <xsd:documentation>The subject referenced by the input subject ID does not
1697 exist.</xsd:documentation>
1700 <xsd:enumeration value="UNKNOWN_GALLERY">
1702 <xsd:documentation>The gallery referenced by the input gallery ID does not
1706 <xsd:enumeration value="UNKNOWN_ENCOUNTER">
1708 <xsd:documentation>The encounter referenced by the input encounter ID does not
1712 <xsd:enumeration value="UNKNOWN_BIOGRAPHIC_FORMAT">
1714 <xsd:documentation>The biographic data format is not known or not
1715 supported.</xsd:documentation>
1718 <xsd:enumeration value="UNKNOWN_IDENTITY_CLAIM">
1720 <xsd:documentation>The identity referenced by the input identity claim does not
1724 <xsd:enumeration value="INVALID_IDENTITY_CLAIM">
1726 <xsd:documentation>The identity claim requested is already in
1727 use.</xsd:documentation>
1730 <xsd:enumeration value="NONEXISTANT_DATA">
1732 <xsd:documentation>The data requested for deletion does not

1738 <xsd:complexType name="BIASFaultDetail">
1740 <xsd:documentation>Defines the error information associated with a SOAP
1741 fault.</xsd:documentation>
1743 <xsd:sequence>
1744 <xsd:element minOccurs="1" maxOccurs="1" name="BIASFaultType" type="tns:BIASFaultCode">
1746 <xsd:documentation>References an error code.</xsd:documentation>
1748 </xsd:element>
1749 <xsd:element minOccurs="1" maxOccurs="1" name="BIASFaultMessage" type="xsd:string">
1751 <xsd:documentation>Provides an explanation of the fault.</xsd:documentation>
1753 </xsd:element>
1754 <xsd:element minOccurs="0" maxOccurs="1" name="BIASFaultDescription" type="xsd:string">
1756 <xsd:documentation>Provides detailed information about a BIAS fault, such as trace
1757 details.</xsd:documentation>
1759 </xsd:element>
1762 <xsd:complexType name="BIASIdentity">
1764 <xsd:documentation>
1765 Defines a single element for encapsulating the data associated
1766 with an Identity. Includes the Identity's reference identifiers,
1767 biographic data, and biometric data.
1768 </xsd:documentation>

1770 <xsd:sequence>
1771 <xsd:element name="SubjectID" type="tns:BIASIDType" minOccurs="0" maxOccurs="1">
1773 <xsd:documentation>A system unique identifier for a subject.</xsd:documentation>
1775 </xsd:element>
1776 <xsd:element name="IdentityClaim" type="tns:BIASIDType" minOccurs="0" maxOccurs="1">
1778 <xsd:documentation>An identifier by which a subject is known to a particular
1779 gallery or population group.</xsd:documentation>
1781 </xsd:element>
1782 <xsd:element name="EncounterID" type="tns:BIASIDType" minOccurs="0" maxOccurs="1">
1784 <xsd:documentation>The identifier of an encounter associated with the subject,
1785 required for encounter-centric models.</xsd:documentation>
1787 </xsd:element>
1788 <xsd:element name="EncounterList" type="tns:EncounterListType" minOccurs="0" maxOccurs="1">
1790 <xsd:documentation>A list of encounters associated with a
1791 subject.</xsd:documentation>
1793 </xsd:element>
1794 <xsd:element name="BiographicData" type="tns:BiographicDataType" minOccurs="0" maxOccurs="1">
1796 <xsd:documentation>An Identity's biographic data.</xsd:documentation>
1798 </xsd:element>
1799 <xsd:element name="BiometricData" type="tns:BIASBiometricDataType" minOccurs="0" maxOccurs="1">
1801 <xsd:documentation>An Identity's biometric data.</xsd:documentation>
1803 </xsd:element>
1806 <xsd:simpleType name="BIASIDType">

1808 <xsd:documentation>A BIAS identifier</xsd:documentation>
1810 <xsd:restriction base="xsd:string"/>
1812 <xsd:complexType name="BiographicDataListType">
1814 <xsd:documentation>Defines a list of biographic data.</xsd:documentation>
1816 <xsd:sequence>
1817 <xsd:element name="BiographicData" type="tns:BiographicDataType" minOccurs="0"
1818 maxOccurs="unbounded">
1820 <xsd:documentation>Data structure containing information about a biographic
1821 record.</xsd:documentation>
1823 </xsd:element>
1826 <xsd:complexType name="BiographicDataItemType">
1828 <xsd:documentation>Defines a single biographic data element.</xsd:documentation>
1830 <xsd:sequence>
1831 <xsd:element name="Name" type="xsd:string" minOccurs="1" maxOccurs="1">
1833 <xsd:documentation>The name of the biographic data item.</xsd:documentation>
1835 </xsd:element>
1836 <xsd:element name="Type" type="xsd:string" minOccurs="1" maxOccurs="1">
1838 <xsd:documentation>The data type for the biographic data item.</xsd:documentation>
1840 </xsd:element>
1841 <xsd:element name="Value" type="xsd:string" minOccurs="0" maxOccurs="1">

1843 <xsd:documentation>The value assigned to the biographic data
1844 item.</xsd:documentation>
1846 </xsd:element>
1849 <xsd:complexType name="BiographicDataItemListType">
1851 <xsd:documentation>Defines a list of biographic data elements.</xsd:documentation>
1853 <xsd:sequence>
1854 <xsd:element name="BiographicDataItem" type="tns:BiographicDataItemType" minOccurs="1"
1857 <xsd:documentation>Data structure containing information about a biographic
1860 </xsd:element>
1863 <xsd:complexType name="BiographicDataSetType">
1865 <xsd:documentation>Defines a set of biographic data that is formatted according to the specified
1868 <xsd:sequence>
1869 <xsd:element name="name" type="xsd:string" minOccurs="1" maxOccurs="1">
1871 <xsd:documentation>The name of the biographic data format. Use these names for
1872 common formats: FBI-EFTS, FBI-EBTS, DOD-EBTS, INT-I, NIEM, xNAL, HR-XML.</xsd:documentation>
1874 </xsd:element>
1875 <xsd:element name="version" type="xsd:string" minOccurs="0" maxOccurs="1">
1877 <xsd:documentation>The version of the biographic data format (e.g., “7.1" for FBI-
1878 EFTS or “2.0" for NIEM).</xsd:documentation>
1880 </xsd:element>

1881 <xsd:element name="source" type="xsd:string" minOccurs="1" maxOccurs="1">
1883 <xsd:documentation>Reference to a URI/IRI describing the biographic data format.
1884 For example: (FBI-EFTS) www.fbibiospecs.org, (DOD-EBTS) www.biometrics.dod.mil, (INT-I) www.interpol.int, (NIEM) www.niem.gov, (xNAL)
1885 www.oasis-open.org, (HR-XML) www.hr-xml.org.</xsd:documentation>
1887 </xsd:element>
1888 <xsd:element name="type" type="xsd:string" minOccurs="1" maxOccurs="1">
1890 <xsd:documentation>The biographic data format type. Use these types for common
1891 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
1892 version of FBI-EBTS).</xsd:documentation>
1894 </xsd:element>
1895 <xsd:any namespace="##any">
1897 <xsd:documentation>Biographic data formatted according to a specific
1900 </xsd:any>
1903 <xsd:complexType name="BiographicDataType">
1906 Defines a set of biographic data elements, utilizing either the
1907 BiographicDataItemType to represent a list of elements or the
1908 BiographicDataSetType to represent a complete, formatted set of
1909 biographic information.
1912 <xsd:sequence>
1913 <xsd:element name="LastName" type="xsd:string" minOccurs="0" maxOccurs="1">
1915 <xsd:documentation>The last name of a subject.</xsd:documentation>
1917 </xsd:element>

1918 <xsd:element name="FirstName" type="xsd:string" minOccurs="0" maxOccurs="1">
1920 <xsd:documentation>The first name of a subject.</xsd:documentation>
1922 </xsd:element>
1923 <xsd:element name="BiographicDataItemList" type="tns:BiographicDataItemListType" minOccurs="0"
1924 maxOccurs="1">
1926 <xsd:documentation>A list of biographic data elements.</xsd:documentation>
1928 </xsd:element>
1929 <xsd:element name="BiographicDataSet" type="tns:BiographicDataSetType" minOccurs="0"
1930 maxOccurs="1">
1932 <xsd:documentation>A set of biographic data information.</xsd:documentation>
1934 </xsd:element>
1937 <xsd:complexType name="BiometricDataType">
1940 Provides descriptive information about biometric data, such as
1941 the biometric type, subtype, and format, contained in the BDB of
1942 the CBEFF-BIR.
1945 <xsd:sequence>
1946 <xsd:element name="BiometricType" type="cbeff:MultipleTypesType" minOccurs="1" maxOccurs="1">
1948 <xsd:documentation>The type of biological or behavioral data stored in the
1949 biometric record, as defined by CBEFF.</xsd:documentation>
1951 </xsd:element>
1952 <xsd:element name="BiometricTypeCount" type="xsd:positiveInteger" minOccurs="0" maxOccurs="1">

1954 <xsd:documentation>The number of biometric records having the biometric type
1955 recorded in the biometric type field.</xsd:documentation>
1957 </xsd:element>
1958 <xsd:element name="BiometricSubType" type="cbeff:SubtypeType" minOccurs="0" maxOccurs="1">
1960 <xsd:documentation>More specifically defines the type of biometric data stored in
1961 the biometric record, as defined by CBEFF.</xsd:documentation>
1963 </xsd:element>
1964 <xsd:element name="BDBFormatOwner" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1">
1966 <xsd:documentation>Identifies the standards body, working group, industry
1967 consortium, or other CBEFF biometric organization that has defined the format for the biometric data.</xsd:documentation>
1969 </xsd:element>
1970 <xsd:element name="BDBFormatType" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1">
1972 <xsd:documentation>Identifies the specific biometric data format specified by the
1973 CBEFF biometric organization recorded in the BDB Format Owner field.</xsd:documentation>
1975 </xsd:element>
1978 <xsd:complexType name="BiometricDataListType">
1980 <xsd:documentation>A list of biometric data elements.</xsd:documentation>
1982 <xsd:sequence>
1983 <xsd:element name="BiometricData" type="tns:BiometricDataType" minOccurs="0"
1986 <xsd:documentation>Data structure containing information about a biometric
1989 </xsd:element>

1992 <xsd:complexType name="CandidateListType">
1995 Defines a set of candidates, utilizing the Candidate Type to
1996 represent each element in the set.
1999 <xsd:sequence>
2000 <xsd:element name="Candidate" type="tns:CandidateType" minOccurs="0" maxOccurs="unbounded">
2002 <xsd:documentation>A single candidate.</xsd:documentation>
2004 </xsd:element>
2007 <xsd:complexType name="CandidateType">
2010 Defines a single candidate as a possible match in response to a
2011 biometric identification request.
2014 <xsd:sequence>
2015 <xsd:element name="ScoreList" minOccurs="0">
2016 <xsd:complexType>
2017 <xsd:sequence>
2018 <xsd:element name="Score" type="tns:ScoreType"/>
2021 </xsd:element>
2022 <xsd:element name="Identity" type="tns:BIASIdentity"/>
2023 <xsd:element name="Rank" type="xsd:integer" minOccurs="1" maxOccurs="1">
2025 <xsd:documentation>The rank of the candidate in relation to other candidates for
2026 the same biometric identification operation.</xsd:documentation>

2028 </xsd:element>
2029 <xsd:element name="BiographicData" type="tns:BiographicDataType" minOccurs="0">
2031 <xsd:documentation>Biographic data associated with the candidate
2032 match.</xsd:documentation>
2034 </xsd:element>
2037 <xsd:complexType name="CapabilityListType">
2039 <xsd:documentation>Defines a set of capabilities.</xsd:documentation>
2041 <xsd:sequence>
2042 <xsd:element name="Capability" type="tns:CapabilityType" minOccurs="0" maxOccurs="unbounded">
2044 <xsd:documentation>A single capability.</xsd:documentation>
2046 </xsd:element>
2049 <xsd:simpleType name="CapabilityName">
2051 <xsd:documentation>A list of capability items.</xsd:documentation>
2054 <xsd:enumeration value="AggregateInputDataOptional">
2056 <xsd:documentation>A data element accepted as optional input by the implementing
2057 system for the aggregate services.</xsd:documentation>
2060 <xsd:enumeration value="AggregateInputDataRequired">
2062 <xsd:documentation>A data element required as input by the implementing system for
2063 the aggregate services.</xsd:documentation>

2066 <xsd:enumeration value="AggregateProcessingOption">
2068 <xsd:documentation>A processing option supported by the implementing system for
2069 the aggregate services.</xsd:documentation>
2072 <xsd:enumeration value="AggregateReturnData">
2074 <xsd:documentation>A data element returned by the implementing system for the
2075 aggregate services.</xsd:documentation>
2078 <xsd:enumeration value="AggregateServiceDescription">
2080 <xsd:documentation>Describes the processing logic of an aggregate service
2081 supported by the implementing system.</xsd:documentation>
2084 <xsd:enumeration value="BiographicDataSet">
2086 <xsd:documentation>Identifies a biographic data set supported by the implementing
2087 system.</xsd:documentation>
2090 <xsd:enumeration value="CBEFFPatronFormat">
2092 <xsd:documentation>A patron format supported by the implementing
2096 <xsd:enumeration value="ClassificationAlgorithmType">
2098 <xsd:documentation>A classification algorithm type supported by the implementing
2102 <xsd:enumeration value="ConformanceClass">

2104 <xsd:documentation>Identifies the conformance class of the BIAS
2105 implementation.</xsd:documentation>
2108 <xsd:enumeration value="Gallery">
2110 <xsd:documentation>A gallery or population group supported by the implementing
2114 <xsd:enumeration value="IdentityModel">
2116 <xsd:documentation>Identifies whether the implementing system is person-centric or
2117 encounter-centric based.</xsd:documentation>
2120 <xsd:enumeration value="MatchAlgorithm">
2122 <xsd:documentation>A match algorithm vendor and algorithm vendor product ID
2126 <xsd:enumeration value="MatchScore">
2128 <xsd:documentation> Identifies the use of match scores returned by the
2129 implementing system.</xsd:documentation>
2132 <xsd:enumeration value="QualityAlgorithm">
2134 <xsd:documentation>A quality algorithm vendor and algorithm vendor product ID
2138 <xsd:enumeration value="SupportedBiometric">

2140 <xsd:documentation>A biometric type supported by the implementing
2144 <xsd:enumeration value="TransformOperation">
2146 <xsd:documentation>A transform operation type supported by the implementing
2152 <xsd:complexType name="CapabilityType">
2154 <xsd:documentation>Defines a single capability supported by an implementing
2157 <xsd:sequence>
2158 <xsd:element name="CapabilityName" type="tns:CapabilityName" minOccurs="1" maxOccurs="1">
2160 <xsd:documentation>The name of the capability.</xsd:documentation>
2162 </xsd:element>
2163 <xsd:element name="CapabilityID" type="xsd:string" minOccurs="0" maxOccurs="1">
2165 <xsd:documentation>An identifier assigned to the capability by the implementing
2168 </xsd:element>
2169 <xsd:element name="CapabilityDescription" type="xsd:string" minOccurs="0" maxOccurs="1">
2171 <xsd:documentation>A description of the capability.</xsd:documentation>
2173 </xsd:element>
2174 <xsd:element name="CapabilityValue" type="xsd:string" minOccurs="0" maxOccurs="1">
2176 <xsd:documentation>A value assigned to the capability.</xsd:documentation>

2178 </xsd:element>
2179 <xsd:element name="CapabilitySupportingValue" type="xsd:string" minOccurs="0" maxOccurs="1">
2181 <xsd:documentation>A secondary value supporting the
2182 capability.</xsd:documentation>
2184 </xsd:element>
2185 <xsd:element name="CapabilityAdditionalInfo" type="xsd:string" minOccurs="0" maxOccurs="1">
2187 <xsd:documentation> Contains additional information for the supported
2188 capability.</xsd:documentation>
2190 </xsd:element>
2193 <xsd:complexType name="CBEFF_BIR_ListType">
2195 <xsd:documentation>A list of CBEFF-BIR elements.</xsd:documentation>
2197 <xsd:sequence>
2198 <xsd:element name="BIR" type="tns:CBEFF_BIR_Type" minOccurs="0" maxOccurs="unbounded">
2200 <xsd:documentation>CBEFF structure containing information about a biometric
2201 sample.</xsd:documentation>
2203 </xsd:element>
2206 <xsd:complexType name="CBEFF_BIR_Type">
2208 <xsd:documentation>Represents biometric information, with either a non-XML or XML
2209 representation.</xsd:documentation>
2211 <xsd:sequence>
2212 <xsd:element name="FormatOwner" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1"/>
2213 <xsd:element name="FormatType" type="xsd:positiveInteger" minOccurs="1" maxOccurs="1"/>

2214 <xsd:element name="BIR_Information" minOccurs="0" maxOccurs="1">
2216 <xsd:sequence>
2217 <xsd:element name="BIR_Info" type="cbeff:BIRInfoType" minOccurs="0"
2218 maxOccurs="1"/>
2219 <xsd:element name="BDB_Info" type="cbeff:BDBInfoType" minOccurs="0"
2221 <xsd:element name="SB_Info" type="cbeff:SBInfoType" minOccurs="0"
2225 </xsd:element>
2226 <xsd:element name="BIR" type="tns:BaseBIRType"/>
2229 <xsd:complexType name="BaseBIRType">
2231 <xsd:complexType name="BinaryBIR">
2233 <xsd:extension base="tns:BaseBIRType">
2234 <xsd:sequence>
2235 <xsd:element name="Binary" type="xsd:base64Binary"/>
2240 <xsd:complexType name="URI_BIR">
2243 <xsd:sequence>
2244 <xsd:element name="URI" type="xsd:anyURI"/>
2249 <xsd:complexType name="XML_BIR">

2252 <xsd:sequence>
2253 <xsd:element name="XML" type="cbeff:BIRType"/>
2258 <xsd:simpleType name="Classification">
2260 <xsd:documentation>The result of a classification.</xsd:documentation>
2264 <xsd:simpleType name="ClassificationAlgorithmType">
2266 <xsd:documentation>Type of classification algorithm that was used to perform the
2267 classification.</xsd:documentation>
2271 <xsd:complexType name="ClassificationData">
2273 <xsd:documentation>Contains information on classification results and the algorithm used to
2274 determine the classification.</xsd:documentation>
2276 <xsd:sequence>
2277 <xsd:element name="Classification" type="tns:Classification" minOccurs="1" maxOccurs="1">
2279 <xsd:documentation>The result of the classification.</xsd:documentation>
2281 </xsd:element>
2282 <xsd:element name="ClassificationAlgorithmType" type="tns:ClassificationAlgorithmType"
2285 <xsd:documentation>Identifies the type of classification algorithm that was used
2286 to perform the classification.</xsd:documentation>

2288 </xsd:element>
2291 <xsd:complexType name="DocumentDataType">
2293 <xsd:documentation>Defines a set of document data elements providing information about the
2294 presented identity document. </xsd:documentation>
2296 <xsd:sequence>
2297 <xsd:element name="DocumentCategory" type="xsd:string" minOccurs="1" maxOccurs="1">
2299 <xsd:documentation>The type of identity document presented (e.g.
2300 passport).</xsd:documentation>
2302 </xsd:element>
2303 <xsd:element name="DocumentIDNumber" type="xsd:string" minOccurs="0" maxOccurs="1">
2305 <xsd:documentation>The number associated with the identity document (e.g. passport
2306 number).</xsd:documentation>
2308 </xsd:element>
2309 <xsd:element name="DocumentIssuanceCountryCode" type="iso_3166_1:CountryAlpha2CodeType"
2312 <xsd:documentation>The ISO 2-character code for the country which issued the
2313 document or from within which it was issued.</xsd:documentation>
2315 </xsd:element>
2316 <xsd:element name="DocumentIssuingOrganization" type="xsd:string" minOccurs="0" maxOccurs="1">
2318 <xsd:documentation>The entity which issued the identity
2319 document.</xsd:documentation>
2321 </xsd:element>
2322 <xsd:element name="DocumentIssuanceDate" type="xsd:dateTime" minOccurs="0" maxOccurs="1">
2324 <xsd:documentation>The date upon which the identity document was
2325 issued.</xsd:documentation>

2327 </xsd:element>
2328 <xsd:element name="DocumentExpirationDate" type="xsd:dateTime" minOccurs="0" maxOccurs="1">
2330 <xsd:documentation>The date upon which the identity document is no longer valid
2331 (expires).</xsd:documentation>
2333 </xsd:element>
2334 <xsd:element name="DocumentLastName" type="xsd:string" minOccurs="0" maxOccurs="1">
2336 <xsd:documentation>The family name of the person to whom the identity document was
2337 issued, as contained within the document itself.</xsd:documentation>
2339 </xsd:element>
2340 <xsd:element name="DocumentFirstName" type="xsd:string" minOccurs="0" maxOccurs="1">
2342 <xsd:documentation>The first given name of the person to whom the identity
2343 document was issued, as contained within the document itself.</xsd:documentation>
2345 </xsd:element>
2346 <xsd:element name="DocumentMiddleName" type="xsd:string" minOccurs="0" maxOccurs="1">
2348 <xsd:documentation>The second given name of the person to whom the identity
2349 document was issued, as contained within the document itself.</xsd:documentation>
2351 </xsd:element>
2352 <xsd:element name="DocumentValidity" type="xsd:boolean" minOccurs="0" maxOccurs="1">
2354 <xsd:documentation>The assessed validity of the identity document (e.g. as the
2355 result of local or online validity checks).</xsd:documentation>
2357 </xsd:element>
2358 <xsd:element name="DocumentValidityText" type="xsd:string" minOccurs="0" maxOccurs="1">
2360 <xsd:documentation>Details or remarks associated with the assessed validity (e.g.
2361 description of validity issue).</xsd:documentation>
2363 </xsd:element>

2364 <xsd:element name="DocumentImage" type="xsd:base64Binary" minOccurs="0" maxOccurs="1">
2366 <xsd:documentation>A scanned image of the subject document (e.g. passport picture
2367 page).</xsd:documentation>
2369 </xsd:element>
2372 <xsd:complexType name="DocumentDataListType">
2374 <xsd:documentation>Defines a list of documents. </xsd:documentation>
2376 <xsd:sequence>
2377 <xsd:element name="DocumentData" type="tns:DocumentDataType" minOccurs="0" maxOccurs="unbounded">
2379 <xsd:documentation>Data structure containing information about a document and
2380 optionally an image of that document.</xsd:documentation>
2382 </xsd:element>
2385 <xsd:simpleType name="EncounterCategoryType">
2387 <xsd:documentation>Identifies the type of encounter (interaction) during which the identity
2388 (biographic, biometric, and/or document) data was collected from the subject as determined by the requester.</xsd:documentation>
2391 <xsd:enumeration value="Enrolment">
2393 <xsd:documentation>The encounter is created during an enrolment
2394 interaction.</xsd:documentation>
2397 <xsd:enumeration value="Recognition">
2399 <xsd:documentation>The encounter is created during a recognition
2400 interaction.</xsd:documentation>

2403 <xsd:enumeration value="Unspecified">
2405 <xsd:documentation>The type of encounter is unknown.</xsd:documentation>
2408 <xsd:pattern value="([a-zA-Z0-9])+"/>
2411 <xsd:complexType name="EncounterListType">
2413 <xsd:documentation>Defines a set of encounters.</xsd:documentation>
2415 <xsd:sequence>
2416 <xsd:element name="EncounterID" type="tns:BIASIDType" minOccurs="0" maxOccurs="unbounded">
2418 <xsd:documentation>The identifier of an encounter.</xsd:documentation>
2420 </xsd:element>
2423 <xsd:complexType name="FusionIdentityListType">
2426 Contains fusion input elements for one or more identities, utilizing the FusionInformationListType to represent a single
2427 set of fusion information for each identity.
2430 <xsd:sequence>
2431 <xsd:element name="FusionIdentity" type="tns:FusionInformationListType" minOccurs="0"
2434 <xsd:documentation>A set of fusion information for a single
2435 identity.</xsd:documentation>
2437 </xsd:element>

2440 <xsd:complexType name="FusionInformationListType">
2443 Contains at a minimum two sets of fusion input
2444 elements, as input to the PerformFusion request.
2447 <xsd:sequence>
2448 <xsd:element name="FusionElement" type="tns:FusionInformationType" minOccurs="2"
2451 <xsd:documentation>A set of fusion information.</xsd:documentation>
2453 </xsd:element>
2456 <xsd:complexType name="FusionInformationType">
2458 <xsd:documentation>Represents the information necessary to perform a fusion
2459 operation.</xsd:documentation>
2461 <xsd:sequence>
2462 <xsd:element name="BiometricType" type="cbeff:MultipleTypesType" minOccurs="1" maxOccurs="1">
2464 <xsd:documentation>The type of biological or behavioral data stored in the
2465 biometric record, as defined by CBEFF.</xsd:documentation>
2467 </xsd:element>
2468 <xsd:element name="BiometricSubType" type="cbeff:SubtypeType" minOccurs="0" maxOccurs="1">
2470 <xsd:documentation>More specifically defines the type of biometric data stored in
2471 the biometric record.</xsd:documentation>
2473 </xsd:element>
2474 <xsd:element name="AlgorithmOwner" type="xsd:string" minOccurs="1" maxOccurs="1">

2476 <xsd:documentation>The owner or vendor of the algorithm used to determine the
2477 score or decision.</xsd:documentation>
2479 </xsd:element>
2480 <xsd:element name="AlgorithmType" type="xsd:string" minOccurs="1" maxOccurs="1">
2482 <xsd:documentation>The Algorithm Owner's identifier for the specific algorithm
2483 product and version used to determine the score or decision.</xsd:documentation>
2485 </xsd:element>
2486 <xsd:element name="FusionResult" type="tns:FusionResult"/>
2489 <xsd:complexType name="FusionResult">
2490 <xsd:sequence/>
2492 <xsd:complexType name="FusionScore">
2494 <xsd:extension base="tns:FusionResult">
2495 <xsd:sequence>
2496 <xsd:element name="Score" type="tns:ScoreType">
2498 <xsd:documentation>The similarity score assigned by the matching
2499 algorithm.</xsd:documentation>
2501 </xsd:element>
2506 <xsd:complexType name="FusionDecision">
2508 <xsd:extension base="tns:FusionResult">
2509 <xsd:sequence>
2510 <xsd:element name="Decision" type="xsd:string">

2512 <xsd:documentation>The match decision assigned by the matching
2513 algorithm.</xsd:documentation>
2515 </xsd:element>
2520 <xsd:complexType name="GenericRequestParameters">
2522 <xsd:documentation>Common request parameters that can be used to identify the
2523 requester.</xsd:documentation>
2525 <xsd:sequence>
2526 <xsd:element name="Application" type="tns:ApplicationIdentifier" minOccurs="0" maxOccurs="1">
2528 <xsd:documentation>Identifies the requesting application.</xsd:documentation>
2530 </xsd:element>
2531 <xsd:element name="ApplicationUser" type="tns:ApplicationUserIdentifier" minOccurs="0"
2532 maxOccurs="1">
2534 <xsd:documentation>Identifers the user or instance of the requesting
2535 application.</xsd:documentation>
2537 </xsd:element>
2538 <xsd:element name="BIASOperationName" type="xsd:string" minOccurs="0" maxOccurs="1">
2540 <xsd:documentation>Identifers the BIAS operation name that is being
2541 requested.</xsd:documentation>
2543 </xsd:element>
2546 <xsd:complexType name="InformationType">

2549 Allows for an unlimited number of data element types, and it does
2550 not specify nor require any particular data element.
2553 
2555 <xsd:sequence>
2556 <xsd:element name="GUID" type="xsd:string" minOccurs="0" />
2557 <xsd:element name="GivenName" type="xsd:string" minOccurs="0" />
2558 <xsd:element name="FamilyName" type="xsd:string" minOccurs="0" />
2559 <xsd:element name="DateOfBirth" type="xsd:string" minOccurs="0" />
2560 <xsd:element name="Sex" type="xsd:string" minOccurs="0" />
2561 <xsd:element name="Citizenship" type="xsd:string" minOccurs="0" />
2562 <xsd:element name="Images" minOccurs="0">
2564 <xsd:sequence>
2565 <xsd:element name="Image" minOccurs="0" maxOccurs="unbounded">
2567 <xsd:sequence>
2568 <xsd:element name="ContentType" type="xsd:string"
2569 minOccurs="0" />
2570 <xsd:element name="EyebrowDistance"
2571 type="xsd:string" minOccurs="0" />
2572 <xsd:element name="LEyebrowWidth" type="xsd:string"
2574 <xsd:element name="REyebrowWidth" type="xsd:string"
2576 <xsd:element name="REyeHeight" type="xsd:string"
2578 <xsd:element name="LEyeHeight" type="xsd:string"
2580 <xsd:element name="EyeDistance" type="xsd:string"
2582 <xsd:element name="PupilDistance" type="xsd:string"
2584 <xsd:element name="BridgeWidth" type="xsd:string"
2586 <xsd:element name="NoseAlarWidth" type="xsd:string"

2588 <xsd:element name="NostrilWidth" type="xsd:string"
2590 <xsd:element name="UpperLipHeight" type="xsd:string"
2592 <xsd:element name="LowerLipHeight" type="xsd:string"
2594 <xsd:element name="ImageData"
2595 type="xsd:base64Binary" minOccurs="0" />
2598 </xsd:element>
2601 </xsd:element>
2602 <xsd:element name="Identities" minOccurs="0">
2604 <xsd:sequence>
2605 <xsd:element name="Identity" type="xsd:string" maxOccurs="unbounded" />
2608 </xsd:element>
2611 <xsd:complexType name="Example_BIR">
2614 <xsd:sequence>
2615 <xsd:element name="BiometricSample" type="xsd:string"/>
2616 <xsd:element name="BiometricSampleType" type="xsd:string"/>
2621 <xsd:complexType name="ListFilterType">
2623 <xsd:documentation>Provides a method to filter the amount of information returned in a search of
2624 biometric data.

2627 <xsd:sequence>
2628 <xsd:element name="BiometricTypeFilters">
2630 <xsd:sequence>
2631 <xsd:element name="BiometricTypeFilter" type="cbeff:MultipleTypesType"
2632 minOccurs="1" maxOccurs="unbounded">
2634 <xsd:documentation>Limits the returned information to a
2635 specific type of biometric, as defined by CBEFF.</xsd:documentation>
2637 </xsd:element>
2640 </xsd:element>
2641 <xsd:element name="IncludeBiometricSubtype" type="xsd:boolean" minOccurs="1" maxOccurs="1">
2643 <xsd:documentation>A Boolean flag indicating if biometric subtype information
2644 should be returned.</xsd:documentation>
2646 </xsd:element>
2649 <xsd:simpleType name="MatchType">
2651 <xsd:documentation>The result of a fusion method.</xsd:documentation>
2653 <xsd:restriction base="xsd:boolean"/>
2655 <xsd:complexType name="OptionType">
2658 BIAS aggregate operations support the ability to include various processing options which direct and possibly control the
2659 business logic for that operation. Together with the ProcessingOptionsType, The OptionType provides a method to represent those
2660 options. Processing options SHOULD be defined by the implementing system.

2663 <xsd:sequence>
2664 <xsd:element name="Key" type="xsd:string">
2666 <xsd:documentation>The identifier of an option supported by the implementing
2669 </xsd:element>
2670 <xsd:element name="Value" type="xsd:string" minOccurs="0">
2672 <xsd:documentation>The value for an option supported by the implementing
2675 </xsd:element>
2678 <xsd:complexType name="ProcessingOptionsType">
2681 BIAS aggregate services support the ability to include various
2682 processing options which direct and possibly control the business
2683 logic for that service. The ProcessingOptionsType provides a
2684 method to represent those options. Processing options should be
2685 defined by the implementing system.
2688 <xsd:sequence>
2689 <xsd:element name="Option" type="tns:OptionType" minOccurs="0" maxOccurs="unbounded">
2691 <xsd:documentation>An option supported by the implementing
2694 </xsd:element>
2697 <xsd:simpleType name="ProductID">

2699 <xsd:documentation>The vendor's ID for a particular product.</xsd:documentation>
2703 <xsd:complexType name="QualityData">
2705 <xsd:documentation>Contains information about a biometric sample's quality and the algorithm used
2706 to compute the quality.</xsd:documentation>
2708 <xsd:sequence>
2709 <xsd:element name="QualityScore" type="cbeff:QualityType" minOccurs="0" maxOccurs="1">
2711 <xsd:documentation>The quality of a biometric sample.</xsd:documentation>
2713 </xsd:element>
2714 <xsd:element name="AlgorithmVendor" type="tns:VendorIdentifier" minOccurs="1" maxOccurs="1">
2716 <xsd:documentation>The vendor of the qualilty algorithm used to determine the
2717 quality score.</xsd:documentation>
2719 </xsd:element>
2720 <xsd:element name="AlgorithmVendorProductID" type="tns:ProductID" minOccurs="1" maxOccurs="1">
2722 <xsd:documentation>The vendor's ID for the algorithm used to determine the
2723 quality.</xsd:documentation>
2725 </xsd:element>
2726 <xsd:element name="AlgorithmVersion" type="tns:VersionType" minOccurs="0" maxOccurs="1">
2728 <xsd:documentation>The version of the algorithm used to determine the
2729 quality.</xsd:documentation>
2731 </xsd:element>
2734 <xsd:complexType name="RequestTemplate">

2736 <xsd:documentation>Base template for BIAS primitive service requests.</xsd:documentation>
2738 <xsd:sequence>
2739 <xsd:element name="GenericRequestParameters" type="tns:GenericRequestParameters" minOccurs="0"
2743 <xsd:complexType name="ResponseStatus">
2744 <xsd:sequence>
2745 <xsd:element name="Return" type="tns:ReturnCode" minOccurs="1" maxOccurs="1">
2747 <xsd:documentation>The return code indicates the return status of the
2748 operation.</xsd:documentation>
2750 </xsd:element>
2751 <xsd:element name="Message" type="xsd:string" minOccurs="0" maxOccurs="1">
2753 <xsd:documentation>A short message corresponding to the return
2754 code.</xsd:documentation>
2756 </xsd:element>
2759 <xsd:complexType name="ResponseTemplate">
2761 <xsd:documentation>Base template for BIAS responses.</xsd:documentation>
2763 <xsd:sequence>
2764 <xsd:element name="ResponseStatus" type="tns:ResponseStatus" minOccurs="1" maxOccurs="1">
2766 <xsd:documentation>Returned status for the operation.</xsd:documentation>
2768 </xsd:element>
2771 <xsd:simpleType name="ReturnCode">

2773 <xsd:documentation>BIAS Operation Return Codes</xsd:documentation>
2775 <xsd:restriction base="xsd:unsignedLong">
2776 <xsd:enumeration value="0">
2778 <xsd:documentation>Success</xsd:documentation>
2783 <xsd:complexType name="ScoreType">
2785 <xsd:documentation>Match result or quality score.</xsd:documentation>
2787 <xsd:sequence>
2788 <xsd:element name="Value" type="xsd:float"/>
2789 <xsd:element name="BiometricType" type="cbeff:MultipleTypesType" minOccurs="0"/>
2790 <xsd:element name="BiometricSubType" type="cbeff:SubtypeType" minOccurs="0"/>
2793 <xsd:complexType name="TokenType">
2795 <xsd:documentation>Defines a token that is returned for asynchronous
2796 processing.</xsd:documentation>
2798 <xsd:sequence>
2799 <xsd:element name="TokenValue" type="xsd:string" minOccurs="1" maxOccurs="1">
2801 <xsd:documentation>A value returned by the implementing system that is used to
2802 retrieve the results to a service at a later time.</xsd:documentation>
2804 </xsd:element>
2805 <xsd:element name="Expiration" type="xsd:date" minOccurs="1" maxOccurs="1">
2807 <xsd:documentation>A date and time at which point the token expires and the
2808 service results are no longer guaranteed to be available.</xsd:documentation>

2810 </xsd:element>
2813 <xsd:simpleType name="VendorIdentifier">
2815 <xsd:documentation>Identifies a vendor.</xsd:documentation>
2819 <xsd:complexType name="Version">
2822 For a description or definition of each data element, see the
2823 referenced CBEFF standards in the CBEFF_XML_BIR_Type schema.
2826 <xsd:sequence>
2827 <xsd:element name="major" type="xsd:nonNegativeInteger" minOccurs="1" maxOccurs="1"/>
2828 <xsd:element name="minor" type="xsd:nonNegativeInteger" minOccurs="1" maxOccurs="1"/>
2831 <xsd:simpleType name="VersionType">
2833 <xsd:documentation>The version of a component.</xsd:documentation>
2837 <xsd:element name="AddSubjectToGallery">
2841 Register a subject to a given gallery or population group.
2844 <xsd:sequence>
2845 <xsd:element name="AddSubjectToGalleryRequest" nillable="true">

2849 <xsd:sequence>
2850 <xsd:element name="GalleryID" type="tns:BIASIDType"
2853 <xsd:documentation>The identifier of
2854 the gallery or population group to which the subject will be added.</xsd:documentation>
2856 </xsd:element>
2857 <xsd:element name="Identity" type="tns:BIASIdentity"
2860 <xsd:documentation>The identity to
2861 add to the gallery.</xsd:documentation>
2863 </xsd:element>
2868 </xsd:element>
2871 </xsd:element>
2872 <xsd:element name="AddSubjectToGalleryResponse">
2876 The response to an AddSubjectToGallery request.
2879 <xsd:sequence>
2880 <xsd:element name="AddSubjectToGalleryResponsePackage" nillable="true">

2883 <xsd:extension base="tns:ResponseTemplate"/>
2886 </xsd:element>
2889 </xsd:element>
2890 <xsd:element name="CheckQuality">
2894 Calculate a quality score for a given biometric.
2897 <xsd:sequence>
2898 <xsd:element name="CheckQualityRequest" nillable="true">
2902 <xsd:sequence>
2903 <xsd:element name="BiometricData"
2904 type="tns:BIASBiometricDataType" minOccurs="0" maxOccurs="1">
2906 <xsd:documentation>Data structure
2907 containing a single biometric sample for which a quality score is to be determined; required if no SubjectID is
2908 provided.</xsd:documentation>
2910 </xsd:element>
2915 containing a Subject ID associated with a single biometric sample for which a quality score is to be determined; required if no BIR is
2916 provided.</xsd:documentation>
2918 </xsd:element>
2919 <xsd:element name="QualityInfo"
2920 type="tns:QualityData" minOccurs="0" maxOccurs="1">

2922 <xsd:documentation>Specifies a
2923 particular algorithm vendor and vender product ID.</xsd:documentation>
2925 </xsd:element>
2930 </xsd:element>
2933 </xsd:element>
2934 <xsd:element name="CheckQualityResponse">
2938 The response to a CheckQuality request.
2941 <xsd:sequence>
2942 <xsd:element name="CheckQualityResponsePackage" nillable="true">
2946 <xsd:sequence>
2947 <xsd:element name="QualityInfo"
2948 type="tns:QualityData" minOccurs="1" maxOccurs="1">
2950 <xsd:documentation>Contains the
2951 quality information for the submitted biometric sample.</xsd:documentation>
2953 </xsd:element>

2958 </xsd:element>
2961 </xsd:element>
2962 <xsd:element name="ClassifyBiometricData">
2966 Classifies a biometric sample.
2969 <xsd:sequence>
2970 <xsd:element name="ClassifyBiometricDataRequest" nillable="true">
2974 <xsd:sequence>
2975 <xsd:element name="BiometricData"
2976 type="tns:BIASBiometricDataType" minOccurs="1" maxOccurs="1">
2979 containing a single biometric sample for which the classification is to be determined.</xsd:documentation>
2981 </xsd:element>
2982 <xsd:element name="ClassificationData"
2983 type="tns:ClassificationData" minOccurs="0" maxOccurs="1">
2986 algorithm to be used to determine the classification.</xsd:documentation>
2988 </xsd:element>
2993 </xsd:element>

2996 </xsd:element>
2997 <xsd:element name="ClassifyBiometricDataResponse">
3001 The response to a ClassifyBiometricData request, containing
3002 the classification of a biometric sample.
3005 <xsd:sequence>
3006 <xsd:element name="ClassifyBiometricDataResponsePackage" nillable="true">
3010 <xsd:sequence>
3011 <xsd:element name="ClassificationData"
3012 type="tns:ClassificationData" minOccurs="1" maxOccurs="1">
3014 <xsd:documentation>Information on the
3015 results and type of classification performed.</xsd:documentation>
3017 </xsd:element>
3022 </xsd:element>
3025 </xsd:element>
3026 <xsd:element name="CreateEncounter">
3030 Create a new encounter record.

3033 <xsd:sequence>
3034 <xsd:element name="CreateEncounterRequest" nillable="true">
3037 <xsd:extension base="tns:RequestTemplate"/>
3040 </xsd:element>
3043 </xsd:element>
3044 <xsd:element name="CreateEncounterResponse">
3048 The response to a CreateEncounter request, containing the encounter
3049 ID of the new encounter record.
3052 <xsd:sequence>
3053 <xsd:element name="CreateEncounterResponsePackage" nillable="true">
3057 <xsd:sequence>
3062 encounter ID of the new encounter record.</xsd:documentation>
3064 </xsd:element>

3069 </xsd:element>
3072 </xsd:element>
3073 <xsd:element name="CreateSubject">
3077 Create a new subject record.
3080 <xsd:sequence>
3081 <xsd:element name="CreateSubjectRequest" nillable="true">
3087 </xsd:element>
3090 </xsd:element>
3091 <xsd:element name="CreateSubjectResponse">
3095 The response to a CreateSubject request, containing the subject
3096 ID of the new subject record.
3099 <xsd:sequence>
3100 <xsd:element name="CreateSubjectResponsePackage" nillable="true">

3104 <xsd:sequence>
3109 subject ID of the new subject record.</xsd:documentation>
3111 </xsd:element>
3116 </xsd:element>
3119 </xsd:element>
3120 <xsd:element name="DeleteBiographicData">
3124 Erase all of the biographic data associated with a given
3125 subject record or, in the encounter-centric model, with a
3126 given encounter.
3129 <xsd:sequence>
3130 <xsd:element name="DeleteBiographicDataRequest" nillable="true">
3134 <xsd:sequence>
3138 <xsd:documentation>Contains either
3139 the subject ID or encounter ID reference.</xsd:documentation>

3141 </xsd:element>
3146 the gallery or population group from which the biographic information will be deleted.</xsd:documentation>
3148 </xsd:element>
3153 </xsd:element>
3156 </xsd:element>
3157 <xsd:element name="DeleteBiographicDataResponse">
3161 The response to a DeleteBiographicData request.
3164 <xsd:sequence>
3165 <xsd:element name="DeleteBiographicDataResponsePackage" nillable="true">
3171 </xsd:element>
3174 </xsd:element>
3175 <xsd:element name="DeleteBiometricData">

3179 Erase all of the biometric data associated with a given
3180 subject record or, in the encounter-centric model, with a
3181 given encounter.
3184 <xsd:sequence>
3185 <xsd:element name="DeleteBiometricDataRequest" nillable="true">
3189 <xsd:sequence>
3196 </xsd:element>
3197 <xsd:element name="BiometricType"
3198 type="cbeff:MultipleTypesType" minOccurs="0" maxOccurs="1">
3200 <xsd:documentation>The type of
3201 biological or behavioral data to delete, as defined by CBEFF.</xsd:documentation>
3203 </xsd:element>
3208 the gallery or population group from which the biometric information will be deleted.</xsd:documentation>
3210 </xsd:element>

3215 </xsd:element>
3218 </xsd:element>
3219 <xsd:element name="DeleteBiometricDataResponse">
3223 The response to a DeleteBiometricData request.
3226 <xsd:sequence>
3227 <xsd:element name="DeleteBiometricDataResponsePackage" nillable="true">
3233 </xsd:element>
3236 </xsd:element>
3237 <xsd:element name="DeleteDocumentData">
3240 <xsd:documentation>Erase all of the document data associated with a given subject record
3241 or, in the encounter-centric model, with a given encounter.</xsd:documentation>
3243 <xsd:sequence>
3244 <xsd:element name="DeleteDocumentDataRequest" nillable="true">
3248 <xsd:sequence>

3255 </xsd:element>
3256 <xsd:element name="DocumentData"
3257 type="tns:DocumentDataType" minOccurs="0" maxOccurs="1">
3259 <xsd:documentation>Defines a set of
3260 document data elements providing information about the presented identity document. </xsd:documentation>
3262 </xsd:element>
3267 </xsd:element>
3270 </xsd:element>
3271 <xsd:element name="DeleteDocumentDataResponse">
3275 The response to a DeleteDocumentData request.
3278 <xsd:sequence>
3279 <xsd:element name="DeleteDocumentDataResponsePackage" nillable="true">
3285 </xsd:element>

3288 </xsd:element>
3289 <xsd:element name="DeleteEncounter">
3293 Delete an existing encounter record from the system.
3296 <xsd:sequence>
3297 <xsd:element name="DeleteEncounterRequest" nillable="true">
3301 <xsd:sequence>
3305 <xsd:documentation>Subject ID and
3306 encounter ID of the identity to delete.</xsd:documentation>
3308 </xsd:element>
3313 </xsd:element>
3316 </xsd:element>
3317 <xsd:element name="DeleteEncounterResponse">
3321 The response to a DeleteEncounter request.

3324 <xsd:sequence>
3325 <xsd:element name="DeleteEncounterResponsePackage" nillable="true">
3331 </xsd:element>
3334 </xsd:element>
3335 <xsd:element name="DeleteSubject">
3339 Delete an existing subject record and, in an encounter-centric
3340 model, any associated encounter information.
3343 <xsd:sequence>
3344 <xsd:element name="DeleteSubjectRequest" nillable="true">
3348 <xsd:sequence>
3352 <xsd:documentation>Subject ID of the
3353 identity to delete.</xsd:documentation>
3355 </xsd:element>

3360 </xsd:element>
3363 </xsd:element>
3364 <xsd:element name="DeleteSubjectResponse">
3368 The response to a DeleteSubject request.
3371 <xsd:sequence>
3372 <xsd:element name="DeleteSubjectResponsePackage" nillable="true">
3378 </xsd:element>
3381 </xsd:element>
3382 <xsd:element name="DeleteSubjectFromGallery">
3386 Remove the registration of a subject from a gallery or
3387 population group.
3390 <xsd:sequence>
3391 <xsd:element name="DeleteSubjectFromGalleryRequest" nillable="true">

3395 <xsd:sequence>
3400 the gallery or population group from which the subject will be deleted.</xsd:documentation>
3402 </xsd:element>
3406 <xsd:documentation>The identity to
3407 remove from the gallery.</xsd:documentation>
3409 </xsd:element>
3414 </xsd:element>
3417 </xsd:element>
3418 <xsd:element name="DeleteSubjectFromGalleryResponse">
3422 The response to a DeleteSubjectFromGallery request.
3425 <xsd:sequence>
3426 <xsd:element name="DeleteSubjectFromGalleryResponsePackage" nillable="true">

3432 </xsd:element>
3435 </xsd:element>
3436 <xsd:element name="GetIdentifySubjectResults">
3440 Retrieve the identification results for a specified token,
3441 which was returned by the Identify Subject service.
3444 <xsd:sequence>
3445 <xsd:element name="GetIdentifySubjectResultsRequest" nillable="true">
3449 <xsd:sequence>
3450 <xsd:element name="Token" type="tns:TokenType"
3453 <xsd:documentation>A value used to
3454 retrieve the results of an IdentifySubject request.</xsd:documentation>
3456 </xsd:element>
3461 </xsd:element>
3464 </xsd:element>
3465 <xsd:element name="GetIdentifySubjectResultsResponse">

3469 The response to a GetIdentifySubjectResults request, which includes a candidate
3470 list.
3473 <xsd:sequence>
3474 <xsd:element name="GetIdentifySubjectResultsResponsePackage" nillable="true">
3478 <xsd:sequence>
3479 <xsd:element name="CandidateList"
3480 type="tns:CandidateListType" minOccurs="1" maxOccurs="1">
3482 <xsd:documentation>A rank-ordered
3483 list of candidates that have a likelihood of matching the input biometric sample.</xsd:documentation>
3485 </xsd:element>
3490 </xsd:element>
3493 </xsd:element>
3494 <xsd:element name="IdentifySubject">
3498 Perform an identification search against a given gallery for
3499 a given biometric.
3502 <xsd:sequence>
3503 <xsd:element name="IdentifySubjectRequest" nillable="true">

3507 <xsd:sequence>
3512 the gallery or population group which will be searched. Must not be used in conjunction with Gallery parameter</xsd:documentation>
3514 </xsd:element>
3515 <xsd:element name="Gallery"
3518 <xsd:documentation>A list of BIRs to
3519 be used instead of a stored gallery. Must not be used in conjunction with GalleryID parameter.</xsd:documentation>
3521 </xsd:element>
3525 <xsd:documentation>Contains the BIR,
3526 a data structure containing the biometric sample for the search.</xsd:documentation>
3528 </xsd:element>
3529 <xsd:element name="MaxListSize"
3530 type="xsd:positiveInteger" minOccurs="1" maxOccurs="1">
3532 <xsd:documentation>The maximum size
3533 of the candidate list that should be returned.</xsd:documentation>
3535 </xsd:element>
3540 </xsd:element>

3543 </xsd:element>
3544 <xsd:element name="IdentifySubjectResponse">
3548 The response to an IdentifySubject request, returning a
3549 rank-ordered candidate list.
3552 <xsd:sequence>
3553 <xsd:element name="IdentifySubjectResponsePackage" nillable="true">
3557 <xsd:sequence>
3558 <xsd:element name="IdentifySubjectResult"
3559 type="tns:IdentifySubjectResultType"/>
3564 </xsd:element>
3567 </xsd:element>
3568 <xsd:complexType name="IdentifySubjectResultType">
3569 <xsd:sequence/>
3571 <xsd:complexType name="CandidateListResultType">
3573 <xsd:extension base="tns:IdentifySubjectResultType">
3574 <xsd:sequence>
3575 <xsd:element name="CandidateList" type="tns:CandidateListType" minOccurs="0"
3576 maxOccurs="1">

3578 <xsd:documentation>A rank-ordered list of candidates that have a
3579 likelihood of matching the input biometric sample; returned with successful synchronous request processing.</xsd:documentation>
3581 </xsd:element>
3586 <xsd:complexType name="TokenResultType">
3588 <xsd:extension base="tns:IdentifySubjectResultType">
3589 <xsd:sequence>
3590 <xsd:element name="Token" type="tns:TokenType" minOccurs="0" maxOccurs="1">
3592 <xsd:documentation>A token used to retrieve the results of the
3593 IdentifySubject request; returned with asynchronous request processing.</xsd:documentation>
3595 </xsd:element>
3600 <xsd:element name="ListBiographicData">
3604 Lists the biographic data elements stored for a subject.
3607 <xsd:sequence>
3608 <xsd:element name="ListBiographicDataRequest" nillable="true">
3612 <xsd:sequence>

3616 <xsd:documentation>Identifies the
3617 subject or, in the encounter-centric model, a subject and an encounter.</xsd:documentation>
3619 </xsd:element>
3620 <xsd:element name="EncounterType"
3621 type="tns:EncounterCategoryType" minOccurs="0" maxOccurs="1">
3624 category of encounter. If an encounter ID is not specified
3625 and encounter data exists for
3626 the subject, the operation returns the list of encounter IDs of a specific
3627 type which contain biographic
3628 data using the Encounter List output parameter, and the Biographic
3629 Data Elements output parameter
3630 is empty. Should not be used in conjunction with EncounterID.
3633 </xsd:element>
3638 </xsd:element>
3641 </xsd:element>
3642 <xsd:element name="ListBiographicDataResponse">
3646 The response to a ListBiographicData request, containing a list
3647 of biographic data elements stored for a subject. In the
3648 encounter-centric model, the biographic data elements for a
3649 specific encounter are returned. If an encounter ID is not
3650 specified and encounter data exists for the subject, the list
3651 of encounter IDs which contain biographic data is returned.

3654 <xsd:sequence>
3655 <xsd:element name="ListBiographicDataResponsePackage" nillable="true">
3659 <xsd:sequence>
3664 Contains a list of biographic
3665 data elements associated with a
3666 subject or encounter; non-
3667 empty if the service was
3668 successful, biographic data
3669 exists, and either (a) the
3670 person-centric model is being
3671 used or (b) the
3672 encounter-centric model is
3673 being used and an encounter
3674 identifier was specified.
3677 </xsd:element>
3682 </xsd:element>
3685 </xsd:element>
3686 <xsd:element name="ListBiometricData">
3690 Lists the biometric data elements stored for a subject. Note

3691 that no actual biometric data is returned by this service (see
3692 the RetrieveBiometricData service to obtain the biometric
3693 data).
3696 <xsd:sequence>
3697 <xsd:element name="ListBiometricDataRequest" nillable="true">
3701 <xsd:sequence>
3708 </xsd:element>
3713 category of encounter. If an encounter ID is not specified and
3714 encounter data exists for the
3715 subject, the operation may return the list of encounter IDs of a specific
3716 type which contain biometric
3717 data using the Encounter List output parameter, and the Biometric Data
3718 List output parameter is
3719 empty. Should not be used in conjunction with EncounterID.
3722 </xsd:element>
3723 <xsd:element name="ListFilter"
3724 type="tns:ListFilterType" minOccurs="0" maxOccurs="1">
3726 <xsd:documentation>Indicates what
3727 biometric information should be returned.</xsd:documentation>

3729 </xsd:element>
3734 </xsd:element>
3737 </xsd:element>
3738 <xsd:element name="ListBiometricDataResponse">
3742 The response to a ListBiometricData request, containing a list
3743 of biometric data elements stored for a subject. In the
3744 encounter-centric model, the biometric data elements for a
3745 specific encounter are returned. If an encounter ID is not
3747 of encounter IDs which contain biometric data is returned.
3750 <xsd:sequence>
3751 <xsd:element name="ListBiometricDataResponsePackage" nillable="true">
3755 <xsd:sequence>
3756 <xsd:element name="Identity"
3757 type="tns:BIASIdentity">
3760 Includes a list of biometric
3761 data elements associated
3762 with a subject or encounter or
3763 a list of encounter ID's
3764 associated with a subject and
3765 which contain biometric

3766 data.
3769 </xsd:element>
3774 </xsd:element>
3777 </xsd:element>
3778 <xsd:element name="ListDocumentData">
3782 Lists the document categories stored for a subject.
3785 <xsd:sequence>
3786 <xsd:element name="ListDocumentDataRequest" nillable="true">
3790 <xsd:sequence>
3797 </xsd:element>
3802 category of encounter. If an encounter ID is not specified and encounter data exists for the

3803 subject, the operation shall return
3804 the list of encounter IDs which contain document data using the Encounter List Output parameter,
3805 and the Document Data Elements output
3806 parameter shall be empty. Should not be used in conjunction with EncounterID.
3809 </xsd:element>
3814 </xsd:element>
3817 </xsd:element>
3818 <xsd:element name="ListDocumentDataResponse">
3822 The response to a ListDocumentData request, containing a list of document
3823 categories stored for a subject.
3824 In the encounter-centric model, an encounterID may be specified to indicate that
3825 only document data categories
3826 stored for that encounter should be returned. If an encounter ID is not
3828 of encounter IDs which contain document data is returned.
3831 <xsd:sequence>
3832 <xsd:element name="ListDocumentDataResponsePackage" nillable="true">
3836 <xsd:sequence>
3837 <xsd:element name="DocumentDataList"
3838 type="tns:DocumentDataListType" minOccurs="0" maxOccurs="1">

3841 A list of document categories
3842 associated with a subject or encounter; non-empty if the service
3843 was successful, document data
3844 exists, and either the person-centric model is being used or the
3845 encounter-centric model is
3846 being used and an encounter identifier was specified.
3849 </xsd:element>
3854 A list of encounter IDs
3855 associated with a subject and which contain document data; non-empty
3856 if the service was successful,
3857 document data exists, the encounter-centric model is being used,
3858 and an encounter identifier
3859 was not specified..
3862 </xsd:element>
3867 </xsd:element>
3870 </xsd:element>
3871 <xsd:element name="PerformFusion">
3875 Accepts either match score or match decision information and creates a fused match
3876 result.

3879 <xsd:sequence>
3880 <xsd:element name="PerformFusionRequest" nillable="true">
3884 <xsd:sequence>
3885 <xsd:element name="FusionInput"
3886 type="tns:FusionIdentityListType" minOccurs="1" maxOccurs="1">
3888 <xsd:documentation>Score or decision
3889 input information to the fusion method for each identity.</xsd:documentation>
3891 </xsd:element>
3896 </xsd:element>
3899 </xsd:element>
3900 <xsd:element name="PerformFusionResponse">
3904 The response to the PerformFusion request.
3907 <xsd:sequence>
3908 <xsd:element name="PerformFusionResponsePackage" nillable="true">
3912 <xsd:sequence>
3913 <xsd:element name="Match" type="tns:MatchType"

3916 <xsd:documentation>Indicates the
3917 result of the fusion method</xsd:documentation>
3919 </xsd:element>
3924 </xsd:element>
3927 </xsd:element>
3928 <xsd:element name="QueryCapabilities">
3932 Returns a list of the capabilities, options, galleries, etc.
3933 that are supported by the BIAS implementation.
3936 <xsd:sequence>
3937 <xsd:element name="QueryCapabilitiesRequest" nillable="true">
3943 </xsd:element>
3946 </xsd:element>
3947 <xsd:element name="QueryCapabilitiesResponse">

3951 The response to a QueryCapabilities request.
3954 <xsd:sequence>
3955 <xsd:element name="QueryCapabilitiesResponsePackage" nillable="true">
3959 <xsd:sequence>
3960 <xsd:element name="CapabilityList"
3961 type="tns:CapabilityListType" minOccurs="1" maxOccurs="1">
3963 <xsd:documentation>A list of
3964 capabilities supported by the BIAS implementation.</xsd:documentation>
3966 </xsd:element>
3971 </xsd:element>
3974 </xsd:element>
3975 <xsd:element name="RetrieveBiographicData">
3979 Retrieves the biographic data associated with a subject ID.
3982 <xsd:sequence>
3983 <xsd:element name="RetrieveBiographicDataRequest" nillable="true">

3987 <xsd:sequence>
3994 </xsd:element>
3999 type of encounter during which data was collected from the subject,
4000 as determined by the requester.
4003 </xsd:element>
4008 the gallery or population group from which the biographic information will be retrieved.</xsd:documentation>
4010 </xsd:element>
4015 </xsd:element>
4018 </xsd:element>
4019 <xsd:element name="RetrieveBiographicDataResponse">
4023 The response to a RetrieveBiographicData request,
4024 containing the biographic data associated with a subject ID. In

4025 the encounter-centric model, the biographic data associated with
4026 a specified encounter is returned. If the encounter ID is not
4027 specified in the encounter-centric model, the biographic
4028 information associated with the most recent encounter is returned.
4031 <xsd:sequence>
4032 <xsd:element name="RetrieveBiographicDataResponsePackage" nillable="true">
4036 <xsd:sequence>
4040 <xsd:documentation>Includes the set
4041 of biographic data associated with a subject.</xsd:documentation>
4043 </xsd:element>
4048 </xsd:element>
4051 </xsd:element>
4052 <xsd:element name="RetrieveBiometricData">
4056 Retrieves the biometric data associated with a subject ID.
4059 <xsd:sequence>
4060 <xsd:element name="RetrieveBiometricDataRequest" nillable="true">

4064 <xsd:sequence>
4071 </xsd:element>
4076 type of encounter during which data was collected from the subject,
4077 as determined by the requester.
4080 </xsd:element>
4085 the gallery or population group from which the biometric information will be retrieved.</xsd:documentation>
4087 </xsd:element>
4088 <xsd:element name="BiometricType"
4089 type="cbeff:MultipleTypesType" minOccurs="0" maxOccurs="1">
4091 <xsd:documentation>The type of
4092 biological or behavioral data to retrieve.</xsd:documentation>
4094 </xsd:element>

4099 </xsd:element>
4102 </xsd:element>
4103 <xsd:element name="RetrieveBiometricDataResponse">
4107 The response to a RetrieveBiometricData request,
4108 containing the biometric data associated with a subject ID. In
4109 the encounter-centric model, the biometric data associated with
4110 a specified encounter is returned. If the encounter ID is not
4111 specified in the encounter-centric model, the biometric
4112 information associated with the most recent encounter is returned.
4115 <xsd:sequence>
4116 <xsd:element name="RetrieveBiometricDataResponsePackage" nillable="true">
4120 <xsd:sequence>
4124 <xsd:documentation>Includes the
4125 biometric data associated with a subject.</xsd:documentation>
4127 </xsd:element>
4132 </xsd:element>

4135 </xsd:element>
4136 <xsd:element name="RetrieveDocumentData">
4139 <xsd:documentation>Retrieves the list of document data associated with a subject ID for
4140 the category(ies) specified. </xsd:documentation>
4142 <xsd:sequence>
4143 <xsd:element name="RetrieveDocumentDataRequest" nillable="true">
4147 <xsd:sequence>
4154 </xsd:element>
4155 <xsd:element name="DocumentData"
4156 type="tns:DocumentDataType" minOccurs="0" maxOccurs="1">
4159 document data elements providing information about the requested identity document. </xsd:documentation>
4161 </xsd:element>
4166 category of encounter.</xsd:documentation>
4168 </xsd:element>

4173 the gallery or population group from which the biographic information will be retrieved. </xsd:documentation>
4175 </xsd:element>
4180 </xsd:element>
4183 </xsd:element>
4184 <xsd:element name="RetrieveDocumentDataResponse">
4188 The response to a RetrieveDocumentData request.
4191 <xsd:sequence>
4192 <xsd:element name="RetrieveDocumentDataResponsePackage" nillable="true">
4198 </xsd:element>
4199 <xsd:element name="DocumentDataList" type="tns:DocumentDataListType" minOccurs="1"
4200 maxOccurs="1">
4202 <xsd:documentation>A list of document data associated with a subject or
4203 encounter</xsd:documentation>
4205 </xsd:element>
4208 </xsd:element>

4209 <xsd:element name="SetBiographicData">
4213 Associates biographic data to a given subject record.
4216 <xsd:sequence>
4217 <xsd:element name="SetBiographicDataRequest" nillable="true">
4221 <xsd:sequence>
4226 subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to store.</xsd:documentation>
4228 </xsd:element>
4233 the gallery or population group to which the biographic will be added.</xsd:documentation>
4235 </xsd:element>
4240 </xsd:element>
4243 </xsd:element>
4244 <xsd:element name="SetBiographicDataResponse">

4248 The response to a SetBiographicData request.
4251 <xsd:sequence>
4252 <xsd:element name="SetBiographicDataResponsePackage" nillable="true">
4256 <xsd:sequence>
4260 <xsd:documentation>In an encounter-
4261 centric model, identifies the encounter ID assigned to a new encounter.</xsd:documentation>
4263 </xsd:element>
4268 </xsd:element>
4271 </xsd:element>
4272 <xsd:element name="SetBiometricData">
4276 Associates biometric data to a given subject record.
4279 <xsd:sequence>
4280 <xsd:element name="SetBiometricDataRequest" nillable="true">

4284 <xsd:sequence>
4289 subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to store.</xsd:documentation>
4291 </xsd:element>
4296 the gallery or population group to which the biometric will be added.</xsd:documentation>
4298 </xsd:element>
4303 </xsd:element>
4306 </xsd:element>
4307 <xsd:element name="SetBiometricDataResponse">
4311 The response to a SetBiometricData request.
4314 <xsd:sequence>
4315 <xsd:element name="SetBiometricDataResponsePackage" nillable="true">

4319 <xsd:sequence>
4326 </xsd:element>
4331 </xsd:element>
4334 </xsd:element>
4335 <xsd:element name="SetDocumentData">
4339 Associates document data to a given subject record.
4342 <xsd:sequence>
4343 <xsd:element name="SetDocumentDataRequest" nillable="true">
4347 <xsd:sequence>
4352 subject or, in the encounter-centric model, a subject and an encounter, and includes the document data to store.</xsd:documentation>
4354 </xsd:element>

4359 the gallery or population group to which the document data will be added.</xsd:documentation>
4361 </xsd:element>
4366 document data elements to associate with the subject or encounter. </xsd:documentation>
4368 </xsd:element>
4373 </xsd:element>
4376 </xsd:element>
4377 <xsd:element name="SetDocumentDataResponse">
4381 The response to a SetDocumentData request.
4384 <xsd:sequence>
4385 <xsd:element name="SetDocumentDataResponsePackage" nillable="true">
4389 <xsd:sequence>

4396 </xsd:element>
4401 </xsd:element>
4404 </xsd:element>
4405 <xsd:element name="TransformBiometricData">
4409 Transforms or processes a given biometric in one format into a new target format.
4412 <xsd:sequence>
4413 <xsd:element name="TransformBiometricDataRequest" nillable="true">
4417 <xsd:sequence>
4418 <xsd:element name="InputBIR"
4419 type="tns:CBEFF_BIR_Type" minOccurs="1" maxOccurs="1">
4422 containing the biometric information to be transformed.</xsd:documentation>
4424 </xsd:element>
4425 <xsd:element name="TransformOperation"
4426 type="xsd:unsignedLong" minOccurs="1" maxOccurs="1">

4428 <xsd:documentation>Value indicating
4429 the type of transformation to perform.</xsd:documentation>
4431 </xsd:element>
4432 <xsd:element name="TransformControl"
4433 type="xsd:string" minOccurs="0" maxOccurs="1">
4435 <xsd:documentation> Specifies
4436 controls for the requested transform operation.</xsd:documentation>
4438 </xsd:element>
4443 </xsd:element>
4446 </xsd:element>
4447 <xsd:element name="TransformBiometricDataResponse">
4451 The response to a TransformBiometricData request.
4454 <xsd:sequence>
4455 <xsd:element name="TransformBiometricDataResponsePackage" nillable="true">
4459 <xsd:sequence>
4460 <xsd:element name="OutputBIR"
4461 type="tns:CBEFF_BIR_Type" minOccurs="1" maxOccurs="1">
4464 containing the new, transformed biometric information.</xsd:documentation>

4466 </xsd:element>
4471 </xsd:element>
4474 </xsd:element>
4475 <xsd:element name="UpdateBiographicData">
4479 Updates the biographic data for a given subject record.
4482 <xsd:sequence>
4483 <xsd:element name="UpdateBiographicDataRequest" nillable="true">
4487 <xsd:sequence>
4492 subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to update.</xsd:documentation>
4494 </xsd:element>
4499 </xsd:element>

4502 </xsd:element>
4503 <xsd:element name="UpdateBiographicDataResponse">
4507 The response to an UpdateBiographicData request.
4510 <xsd:sequence>
4511 <xsd:element name="UpdateBiographicDataResponsePackage" nillable="true">
4517 </xsd:element>
4520 </xsd:element>
4521 <xsd:element name="UpdateBiometricData">
4525 Updates a single biometric sample for a given subject record.
4528 <xsd:sequence>
4529 <xsd:element name="UpdateBiometricDataRequest" nillable="true">
4533 <xsd:sequence>

4538 subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to update.</xsd:documentation>
4540 </xsd:element>
4541 <xsd:element name="Merge" type="xsd:boolean"
4544 <xsd:documentation>Value indicating
4545 if the input biometric sample should be merged with any existing biometric information.</xsd:documentation>
4547 </xsd:element>
4552 </xsd:element>
4555 </xsd:element>
4556 <xsd:element name="UpdateBiometricDataResponse">
4560 The response to an UpdateBiometricData request.
4563 <xsd:sequence>
4564 <xsd:element name="UpdateBiometricDataResponsePackage" nillable="true">
4570 </xsd:element>
4573 </xsd:element>

4574 <xsd:element name="UpdateDocumentData">
4578 Updates the document data for a given subject record.
4581 <xsd:sequence>
4582 <xsd:element name="UpdateDocumentDataRequest" nillable="true">
4586 <xsd:sequence>
4591 subject or, in the encounter-centric model, a subject and an encounter, and includes the document data to update.</xsd:documentation>
4593 </xsd:element>
4598 updated document data elements to associate with the subject or encounter. </xsd:documentation>
4600 </xsd:element>
4605 </xsd:element>
4608 </xsd:element>
4609 <xsd:element name="UpdateDocumentDataResponse">

4613 The response to an UpdateDocumentData request.
4616 <xsd:sequence>
4617 <xsd:element name="UpdateDocumentDataResponsePackage" nillable="true">
4623 </xsd:element>
4626 </xsd:element>
4627 <xsd:element name="VerifySubject">
4631 Performs a 1:1 verification match between a given biometric and
4632 either a claim to identity in a given gallery or another given
4633 biometric.
4636 <xsd:sequence>
4637 <xsd:element name="VerifySubjectRequest" nillable="true">
4641 <xsd:sequence>
4646 the gallery or population group of which the subject must be a member.</xsd:documentation>

4648 </xsd:element>
4653 identifying information and/or input and reference biometric samples.</xsd:documentation>
4655 </xsd:element>
4656 <xsd:element name="InputData"
4657 type="tns:InformationType" minOccurs="0" maxOccurs="1">
4660 output data for the response.</xsd:documentation>
4662 </xsd:element>
4667 </xsd:element>
4670 </xsd:element>
4671 <xsd:element name="VerifySubjectResponse">
4675 The response to a VerifySubject request.
4678 <xsd:sequence>
4679 <xsd:element name="VerifySubjectResponsePackage" nillable="true">
4683 <xsd:sequence>

4684 <xsd:element name="Match" type="xsd:boolean"
4687 <xsd:documentation>Indicates if the
4688 Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.</xsd:documentation>
4690 </xsd:element>
4691 <xsd:element name="Score" type="tns:ScoreType"
4694 <xsd:documentation>The score if the
4695 biometric information matched.</xsd:documentation>
4697 </xsd:element>
4702 </xsd:element>
4705 </xsd:element>
4706 <xsd:element name="Delete">
4710 The Delete operation deletes an existing subject or, in an encounter-centric model, an
4711 existing encounter from the
4712 system.
4715 <xsd:sequence>
4716 <xsd:element name="DeleteRequest" nillable="true">
4719 <xsd:extension base="tns:AggregateRequestTemplate">
4720 <xsd:sequence>

4724 <xsd:documentation>The identifier for
4725 the subject, or in encounter-centric model the encounter to be
4726 deleted; required for encounter-
4727 centric models.</xsd:documentation>
4729 </xsd:element>
4734 </xsd:element>
4737 </xsd:element>
4738 <xsd:element name="DeleteResponse">
4741 <xsd:documentation>The response to an Delete request.</xsd:documentation>
4743 <xsd:sequence>
4744 <xsd:element name="DeleteResponsePackage" nillable="true">
4747 <xsd:extension base="tns:AggregateResponseTemplate">
4748 <xsd:sequence>
4753 the subject, or in encounter-centric model, the encounter being deleted;
4754 required for encounter-centric
4755 models.</xsd:documentation>
4757 </xsd:element>

4762 retrieve the results of the Delete request.</xsd:documentation>
4764 </xsd:element>
4769 </xsd:element>
4772 </xsd:element>
4773 <xsd:element name="Enrol">
4777 The Enrol aggregate service adds a new subject or, in an
4778 encounter-centric model, a new encounter to the system.
4781 <xsd:sequence>
4782 <xsd:element name="EnrolRequest" nillable="true">
4786 <xsd:sequence>
4791 the encounter; required for encounter-centric models.</xsd:documentation>
4793 </xsd:element>

4798 </xsd:element>
4801 </xsd:element>
4802 <xsd:element name="EnrolResponse">
4805 <xsd:documentation>The response to an Enrol request.</xsd:documentation>
4807 <xsd:sequence>
4808 <xsd:element name="EnrolResponsePackage" nillable="true">
4812 <xsd:sequence>
4817 the encounter; required for encounter-centric models.</xsd:documentation>
4819 </xsd:element>
4824 retrieve the results of the Enrol request.</xsd:documentation>
4826 </xsd:element>
4831 </xsd:element>

4834 </xsd:element>
4835 <xsd:element name="GetDeletionResults">
4839 The GetDeletionResults operation retrieves the deletion results for the specified
4840 token.
4843 <xsd:sequence>
4844 <xsd:element name="GetDeletionResultsRequest" nillable="true">
4848 <xsd:sequence>
4853 retrieve the results of the Deletion request.</xsd:documentation>
4855 </xsd:element>
4860 </xsd:element>
4863 </xsd:element>
4864 <xsd:element name="GetDeletionResultsResponse">
4867 <xsd:documentation>The response to a GetDeletionResults request.</xsd:documentation>

4869 <xsd:sequence>
4870 <xsd:element name="GetDeletionResultsResponsePackage" nillable="true">
4874 <xsd:sequence>
4875 <xsd:element name="ReturnData"
4876 type="tns:InformationType" minOccurs="0" maxOccurs="1">
4879 output data for the response.</xsd:documentation>
4881 </xsd:element>
4886 </xsd:element>
4889 </xsd:element>
4890 <xsd:element name="GetEnrolResults">
4894 The GetEnrolResults aggregate service retrieves the enrolment
4895 results for the specified token.
4898 <xsd:sequence>
4899 <xsd:element name="GetEnrolResultsRequest" nillable="true">
4903 <xsd:sequence>

4908 retrieve the results of the Enrol request.</xsd:documentation>
4910 </xsd:element>
4915 </xsd:element>
4918 </xsd:element>
4919 <xsd:element name="GetEnrolResultsResponse">
4922 <xsd:documentation>The response to a GetEnrolResults request.</xsd:documentation>
4924 <xsd:sequence>
4925 <xsd:element name="GetEnrolResultsResponsePackage" nillable="true">
4929 <xsd:sequence>
4934 the subject, and in encounter-centric models, the encounter.</xsd:documentation>
4936 </xsd:element>
4941 </xsd:element>

4944 </xsd:element>
4945 <xsd:element name="GetIdentifyResults">
4949 The GetIdentifyResults aggregate service retrieves the
4950 identification results for the specified token.
4953 <xsd:sequence>
4954 <xsd:element name="GetIdentifyResultsRequest" nillable="true">
4958 <xsd:sequence>
4963 retrieve the results of the Identify request.</xsd:documentation>
4965 </xsd:element>
4970 </xsd:element>
4973 </xsd:element>
4974 <xsd:element name="GetIdentifyResultsResponse">
4977 <xsd:documentation>The response to a GetIdentifyResults request.</xsd:documentation>

4979 <xsd:sequence>
4980 <xsd:element name="GetIdentifyResultsResponsePackage" nillable="true">
4984 <xsd:sequence>
4989 the encounter, if assigned.</xsd:documentation>
4991 </xsd:element>
4996 list of candidates that have a likelihood of matching the
4997 input biometric
4998 sample.</xsd:documentation>
5000 </xsd:element>
5005 </xsd:element>
5008 </xsd:element>
5009 <xsd:element name="GetUpdateResults">
5013 The GetUpdateResults operation retrieves the update results for the specified
5014 token.

5017 <xsd:sequence>
5018 <xsd:element name="GetUpdateResultsRequest" nillable="true">
5022 <xsd:sequence>
5027 retrieve the results of the Update request.</xsd:documentation>
5029 </xsd:element>
5034 </xsd:element>
5037 </xsd:element>
5038 <xsd:element name="GetUpdateResultsResponse">
5041 <xsd:documentation>The response to a GetUpdateResults request.</xsd:documentation>
5043 <xsd:sequence>
5044 <xsd:element name="GetUpdateResultsResponsePackage" nillable="true">
5048 <xsd:sequence>

5053 </xsd:element>
5056 </xsd:element>
5057 <xsd:element name="GetVerifyResults">
5061 The GetVerifyResults aggregate service retrieves the verification
5062 results for the specified token.
5065 <xsd:sequence>
5066 <xsd:element name="GetVerifyResultsRequest" nillable="true">
5070 <xsd:sequence>
5075 retrieve the results of the Verify request.</xsd:documentation>
5077 </xsd:element>
5082 </xsd:element>
5085 </xsd:element>
5086 <xsd:element name="GetVerifyResultsResponse">

5089 <xsd:documentation>The response to a GetVerifyResults request.</xsd:documentation>
5091 <xsd:sequence>
5092 <xsd:element name="GetVerifyResultsResponsePackage" nillable="true">
5096 <xsd:sequence>
5101 Input BIR matched either the biometric information
5102 associated with the Identity Claim or
5103 the Reference BIR.</xsd:documentation>
5105 </xsd:element>
5112 </xsd:element>
5119 </xsd:element>
5124 </xsd:element>

5127 </xsd:element>
5128 <xsd:element name="Identify">
5132 The Identify aggregate service performs an identification
5133 function according to system requirements and/or resources.
5136 <xsd:sequence>
5137 <xsd:element name="IdentifyRequest" nillable="true">
5141 <xsd:sequence>
5146 the gallery or population group which will be searched.</xsd:documentation>
5148 </xsd:element>
5149 <xsd:element name="MaxListSize"
5150 type="xsd:positiveInteger" minOccurs="1" maxOccurs="1">
5152 <xsd:documentation>The maximum size
5153 of the candidate list that should be returned.</xsd:documentation>
5155 </xsd:element>
5160 </xsd:element>
5163 </xsd:element>

5164 <xsd:element name="IdentifyResponse">
5167 <xsd:documentation>The response to an Identify request.</xsd:documentation>
5169 <xsd:sequence>
5170 <xsd:element name="IdentifyResponsePackage" nillable="true">
5174 <xsd:sequence>
5181 </xsd:element>
5186 list of candidates that have a likelihood of matching the input
5187 biometric sample; returned with
5188 successful, synchronous processing.</xsd:documentation>
5190 </xsd:element>
5195 retrieve the results of the Identify request.</xsd:documentation>
5197 </xsd:element>

5202 </xsd:element>
5205 </xsd:element>
5206 <xsd:element name="RetrieveData">
5210 The RetrieveData aggregate service retrieves requested
5211 information about a subject, or in an encounter-centric model
5212 about an encounter.
5215 <xsd:sequence>
5216 <xsd:element name="RetrieveDataRequest" nillable="true">
5220 <xsd:sequence>
5221 <xsd:element name="ProcessingOptions"
5222 type="tns:ProcessingOptionsType" minOccurs="1" maxOccurs="1">
5224 <xsd:documentation>Options that guide
5225 how the service request is processed, and may identify what
5226 type(s) of information should be
5227 returned.</xsd:documentation>
5229 </xsd:element>
5234 identifier of the subject or encounter.</xsd:documentation>
5236 </xsd:element>

5241 </xsd:element>
5244 </xsd:element>
5245 <xsd:element name="RetrieveDataResponse">
5248 <xsd:documentation>The response to a RetrieveData request.</xsd:documentation>
5250 <xsd:sequence>
5251 <xsd:element name="RetrieveDataResponsePackage" nillable="true">
5254 <xsd:extension base="tns:AggregateResponseTemplate"/>
5257 </xsd:element>
5260 </xsd:element>
5261 <xsd:element name="Update">
5265 The Update operation updates specified information about a subject, or in an
5266 encounter-centric model about an encounter.
5269 <xsd:sequence>
5270 <xsd:element name="UpdateRequest" nillable="true">
5274 <xsd:sequence>

5279 identifier of the subject or encounter.</xsd:documentation>
5281 </xsd:element>
5286 </xsd:element>
5289 </xsd:element>
5290 <xsd:element name="UpdateResponse">
5293 <xsd:documentation>The response to a Update request.</xsd:documentation>
5295 <xsd:sequence>
5296 <xsd:element name="UpdateResponsePackage" nillable="true">
5300 <xsd:sequence>
5305 retrieve the results of the Update request.</xsd:documentation>
5307 </xsd:element>

5312 </xsd:element>
5315 </xsd:element>
5316 <xsd:element name="Verify">
5320 The Verify aggregate service performs a 1:1 verification
5321 function according to system requirements and/or resources.
5322 Either the IdentityClaim or ReferenceBIR input data elements in
5323 the Identity parameter are required.
5326 <xsd:sequence>
5327 <xsd:element name="VerifyRequest" nillable="true">
5331 <xsd:sequence>
5335 <xsd:documentation>Includes either
5336 the IdentityClaim or ReferenceBIR.</xsd:documentation>
5338 </xsd:element>
5343 the gallery or population group of which the subject must be a member.</xsd:documentation>
5345 </xsd:element>

5350 </xsd:element>
5353 </xsd:element>
5354 <xsd:element name="VerifyResponse">
5357 <xsd:documentation>The response to a Verify request.</xsd:documentation>
5359 <xsd:sequence>
5360 <xsd:element name="VerifyResponsePackage" nillable="true">
5364 <xsd:sequence>
5369 Input BIR matched either the biometric information
5370 associated with the Identity Claim or
5371 the Reference BIR.</xsd:documentation>
5373 </xsd:element>
5380 </xsd:element>

5387 </xsd:element>
5392 retrieve the results of the Verify request; </xsd:documentation>
5394 </xsd:element>
5399 </xsd:element>
5402 </xsd:element>
5403 <xsd:element name="BIASFault" type="tns:BIASFaultDetail"/>
5404 </xsd:schema>
5405 </wsdl:types>
5406 <wsdl:message name="BIASFaultMessage">
5407 <wsdl:part name="parameters" element="tns:BIASFault"/>
5408 </wsdl:message>
5409 <wsdl:message name="AddSubjectToGalleryRequestMessage">
5410 <wsdl:part name="parameters" element="tns:AddSubjectToGallery"/>
5412 <wsdl:message name="AddSubjectToGalleryResponseMessage">
5413 <wsdl:part name="parameters" element="tns:AddSubjectToGalleryResponse"/>
5415 <wsdl:message name="CheckQualityRequestMessage">
5416 <wsdl:part name="parameters" element="tns:CheckQuality"/>
5418 <wsdl:message name="CheckQualityResponseMessage">
5419 <wsdl:part name="parameters" element="tns:CheckQualityResponse"/>
5421 <wsdl:message name="ClassifyBiometricDataRequestMessage">
5422 <wsdl:part name="parameters" element="tns:ClassifyBiometricData"/>

5424 <wsdl:message name="ClassifyBiometricDataResponseMessage">
5425 <wsdl:part name="parameters" element="tns:ClassifyBiometricDataResponse"/>
5427 <wsdl:message name="CreateSubjectRequestMessage">
5428 <wsdl:part name="parameters" element="tns:CreateSubject"/>
5430 <wsdl:message name="CreateSubjectResponseMessage">
5431 <wsdl:part name="parameters" element="tns:CreateSubjectResponse"/>
5433 <wsdl:message name="DeleteBiographicDataRequestMessage">
5434 <wsdl:part name="parameters" element="tns:DeleteBiographicData"/>
5436 <wsdl:message name="DeleteBiographicDataResponseMessage">
5437 <wsdl:part name="parameters" element="tns:DeleteBiographicDataResponse"/>
5439 <wsdl:message name="DeleteBiometricDataRequestMessage">
5440 <wsdl:part name="parameters" element="tns:DeleteBiometricData"/>
5442 <wsdl:message name="DeleteBiometricDataResponseMessage">
5443 <wsdl:part name="parameters" element="tns:DeleteBiometricDataResponse"/>
5445 <wsdl:message name="DeleteSubjectRequestMessage">
5446 <wsdl:part name="parameters" element="tns:DeleteSubject"/>
5448 <wsdl:message name="DeleteSubjectResponseMessage">
5449 <wsdl:part name="parameters" element="tns:DeleteSubjectResponse"/>
5451 <wsdl:message name="DeleteSubjectFromGalleryRequestMessage">
5452 <wsdl:part name="parameters" element="tns:DeleteSubjectFromGallery"/>
5454 <wsdl:message name="DeleteSubjectFromGalleryResponseMessage">
5455 <wsdl:part name="parameters" element="tns:DeleteSubjectFromGalleryResponse"/>
5457 <wsdl:message name="GetIdentifySubjectResultsRequestMessage">
5458 <wsdl:part name="parameters" element="tns:GetIdentifySubjectResults"/>

5460 <wsdl:message name="GetIdentifySubjectResultsResponseMessage">
5461 <wsdl:part name="parameters" element="tns:GetIdentifySubjectResultsResponse"/>
5463 <wsdl:message name="IdentifySubjectRequestMessage">
5464 <wsdl:part name="parameters" element="tns:IdentifySubject"/>
5466 <wsdl:message name="IdentifySubjectResponseMessage">
5467 <wsdl:part name="parameters" element="tns:IdentifySubjectResponse"/>
5469 <wsdl:message name="ListBiographicDataRequestMessage">
5470 <wsdl:part name="parameters" element="tns:ListBiographicData"/>
5472 <wsdl:message name="ListBiographicDataResponseMessage">
5473 <wsdl:part name="parameters" element="tns:ListBiographicDataResponse"/>
5475 <wsdl:message name="ListBiometricDataRequestMessage">
5476 <wsdl:part name="parameters" element="tns:ListBiometricData"/>
5478 <wsdl:message name="ListBiometricDataResponseMessage">
5479 <wsdl:part name="parameters" element="tns:ListBiometricDataResponse"/>
5481 <wsdl:message name="PerformFusionRequestMessage">
5482 <wsdl:part name="parameters" element="tns:PerformFusion"/>
5484 <wsdl:message name="PerformFusionResponseMessage">
5485 <wsdl:part name="parameters" element="tns:PerformFusionResponse"/>
5487 <wsdl:message name="QueryCapabilitiesRequestMessage">
5488 <wsdl:part name="parameters" element="tns:QueryCapabilities"/>
5490 <wsdl:message name="QueryCapabilitiesResponseMessage">
5491 <wsdl:part name="parameters" element="tns:QueryCapabilitiesResponse"/>
5493 <wsdl:message name="RetrieveBiographicDataRequestMessage">
5494 <wsdl:part name="parameters" element="tns:RetrieveBiographicData"/>

5496 <wsdl:message name="RetrieveBiographicDataResponseMessage">
5497 <wsdl:part name="parameters" element="tns:RetrieveBiographicDataResponse"/>
5499 <wsdl:message name="RetrieveBiometricDataRequestMessage">
5500 <wsdl:part name="parameters" element="tns:RetrieveBiometricData"/>
5502 <wsdl:message name="RetrieveBiometricDataResponseMessage">
5503 <wsdl:part name="parameters" element="tns:RetrieveBiometricDataResponse"/>
5505 <wsdl:message name="SetBiographicDataRequestMessage">
5506 <wsdl:part name="parameters" element="tns:SetBiographicData"/>
5508 <wsdl:message name="SetBiographicDataResponseMessage">
5509 <wsdl:part name="parameters" element="tns:SetBiographicDataResponse"/>
5511 <wsdl:message name="SetBiometricDataRequestMessage">
5512 <wsdl:part name="parameters" element="tns:SetBiometricData"/>
5514 <wsdl:message name="SetBiometricDataResponseMessage">
5515 <wsdl:part name="parameters" element="tns:SetBiometricDataResponse"/>
5517 <wsdl:message name="TransformBiometricDataRequestMessage">
5518 <wsdl:part name="parameters" element="tns:TransformBiometricData"/>
5520 <wsdl:message name="TransformBiometricDataResponseMessage">
5521 <wsdl:part name="parameters" element="tns:TransformBiometricDataResponse"/>
5523 <wsdl:message name="UpdateBiographicDataRequestMessage">
5524 <wsdl:part name="parameters" element="tns:UpdateBiographicData"/>
5526 <wsdl:message name="UpdateBiographicDataResponseMessage">
5527 <wsdl:part name="parameters" element="tns:UpdateBiographicDataResponse"/>
5529 <wsdl:message name="UpdateBiometricDataRequestMessage">
5530 <wsdl:part name="parameters" element="tns:UpdateBiometricData"/>

5532 <wsdl:message name="UpdateBiometricDataResponseMessage">
5533 <wsdl:part name="parameters" element="tns:UpdateBiometricDataResponse"/>
5535 <wsdl:message name="VerifySubjectRequestMessage">
5536 <wsdl:part name="parameters" element="tns:VerifySubject"/>
5538 <wsdl:message name="VerifySubjectResponseMessage">
5539 <wsdl:part name="parameters" element="tns:VerifySubjectResponse"/>
5541 <wsdl:message name="EnrolRequestMessage">
5542 <wsdl:part name="parameters" element="tns:Enrol"/>
5544 <wsdl:message name="EnrolResponseMessage">
5545 <wsdl:part name="parameters" element="tns:EnrolResponse"/>
5547 <wsdl:message name="GetEnrolResultsRequestMessage">
5548 <wsdl:part name="parameters" element="tns:GetEnrolResults"/>
5550 <wsdl:message name="GetEnrolResultsResponseMessage">
5551 <wsdl:part name="parameters" element="tns:GetEnrolResultsResponse"/>
5553 <wsdl:message name="GetIdentifyResultsRequestMessage">
5554 <wsdl:part name="parameters" element="tns:GetIdentifyResults"/>
5556 <wsdl:message name="GetIdentifyResultsResponseMessage">
5557 <wsdl:part name="parameters" element="tns:GetIdentifyResultsResponse"/>
5559 <wsdl:message name="GetVerifyResultsRequestMessage">
5560 <wsdl:part name="parameters" element="tns:GetVerifyResults"/>
5562 <wsdl:message name="GetVerifyResultsResponseMessage">
5563 <wsdl:part name="parameters" element="tns:GetVerifyResultsResponse"/>
5565 <wsdl:message name="IdentifyRequestMessage">
5566 <wsdl:part name="parameters" element="tns:Identify"/>

5568 <wsdl:message name="IdentifyResponseMessage">
5569 <wsdl:part name="parameters" element="tns:IdentifyResponse"/>
5571 <wsdl:message name="RetrieveDataRequestMessage">
5572 <wsdl:part name="parameters" element="tns:RetrieveData"/>
5574 <wsdl:message name="RetrieveDataResponseMessage">
5575 <wsdl:part name="parameters" element="tns:RetrieveDataResponse"/>
5577 <wsdl:message name="VerifyRequestMessage">
5578 <wsdl:part name="parameters" element="tns:Verify"/>
5580 <wsdl:message name="VerifyResponseMessage">
5581 <wsdl:part name="parameters" element="tns:VerifyResponse"/>
5583 <wsdl:portType name="BIAS_v2">
5584 <wsdl:operation name="AddSubjectToGallery">
5585 <wsdl:input name="AddSubjectToGallery" message="tns:AddSubjectToGalleryRequestMessage"/>
5586 <wsdl:output name="AddSubjectToGalleryResponse" message="tns:AddSubjectToGalleryResponseMessage"/>
5587 <wsdl:fault name="BIASFault" message="tns:BIASFaultMessage"/>
5588 </wsdl:operation>
5589 <wsdl:operation name="CheckQuality">
5590 <wsdl:input name="CheckQuality" message="tns:CheckQualityRequestMessage"/>
5591 <wsdl:output name="CheckQualityResponse" message="tns:CheckQualityResponseMessage"/>
5594 <wsdl:operation name="ClassifyBiometricData">
5595 <wsdl:input name="ClassifyBiometricData" message="tns:ClassifyBiometricDataRequestMessage"/>
5596 <wsdl:output name="ClassifyBiometricDataResponse" message="tns:ClassifyBiometricDataResponseMessage"/>
5599 <wsdl:operation name="CreateSubject">
5600 <wsdl:input name="CreateSubject" message="tns:CreateSubjectRequestMessage"/>
5601 <wsdl:output name="CreateSubjectResponse" message="tns:CreateSubjectResponseMessage"/>

5604 <wsdl:operation name="DeleteBiographicData">
5605 <wsdl:input name="DeleteBiographicData" message="tns:DeleteBiographicDataRequestMessage"/>
5606 <wsdl:output name="DeleteBiographicDataResponse" message="tns:DeleteBiographicDataResponseMessage"/>
5609 <wsdl:operation name="DeleteBiometricData">
5610 <wsdl:input name="DeleteBiometricData" message="tns:DeleteBiometricDataRequestMessage"/>
5611 <wsdl:output name="DeleteBiometricDataResponse" message="tns:DeleteBiometricDataResponseMessage"/>
5614 <wsdl:operation name="DeleteSubject">
5615 <wsdl:input name="DeleteSubject" message="tns:DeleteSubjectRequestMessage"/>
5616 <wsdl:output name="DeleteSubjectResponse" message="tns:DeleteSubjectResponseMessage"/>
5619 <wsdl:operation name="DeleteSubjectFromGallery">
5620 <wsdl:input name="DeleteSubjectFromGallery" message="tns:DeleteSubjectFromGalleryRequestMessage"/>
5621 <wsdl:output name="DeleteSubjectFromGalleryResponse" message="tns:DeleteSubjectFromGalleryResponseMessage"/>
5624 <wsdl:operation name="GetIdentifySubjectResults">
5625 <wsdl:input name="GetIdentifySubjectResults" message="tns:GetIdentifySubjectResultsRequestMessage"/>
5626 <wsdl:output name="GetIdentifySubjectResultsResponse" message="tns:GetIdentifySubjectResultsResponseMessage"/>
5629 <wsdl:operation name="IdentifySubject">
5630 <wsdl:input name="IdentifySubject" message="tns:IdentifySubjectRequestMessage"/>
5631 <wsdl:output name="IdentifySubjectResponse" message="tns:IdentifySubjectResponseMessage"/>
5634 <wsdl:operation name="ListBiographicData">
5635 <wsdl:input name="ListBiographicData" message="tns:ListBiographicDataRequestMessage"/>
5636 <wsdl:output name="ListBiographicDataResponse" message="tns:ListBiographicDataResponseMessage"/>

5639 <wsdl:operation name="ListBiometricData">
5640 <wsdl:input name="ListBiometricData" message="tns:ListBiometricDataRequestMessage"/>
5641 <wsdl:output name="ListBiometricDataResponse" message="tns:ListBiometricDataResponseMessage"/>
5644 <wsdl:operation name="PerformFusion">
5645 <wsdl:input name="PerformFusion" message="tns:PerformFusionRequestMessage"/>
5646 <wsdl:output name="PerformFusionResponse" message="tns:PerformFusionResponseMessage"/>
5649 <wsdl:operation name="QueryCapabilities">
5650 <wsdl:input name="QueryCapabilities" message="tns:QueryCapabilitiesRequestMessage"/>
5651 <wsdl:output name="QueryCapabilitiesResponse" message="tns:QueryCapabilitiesResponseMessage"/>
5654 <wsdl:operation name="RetrieveBiographicData">
5655 <wsdl:input name="RetrieveBiographicData" message="tns:RetrieveBiographicDataRequestMessage"/>
5656 <wsdl:output name="RetrieveBiographicDataResponse" message="tns:RetrieveBiographicDataResponseMessage"/>
5659 <wsdl:operation name="RetrieveBiometricData">
5660 <wsdl:input name="RetrieveBiometricData" message="tns:RetrieveBiometricDataRequestMessage"/>
5661 <wsdl:output name="RetrieveBiometricDataResponse" message="tns:RetrieveBiometricDataResponseMessage"/>
5664 <wsdl:operation name="SetBiographicData">
5665 <wsdl:input name="SetBiographicData" message="tns:SetBiographicDataRequestMessage"/>
5666 <wsdl:output name="SetBiographicDataResponse" message="tns:SetBiographicDataResponseMessage"/>
5669 <wsdl:operation name="SetBiometricData">
5670 <wsdl:input name="SetBiometricData" message="tns:SetBiometricDataRequestMessage"/>
5671 <wsdl:output name="SetBiometricDataResponse" message="tns:SetBiometricDataResponseMessage"/>
5674 <wsdl:operation name="TransformBiometricData">

5675 <wsdl:input name="TransformBiometricData" message="tns:TransformBiometricDataRequestMessage"/>
5676 <wsdl:output name="TransformBiometricDataResponse" message="tns:TransformBiometricDataResponseMessage"/>
5679 <wsdl:operation name="UpdateBiographicData">
5680 <wsdl:input name="UpdateBiographicData" message="tns:UpdateBiographicDataRequestMessage"/>
5681 <wsdl:output name="UpdateBiographicDataResponse" message="tns:UpdateBiographicDataResponseMessage"/>
5684 <wsdl:operation name="UpdateBiometricData">
5685 <wsdl:input name="UpdateBiometricData" message="tns:UpdateBiometricDataRequestMessage"/>
5686 <wsdl:output name="UpdateBiometricDataResponse" message="tns:UpdateBiometricDataResponseMessage"/>
5689 <wsdl:operation name="VerifySubject">
5690 <wsdl:input name="VerifySubject" message="tns:VerifySubjectRequestMessage"/>
5691 <wsdl:output name="VerifySubjectResponse" message="tns:VerifySubjectResponseMessage"/>
5694 <wsdl:operation name="Enrol">
5695 <wsdl:input name="Enrol" message="tns:EnrolRequestMessage"/>
5696 <wsdl:output name="EnrolResponse" message="tns:EnrolResponseMessage"/>
5699 <wsdl:operation name="GetEnrolResults">
5700 <wsdl:input name="GetEnrolResults" message="tns:GetEnrolResultsRequestMessage"/>
5701 <wsdl:output name="GetEnrolResultsResponse" message="tns:GetEnrolResultsResponseMessage"/>
5704 <wsdl:operation name="GetIdentifyResults">
5705 <wsdl:input name="GetIdentifyResults" message="tns:GetIdentifyResultsRequestMessage"/>
5706 <wsdl:output name="GetIdentifyResultsResponse" message="tns:GetIdentifyResultsResponseMessage"/>
5709 <wsdl:operation name="GetVerifyResults">
5710 <wsdl:input name="GetVerifyResults" message="tns:GetVerifyResultsRequestMessage"/>

5711 <wsdl:output name="GetVerifyResultsResponse" message="tns:GetVerifyResultsResponseMessage"/>
5714 <wsdl:operation name="Identify">
5715 <wsdl:input name="Identify" message="tns:IdentifyRequestMessage"/>
5716 <wsdl:output name="IdentifyResponse" message="tns:IdentifyResponseMessage"/>
5719 <wsdl:operation name="RetrieveData">
5720 <wsdl:input name="RetrieveData" message="tns:RetrieveDataRequestMessage"/>
5721 <wsdl:output name="RetrieveDataResponse" message="tns:RetrieveDataResponseMessage"/>
5724 <wsdl:operation name="Verify">
5725 <wsdl:input name="Verify" message="tns:VerifyRequestMessage"/>
5726 <wsdl:output name="VerifyResponse" message="tns:VerifyResponseMessage"/>
5729 </wsdl:portType>
5730 <wsdl:binding name="BIAS_v2HttpBinding" type="tns:BIAS_v2">
5731 <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
5732 <wsdl:operation name="AddSubjectToGallery">
5733 <soap:operation soapAction="AddSubjectToGallery"/>
5734 <wsdl:input name="AddSubjectToGallery">
5735 <soap:body use="literal"/>
5736 </wsdl:input>
5737 <wsdl:output name="AddSubjectToGalleryResponse">
5739 </wsdl:output>
5740 <wsdl:fault name="BIASFault">
5741 <soap:fault name="BIASFault" use="literal"/>
5742 </wsdl:fault>
5744 <wsdl:operation name="CheckQuality">
5745 <soap:operation soapAction="CheckQuality"/>
5746 <wsdl:input name="CheckQuality">

5748 </wsdl:input>
5749 <wsdl:output name="CheckQualityResponse">
5751 </wsdl:output>
5754 </wsdl:fault>
5756 <wsdl:operation name="ClassifyBiometricData">
5757 <soap:operation soapAction="ClassifyBiometricData"/>
5758 <wsdl:input name="ClassifyBiometricData">
5760 </wsdl:input>
5761 <wsdl:output name="ClassifyBiometricDataResponse">
5763 </wsdl:output>
5766 </wsdl:fault>
5768 <wsdl:operation name="CreateSubject">
5769 <soap:operation soapAction="CreateSubject"/>
5770 <wsdl:input name="CreateSubject">
5772 </wsdl:input>
5773 <wsdl:output name="CreateSubjectResponse">
5775 </wsdl:output>
5778 </wsdl:fault>
5780 <wsdl:operation name="DeleteBiographicData">
5781 <soap:operation soapAction="DeleteBiographicData"/>
5782 <wsdl:input name="DeleteBiographicData">

5784 </wsdl:input>
5785 <wsdl:output name="DeleteBiographicDataResponse">
5787 </wsdl:output>
5790 </wsdl:fault>
5792 <wsdl:operation name="DeleteBiometricData">
5793 <soap:operation soapAction="DeleteBiometricData"/>
5794 <wsdl:input name="DeleteBiometricData">
5796 </wsdl:input>
5797 <wsdl:output name="DeleteBiometricDataResponse">
5799 </wsdl:output>
5802 </wsdl:fault>
5804 <wsdl:operation name="DeleteSubject">
5805 <soap:operation soapAction="DeleteSubject"/>
5806 <wsdl:input name="DeleteSubject">
5808 </wsdl:input>
5809 <wsdl:output name="DeleteSubjectResponse">
5811 </wsdl:output>
5814 </wsdl:fault>
5816 <wsdl:operation name="DeleteSubjectFromGallery">
5817 <soap:operation soapAction="DeleteSubjectFromGallery"/>
5818 <wsdl:input name="DeleteSubjectFromGallery">

5820 </wsdl:input>
5821 <wsdl:output name="DeleteSubjectFromGalleryResponse">
5823 </wsdl:output>
5826 </wsdl:fault>
5828 <wsdl:operation name="GetIdentifySubjectResults">
5829 <soap:operation soapAction="GetIdentifySubjectResults"/>
5830 <wsdl:input name="GetIdentifySubjectResults">
5832 </wsdl:input>
5833 <wsdl:output name="GetIdentifySubjectResultsResponse">
5835 </wsdl:output>
5838 </wsdl:fault>
5840 <wsdl:operation name="IdentifySubject">
5841 <soap:operation soapAction="IdentifySubject"/>
5842 <wsdl:input name="IdentifySubject">
5844 </wsdl:input>
5845 <wsdl:output name="IdentifySubjectResponse">
5847 </wsdl:output>
5850 </wsdl:fault>
5852 <wsdl:operation name="ListBiographicData">
5853 <soap:operation soapAction="ListBiographicData"/>
5854 <wsdl:input name="ListBiographicData">

5856 </wsdl:input>
5857 <wsdl:output name="ListBiographicDataResponse">
5859 </wsdl:output>
5862 </wsdl:fault>
5864 <wsdl:operation name="ListBiometricData">
5865 <soap:operation soapAction="ListBiometricData"/>
5866 <wsdl:input name="ListBiometricData">
5868 </wsdl:input>
5869 <wsdl:output name="ListBiometricDataResponse">
5871 </wsdl:output>
5874 </wsdl:fault>
5876 <wsdl:operation name="PerformFusion">
5877 <soap:operation soapAction="PerformFusion"/>
5878 <wsdl:input name="PerformFusion">
5880 </wsdl:input>
5881 <wsdl:output name="PerformFusionResponse">
5883 </wsdl:output>
5886 </wsdl:fault>
5888 <wsdl:operation name="QueryCapabilities">
5889 <soap:operation soapAction="QueryCapabilities"/>
5890 <wsdl:input name="QueryCapabilities">

5892 </wsdl:input>
5893 <wsdl:output name="QueryCapabilitiesResponse">
5895 </wsdl:output>
5898 </wsdl:fault>
5900 <wsdl:operation name="RetrieveBiographicData">
5901 <soap:operation soapAction="RetrieveBiographicData"/>
5902 <wsdl:input name="RetrieveBiographicData">
5904 </wsdl:input>
5905 <wsdl:output name="RetrieveBiographicDataResponse">
5907 </wsdl:output>
5910 </wsdl:fault>
5912 <wsdl:operation name="RetrieveBiometricData">
5913 <soap:operation soapAction="RetrieveBiometricData"/>
5914 <wsdl:input name="RetrieveBiometricData">
5916 </wsdl:input>
5917 <wsdl:output name="RetrieveBiometricDataResponse">
5919 </wsdl:output>
5922 </wsdl:fault>
5924 <wsdl:operation name="SetBiographicData">
5925 <soap:operation soapAction="SetBiographicData"/>
5926 <wsdl:input name="SetBiographicData">

5928 </wsdl:input>
5929 <wsdl:output name="SetBiographicDataResponse">
5931 </wsdl:output>
5934 </wsdl:fault>
5936 <wsdl:operation name="SetBiometricData">
5937 <soap:operation soapAction="SetBiometricData"/>
5938 <wsdl:input name="SetBiometricData">
5940 </wsdl:input>
5941 <wsdl:output name="SetBiometricDataResponse">
5943 </wsdl:output>
5946 </wsdl:fault>
5948 <wsdl:operation name="TransformBiometricData">
5949 <soap:operation soapAction="TransformBiometricData"/>
5950 <wsdl:input name="TransformBiometricData">
5952 </wsdl:input>
5953 <wsdl:output name="TransformBiometricDataResponse">
5955 </wsdl:output>
5958 </wsdl:fault>
5960 <wsdl:operation name="UpdateBiographicData">
5961 <soap:operation soapAction="UpdateBiographicData"/>
5962 <wsdl:input name="UpdateBiographicData">

5964 </wsdl:input>
5965 <wsdl:output name="UpdateBiographicDataResponse">
5967 </wsdl:output>
5970 </wsdl:fault>
5972 <wsdl:operation name="UpdateBiometricData">
5973 <soap:operation soapAction="UpdateBiometricData"/>
5974 <wsdl:input name="UpdateBiometricData">
5976 </wsdl:input>
5977 <wsdl:output name="UpdateBiometricDataResponse">
5979 </wsdl:output>
5982 </wsdl:fault>
5984 <wsdl:operation name="VerifySubject">
5985 <soap:operation soapAction="VerifySubject"/>
5986 <wsdl:input name="VerifySubject">
5988 </wsdl:input>
5989 <wsdl:output name="VerifySubjectResponse">
5991 </wsdl:output>
5994 </wsdl:fault>
5996 <wsdl:operation name="Enrol">
5997 <soap:operation soapAction="Enrol"/>
5998 <wsdl:input name="Enrol">

6000 </wsdl:input>
6001 <wsdl:output name="EnrolResponse">
6003 </wsdl:output>
6006 </wsdl:fault>
6008 <wsdl:operation name="GetEnrolResults">
6009 <soap:operation soapAction="GetEnrolResults"/>
6010 <wsdl:input name="GetEnrolResults">
6012 </wsdl:input>
6013 <wsdl:output name="GetEnrolResultsResponse">
6015 </wsdl:output>
6018 </wsdl:fault>
6020 <wsdl:operation name="GetIdentifyResults">
6021 <soap:operation soapAction="GetIdentifyResults"/>
6022 <wsdl:input name="GetIdentifyResults">
6024 </wsdl:input>
6025 <wsdl:output name="GetIdentifyResultsResponse">
6027 </wsdl:output>
6030 </wsdl:fault>
6032 <wsdl:operation name="GetVerifyResults">
6033 <soap:operation soapAction="GetVerifyResults"/>
6034 <wsdl:input name="GetVerifyResults">

6036 </wsdl:input>
6037 <wsdl:output name="GetVerifyResultsResponse">
6039 </wsdl:output>
6042 </wsdl:fault>
6044 <wsdl:operation name="Identify">
6045 <soap:operation soapAction="Identify"/>
6046 <wsdl:input name="Identify">
6048 </wsdl:input>
6049 <wsdl:output name="IdentifyResponse">
6051 </wsdl:output>
6054 </wsdl:fault>
6056 <wsdl:operation name="RetrieveData">
6057 <soap:operation soapAction="RetrieveData"/>
6058 <wsdl:input name="RetrieveData">
6060 </wsdl:input>
6061 <wsdl:output name="RetrieveDataResponse">
6063 </wsdl:output>
6066 </wsdl:fault>
6068 <wsdl:operation name="Verify">
6069 <soap:operation soapAction="Verify"/>
6070 <wsdl:input name="Verify">

6072 </wsdl:input>
6073 <wsdl:output name="VerifyResponse">
6075 </wsdl:output>
6078 </wsdl:fault>
6080 </wsdl:binding>
6081 <wsdl:service name="BIAS_v2">
6082 <wsdl:port name="BIAS_v2HttpBindingPort" binding="tns:BIAS_v2HttpBinding">
6083 <soap:address location="http://your_URI/IRI_to_your_BIAS_implementation"/>
6084 </wsdl:port>
6085 </wsdl:service>
6086 </wsdl:definitions>
6087

6088 Appendix B. Use Cases (non-normative)
6089 The intent of this annex is to provide operational sequence diagrams / flow charts that show how the
6090 higher level usage scenarios within [ISO/IEC-BIAS] could be implemented using the BIAS SOAP profile.
6091 The following use cases are given:
6092  Verification (synchronous/aggregate)
6093  Verification (asynchronous/aggregate)
6094  Verification (primitive)
6095  Identification (primitive)
6096  Enrolment (aggregate)
6097  Enrolment (primitive)
6098 B.1 Verification Use Case

6099 This use case uses the aggregate Verify operation in which a single request results in some set of
6100 operations (in this case, a series of primitive BIAS operations) being performed by the BIAS service
6101 provider.
6102
Client Application BIAS Client BIAS Server Agent BIAS Impl
Verify
Verify
Verify
CheckQuality
VerifySubject
MatchDecision
MatchDecision
MatchDecision
Note that
1. CheckQuality, TransformBiometricData, VerifySubject can be exposed as interfaces of BIAS server agent.
6103

6104 B.2 Asynchronous Verification Use Case
6105 In this use case, the requester issues two requests – the BIAS Verify request to initiate the operation
6106 followed by a BIAS GetVerifyResult request to retrieve the results of that operation.
6107
Verify
Verify
Verify
ReturnToken
CheckQuality
VerifySubject
MatchDecision
Periodically Polling
GetVerfiyResult
MatchDecision
MatchDecision
Note that
1. CheckQuality, TransformBiometricData, VerifySubject can be exposed as interfaces of BIAS server agent.
6108
6109

6110 B.3 Primitive Verification Use Case
6111 In this use case, the verification operation is performed as a series of requests using the BIAS primitive
6112 operations. In this case, the client rather than the service provider controls the workflow of the higher
6113 level operation.
6114
BIAS Client BIAS Implementation
CheckQuality
CheckQuality
Return
Return
VerifySubject
VerifySubject
Return
6115

6116 B.4 Identification Use Case
6117 This use case uses the aggregate Identify operation in which a single request results in some set of
6119 provider.
6120
6121
6122
Identify
Identify
Identify
CheckQuality
IdentifySubject
CandidateList
CandidateList
CandidateList
Note that
1. CheckQuality, TransformBiometricData, IdentifySubject can be exposed as interfaces of BIAS server agent.
6123

6124 B.5 Biometric Enrolment Use Case
6125 This use case uses the aggregate Enrol operation in which a single request results in some set of
6127 provider.
6128 Here, if the result of the IdentifySubject is no matches found, then the subject is added to the gallery. If a
6129 match had been found then other logic may have been applied (e.g., return candidate list, add encounter
6130 for existing subject, etc.).
6131
Client BIAS Client BIAS Server Agent BIAS Impl
Enroll
Enroll
Enroll
CheckQuality
IdentifySubject
CreateSubject
SetBiographicData
SetBiometricData
AddSubjectToGallery
ReturnData
ReturnData
ReturnData
6132

6133 B.6 Primitive Enrolment Use Case
6134 In this use case, the enrolment operation is performed as a series of requests using the BIAS primitive
6135 operations. In this case, the client rather than the service provider controls the workflow of the higher
6136 level operation.
6137
BIAS Client BIAS Implementation
CheckQuality
CheckQuality
Return
Return
IdentifySubject
IdentifySubject
Return
CreateSubject
CreateSubject
Return
SetBiographicData
SetBiographicData
Return
SetBiometricData
SetBiometricData
Return
AddSubjectToGallery
AddSubjectToGallery
Return
6138

6139 Appendix C. Samples (non-normative)
6140 C.1 Create Subject Request/Response Example
6141 ISO/IEC BIAS Specification
6142 <interface name="CreateSubject">
6143 <parameter name="SubjectID" type="xs:string" direction="inout"use=”optional” />
6144 <parameter name="Return" type="xs:unsignedLong" direction="out" />
6145 </interface>
6146 OASIS BIAS Examples
6147 Simple Create Subject Request:
6152 SOAPAction: “CreateSubject”
6153 <?xml version=”1.0”?>
6155 <soap:Body>
6156 <tns:CreateSubject
6157 xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/” />
6158 </soap:Body>
6160 Create Subject Request with SubjectID Parameter:
6166 <?xml version=”1.0”?>
6168 <soap:Body>
6169 <tns:CreateSubject xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/”>
6170 <tns:Identity>
6173 </tns:CreateSubject>
6174 </soap:Body>
6176 Create Subject Request with Optional OASIS BIAS Content:
6182 <?xml version=”1.0”?>
6184 <soap:Body>
6185 <tns:CreateSubject xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/”>
6186 <tns:GenericRequestParameters>
6187 <tns:Application>BIAS Application</tns:Application>
6188 <tns:ApplicationUser>BIAS User</tns:ApplicationUser>
6189 </tns:GenericRequestParameters>
6190 <tns:Identity>
6193 </tns:CreateSubject>
6194 </soap:Body>
6196 Simple Create Subject Response:
6197 HTTP/1.1 200 OK
6200 <?xml version=”1.0”?>
6202 <soap:Body>
6203 <tns:CreateSubjectResponse xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/”>
6204 <tns:ResponseStatus>
6205 <tns:Return>0</tns:Return>
6206 </tns:ResponseStatus>
6207 <tns:Identity>
6210 </tns:CreateSubjectResponse>
6211 </soap:Body>
6213 Create Subject Response with Optional OASIS BIAS Content:
6214 HTTP/1.1 200 OK
6217 <?xml version=”1.0”?>
6219 <soap:Body>
6220 <tns:CreateSubjectResponse xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/”>

6223 <tns:Message>Subject ID 123456789 successfully
6224 created.</tns:Message>
6226 <tns:Identity>
6229 </tns:CreateSubjectResponse>
6230 </soap:Body>
6232
6233 C.2 Set Biographic Data Request/Response Example

6235 <interface name="SetBiographicData">
6236 <parameter name="SubjectID" type="xs:string" direction="in" />
6237 <parameter name="IdentityModel" type="IdentityModelType"direction="in" />
6238 <parameter name="EncounterID"type="xs:string" direction="inout" use="optional" />
6239 <parameter name="BiographicData" type="BiographicDataType"direction="in" />
6241 </interface>
6243 Set Biographic Data Request:
6248 SOAPAction: “SetBiographicData”
6249 <?xml version=”1.0”?>
6251 <soap:Body>
6252 <tns:SetBiographicData
6253 xmlns:tns=”http://docs.oasis‐open.org/bias/bias‐1.0/”>
6254 <tns:Identity>
6255 <tns:SubjectID>123456789></tns:SubjectID>
6256 <tns:BiographicData>
6257 <tns:BiographicDataItem>
6258 <tns:Name>Last</tns:Name>
6259 <tns:Type>string</tns:Type>
6260 <tns:Value>Doe</tns:Value>
6261 </tns:BiographicDataItem>
6262 </tns:BiographicData>
6264 <tns:IdentityModel>person</tns:IdentityModel>
6265 </tns:SetBiographicData>
6266 </soap:Body>
6268 Set Biographic Data Response:
6269 HTTP/1.1 200 OK
6272 <?xml version=”1.0”?>
6274 <soap:Body>
6275 <tns:SetBiographicDataResponse
6280 </tns:SetBiographicDataResponse>
6281 </soap:Body>
6283
6284 C.3 Set Biometric Data Request/Response Example

6286 <interface name="SetBiometricData">
6287 <parameter name="SubjectID" type="xs:string" direction="in" />
6288 <parameter name="IdentityModel" type="IdentityModelType"direction="in" />
6289 <parameter name="EncounterID"type="xs:string" direction="inout" use="optional" />
6290 <parameter name="BIRList"type="CBEFF_BIR_ListType" direction="in" />
6292 </interface>
6294 Set Biometric Data Request:
6299 SOAPAction: “SetBiometricData”
6300 <?xml version=”1.0”?>
6302 <soap:Body>
6303 <tns:SetBiometricData

6305 <tns:Identity>
6306 <tns:SubjectID>123456789></tns:SubjectID>
6307 <tns:BiometricData>
6308 <tns:BIRList>
6309 <tns:BIR>biometric data</tns:BIR>
6310 </tns:BIRList>
6311 </tns:BiometricData>
6313 <tns:IdentityModel>person</tns:IdentityModel>
6314 </tns:SetBiometricData>
6315 </soap:Body>
6317 Set Biometric Data Response:
6318 HTTP/1.1 200 OK
6321 <?xml version=”1.0”?>
6323 <soap:Body>
6324 <tns:SetBiometricDataResponse
6329 </tns:SetBiometricDataResponse>
6330 </soap:Body>
6332

6333 Appendix D. Acknowledgements
6334 The following individuals have participated in the creation of this specification and are gratefully
6335 acknowledged:
6336
6337 Participants:!!br0ken!!
6338
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

6339
6340 * Though no longer members of the BIAS TC at time of publication, these individuals contributed in the
6341 early stages of the development of this standard.
6342 In addition, the inputs from the ISO/IEC technical committee are also gratefully appreciated.
6343

6344 Appendix E. Revision History
6345
Revision Date Editor Changes Made
WD 1 2015-XX-XX Kevin Mangold

6346

BIAS-v2 0

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

BIAS-v2 0

Uploaded by

Copyright:

Available Formats

1 Biometric Identity Assurance Services

2 (BIAS) Soap Profile Version 2.0

BIAS-v2.0-cs01 11 July 2017

BIAS-v2.0-cs01 11 July 2017

BIAS-v2.0-cs01 11 July 2017

BIAS-v2.0-cs01 11 July 2017

BIAS-v2.0-cs01 11 July 2017

BIAS-v2.0-cs01 11 July 2017

BIAS-v2.0-cs01 11 July 2017

280 1.2 Purpose/Scope

290 1.3 Overview

303 1.4 Background

BIAS-v2.0-cs01 11 July 2017

321 1.5 Relationship to Other Standards

335 1.6 Terminology

391 1.7 References

BIAS-v2.0-cs01 11 July 2017

429 [WS-I-Basic] Basic Profile Version 1.1, 10 April 2006

438 [XOP] XML-binary Optimized Packaging, W3C Recommendation, 25 January 2005

440 1.7.2 Non-Normative References

BIAS-v2.0-cs01 11 July 2017

446 [EBTS-DOD] Department of DefenseElectronic Biometric TransmissionSpecification, Version 2.0,

477 [SSL3] SSL 3.0 Specification

BIAS-v2.0-cs01 11 July 2017

494 2.2 Context

513 2.3 Architecture

BIAS-v2.0-cs01 11 July 2017

557 3.1 Documentation Conventions

563 Figure 3. BIAS Message Input/Output Dictionary Table Headings

564 Fields Hierarchy Explained:

BIAS-v2.0-cs01 11 July 2017

Description: Identifies an application.

Max Length: 255

571 3.2.2 ApplicationUserIdentifier

Description: Identifies an application user or instance.

Max Length: 255

572 3.2.3 BaseBIRType

573 3.2.4 BIASBiometricDataType

BIRList CBEFF_BIR_ListType 0..1 N A list of CBEFF-BIR elements.

BIR CBEFF_BIR_Type 0..1 N Contains biometric information in

InputBIR CBEFF_BIR_Type 0..1 N Maps to specific ISO/IEC BIAS

ReferenceBIR CBEFF_BIR_Type 0..1 N Maps to specific ISO/IEC BIAS

BIAS-v2.0-cs01 11 July 2017

Description: Error code referenced in a SOAP fault.

575 BIASFaultCode Enumeration Values

UNKNOWN_ERROR The service failed for an unknown reason.

UNSUPPORTED_CAPABILITY A requested capability is not supported by the

INVALID_INPUT The data in a service input parameter is invalid.

BIR_QUALITY_ERROR Biometric sample quality is too poor for the

INVALID_BIR The input BIR is empty or in an invalid or

BIR_SIGNATURE_FAILURE The service could not validate the signature, if

BIR_DECRYPTION_FAILURE The service could not decrypt an encrypted input

INVALID_ENCOUNTER_ID The input encounter ID is empty or in an invalid

INVALID_SUBJECT_ID The input subject ID is empty or in an invalid

UNKNOWN_SUBJECT The subject referenced by the input subject ID

UNKNOWN_GALLERY The gallery referenced by the input gallery ID

UNKNOWN_ENCOUNTER The encounter referenced by the input encounter

UNKNOWN_BIOGRAPHIC_FORMAT The biographic data format is not known or not

UNKNOWN_IDENTITY_CLAIM The identity referenced by the input identity claim

INVALID_IDENTITY_CLAIM The identity claim requested is already in use.

NONEXISTANT_DATA The data requested for deletion does not exist.

UNKNOWN_DOCUMENT_CATEGORY The data requested does not exist.

INVALID_TOKEN The data requested does not exist.