Biometric Identity Assurance Services (BIAS) SOAP Profile, Version 1.0
Working Draft 07
27 November 2008
Specification URIs:
This Version:
http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0-wd-07.pdf
http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0-wd-07.doc
http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0-wd-07.html
Previous Version:
N/A
Latest Version:
http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0.pdf
http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0.doc
http://docs.oasis-open.org/bias/soap-profile/v1.0/biasprofile-1.0.html
Technical Committee:
OASIS Biometric Identity Assurance Services (BIAS) Integration TC
Chair(s):
Cathy Tilton, Daon
Editor(s):
TBD
Related Work:
This specification is related to:
· ANSI INCITS 442-2008, Biometric Identity Assurance Services (BIAS)
Declared XML Namespace(s):
http://docs.oasis-open.org/bias/ns/bias-1.0/
Abstract:
This document specifies a SOAP profile that implements the BIAS abstract operations specified in INCITS 442 as SOAP messages.
Status:
This document was last revised or approved by the OASIS BIAS TC on the above date. The level of approval is also listed above. Check the “Latest Version” or “Latest Approved Version” location noted above for possible later revisions of this document.
Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at http://www.oasis-open.org/committees/bias/.
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http://www.oasis-open.org/committees/bias/ipr.php.
The non-normative errata page for this specification is located at http://www.oasis-open.org/committees/bias/.
Notices
Copyright © OASIS® 2008. All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.
The names "OASIS", “BIAS” are trademarks of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance.
Table of Contents
1.4 Relationship to Other Standards
1.6.2 Non-Normative References
2 Design Concepts and Architecture (non-normative)
3.2.2 ApplicationUserIdentifier
3.2.12 BiometricDataElementType
3.2.24 ClassificationAlgorithmType
3.2.27 FusionInformationListType
3.2.29 GenericRequestParameters
4.4.1 Use of SSL 3.0 or TLS 1.0
4.4.2 Data Origin Authentication
4.5 Use with other WS* standards
C.1 Create Subject Request/Response Example
C.2 Set Biographic Data Request/Response Example
This Organization for the Advancement of Structured Information Standards (OASIS) Biometric Identity Assurance Services (BIAS) profile specifies how to use the eXtensible Markup Language (XML) defined in ANSI INCITS 442-2008 – Biometric Identity Assurance Services [INCITS-BIAS] to invoke Simple Object Access Protocol (SOAP) -based services that implement BIAS operations. These SOAP-based services enable an application to invoke biometric identity assurance operations remotely in a Services Oriented Architecture (SOA) infrastructure.
Not included in the scope of BIAS is the incorporation of biometric authentication as an integral component of an authentication or security protocol.
In addition to this introduction, this standard includes the following:
· Chapter 2 contains conformance requirements (TBD).
· Chapter 3 presents the design concepts and architecture for invoking SOAP-based services that implement BIAS operations.
· Chapter 4 presents the namespaces necessary to implement this profile, INCITS BIAS operations and data elements, and identifies relationships to external data definitions.
· Chapter 5 presents the BIAS message structure, as well as rules and considerations for its application.
· Chapter 6 presents information on error handling.
· Appendices include the OASIS BIAS XML schema, sample Web Service Definition Language (WSDL) and WSDL templates, use cases, acknowledgements, and the revision history of this profile.
In late 2005/early 2006, a gap was identified in the existing biometric standards portfolio with respect to biometric services. The Biometric Identity Assurance Services standard proposal was for a collaborative effort between government and private industry to provide a services-based framework for delivering identity assurance capabilities, allowing for platform and application independence. This standard proposal required the attention of two major technical disciplines: biometrics and service architectures. The expertise of both disciplines was required to ensure the standard was technically sound, market relevant, and achieved widespread adoption. The International Committee for Information Technology Standards (INCITS) M1 provided the standards leadership relevant to biometrics, defining the “taxonomy” of biometric operations and data elements. OASIS provided the standards leadership relevant to service architectures with an initial focus on web services, defining the schema and protocol.
The driving requirements of the BIAS standard proposal were to provide the ability to remotely invoke biometric operations across an SOA infrastructure; to provide business level operations without constraining the application/business logic that implements those operations; to be as generic as possible – technology, framework, & application domain independent; and to provide basic capabilities that can be used to construct higher level, aggregate/composite operations.
This OASIS BIAS profile comprises a companion standard to ANSI INCITS 442-2008 – Biometric Identity Assurance Services, which defines the BIAS requirements and taxonomy, specifying the identity assurance operations and the associated data elements. This OASIS BIAS profile specifies the design concepts and architecture, data model and data dictionary, message structure and rules, and error handling necessary to invoke SOAP-based services that implement BIAS operations.
Together, the BIAS standard and the BIAS profile provide an open framework for deploying and remotely invoking biometric-based identity assurance capabilities that can be readily accessed across an SOA infrastructure.
This relationship allows the leveraging of the biometrics and web services expertise of the two standards development organizations. Existing standards are available in both domains and many of these standards will provide the foundation and underlying capabilities upon which the biometric services depend.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC2119].
The following additional terms and definitions are used:
Note: The terms and definitions specified in INCITS (InterNational Committee for Information Technology Standards) (Project 1823-D) also apply to this Standard.
BIAS
Biometric Identity Assurance Services
BIR
Biometric Information Record
ESB
Enterprise Service Bus
SOA
Service-Oriented Architecture
CBEFF
Common Biometric Exchange Formats Framework - data elements and BIR formats specified in ISO/IEC 19785-1
BIAS implementation
software entity that is capable of creating, processing, sending, and receiving BIAS messages
BIAS endpoint
runtime entity, identified by an endpoint IRI, capable of sending and receiving BIAS messages, and containing a running BIAS implementation
BIAS message
message that can be sent from a BIAS endpoint to another BIAS endpoint through a BIAS link channel
request BIAS message
BIAS message conveying a request for an action to be performed by the receiving BIAS endpoint
response BIAS message
BIAS message conveying a response to a prior request BIAS message
[RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
[INCITS-BIAS] ANSI INCITS 442-2008, Biometric Identity Assurance Services (BIAS), May 2008
[SOAP11] Simple Object Access
Protocol (SOAP) 1.1, 8 May 2000
http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
[WS-Addr] Web Services Addressing (WS-Addressing), 10 Aug 2004 http://www.w3.org/Submission/ws-addressing/
[WS-I-Basic] Basic Profile Version 1.1,
10 April 2006
http://www.ws-i.org/Profiles/BasicProfile-1.1-2006-04-10.html
[WS-I-Bind] Web
Services-Interoperability Organization (WS-I) Simple SOAP Binding Profile
Version 1.0, 24 August 2004
http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0-2004-08-24.html
[WSDL11] Web Services Description
Language (WSDL) 1.1, 15 March 2001
http://www.w3.org/TR/2001/NOTE-wsdl-20010315
[XML 10] Extensible Markup
Language (XML) 1.0, 16 August 2006
http://www.w3.org/TR/2006/REC-xml-20060816/
[XOP] XML-binary Optimized
Packaging, W3C Recommendation, 25 January 2005
http://www.w3.org/TR/2005/REC-xop10-20050125/
[RFC2246] T. Dierks & C. Allen, The TLS Protocol, Version 1.0, January 1999
http://www.ietf.org/rfc/rfc2246.txt
[RFC2617] J. Franks, et al, HTTP
Authentication: Basic and Digest Access Authentication, June 1999
http://www.ietf.org/rfc/rfc2617.txt
[RFC3280] R. Housley, et al,
Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation
List (CRL) Profile, April 2002
http://www.ietf.org/rfc/rfc3280.txt
[SAML] Security Assertion Markup Language (SAML), Oasis
Standard, March 2005
http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
[SSL3] SSL 3.0 Specification
http://www.freesoft.org/CIE/Topics/ssl-draft/3-SPEC.HTM
[X509] X.509: Information technology - Open Systems Interconnection - The Directory: Public-key and attribute certificate frameworks, ITU-T, August 2005
Rather than define a totally new and unique messaging protocol for biometric services, this specification instead defines a method for using existing biometric and Web services standards to exchange biometric data and perform biometric operations.
Today, biometric systems are being developed which collect, process, store and match biometric data for a variety of purposes. In many cases, data and/or capabilities need to be shared between systems or systems serve a number of different client stakeholders. As architectures move towards services-based frameworks, access to these biometric databases and services is via a Web services front-end. However, lack of standardization in this area has led implementers to develop customized services for each system/application.
BIAS is intended to provide a common, yet flexible, Web services interface that can be used within both closed and open SOA systems. Figure 1, below, depicts the context in which the BIAS messages will be implemented.
Figure 1. BIAS Context
The clients (requesters) may use standard discovery mechanisms (i.e., UDDI directories) to discover the BIAS service provider (implementation) or, particularly in closed systems, the URI and WSDL for the service provider may be known a priori by the client BIAS application developer.
BIAS Web services are intended to be used within systems employing a services framework, such as a services-oriented architecture (SOA) (although implementations are not limited to this environment). As such, it is recognized that the clients may interact directly with the BIAS service provider or layers may exist between the client and the service provider, for example as an ESB or other application layer.
The BIAS Architecture as shown in Figure 2, in which:
· A Client request to the BIAS Web services may be triggered by a human interaction OR any proxy system such as an ESB.
· Client sends and receives SOAP messages that conform to the BIAS schemas
· The calls to the BIAS Implementation use OASIS Service Interfaces and Bindings (via WSDL)
· The BIAS implementation maps the service call to the appropriate internal API or set of APIs and returns data according to the service interface.
Note that services are represented as circles.
Figure 2. BIAS Architecture
At the heart of the BIAS messaging protocol are the concepts of BIAS messages, endpoints, and links.
BIAS implementation
A BIAS implementation is a software entity that is capable of creating, processing, sending, and receiving BIAS messages. This standard does not define requirements for the BIAS implementation other than defining the messages and protocols used by the endpoints.
BIAS messages
A BIAS message is a one that can be sent from a BIAS endpoint to another BIAS endpoint over a TCP/IP link.
BIAS endpoints
A BIAS endpoint is a runtime entity, uniquely identified and accessed by an endpoint IRI, capable of sending and receiving BIAS messages.
Note that when not publicly and directly exposed, the endpoints for purposes of this specification are the BIAS service provider exposing BIAS services and the component that directly interacts with that service provider, e.g., the business application or ESB, rather than the ultimate end client requester.
This section describes the BIAS operations and the data elements contained therein. Common data elements are defined for use in one or more operations. These include common data types or return codes. The operations are listed alphabetically, with each operation containing a request and a response message.
BIAS operations and data elements are defined in ANSI INCITS 442-2008. The elements, complex types and simple types described for the BIAS messages belong to the following namespace: http://docs.oasis-open.org/bias/ns/bias-1.0/. See Appendix B for the XML schema.
Each operation has a section describing the request and response messages and the input and output parameters. Additionally, each common element has a section describing its content. The input and output of each message and the comment elements are detailed in a table as described in the figure below. Each field that forms part of the input/output to the message is detailed in the table.
Header Name |
Description |
Values |
Value Meaning |
Field |
The name of the field. |
|
|
Type |
The XML schema type of the field. |
|
|
# |
The cardinality of the field |
1 |
One occurrence |
0..1 |
Zero or one occurrence |
||
0..* |
Zero or more occurrences |
||
1..* |
One or more occurrences |
||
? |
Defines if the field must be present. |
Y |
Yes – is always required |
N |
No – is not always required, an optional field. |
||
C |
Conditional – requirement is dependent on system or message conditions. |
||
Meaning |
Gives a short description of the field’s use |
|
|
Figure 3. BIAS Message Input/Output Dictionary Table Headings
Fields Hierarchy Explained:
To denote the field hierarchy the
symbol is used to denote the child-of
relationship.
Type: |
string |
Description: |
Identifies an application. |
Min Length: |
1 |
Max Length: |
255 |
Type: |
string |
Description: |
Identifies an application user or instance. |
Min Length: |
1 |
Max Length: |
255 |
Field |
Type |
# |
? |
Meaning |
BDB-info |
|
|
|
For a description of each data element, see the referenced CBEFF standards in the CBEFF_XML_BIR_Type definition. |
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
integer |
1 |
Y |
|
|
integer |
1 |
Y |
|
|
string |
1 |
Y |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
integer |
1 |
Y |
|
|
integer |
1 |
Y |
|
|
string |
0..1 |
N |
|
|
|
0..1 |
N |
|
|
string |
1 |
Y |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
integer |
0..1 |
N |
|
|
integer |
0..1 |
N |
Field |
Type |
# |
? |
Meaning |
BIASBiometricDataType |
|
|
Y |
Wraps the various BIAS biometric types. The operations that use this type specify which elements are required. |
|
CBEFF_BIR_ListType |
0..1 |
N |
A list of CBEFF-BIR elements. |
|
CBEFF_BIR_Type |
0..1 |
N |
Contains biometric information in either a non-XML or an XML representation. |
|
CBEFF_BIR_Type |
0..1 |
N |
Maps to specific INCITS BIAS elements as required by that specification. |
|
CBEFF_BIR_Type |
0..1 |
N |
Maps to specific INCITS BIAS elements as required by that specification. |
|
BiometricDataListType |
0..1 |
N |
A list of biometric data elements. |
Type: |
string |
Description: |
Error code referenced in a SOAP fault. |
BIASFaultCode Enumeration Values
Value |
Description |
UNKNOWN_ERROR |
The service failed for an unknown reason. |
UNSUPPORTED_CAPABILITY |
A requested capability is not supported by the service implementation. |
INVALID_INPUT |
The data in a service input parameter is invalid. |
BIR_QUALITY_ERROR |
Biometric sample quality is too poor for the service to succeed. |
INVALID_BIR |
The input BIR is empty or in an invalid or unrecognized format. |
BIR_SIGNATURE_FAILURE |
The service could not validate the signature, if used, on the input BIR. |
BIR_DECRYPTION_FAILURE |
The service could not decrypt an encrypted input BIR. |
INVALID_ENCOUNTER_ID |
The input encounter ID is empty or in an invalid format. |
INVALID_SUBJECT_ID |
The input subject ID is empty or in an invalid format. |
UNKNOWN_SUBJECT |
The subject referenced by the input subject ID does not exist. |
UNKNOWN_GALLERY |
The gallery referenced by the input gallery ID does not exist. |
UNKNOWN_ENCOUNTER |
The encounter referenced by the input encounter ID does not exist. |
Field |
Type |
# |
? |
Meaning |
BIASFaultDetail |
|
|
Y |
Defines the error information associated with a SOAP fault. |
|
1 |
Y |
References an error code. |
|
|
string |
1 |
Y |
Provides an explanation of the fault. |
|
string |
0..1 |
N |
Provides detailed information about a BIAS fault, such as trace details. |
Field |
Type |
# |
? |
Meaning |
BIASIdentity |
|
|
Y |
Defines a single element for encapsulating the data associated with an Identity. Includes the Identity's reference identifiers, biographic data, and biometric data. The operations that use this type specify which elements are required. |
|
BIASIDType |
0..1 |
C |
A system unique identifier for a subject. Required as input to many operations. |
|
BIASIDType |
0..1 |
N |
An identifier by which a subject is known to a particular gallery or population group. |
|
BIASIDType |
0..1 |
C |
The identifier of an encounter associated with the subject. Required for encounter-centric models. |
|
EncounterListType |
0..1 |
N |
A list of encounters associated with a subject. |
|
BiographicDataType |
0..1 |
N |
An Identity's biographic data. |
|
BiographicDataType |
0..1 |
N |
An Identity's biographic data elements that are stored in the implementing system. |
|
BIASBiometricDataType |
0..1 |
N |
An Identity's biometric data. |
Type: |
string |
Description: |
A BIAS Identifier. |
Field |
Type |
# |
? |
Meaning |
BiographicDataItemType |
|
|
Y |
Defines a single biographic data element. |
|
string |
1 |
Y |
The name of the biographic data item. |
|
string |
1 |
Y |
The data type for the biographic data item. |
|
string |
0..1 |
N |
The value assigned to the biographic data item. |
Field |
Type |
# |
? |
Meaning |
BiographicDataSetType |
|
|
Y |
Defines a set of biographic data that is formatted according to the specified format. |
|
any |
0..* |
N |
Biographic data formatted according to a specific format. |
BiographicDataSetType Attributes
Name |
Type |
Use |
Meaning |
name |
string |
required |
The name of the biographic data format. Use these names for common formats: EFTS, EBTS, NIEM, xNAL, HR-XML. |
version |
string |
optional |
The version of the biographic data format. Use these versions for common formats: (EFTS) 7.1, (EBTS) 1.2, (NIEM) 1.0 or 2.0, (xNAL) 2.0 or 3.0, (HR-XML) 2.5. |
source |
string |
required |
Reference to a URI describing the biographic data format. Use these sources for common formats: (EFTS) www.fbi.gov, (EBTS) www.biometrics.dod.mil, (NIEM) www.niem.gov, (xNAL) www.oasis-open.org, (HR-XML) www.hr-xml.org. |
type |
string |
required |
The biographic data format type. Use these types for common formats: (EFTS and EBTS) ASCII, (NIEM, xNAL, and HR-XML) XML. |
Field |
Type |
# |
? |
Meaning |
BiographicDataType |
|
|
Y |
Defines a set of biographic data elements, utilizing either the BiographicDataItemType to represent a list of elements or the BiographicDataSetType to represent a complete, formatted set of biographic information. One of the following elements must be present. |
|
string |
0..1 |
C |
The last name of a subject. |
|
string |
0..1 |
C |
The first name of a subject. |
|
BiographicDataItemType |
0..* |
C |
A single biographic data element. |
|
BiographicDataSetType |
0..1 |
C |
A set of biographic data information. |
Field |
Type |
# |
? |
Meaning |
BiometricDataElementType |
|
|
Y |
Provides descriptive information about biometric data, such as the biometric type, subtype, and format, contained in the BDB of the CBEFF-BIR. |
|
hexBinary |
1 |
Y |
The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. |
|
positiveInteger |
0..1 |
N |
The number of biometric records having the biometric type recorded in the biometric type field. |
|
hexBinary |
0..1 |
N |
More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF. |
|
string |
1 |
Y |
Identifies the standards body, working group, industry consortium, or other CBEFF biometric organization that has defined the format for the biometric data. |
|
string |
1 |
Y |
Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field. |
Field |
Type |
# |
? |
Meaning |
BiometricDataListType |
|
|
Y |
A list of biometric data elements. |
|
BiometricDataElementType |
0..* |
N |
Data structure containing information about a biometric record. |
Field |
Type |
# |
? |
Meaning |
BIR-info |
|
0..1 |
Y |
For a description or definition of each data element, see the referenced CBEFF standards in the CBEFF_XML_BIR_Type schema. |
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
anyType |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
|
|
string |
0..1 |
N |
Field |
Type |
# |
? |
Meaning |
CandidateListType |
|
|
Y |
Defines a set of candidates, utilizing the CandidateType to represent each element in the set. |
|
CandidateType |
0..* |
N |
A single candidate. |
Field |
Type |
# |
? |
Meaning |
CandidateType |
|
|
Y |
Defines a single candidate as a possible match in response to a biometric identification request. |
|
string |
0..1 |
N |
The match score. |
|
BiographicDataType |
0..1 |
N |
Biographic data associated with the candidate match. |
|
CBEFF_BIR_ListType |
1 |
Y |
Biometric data associated with the candidate match. |
CandidateType Attributes
Name |
Type |
Use |
Meaning |
Rank |
integer |
required |
The rank of the candidate in relation to other candidates for the same biometric identification operation. |
Field |
Type |
# |
? |
Meaning |
CapabilityListType |
|
|
Y |
Defines a set of capabilities. |
|
CapabilityType |
0..* |
N |
A single capability. |
Type: |
string |
Description: |
A list of capability items. |
CapabilityName Enumeration Values
Value |
Description |
AggregateInputDataOptional |
A data element accepted as optional input by the implementing system for the aggregate services. |
AggregateInputDataRequired |
A data element required as input by the implementing system for the aggregate services. |
AggregateProcessingOption |
A processing option supported by the implementing system for the aggregate services. |
AggregateReturnData |
A data element returned by the implementing system for the aggregate services. |
AggregateServiceDescription |
Describes the processing logic of an aggregate service supported by the implementing system. |
BiographicDataSet |
Identifies a biographic data set supported by the implementing system. |
CBEFFPatronFormat |
A patron format supported by the implementing system. |
ClassificationAlgorithmType |
A classification algorithm type supported by the implementing system. |
ConformanceClass |
Identifies the conformance class of the BIAS implementation. |
Gallery |
A gallery or population group supported by the implementing system. |
IdentityModel |
Identifies whether the implementing system is person-centric or encounter-centric based. |
QualityAlgorithm |
A quality algorithm vendor and algorithm vendor product ID supported by the implementing system. |
SupportedBiometric |
A biometric type supported by the implementing system. |
TransformOperation |
A transform operation type supported by the implementing system. |
Field |
Type |
# |
? |
Meaning |
CapabilityType |
|
|
Y |
Defines a single capability supported by an implementing system. |
|
CapabilityName |
1 |
Y |
The name of the capability. |
|
string |
0..1 |
N |
An identifier assigned to the capability by the implementing system. |
|
string |
0..1 |
N |
A description of the capability. |
|
string |
0..1 |
N |
A value assigned to the capability. |
|
string |
0..1 |
N |
A secondary value supporting the capability. |
Field |
Type |
# |
? |
Meaning |
CBEFF_BIR_ListType |
|
|
Y |
A list of CBEFF-BIR elements. |
|
CBEFF_BIR_Type |
0..* |
N |
CBEFF structure containing information about a biometric sample. |
Field |
Type |
# |
? |
Meaning |
CBEFF_BIR_Type |
|
|
Y |
Represents biometric information, with either a non-XML or XML representation. One of the following elements must be present. |
|
any |
0..1 |
C |
Must be present if XML_BIR is not used. |
|
CBEFF_XML_BIR_Type |
0..1 |
C |
Must be present if the unspecified element is not used. |
Field |
Type |
# |
? |
Meaning |
CBEFF_XML_BIR_Type |
|
|
Y |
An XML representation for biometric information. This schema represents CBEFF data elements from both the US (INCITS 398-2005 Revision 1) and International (ISO/IEC 19785-1:2006) versions of the CBEFF standard. The data elements in the two standards are fairly similar. However, a data element may have a different meaning and/or a different set of valid values based on which standard is used. The cbeff-version data element specifies whether the US or International version is being used. An additional data element, other, has been added to this schema to capture non-standard information and to allow for flexibility to any future changes in the existing CBEFF standards. For a description or definition of each data element, see the referenced CBEFF standards. |
|
string |
0..1 |
N |
|
|
Version |
0..1 |
N |
|
|
Version |
0..1 |
N |
|
|
BIR-info |
0..1 |
N |
|
|
BDB-info |
0..1 |
N |
|
|
SB-info |
0..1 |
N |
|
|
|
0..* |
N |
Used to capture non-standard information and to allow for flexibility to any future changes in the existing CBEFF standards. |
|
any |
0..* |
N |
|
|
base64Binary |
1 |
Y |
|
Type: |
string |
Description: |
The result of a classification. |
Type: |
string |
Description: |
Type of classification algorithm that was used to perform the classification. |
Field |
Type |
# |
? |
Meaning |
ClassificationData |
|
|
Y |
Contains information on classification results and the algorithm used to determine the classification. |
|
Classification |
1 |
Y |
The result of the classification. |
|
ClassificationAlgorithmType |
1 |
Y |
Identifies the type of classification algorithm that was used to perform the classification. |
Field |
Type |
# |
? |
Meaning |
EncounterListType |
|
|
Y |
Defines a set of encounters. |
|
BIASIDType |
0..* |
N |
The identifier of an encounter. |
Field |
Type |
# |
? |
Meaning |
FusionInformationListType |
|
|
Y |
Contains at a minimum two sets of fusion input elements, as input to the PerformFusion operation. |
|
FusionInformationType |
2..* |
Y |
A set of fusion information. |
Field |
Type |
# |
? |
Meaning |
FusionInformationType |
|
|
Y |
Represents the information necessary to perform a fusion operation. |
|
hexBinary |
1 |
Y |
The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. |
|
string |
0..1 |
N |
More specifically defines the type of biometric data stored in the biometric record. |
|
string |
1 |
Y |
The owner or vendor of the algorithm used to determine the score or decision. |
|
string |
1 |
Y |
The Algorithm Owner's identifier for the specific algorithm product and version used to determine the score or decision. |
|
unsignedLong |
0..1 |
C |
The similarity score assigned by the matching algorithm. Either a Score or a Decision element must be used. |
|
string |
0..1 |
C |
The match decision assigned by the matching algorithm. Either a Score or a Decision element must be used. |
Field |
Type |
# |
? |
Meaning |
GenericRequestParameters |
|
|
Y |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested. |
Type: |
string |
Description: |
Defines the requested or supported identity model. |
IdentityModelType Enumeration Values
Value |
Description |
encounter |
Designation for the encounter-centric model. |
person |
Designation for the person-centric model. |
Field |
Type |
# |
? |
Meaning |
InformationType |
|
|
Y |
Allows for an unlimited number of data element types, and it does not specify nor require any particular data element. |
|
any |
0..* |
N |
|
Field |
Type |
# |
? |
Meaning |
ListFilterType |
|
|
Y |
Provides a method to filter the amount of information returned in a search of biometric data. |
|
hexBinary |
1..* |
Y |
Limits the returned information to a specific type of biometric, as defined by CBEFF. |
|
boolean |
1 |
Y |
A Boolean flag indicating if biometric subtype information should be returned. |
Type: |
boolean |
Description: |
The result of a fusion method. |
Field |
Type |
# |
? |
Meaning |
ProcessingOptionsType |
|
|
Y |
BIAS aggregate operations support the ability to include various processing options which direct and possibly control the business logic for that operation. The ProcessingOptionsType provides a method to represent those options. Processing options should be defined by the implementing system. |
|
string |
0..* |
N |
An option supported by the implementing system. |
Type: |
string |
Description: |
The vendor's ID for a particular product. |
Field |
Type |
# |
? |
Meaning |
QualityData |
|
|
Y |
Contains information about a biometric sample's quality and the algorithm used to compute the quality. |
|
Score |
0..1 |
N |
The quality of a biometric sample. |
|
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 used to determine the quality. |
|
VersionType |
0..1 |
N |
The version of the algorithm used to determine the quality. |
Field |
Type |
# |
? |
Meaning |
ResponseStatus |
|
|
Y |
|
|
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. |
Type: |
unsignedLong |
Description: |
Return value specifying success or other condition. |
ReturnCode Enumeration Values
Value |
Description |
0 |
Success |
Field |
Type |
# |
? |
Meaning |
SB-info |
|
|
Y |
For a description or definition of each data element, see the referenced CBEFF standards in the CBEFF_XML_BIR_Type schema. |
|
integer |
1 |
Y |
|
|
integer |
1 |
Y |
Type: |
integer |
Description: |
Match result or quality score. |
Field |
Type |
# |
? |
Meaning |
TokenType |
|
|
Y |
Defines a token that is returned for asynchronous processing. |
|
string |
1 |
Y |
A value returned by the implementing system that is used to retrieve the results to an operation at a later time. |
|
date |
1 |
Y |
A date and time at which point the token expires and the operation results are no longer guaranteed to be available. |
Type: |
string |
Description: |
Identifies a vendor. |
Field |
Type |
# |
? |
Meaning |
Version |
|
|
Y |
For a description or definition of each data element, see the referenced CBEFF standards in the CBEFF_XML_BIR_Type schema. |
|
integer |
1 |
Y |
|
|
integer |
1 |
Y |
Type: |
string |
Description: |
The version of a component. |
AddSubjectToGalleryResponse
AddSubjectToGallery(AddSubjectToGalleryRequest addSubjectToGalleryRequest)
The AddSubjectToGallery operation registers a subject to a given gallery or population group. As an optional parameter, the value of the claim to identity by which the subject is known to the gallery may be specified. This claim to identity must be unique across the gallery. If no claim to identity is specified, the subject ID (assigned with the CreateSubject operation) will be used as the claim to identity. Additionally, in the encounter-centric model, the encounter ID associated with the subject’s biometrics that will be added to the gallery must be specified.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Register a subject to a given gallery or population group. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “AddSubjectToGallery”. |
|
BIASIDType |
1 |
Y |
The identifier of the gallery or population group to which the subject will be added. |
|
BIASIdentity |
1 |
Y |
The identity to add to the gallery. |
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
N |
An identifier by which a subject is known to a particular gallery or population group. |
|
BIASIDType |
0..1 |
C |
The identifier of an encounter associated with the subject. Required for encounter-centric models. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to an AddSubjectToGallery operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
CheckQualityResponse
CheckQuality(CheckQualityRequest checkQualityRequest)
The CheckQuality operation returns a quality score for a given biometric. The biometric input is provided in a CBEFF basic structure or CBEFF record, which in this specification is called a CBEFF-BIR. The algorithm vendor and algorithm vendor product ID may be optionally provided in order to request a particular algorithm’s use in calculating the biometric quality. If an algorithm vendor is provided then the algorithm vendor product ID is required. If no algorithm vendor is provided, the implementing system will provide the algorithm vendor and algorithm vendor product ID that were used to calculate the biometric quality as output parameters.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Calculate a quality score for a given biometric. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “CheckQuality”. |
|
BIASBiometricDataType |
1 |
Y |
Data structure containing a single biometric sample for which a quality score is to be determined. |
|
CBEFF_BIR_Type |
1 |
Y |
The biometric sample. |
|
QualityData |
0..1 |
N |
Specifies a particular algorithm vendor and vender product ID. |
|
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 used to determine the quality. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a CheckQuality operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
QualityData |
1 |
Y |
Contains the quality information for the submitted biometric sample. |
|
Score |
0..1 |
N |
The quality of a biometric sample. |
|
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 used to determine the quality. |
|
VersionType |
1 |
Y |
The version of the algorithm used to determine the quality. |
ClassifyBiometricDataResponse
ClassifyBiometricData(ClassifyBiometricDataRequest classifyBiometricDataRequest)
The ClassifyBiometricData operation attempts to classify a biometric sample. For example, a fingerprint biometric sample may be classified as a whorl, loop, or arch (or other classification classes and sub-classes).
To obtain the types of classification algorithms and classes, see the QueryCapabilities operation.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Classifies a biometric sample. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “ClassifyBiometricData”. |
|
BIASBiometricDataType |
1 |
Y |
Data structure containing a single biometric sample for which the classification is to be determined. |
|
CBEFF_BIR_Type |
1 |
Y |
The biometric sample. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a ClassifyBiometricData operation, containing the classification of a biometric sample. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
ClassificationData |
1 |
Y |
Information on the results and type of classification performed. |
|
Classification |
1 |
Y |
The result of the classification. |
|
ClassificationAlgorithmType |
1 |
Y |
Identifies the type of classification algorithm that was used to perform the classification. |
CreateSubjectResponse
CreateSubject(CreateSubjectRequest createSubjectRequest)
The CreateSubject operation creates a new subject record and associates a subject ID to that record. As an optional parameter, the subject ID may be specified by the caller. If no subject ID is specified, the CreateSubject operation will generate one.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
|
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “CreateSubject”. |
|
BIASIdentity |
0..1 |
N |
|
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a CreateSubject operation, containing the subject ID of the new subject record. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
BIASIdentity |
1 |
Y |
|
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
DeleteBiographicDataResponse
DeleteBiographicData(DeleteBiographicDataRequest deleteBiographicDataRequest)
The DeleteBiographicData operation erases all of the biographic data associated with a given subject record. In the encounter-centric model the operation erases all of the biographic data associated with a given encounter, and therefore the encounter ID must be specified.
When deleting data, BIAS implementations may completely erase the information in order to prevent the ability to reconstruct a record in whole or in part, or they may track and record the deleted information for auditing and/or quality control purposes.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Erase all of the biographic data associated with a given subject record or, in the encounter-centric model, with a given encounter. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “DeleteBiographicData”. |
|
BIASIdentity |
1 |
Y |
|
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
C |
The identifier of an encounter associated with the subject. Required for encounter-centric models. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a DeleteBiographicData operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
DeleteBiometricDataResponse
DeleteBiographicData(DeleteBiometricDataRequest deleteBiographicDataRequest)
The DeleteBiometricData operation erases all of the biometric data associated with a given subject record. In the encounter-centric model the operation erases all of the biometric data associated with a given encounter, and therefore the encounter ID must be specified.
When deleting data, BIAS implementations may completely erase the information in order to prevent the ability to reconstruct a record in whole or in part, or they may track and record the deleted information for auditing and/or quality control purposes.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Erase all of the biometric data associated with a given subject record or, in the encounter-centric model, with a given encounter. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “DeleteBiometricData”. |
|
BIASIdentity |
1 |
Y |
|
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
C |
The identifier of an encounter associated with the subject. Required for encounter-centric models. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a DeleteBiometricData operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
DeleteSubjectResponse
DeleteSubject(DeleteSubjectRequest deleteSubjectRequest)
The DeleteSubject operation deletes an existing subject record and, in an encounter-centric model, any associated encounter information from the system. This operation also removes the subject from any registered galleries.
When deleting a subject, BIAS implementations may completely erase the subject information in order to prevent the ability to reconstruct a record or records in whole or in part, or they may track and record the deleted information for auditing and/or quality control purposes.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Delete an existing subject record and, in an encounter-centric model, any associated encounter information. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
BIASIdentity |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “DeleteSubject”. |
|
BIASIdentity |
1 |
Y |
The identity of the subject to delete. |
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a DeleteSubject operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
DeleteSubjectFromGalleryResponse
DeleteSubjectFromGallery(DeleteSubjectFromGalleryRequest deleteSubjectFromGalleryRequest)
The DeleteSubjectFromGallery operation removes the registration of a subject from a gallery or population group. The subject is identified by either the subject ID or the claim to identity that was specified in the AddSubjectToGallery operation.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Remove the registration of a subject from a gallery or population group. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “DeleteSubjectFromGallery”. |
|
BIASIDType |
1 |
Y |
The identifier of the gallery or population group from which the subject will be deleted. |
|
BIASIdentity |
1 |
Y |
The identity to remove from the gallery. |
|
BIASIDType |
0..1 |
C |
A system unique identifier for a subject. Required if an Identity Claim is not provided. |
|
BIASIDType |
0..1 |
C |
An identifier by which a subject is known to a particular gallery or population group. Required if a Subject ID is not provided. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a DeleteSubjectFromGallery operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
GetIdentifySubjectResultsResponse
GetIdentifySubjectResults(GetIdentifySubjectResultsRequest getIdentifySubjectResultsRequest)
The GetIdentifySubjectResults operation retrieves the identification results for the specified token. This opereation is used in conjunction with the IdentifySubject operation. If the IdentifySubject operation is implemented as an asynchronous service, the implementing system returns a token and the GetIdentifySubjectResults operation is used to poll for the results of the original IdentifySubject request.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Retrieve the identification results for a specified token, which was returned by the IdentifySubject operation. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “GetIdentifySubjectResults”. |
|
TokenType |
1 |
Y |
A value used to retrieve the results of an IdentifySubject request. |
|
string |
1 |
Y |
A value returned by the implementing system that is used to retrieve the results to an operation at a later time. |
|
date |
1 |
Y |
A date and time at which point the token expires and the operation results are no longer guaranteed to be available. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a GetIdentifySubjectResults operation, which includes a candidate list. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
CandidateListType |
1 |
Y |
A rank-ordered list of candidates that have a likelihood of matching the input biometric sample. |
|
CandidateType |
0..* |
N |
A single candidate. |
|
string |
0..1 |
N |
The match score. |
|
BiographicDataType |
0..1 |
N |
Biographic data associated with the candidate match. |
|
CBEFF_BIR_ListType |
1 |
Y |
Biometric data associated with the candidate match. |
|
CBEFF_BIR_Type |
0..* |
N |
CBEFF structure containing information about a biometric sample. |
IdentifySubjectResponse
IdentifySubject(IdentifySubjectRequest identifySubjectRequest)
The IdentifySubject operation performs an identification search against a given gallery for a given biometric, returning a rank-ordered candidate list of a given maximum size.
If the IdentifySubject operation is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the candidate list. If the IdentifySubject operation is implemented as an asynchronous service, the implementing system returns a token, which is an indication that the request is being handled asynchronously. In this case, the GetIdentifySubjectResults operation is used to poll for the results of the IdentifySubject request.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Perform an identification search against a given gallery for a given biometric. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “IdentifySubject”. |
|
BIASIDType |
1 |
Y |
The identifier of the gallery or population group which will be searched. |
|
BIASIdentity |
1 |
Y |
Contains the BIR, a data structure containing the biometric sample for the search. |
|
BIASBiometricDataType |
1 |
Y |
An Identity's biometric data. |
|
CBEFF_BIR_Type |
1 |
Y |
Contains biometric information in either a non-XML or an XML representation. |
|
integer |
1 |
Y |
The maximum size of the candidate list that should be returned. |
Field |
Type |
# |
? |
Meaning |
|
|
|
Y |
The response to an IdentifySubject operation, returning a rank-ordered candidate list. |
|
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
|
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. |
|
|
CandidateListType |
0..1 |
C |
A rank-ordered list of candidates that have a likelihood of matching the input biometric sample. Returned with successful synchronous request processing. |
|
|
CandidateType |
0..* |
N |
A single candidate. |
|
|
string |
0..1 |
N |
The match score. |
|
|
BiographicDataType |
0..1 |
N |
Biographic data associated with the candidate match. |
|
|
CBEFF_BIR_ListType |
1 |
Y |
Biometric data associated with the candidate match. |
|
|
CBEFF_BIR_Type |
0..* |
N |
CBEFF structure containing information about a biometric sample. |
|
|
TokenType |
0..1 |
C |
A token used to retrieve the results of the IdentifySubject operation. Returned with asynchronous request processing. |
|
|
string |
1 |
Y |
A value returned by the implementing system that is used to retrieve the results to an operation at a later time. |
|
|
date |
1 |
Y |
A date and time at which point the token expires and the operation results are no longer guaranteed to be available. |
|
ListBiographicDataResponse
ListBiographicData(ListBiographicDataRequest listBiographicDataRequest)
The ListBiographicData operation lists the biographic data elements stored for a subject using the Biographic Data Elements output parameter. Note that no actual biographic data is returned by this operation (see the RetrieveBiographicInformation operation to obtain the biographic data). In the encounter-centric model, an encounter ID may be specified to indicate that only the biographic data elements stored for that encounter should be returned. If an encounter ID is not specified and encounter data exists for the subject, the operation returns the list of encounter IDs which contain biographic data using the Encounter List output parameter, and the Biographic Data Elements output parameter is empty.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Lists the biographic data elements stored for a subject. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “ListBiographicData”. |
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter. |
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
N |
The identifier of an encounter associated with the subject. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a ListBiographicData request, containing a list of biographic data elements stored for a subject. In the encounter-centric model, the biographic data elements for a specific encounter are returned. If an encounter ID is not specified and encounter data exists for the subject, the list of encounter IDs which contain biographic data is returned. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
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. |
|
BiographicDataType |
0..1 |
C |
An Identity's biographic data elements that are stored in the implementing system. |
|
BiographicDataItemType |
0..* |
N |
A single biographic data element. |
|
string |
1 |
Y |
The name of the biographic data item. |
|
string |
1 |
Y |
The data type for the biographic data item. |
|
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. |
|
BIASIDType |
0..* |
N |
The identifier of an encounter. |
ListBiometricDataResponse
ListBiometricData(ListBiometricDataRequest listBiometricDataRequest)
The ListBiometricData operation lists the biometric data elements stored for a subject using the Biometric Data List output parameter. Note that no actual biometric data is returned by this operation (see the RetrieveBiometricInformation operation to obtain the biometric data). In the encounter-centric model, an encounter ID may be specified to indicate that only the biometric data elements stored for that encounter should be returned. If an encounter ID is not specified and encounter data exists for the subject, the operation returns the list of encounter IDs which contain biometric data using the Encounter List output parameter, and the Biometric Data List output parameter is empty.
An optional parameter may be used to indicate a filter on the list of returned data. Such a filter may indicate that only biometric types should be listed (e.g., face, finger, iris, etc.) or that only biometric subtypes for a particular biometric type should be listed (e.g., all fingerprints: left slap, right index, etc.). If a filter is not specified, all biometric type and biometric subtype information are listed (e.g., left index finger, right iris, face frontal, etc.).
Field |
Type |
# |
? |
Meaning |
|
|
|
Y |
Lists the biometric data elements stored for a subject. |
||
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “ListBiometricData”. |
|
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter. |
|
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
|
BIASIDType |
0..1 |
N |
The identifier of an encounter associated with the subject. |
|
|
ListFilterType |
0..1 |
N |
Indicates what biometric information should be returned. |
|
|
hexBinary |
1..* |
Y |
Limits the returned information to a specific type of biometric, as defined by CBEFF. |
|
|
boolean |
1 |
Y |
A Boolean flag indicating if biometric subtype information should be returned. |
Field |
Type |
# |
? |
Meaning |
|
|
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. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
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. |
|
BIASBiometricDataType |
0..1 |
C |
An Identity's biometric data. |
|
BiometricDataListType |
0..1 |
N |
A list of biometric data elements. |
|
BiometricDataElementType |
1..* |
Y |
Data structure containing information about a biometric record. |
|
hexBinary |
1 |
Y |
The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. |
|
positiveInteger |
0..1 |
N |
The number of biometric records having the biometric type recorded in the biometric type field. |
|
hexBinary |
0..1 |
N |
More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF. |
|
string |
1 |
Y |
Identifies the standards body, working group, industry consortium, or other CBEFF biometric organization that has defined the format for the biometric data. |
|
string |
1 |
Y |
Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field. |
|
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. |
|
BIASIDType |
1..* |
Y |
The identifier of an encounter. |
PerformFusionResponse
PerformFusion(PerformFusionRequest performFusionRequest)
The PerformFusion operation accepts either match score or match decision information and creates a fused match result. The FusionInformationListType, through the FusionInformationType, provides specific elements for match score input and match decision input. The fusion method and processes are left to the implementing system.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Accepts either match score or match decision information and creates a fused match result. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “PerformFusion”. |
|
FusionInformationListType |
1 |
Y |
Score or decision input information to the fusion method. |
|
FusionInformationType |
2..* |
Y |
A set of fusion information. |
|
hexBinary |
1 |
Y |
The type of biological or behavioral data stored in the biometric record, as defined by CBEFF. |
|
string |
0..1 |
N |
More specifically defines the type of biometric data stored in the biometric record. |
|
string |
1 |
Y |
The owner or vendor of the algorithm used to determine the score or decision. |
|
string |
1 |
Y |
The Algorithm Owner's identifier for the specific algorithm product and version used to determine the score or decision. |
|
unsignedLong |
0..1 |
C |
The similarity score assigned by the matching algorithm. Either a Score or a Decision element must be used. |
|
string |
0..1 |
C |
The match decision assigned by the matching algorithm. Either a Score or a Decision element must be used. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to the PerformFusion operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
MatchType |
1 |
1 |
Indicates the result of the fusion method. |
QueryCapabilitiesResponse
QueryCapabilities(QueryCapabilitiesRequest queryCapabilitiesRequest)
The QueryCapabilities operation returns a list of the capabilities, options, galleries, etc. that are supported by the BIAS implementation. Refer to Annex A in the INCITS BIAS standard for conformance requirements regarding which capability names an implementation must use in the QueryCapabilities operation.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Returns a list of the capabilities, options, galleries, etc. that are supported by the BIAS implementation. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “QueryCapabilities”. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a QueryCapabilities operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
CapabilityListType |
1 |
Y |
A list of capabilities supported by the BIAS implementation. |
|
CapabilityType |
0..* |
N |
A single capability. |
|
CapabilityName |
1 |
Y |
The name of the capability. |
|
string |
0..1 |
N |
An identifier assigned to the capability by the implementing system. |
|
string |
0..1 |
N |
A description of the capability. |
|
string |
0..1 |
N |
A value assigned to the capability. |
|
string |
0..1 |
N |
A secondary value supporting the capability. |
RetrieveBiographicInformationResponse
RetrieveBiographicInformation(RetrieveBiographicInformationRequest retreiveBiographicInfoRequest)
The RetrieveBiographicInformation operation retrieves the biographic data associated with a subject ID. In the encounter-centric model, the encounter ID may be specified and the operation will return the biographic data associated with that encounter. If the encounter ID is not specified in the encounter-centric model, the operation returns the biographic information associated with the most recent encounter.
Field |
Type |
# |
? |
Meaning |
|
|
|
Y |
Retrieves the biographic data associated with a subject ID. |
||
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “RetrieveBiographicInformation”. |
|
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter. |
|
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
|
BIASIDType |
0..1 |
N |
The identifier of an encounter associated with the subject. |
|
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a RetrieveBiographicInformation operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
BIASIdentity |
1 |
Y |
Includes the set of biographic data associated with a subject. |
|
BiographicDataType |
1 |
Y |
An Identity's biographic data. One of the following elements must be present. |
|
string |
0..1 |
C |
The last name of a subject. |
|
string |
0..1 |
C |
The first name of a subject. |
|
BiographicDataItemType |
0..* |
C |
A single biographic data element. |
|
BiographicDataSetType |
0..1 |
C |
A set of biographic data information. |
RetrieveBiometricInformationResponse
RetrieveBiometricInformation(RetrieveBiometricInformationRequest retrieveBiometricInformationRequest)
The RetrieveBiometricInformation operation retrieves the biometric data associated with a subject ID. In the encounter-centric model, the encounter ID may be specified and the operation will return the biometric data associated with that encounter. If the encounter ID is not specified in the encounter-centric model, the operation returns the biometric information associated with the most recent encounter. The operation provides an optional input parameter to specify that only biometric data of a certain type should be retrieved.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Retrieves the biometric data associated with a subject ID. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “RetrieveBiometricInformation”. |
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter. |
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
N |
The identifier of an encounter associated with the subject. |
|
string |
0..1 |
N |
The type of biological or behavioral data to retrieve. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a RetrieveBiometricInformation operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
BIASIdentity |
1 |
Y |
Includes the biometric data associated with a subject. |
|
BIASBiometricDataType |
1 |
Y |
An Identity's biometric data. |
|
CBEFF_BIR_ListType |
1 |
Y |
A list of CBEFF-BIR elements. |
|
CBEFF_BIR_Type |
0..* |
N |
CBEFF structure containing information about a biometric sample. |
SetBiographicDataResponse
SetBiographicData(SetBiographicDataRequest setBiographicDataRequest)
The SetBiographicData operation associates biographic data to a given subject record. The Identity Model parameter in the request indicates whether the biographic information should replace any existing biographic information (person-centric model) or if a new encounter should be created and associated with the subject (encounter-centric model). For encounter-centric models, the encounter ID may be specified by the caller in order to link biographic and biometric information (assuming biometric information was previously associated using the SetBiometricData operation). If the encounter ID is omitted for the encounter-centric model, the operation returns a system-assigned encounter ID.
Field |
Type |
# |
? |
Meaning |
|
|
|
Y |
Associates biographic data to a given subject record. |
||
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “SetBiographicData”. |
|
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to store. |
|
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
|
BIASIDType |
0..1 |
N |
The identifier of an encounter associated with the subject. |
|
|
BiographicDataType |
1 |
Y |
An Identity's biographic data. One of the following elements must be present. |
|
|
string |
0..1 |
C |
The last name of a subject. |
|
|
string |
0..1 |
C |
The first name of a subject. |
|
|
BiographicDataItemType |
0..* |
C |
A single biographic data element. |
|
|
BiographicDataSetType |
0..1 |
C |
A set of biographic data information. |
|
|
IdentityModelType |
1 |
Y |
Indicates a person-centric or encounter-centric model. |
|
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a SetBiographicData operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
BIASIdentity |
0..1 |
C |
In an encounter-centric model, identifies the encounter ID assigned to a new encounter. |
|
BIASIDType |
1 |
Y |
The identifier of an encounter associated with the subject. |
SetBiometricDataResponse
SetBiometricData(SetBiometricDataRequest setBiometricDataRequest)
The SetBiometricData operation associates biometric data to a given subject record. The Identity Model parameter in the request indicates whether the biometric information should replace any existing biometric information (person-centric model) or if a new encounter should be created and associated with the subject (encounter-centric model). For encounter-centric models, the encounter ID may be specified by the caller in order to link biographic and biometric information (assuming biographic information was previously associated using the SetBiographicData operation). If the encounter ID is omitted for the encounter-centric model, the operation returns a system-assigned encounter ID.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Associates biometric data to a given subject record. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “SetBiometricData”. |
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to store. |
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
N |
The identifier of an encounter associated with the subject. |
|
BIASBiometricDataType |
1 |
Y |
An Identity's biometric data. |
|
CBEFF_BIR_ListType |
1 |
Y |
A list of CBEFF-BIR elements. |
|
CBEFF_BIR_Type |
1..* |
Y |
CBEFF structure containing information about a biometric sample. |
|
IdentityModelType |
1 |
Y |
Indicates a person-centric or encounter-centric model. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a SetBiometricData operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
BIASIdentity |
0..1 |
C |
In an encounter-centric model, identifies the encounter ID assigned to a new encounter. |
|
BIASIDType |
1 |
Y |
The identifier of an encounter associated with the subject. |
TransformBiometricDataResponse
TransformBiometricData(TransformBiometricDataRequest transformBiometricDataRequest)
The TransformBiometricData operation transforms or processes a given biometric in one format into a new target format.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Transforms or processes a given biometric in one format into a new target format. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “TransformBiometricData”. |
|
CBEFF_BIR_Type |
1 |
Y |
Data structure containing the biometric information to be transformed. |
|
unsignedLong |
1 |
Y |
Value indicating the type of transformation to perform. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a TransformBiometricData operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
CBEFF_BIR_Type |
0..1 |
N |
Data structure containing the new, transformed biometric information. |
UpdateBiographicDataResponse
UpdateBiographicData(UpdateBiographicDataRequest updateBiographicDataRequest)
The UpdateBiographicData operation updates the biographic data for an existing subject record. The operation replaces any existing biographic data with the new biographic data. In the encounter-centric model, the encounter ID must be specified.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Updates the biographic data for a given subject record. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “UpdateBiographicData”. |
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to update. |
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
C |
The identifier of an encounter associated with the subject. Required for encounter-centric models. |
|
BiographicDataType |
1 |
Y |
An Identity's biographic data. One of the following elements must be present. |
|
string |
0..1 |
C |
The last name of a subject. |
|
string |
0..1 |
C |
The first name of a subject. |
|
BiographicDataItemType |
0..* |
C |
A single biographic data element. |
|
BiographicDataSetType |
0..1 |
C |
A set of biographic data information. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to an UpdateBiographicData operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
UpdateBiometricDataResponse
UpdateBiometricData(UpdateBiometricDataRequest updateBiometricDataRequest)
The UpdateBiometricData operation updates the biometric data for an existing subject record. The operation includes an optional parameter indicating if the new biometric sample should be merged with the existing biometric sample. If this parameter is set to “False” or is not used in the request, the operation replaces the existing biometric sample with the new biometric sample. In the encounter-centric model, the encounter ID must be specified.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Updates a single biometric sample for a given subject record. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “UpdateBiometricData”. |
|
BIASIdentity |
1 |
Y |
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to update. |
|
BIASIDType |
1 |
Y |
A system unique identifier for a subject. |
|
BIASIDType |
0..1 |
C |
The identifier of an encounter associated with the subject. Required for encounter-centric models. |
|
BIASBiometricDataType |
1 |
Y |
An Identity's biometric data. |
|
CBEFF_BIR_Type |
1 |
Y |
Contains biometric information in either a non-XML or an XML representation. |
|
boolean |
0..1 |
N |
Value indicating if the input biometric sample should be merged with any existing biometric information. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to an UpdateBiometricData operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
VerifySubjectResponse
VerifySubject(VerifySubjectRequest verifySubjectRequest)
The VerifySubject operation performs a 1:1 verification match between a given biometric and either a claim to identity in a given gallery or another given biometric. As such either the Identity Claim or Reference BIR input parameters are required.
Field |
Type |
# |
? |
Meaning |
|
|
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. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
BIASIdentity |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “VerifySubject”. |
|
BIASIDType |
0..1 |
C |
The identifier of the gallery or population group of which the subject must be a member. Required if an Identity Claim is provided. |
|
BIASIdentity |
1 |
Y |
Includes the identifying information and/or input and reference biometric samples. |
|
BIASIDType |
0..1 |
C |
An identifier by which a subject is known to a particular gallery or population group. Required if a Reference BIR is not provided. |
|
BIASBiometricDataType |
1 |
Y |
An Identity's biometric data. |
|
CBEFF_BIR_Type |
1 |
Y |
Maps to specific INCITS BIAS elements as required by that specification. |
|
CBEFF_BIR_Type |
0..1 |
C |
Maps to specific INCITS BIAS elements as required by that specification. Required if an Identity Claim is not provided. |
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to a VerifySubject operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
boolean |
0..1 |
N |
Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR. |
|
Score |
0..1 |
N |
The score if the biometric information matched. |
EnrollResponse
Enroll(EnrollRequest enrollRequest)
The Enroll operation adds a new subject or, in an encounter-centric model, a new encounter to the system. This may be accomplished in a number of different ways according to system requirements and/or resources. If the Enroll operation is implemented as a synchronous service, the implementing system immediately processes the request and returns the results in the Return Data parameter. If the Enroll operation is implemented as an asynchronous service, the implementing system returns a token in the Return Data parameter, which is an indication that the request is being handled asynchronously. In this case, the GetEnrollResults operation is used to poll for the results of the Enroll request.
Field |
Type |
# |
? |
Meaning |
|
|
|
Y |
Adds a new subject or, in an encounter-centric model, a new encounter to the system. |
||
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “Enroll”. |
|
|
ProcessingOptionsType |
1 |
Y |
Options that guide how the aggregate service request is processed. |
|
|
string |
0..* |
N |
An option supported by the implementing system. |
|
|
InformationType |
1 |
Y |
Contains the input data for the operation, as required by the implementing system. |
|
Field |
Type |
# |
? |
Meaning |
|
|
Y |
The response to an Enroll operation. |
|
|
ResponseStatus |
1 |
Y |
Returned status for the operation. |
|
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. |
|
InformationType |
0..1 |
N |
Contains the output data for the response. |
GetEnrollResultsResponse
GetEnrollResults(GetEnrollResultsRequest getEnrollResultsRequest)
The GetEnrollResults operation retrieves the enrollment results for the specified token. This operation is used in conjunction with the Enroll operation. If the Enroll operation is implemented as an asynchronous service, the implementing system returns a token and the GetEnrollResults operation is used to poll for the results of the original Enroll request.
Field |
Type |
# |
? |
Meaning |
|
|
Y |
Retrieves the enrollment results for the specified token. |
|
|
GenericRequestParameters |
0..1 |
N |
Common request parameters that can be used to identify the requester. |
|
ApplicationIdentifier |
0..1 |
N |
Identifies the requesting application. |
|
ApplicationUserIdentifier |
0..1 |
N |
Identifies the user or instance of the requesting application. |
|
string |
0..1 |
N |
Identifies the BIAS operation that is being requested: “GetEnrollResults”. |
|
TokenType |