1 Introduction

1.1 Purpose/Scope

This Organization for the Advancement of Structured Information Standards (OASIS) Biometric Identity Assurance Services (BIAS) profile specifies how to use the eXtensible Markup Language (XML) 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.

1.2 Overview

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.

1.3 Background

In late 2005/early 2006, a gap was identified in the existing biometric standards portfolio with respect to biometric services. The Biometric Identity Assurance Services standard proposal was for a collaborative effort between government and private industry to provide a services-based framework for delivering identity assurance capabilities, allowing for platform and application independence. This standard proposal required the attention of two major technical disciplines: biometrics and service architectures. The expertise of both disciplines was required to ensure the standard was technically sound, market relevant, and achieved widespread adoption. The International Committee for Information Technology Standards (INCITS) M1 provided the standards leadership relevant to biometrics, defining the “taxonomy” of biometric operations and data elements. OASIS provided the standards leadership relevant to service architectures with an initial focus on web services, defining the schema and 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.

1.4 Relationship to Other Standards

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.

1.5 Terminology

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC2119].

The following additional terms and definitions are used:

Note: The terms and definitions specified in INCITS (InterNational Committee for Information Technology Standards) (Project 1823-D) also apply to this Standard.

BIAS

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

1.6 References

1.6.1 Normative References

[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

http://www.incits.org

[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/

1.6.2 Non-Normative References

[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

2 Design Concepts and Architecture (non-normative)

2.1 Philosophy

Rather than define a totally new and unique messaging protocol for biometric services, this specification instead defines a method for using existing biometric and Web services standards to exchange biometric data and perform biometric operations.

2.2 Context

Today, biometric systems are being developed which collect, process, store and match biometric data for a variety of purposes. In many cases, data and/or capabilities need to be shared between systems or systems serve a number of different client stakeholders. As architectures move towards services-based frameworks, access to these biometric databases and services is via a Web services front-end. However, lack of standardization in this area has led implementers to develop customized services for each system/application.

BIAS is intended to provide a common, yet flexible, Web services interface that can be used within both closed and open SOA systems. Figure 1, below, depicts the context in which the BIAS messages will be implemented.

Figure 1. BIAS Context

The clients (requesters) may use standard discovery mechanisms (i.e., UDDI directories) to discover the BIAS service provider (implementation) or, particularly in closed systems, the URI and WSDL for the service provider may be known a priori by the client BIAS application developer.

2.3 Architecture

BIAS Web services are intended to be used within systems employing a services framework, such as a services-oriented architecture (SOA) (although implementations are not limited to this environment). As such, it is recognized that the clients may interact directly with the BIAS service provider or layers may exist between the client and the service provider, for example as an ESB or other application layer.

The BIAS Architecture as shown in Figure 2, in which:

· A Client request to the BIAS Web services may be triggered by a human interaction OR any proxy system such as an ESB.

· Client sends and receives SOAP messages that conform to the BIAS schemas

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

3 Data model/data dictionary

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.

3.1 Documentation Conventions

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.

3.2 Common Elements

3.2.1 ApplicationIdentifier

Type:	string
Description:	Identifies an application.
Min Length:	1
Max Length:	255

3.2.2 ApplicationUserIdentifier

Type:	string
Description:	Identifies an application user or instance.
Min Length:	1
Max Length:	255

3.2.3 BDB-info

Field	Type	#	?	Meaning
BDB-info				For a description of each data element, see the referenced CBEFF standards in the CBEFF_XML_BIR_Type definition.
challenge-response	string	0..1	N
index	string	0..1	N
format-owner	integer	1	Y
format-type	integer	1	Y
security-Encryption-options	string	1	Y
creation-date	string	0..1	N
validity-period	string	0..1	N
type	string	0..1	N
subtype	string	0..1	N
data-type	string	0..1	N
product-owner	integer	1	Y
product-type	integer	1	Y
purpose	string	0..1	N
quality		0..1	N
value	string	1	Y
algorithm-owner	string	0..1	N
algorithm-type	string	0..1	N
device-owner	integer	0..1	N
device-type	integer	0..1	N

3.2.4 BIASBiometricDataType

Field	Type	#	?	Meaning
BIASBiometricDataType			Y	Wraps the various BIAS biometric types. The operations that use this type specify which elements are required.
BIRList	CBEFF_BIR_ListType	0..1	N	A list of CBEFF-BIR elements.
BIR	CBEFF_BIR_Type	0..1	N	Contains biometric information in either a non-XML or an XML representation.
InputBIR	CBEFF_BIR_Type	0..1	N	Maps to specific INCITS BIAS elements as required by that specification.
ReferenceBIR	CBEFF_BIR_Type	0..1	N	Maps to specific INCITS BIAS elements as required by that specification.
BiometricDataList	BiometricDataListType	0..1	N	A list of biometric data elements.

3.2.5 BIASFaultCode

Type:	string
Description:	Error code referenced in a SOAP fault.

BIASFaultCode Enumeration Values

Value	Description
UNKNOWN_ERROR	The service failed for an unknown reason.
UNSUPPORTED_CAPABILITY	A requested capability is not supported by the service implementation.
INVALID_INPUT	The data in a service input parameter is invalid.
BIR_QUALITY_ERROR	Biometric sample quality is too poor for the service to succeed.
INVALID_BIR	The input BIR is empty or in an invalid or unrecognized format.
BIR_SIGNATURE_FAILURE	The service could not validate the signature, if used, on the input BIR.
BIR_DECRYPTION_FAILURE	The service could not decrypt an encrypted input BIR.
INVALID_ENCOUNTER_ID	The input encounter ID is empty or in an invalid format.
INVALID_SUBJECT_ID	The input subject ID is empty or in an invalid format.
UNKNOWN_SUBJECT	The subject referenced by the input subject ID does not exist.
UNKNOWN_GALLERY	The gallery referenced by the input gallery ID does not exist.
UNKNOWN_ENCOUNTER	The encounter referenced by the input encounter ID does not exist.

3.2.6 BIASFaultDetail

Field	Type	#	?	Meaning
BIASFaultDetail			Y	Defines the error information associated with a SOAP fault.
BIASFaultType	BIASFaultCode	1	Y	References an error code.
BIASFaultMessage	string	1	Y	Provides an explanation of the fault.
BIASFaultDescription	string	0..1	N	Provides detailed information about a BIAS fault, such as trace details.

3.2.7 BIASIdentity

Field	Type	#	?	Meaning
BIASIdentity			Y	Defines a single element for encapsulating the data associated with an Identity. Includes the Identity's reference identifiers, biographic data, and biometric data. The operations that use this type specify which elements are required.
SubjectID	BIASIDType	0..1	C	A system unique identifier for a subject. Required as input to many operations.
IdentityClaim	BIASIDType	0..1	N	An identifier by which a subject is known to a particular gallery or population group.
EncounterID	BIASIDType	0..1	C	The identifier of an encounter associated with the subject. Required for encounter-centric models.
EncounterList	EncounterListType	0..1	N	A list of encounters associated with a subject.
BiographicData	BiographicDataType	0..1	N	An Identity's biographic data.
BiographicDataElements	BiographicDataType	0..1	N	An Identity's biographic data elements that are stored in the implementing system.
BiometricData	BIASBiometricDataType	0..1	N	An Identity's biometric data.

3.2.8 BIASIDType

Type:	string
Description:	A BIAS Identifier.

3.2.9 BiographicDataItemType

Field	Type	#	?	Meaning
BiographicDataItemType			Y	Defines a single biographic data element.
Name	string	1	Y	The name of the biographic data item.
Type	string	1	Y	The data type for the biographic data item.
Value	string	0..1	N	The value assigned to the biographic data item.

3.2.10 BiographicDataSetType

Field	Type	#	?	Meaning
BiographicDataSetType			Y	Defines a set of biographic data that is formatted according to the specified format.
unspecified	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.

3.2.11 BiographicDataType

Field	Type	#	?	Meaning
BiographicDataType			Y	Defines a set of biographic data elements, utilizing either the BiographicDataItemType to represent a list of elements or the BiographicDataSetType to represent a complete, formatted set of biographic information. One of the following elements must be present.
LastName	string	0..1	C	The last name of a subject.
FirstName	string	0..1	C	The first name of a subject.
BiographicDataItem	BiographicDataItemType	0..*	C	A single biographic data element.
BiographicDataSet	BiographicDataSetType	0..1	C	A set of biographic data information.

3.2.12 BiometricDataElementType

Field	Type	#	?	Meaning
BiometricDataElementType			Y	Provides descriptive information about biometric data, such as the biometric type, subtype, and format, contained in the BDB of the CBEFF-BIR.
BiometricType	hexBinary	1	Y	The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.
BiometricTypeCount	positiveInteger	0..1	N	The number of biometric records having the biometric type recorded in the biometric type field.
BiometricSubType	hexBinary	0..1	N	More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF.
BDBFormatOwner	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.
BDBFormatType	string	1	Y	Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field.

3.2.13 BiometricDataListType

Field	Type	#	?	Meaning
BiometricDataListType			Y	A list of biometric data elements.
BiometricDataElement	BiometricDataElementType	0..*	N	Data structure containing information about a biometric record.

3.2.14 BIR-info

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.
creator	string	0..1	N
index	string	0..1	N
payload	anyType	0..1	N
integrity-options	string	0..1	N
creation-date	string	0..1	N
validity-period	string	0..1	N
patron-format-owner	string	0..1	N
patron-format-type	string	0..1	N

3.2.15 CandidateListType

Field	Type	#	?	Meaning
CandidateListType			Y	Defines a set of candidates, utilizing the CandidateType to represent each element in the set.
Candidate	CandidateType	0..*	N	A single candidate.

3.2.16 CandidateType

Field	Type	#	?	Meaning
CandidateType			Y	Defines a single candidate as a possible match in response to a biometric identification request.
Score	string	0..1	N	The match score.
BiographicData	BiographicDataType	0..1	N	Biographic data associated with the candidate match.
BIRList	CBEFF_BIR_ListType	1	Y	Biometric data associated with the candidate match.

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.

3.2.17 CapabilityListType

Field	Type	#	?	Meaning
CapabilityListType			Y	Defines a set of capabilities.
Capability	CapabilityType	0..*	N	A single capability.

3.2.18 CapabilityName

Type:	string
Description:	A list of capability items.

CapabilityName Enumeration Values

Value	Description
AggregateInputDataOptional	A data element accepted as optional input by the implementing system for the aggregate services.
AggregateInputDataRequired	A data element required as input by the implementing system for the aggregate services.
AggregateProcessingOption	A processing option supported by the implementing system for the aggregate services.
AggregateReturnData	A data element returned by the implementing system for the aggregate services.
AggregateServiceDescription	Describes the processing logic of an aggregate service supported by the implementing system.
BiographicDataSet	Identifies a biographic data set supported by the implementing system.
CBEFFPatronFormat	A patron format supported by the implementing system.
ClassificationAlgorithmType	A classification algorithm type supported by the implementing system.
ConformanceClass	Identifies the conformance class of the BIAS implementation.
Gallery	A gallery or population group supported by the implementing system.
IdentityModel	Identifies whether the implementing system is person-centric or encounter-centric based.
QualityAlgorithm	A quality algorithm vendor and algorithm vendor product ID supported by the implementing system.
SupportedBiometric	A biometric type supported by the implementing system.
TransformOperation	A transform operation type supported by the implementing system.

3.2.19 CapabilityType

Field	Type	#	?	Meaning
CapabilityType			Y	Defines a single capability supported by an implementing system.
CapabilityName	CapabilityName	1	Y	The name of the capability.
CapabilityID	string	0..1	N	An identifier assigned to the capability by the implementing system.
CapabilityDescription	string	0..1	N	A description of the capability.
CapabilityValue	string	0..1	N	A value assigned to the capability.
CapabilitySupportingValue	string	0..1	N	A secondary value supporting the capability.

3.2.20 CBEFF_BIR_ListType

Field	Type	#	?	Meaning
CBEFF_BIR_ListType			Y	A list of CBEFF-BIR elements.
BIR	CBEFF_BIR_Type	0..*	N	CBEFF structure containing information about a biometric sample.

3.2.21 CBEFF_BIR_Type

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.
unspecified	any	0..1	C	Must be present if XML_BIR is not used.
XML_BIR	CBEFF_XML_BIR_Type	0..1	C	Must be present if the unspecified element is not used.

3.2.22 CBEFF_XML_BIR_Type

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.
patron-format-identifier	string	0..1	N
version	Version	0..1	N
cbeff-version	Version	0..1	N
bir-info	BIR-info	0..1	N
bdb-info	BDB-info	0..1	N
sb-info	SB-info	0..1	N
other		0..*	N	Used to capture non-standard information and to allow for flexibility to any future changes in the existing CBEFF standards.
unspecified	any	0..*	N
BIR	base64Binary	1	Y

3.2.23 Classification

Type:	string
Description:	The result of a classification.

3.2.24 ClassificationAlgorithmType

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

3.2.25 ClassificationData

Field	Type	#	?	Meaning
ClassificationData			Y	Contains information on classification results and the algorithm used to determine the classification.
Classification	Classification	1	Y	The result of the classification.
ClassificationAlgorithmType	ClassificationAlgorithmType	1	Y	Identifies the type of classification algorithm that was used to perform the classification.

3.2.26 EncounterListType

Field	Type	#	?	Meaning
EncounterListType			Y	Defines a set of encounters.
EncounterID	BIASIDType	0..*	N	The identifier of an encounter.

3.2.27 FusionInformationListType

Field	Type	#	?	Meaning
FusionInformationListType			Y	Contains at a minimum two sets of fusion input elements, as input to the PerformFusion operation.
FusionElement	FusionInformationType	2..*	Y	A set of fusion information.

3.2.28 FusionInformationType

Field	Type	#	?	Meaning
FusionInformationType			Y	Represents the information necessary to perform a fusion operation.
BiometricType	hexBinary	1	Y	The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.
BiometricSubType	string	0..1	N	More specifically defines the type of biometric data stored in the biometric record.
AlgorithmOwner	string	1	Y	The owner or vendor of the algorithm used to determine the score or decision.
AlgorithmType	string	1	Y	The Algorithm Owner's identifier for the specific algorithm product and version used to determine the score or decision.
Score	unsignedLong	0..1	C	The similarity score assigned by the matching algorithm. Either a Score or a Decision element must be used.
Decision	string	0..1	C	The match decision assigned by the matching algorithm. Either a Score or a Decision element must be used.

3.2.29 GenericRequestParameters

Field	Type	#	?	Meaning
GenericRequestParameters			Y	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested.

3.2.30 IdentityModelType

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.

3.2.31 InformationType

Field	Type	#	?	Meaning
InformationType			Y	Allows for an unlimited number of data element types, and it does not specify nor require any particular data element.
unspecified	any	0..*	N

3.2.32 ListFilterType

Field	Type	#	?	Meaning
ListFilterType			Y	Provides a method to filter the amount of information returned in a search of biometric data.
BiometricTypeFilter	hexBinary	1..*	Y	Limits the returned information to a specific type of biometric, as defined by CBEFF.
IncludeBiometricSubType	boolean	1	Y	A Boolean flag indicating if biometric subtype information should be returned.

3.2.33 MatchType

Type:	boolean
Description:	The result of a fusion method.

3.2.34 ProcessingOptionsType

Field	Type	#	?	Meaning
ProcessingOptionsType			Y	BIAS aggregate operations support the ability to include various processing options which direct and possibly control the business logic for that operation. The ProcessingOptionsType provides a method to represent those options. Processing options should be defined by the implementing system.
Option	string	0..*	N	An option supported by the implementing system.

3.2.35 ProductID

Type:	string
Description:	The vendor's ID for a particular product.

3.2.36 QualityData

Field	Type	#	?	Meaning
QualityData			Y	Contains information about a biometric sample's quality and the algorithm used to compute the quality.
QualityScore	Score	0..1	N	The quality of a biometric sample.
AlgorithmVendor	VendorIdentifier	1	Y	The vendor of the quality algorithm used to determine the quality score.
AlgorithmVendorProductID	ProductID	1	Y	The vendor's ID for the algorithm used to determine the quality.
AlgorithmVersion	VersionType	0..1	N	The version of the algorithm used to determine the quality.

3.2.37 ResponseStatus

Field	Type	#	?	Meaning
ResponseStatus			Y
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.

3.2.38 ReturnCode

Type:	unsignedLong
Description:	Return value specifying success or other condition.

ReturnCode Enumeration Values

Value	Description
0	Success

3.2.39 SB-info

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.
format-owner	integer	1	Y
format-type	integer	1	Y

3.2.40 Score

Type:	integer
Description:	Match result or quality score.

3.2.41 TokenType

Field	Type	#	?	Meaning
TokenType			Y	Defines a token that is returned for asynchronous processing.
TokenValue	string	1	Y	A value returned by the implementing system that is used to retrieve the results to an operation at a later time.
Expiration	date	1	Y	A date and time at which point the token expires and the operation results are no longer guaranteed to be available.

3.2.42 VendorIdentifier

Type:	string
Description:	Identifies a vendor.

3.2.43 Version

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.
major	integer	1	Y
minor	integer	1	Y

3.2.44 VersionType

Type:	string
Description:	The version of a component.

3.3 BIAS Operations

3.3.1 Primitive Operations

3.3.1.1 AddSubjectToGallery

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.

Input

Field	Type	#	?	Meaning
AddSubjectToGalleryRequest			Y	Register a subject to a given gallery or population group.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “AddSubjectToGallery”.
GalleryID	BIASIDType	1	Y	The identifier of the gallery or population group to which the subject will be added.
Identity	BIASIdentity	1	Y	The identity to add to the gallery.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
IdentityClaim	BIASIDType	0..1	N	An identifier by which a subject is known to a particular gallery or population group.
EncounterID	BIASIDType	0..1	C	The identifier of an encounter associated with the subject. Required for encounter-centric models.

Output

Field	Type	#	?	Meaning
AddSubjectToGalleryResponse			Y	The response to an AddSubjectToGallery operation.
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.

3.3.1.2 CheckQuality

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.

Input

Field	Type	#	?	Meaning
CheckQualityRequest			Y	Calculate a quality score for a given biometric.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “CheckQuality”.
BiometricData	BIASBiometricDataType	1	Y	Data structure containing a single biometric sample for which a quality score is to be determined.
BIR	CBEFF_BIR_Type	1	Y	The biometric sample.
Quality	QualityData	0..1	N	Specifies a particular algorithm vendor and vender product ID.
AlgorithmVendor	VendorIdentifier	1	Y	The vendor of the quality algorithm used to determine the quality score.
AlgorithmVendorProductID	ProductID	1	Y	The vendor's ID for the algorithm used to determine the quality.

Output

Field	Type	#	?	Meaning
CheckQualityResponse			Y	The response to a CheckQuality operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
QualityInfo	QualityData	1	Y	Contains the quality information for the submitted biometric sample.
QualityScore	Score	0..1	N	The quality of a biometric sample.
AlgorithmVendor	VendorIdentifier	1	Y	The vendor of the quality algorithm used to determine the quality score.
AlgorithmVendorProductID	ProductID	1	Y	The vendor's ID for the algorithm used to determine the quality.
AlgorithmVersion	VersionType	1	Y	The version of the algorithm used to determine the quality.

3.3.1.3 ClassifyBiometricData

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.

Input

Field	Type	#	?	Meaning
ClassifyBiometricDataRequest			Y	Classifies a biometric sample.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “ClassifyBiometricData”.
BiometricData	BIASBiometricDataType	1	Y	Data structure containing a single biometric sample for which the classification is to be determined.
BIR	CBEFF_BIR_Type	1	Y	The biometric sample.

Output

Field	Type	#	?	Meaning
ClassifyBiometricDataResponse			Y	The response to a ClassifyBiometricData operation, containing the classification of a biometric sample.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
ClassificationData	ClassificationData	1	Y	Information on the results and type of classification performed.
Classification	Classification	1	Y	The result of the classification.
ClassificationAlgorithmType	ClassificationAlgorithmType	1	Y	Identifies the type of classification algorithm that was used to perform the classification.

3.3.1.4 CreateSubject

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.

Input

Field	Type	#	?	Meaning
CreateSubjectRequest			Y
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “CreateSubject”.
Identity	BIASIdentity	0..1	N
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.

Output

Field	Type	#	?	Meaning
CreateSubjectResponse			Y	The response to a CreateSubject operation, containing the subject ID of the new subject record.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Identity	BIASIdentity	1	Y
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.

3.3.1.5 DeleteBiographicData

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.

Input

Field	Type	#	?	Meaning
DeleteBiographicDataRequest			Y	Erase all of the biographic data associated with a given subject record or, in the encounter-centric model, with a given encounter.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “DeleteBiographicData”.
Identity	BIASIdentity	1	Y
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	C	The identifier of an encounter associated with the subject. Required for encounter-centric models.

Output

Field	Type	#	?	Meaning
DeleteBiographicDataResponse			Y	The response to a DeleteBiographicData operation.
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.

3.3.1.6 DeleteBiometricData

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.

Input

Field	Type	#	?	Meaning
DeleteBiometricDataRequest			Y	Erase all of the biometric data associated with a given subject record or, in the encounter-centric model, with a given encounter.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “DeleteBiometricData”.
Identity	BIASIdentity	1	Y
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	C	The identifier of an encounter associated with the subject. Required for encounter-centric models.

Output

Field	Type	#	?	Meaning
DeleteBiometricDataResponse			Y	The response to a DeleteBiometricData operation.
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.

3.3.1.7 DeleteSubject

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.

Input

Field	Type	#	?	Meaning
DeleteSubjectRequest			Y	Delete an existing subject record and, in an encounter-centric model, any associated encounter information.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	BIASIdentity	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “DeleteSubject”.
Identity	BIASIdentity	1	Y	The identity of the subject to delete.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.

Output

Field	Type	#	?	Meaning
DeleteSubjectResponse			Y	The response to a DeleteSubject operation.
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.

3.3.1.8 DeleteSubjectFromGallery

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.

Input

Field	Type	#	?	Meaning
DeleteSubjectFromGalleryRequest			Y	Remove the registration of a subject from a gallery or population group.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “DeleteSubjectFromGallery”.
GalleryID	BIASIDType	1	Y	The identifier of the gallery or population group from which the subject will be deleted.
Identity	BIASIdentity	1	Y	The identity to remove from the gallery.
SubjectID	BIASIDType	0..1	C	A system unique identifier for a subject. Required if an Identity Claim is not provided.
IdentityClaim	BIASIDType	0..1	C	An identifier by which a subject is known to a particular gallery or population group. Required if a Subject ID is not provided.

Output

Field	Type	#	?	Meaning
DeleteSubjectFromGalleryResponse			Y	The response to a DeleteSubjectFromGallery operation.
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.

3.3.1.9 GetIdentifySubjectResults

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.

Input

Field	Type	#	?	Meaning
GetIdentifySubjectResultsRequest			Y	Retrieve the identification results for a specified token, which was returned by the IdentifySubject operation.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “GetIdentifySubjectResults”.
Token	TokenType	1	Y	A value used to retrieve the results of an IdentifySubject request.
TokenValue	string	1	Y	A value returned by the implementing system that is used to retrieve the results to an operation at a later time.
Expiration	date	1	Y	A date and time at which point the token expires and the operation results are no longer guaranteed to be available.

Output

Field	Type	#	?	Meaning
GetIdentifySubjectResultsResponse			Y	The response to a GetIdentifySubjectResults operation, which includes a candidate list.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
CandidateList	CandidateListType	1	Y	A rank-ordered list of candidates that have a likelihood of matching the input biometric sample.
Candidate	CandidateType	0..*	N	A single candidate.
Score	string	0..1	N	The match score.
BiographicData	BiographicDataType	0..1	N	Biographic data associated with the candidate match.
BIRList	CBEFF_BIR_ListType	1	Y	Biometric data associated with the candidate match.
BIR	CBEFF_BIR_Type	0..*	N	CBEFF structure containing information about a biometric sample.

3.3.1.10 IdentifySubject

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.

Input

Field	Type	#	?	Meaning
IdentifySubjectRequest			Y	Perform an identification search against a given gallery for a given biometric.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “IdentifySubject”.
GalleryID	BIASIDType	1	Y	The identifier of the gallery or population group which will be searched.
Identity	BIASIdentity	1	Y	Contains the BIR, a data structure containing the biometric sample for the search.
BiometricData	BIASBiometricDataType	1	Y	An Identity's biometric data.
BIR	CBEFF_BIR_Type	1	Y	Contains biometric information in either a non-XML or an XML representation.
MaxListSize	integer	1	Y	The maximum size of the candidate list that should be returned.

Output

Field	Type	#	?	Meaning
IdentifySubjectResponse			Y	The response to an IdentifySubject operation, returning a rank-ordered candidate list.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
CandidateList	CandidateListType	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.
Candidate	CandidateType	0..*	N	A single candidate.
Score	string	0..1	N	The match score.
BiographicData	BiographicDataType	0..1	N	Biographic data associated with the candidate match.
BIRList	CBEFF_BIR_ListType	1	Y	Biometric data associated with the candidate match.
BIR	CBEFF_BIR_Type	0..*	N	CBEFF structure containing information about a biometric sample.
Token	TokenType	0..1	C	A token used to retrieve the results of the IdentifySubject operation. Returned with asynchronous request processing.
TokenValue	string	1	Y	A value returned by the implementing system that is used to retrieve the results to an operation at a later time.
Expiration	date	1	Y	A date and time at which point the token expires and the operation results are no longer guaranteed to be available.

3.3.1.11 ListBiographicData

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.

Input

Field	Type	#	?	Meaning
ListBiographicDataRequest			Y	Lists the biographic data elements stored for a subject.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “ListBiographicData”.
Identity	BIASIdentity	1	Y	Identifies the subject or, in the encounter-centric model, a subject and an encounter.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	N	The identifier of an encounter associated with the subject.

Output

Field	Type	#	?	Meaning
ListBiographicDataResponse			Y	The response to a ListBiographicData request, containing a list of biographic data elements stored for a subject. In the encounter-centric model, the biographic data elements for a specific encounter are returned. If an encounter ID is not specified and encounter data exists for the subject, the list of encounter IDs which contain biographic data is returned.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Identity	BIASIdentity	1	Y	Contains a list of biographic data elements associated with a subject or encounter; non-empty if the service was successful, biographic data exists, and either (a) the person-centric model is being used or (b) the encounter-centric model is being used and an encounter identifier was specified.
BiographicDataElements	BiographicDataType	0..1	C	An Identity's biographic data elements that are stored in the implementing system.
BiographicDataItem	BiographicDataItemType	0..*	N	A single biographic data element.
Name	string	1	Y	The name of the biographic data item.
Type	string	1	Y	The data type for the biographic data item.
EncounterList	EncounterListType	0..1	C	A list of encounter ID's associated with a subject and which contain biographic data; non-empty if the service was successful, biographic data exists, the encounter-centric model is being used, and an encounter identifier was not specified.
EncounterID	BIASIDType	0..*	N	The identifier of an encounter.

3.3.1.12 ListBiometricData

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

Input

Field	Type	#	?	Meaning
ListBiometricDataRequest			Y	Lists the biometric data elements stored for a subject.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “ListBiometricData”.
Identity	BIASIdentity	1	Y	Identifies the subject or, in the encounter-centric model, a subject and an encounter.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	N	The identifier of an encounter associated with the subject.
ListFilterType	ListFilterType	0..1	N	Indicates what biometric information should be returned.
BiometricTypeFilter	hexBinary	1..*	Y	Limits the returned information to a specific type of biometric, as defined by CBEFF.
IncludeBiometricSubType	boolean	1	Y	A Boolean flag indicating if biometric subtype information should be returned.

Output

Field	Type	#	?	Meaning
ListBiometricDataResponse			Y	The response to a ListBiometricData operation, containing a list of biometric data elements stored for a subject. In the encounter-centric model, the biometric data elements for a specific encounter are returned. If an encounter ID is not specified and encounter data exists for the subject, the list of encounter IDs which contain biometric data is returned.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Identity	BIASIdentity	0..1	N	Includes a list of biometric data elements associated with a subject or encounter or a list of encounter ID's associated with a subject and which contain biometric data.
BiometricData	BIASBiometricDataType	0..1	C	An Identity's biometric data.
BiometricDataList	BiometricDataListType	0..1	N	A list of biometric data elements.
BiometricDataElement	BiometricDataElementType	1..*	Y	Data structure containing information about a biometric record.
BiometricType	hexBinary	1	Y	The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.
BiometricTypeCount	positiveInteger	0..1	N	The number of biometric records having the biometric type recorded in the biometric type field.
BiometricSubType	hexBinary	0..1	N	More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF.
BDBFormatOwner	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.
BDBFormatType	string	1	Y	Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field.
EncounterList	EncounterListType	0..1	C	A list of encounter ID's associated with a subject and which contain biometric data; non-empty if the service was successful, biometric data exists, the encounter-centric model is being used, and an encounter identifier was not specified.
EncounterID	BIASIDType	1..*	Y	The identifier of an encounter.

3.3.1.13 PerformFusion

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.

Input

Field	Type	#	?	Meaning
PerformFusionRequest			Y	Accepts either match score or match decision information and creates a fused match result.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “PerformFusion”.
FusionInput	FusionInformationListType	1	Y	Score or decision input information to the fusion method.
FusionElement	FusionInformationType	2..*	Y	A set of fusion information.
BiometricType	hexBinary	1	Y	The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.
BiometricSubType	string	0..1	N	More specifically defines the type of biometric data stored in the biometric record.
AlgorithmOwner	string	1	Y	The owner or vendor of the algorithm used to determine the score or decision.
AlgorithmType	string	1	Y	The Algorithm Owner's identifier for the specific algorithm product and version used to determine the score or decision.
Score	unsignedLong	0..1	C	The similarity score assigned by the matching algorithm. Either a Score or a Decision element must be used.
Decision	string	0..1	C	The match decision assigned by the matching algorithm. Either a Score or a Decision element must be used.

Output

Field	Type	#	?	Meaning
PerformFusionResponse			Y	The response to the PerformFusion operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Match	MatchType	1	1	Indicates the result of the fusion method.

3.3.1.14 QueryCapabilities

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.

Input

Field	Type	#	?	Meaning
QueryCapabilitiesRequest			Y	Returns a list of the capabilities, options, galleries, etc. that are supported by the BIAS implementation.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “QueryCapabilities”.

Output

Field	Type	#	?	Meaning
QueryCapabilitiesResponse			Y	The response to a QueryCapabilities operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
CapabilityList	CapabilityListType	1	Y	A list of capabilities supported by the BIAS implementation.
Capability	CapabilityType	0..*	N	A single capability.
CapabilityName	CapabilityName	1	Y	The name of the capability.
CapabilityID	string	0..1	N	An identifier assigned to the capability by the implementing system.
CapabilityDescription	string	0..1	N	A description of the capability.
CapabilityValue	string	0..1	N	A value assigned to the capability.
CapabilitySupportingValue	string	0..1	N	A secondary value supporting the capability.

3.3.1.15 RetrieveBiographicInformation

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.

Input

Field	Type	#		?	Meaning
RetrieveBiographicInformationRequest				Y	Retrieves the biographic data associated with a subject ID.
GenericRequestParameters	GenericRequestParameters	0..1		N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1		N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1		N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1		N	Identifies the BIAS operation that is being requested: “RetrieveBiographicInformation”.
Identity	BIASIdentity	1	Y		Identifies the subject or, in the encounter-centric model, a subject and an encounter.
SubjectID	BIASIDType	1	Y		A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	N		The identifier of an encounter associated with the subject.

Output

Field	Type	#	?	Meaning
RetrieveBiographicInformationResponse			Y	The response to a RetrieveBiographicInformation operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Identity	BIASIdentity	1	Y	Includes the set of biographic data associated with a subject.
BiographicData	BiographicDataType	1	Y	An Identity's biographic data. One of the following elements must be present.
LastName	string	0..1	C	The last name of a subject.
FirstName	string	0..1	C	The first name of a subject.
BiographicDataItem	BiographicDataItemType	0..*	C	A single biographic data element.
BiographicDataSet	BiographicDataSetType	0..1	C	A set of biographic data information.

3.3.1.16 RetrieveBiometricInformation

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.

Input

Field	Type	#	?	Meaning
RetrieveBiometricInformationRequest			Y	Retrieves the biometric data associated with a subject ID.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “RetrieveBiometricInformation”.
Identity	BIASIdentity	1	Y	Identifies the subject or, in the encounter-centric model, a subject and an encounter.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	N	The identifier of an encounter associated with the subject.
BiometricType	string	0..1	N	The type of biological or behavioral data to retrieve.

Output

Field	Type	#	?	Meaning
RetrieveBiometricInformationResponse			Y	The response to a RetrieveBiometricInformation operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Identity	BIASIdentity	1	Y	Includes the biometric data associated with a subject.
BiometricData	BIASBiometricDataType	1	Y	An Identity's biometric data.
BIRList	CBEFF_BIR_ListType	1	Y	A list of CBEFF-BIR elements.
BIR	CBEFF_BIR_Type	0..*	N	CBEFF structure containing information about a biometric sample.

3.3.1.17 SetBiographicData

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.

Input

Field	Type	#	?	Meaning
SetBiographicDataRequest			Y	Associates biographic data to a given subject record.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “SetBiographicData”.
Identity	BIASIdentity	1	Y	Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to store.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	N	The identifier of an encounter associated with the subject.
BiographicData	BiographicDataType	1	Y	An Identity's biographic data. One of the following elements must be present.
LastName	string	0..1	C	The last name of a subject.
FirstName	string	0..1	C	The first name of a subject.
BiographicDataItem	BiographicDataItemType	0..*	C	A single biographic data element.
BiographicDataSet	BiographicDataSetType	0..1	C	A set of biographic data information.
IdentityModel	IdentityModelType	1	Y	Indicates a person-centric or encounter-centric model.

Output

Field	Type	#	?	Meaning
SetBiographicDataResponse			Y	The response to a SetBiographicData operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Identity	BIASIdentity	0..1	C	In an encounter-centric model, identifies the encounter ID assigned to a new encounter.
EncounterID	BIASIDType	1	Y	The identifier of an encounter associated with the subject.

3.3.1.18 SetBiometricData

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.

Input

Field	Type	#	?	Meaning
SetBiometricDataRequest			Y	Associates biometric data to a given subject record.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “SetBiometricData”.
Identity	BIASIdentity	1	Y	Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to store.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	N	The identifier of an encounter associated with the subject.
BiometricData	BIASBiometricDataType	1	Y	An Identity's biometric data.
BIRList	CBEFF_BIR_ListType	1	Y	A list of CBEFF-BIR elements.
BIR	CBEFF_BIR_Type	1..*	Y	CBEFF structure containing information about a biometric sample.
IdentityModel	IdentityModelType	1	Y	Indicates a person-centric or encounter-centric model.

Output

Field	Type	#	?	Meaning
SetBiometricDataResponse			Y	The response to a SetBiometricData operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Identity	BIASIdentity	0..1	C	In an encounter-centric model, identifies the encounter ID assigned to a new encounter.
EncounterID	BIASIDType	1	Y	The identifier of an encounter associated with the subject.

3.3.1.19 TransformBiometricData

TransformBiometricDataResponse

TransformBiometricData(TransformBiometricDataRequest transformBiometricDataRequest)

The TransformBiometricData operation transforms or processes a given biometric in one format into a new target format.

Input

Field	Type	#	?	Meaning
TransformBiometricDataRequest			Y	Transforms or processes a given biometric in one format into a new target format.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “TransformBiometricData”.
InputBIR	CBEFF_BIR_Type	1	Y	Data structure containing the biometric information to be transformed.
TransformOperation	unsignedLong	1	Y	Value indicating the type of transformation to perform.

Output

Field	Type	#	?	Meaning
TransformBiometricDataResponse			Y	The response to a TransformBiometricData operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
OutputBIR	CBEFF_BIR_Type	0..1	N	Data structure containing the new, transformed biometric information.

3.3.1.20 UpdateBiographicData

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.

Input

Field	Type	#	?	Meaning
UpdateBiographicDataRequest			Y	Updates the biographic data for a given subject record.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “UpdateBiographicData”.
Identity	BIASIdentity	1	Y	Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to update.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	C	The identifier of an encounter associated with the subject. Required for encounter-centric models.
BiographicData	BiographicDataType	1	Y	An Identity's biographic data. One of the following elements must be present.
LastName	string	0..1	C	The last name of a subject.
FirstName	string	0..1	C	The first name of a subject.
BiographicDataItem	BiographicDataItemType	0..*	C	A single biographic data element.
BiographicDataSet	BiographicDataSetType	0..1	C	A set of biographic data information.

Output

Field	Type	#	?	Meaning
UpdateBiographicDataResponse			Y	The response to an UpdateBiographicData operation.
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.

3.3.1.21 UpdateBiometricData

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.

Input

Field	Type	#	?	Meaning
UpdateBiometricDataRequest			Y	Updates a single biometric sample for a given subject record.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “UpdateBiometricData”.
Identity	BIASIdentity	1	Y	Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to update.
SubjectID	BIASIDType	1	Y	A system unique identifier for a subject.
EncounterID	BIASIDType	0..1	C	The identifier of an encounter associated with the subject. Required for encounter-centric models.
BiometricData	BIASBiometricDataType	1	Y	An Identity's biometric data.
BIR	CBEFF_BIR_Type	1	Y	Contains biometric information in either a non-XML or an XML representation.
Merge	boolean	0..1	N	Value indicating if the input biometric sample should be merged with any existing biometric information.

Output

Field	Type	#	?	Meaning
UpdateBiometricDataResponse			Y	The response to an UpdateBiometricData operation.
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.

3.3.1.22 VerifySubject

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.

Input

Field	Type	#	?	Meaning
VerifySubjectRequest			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	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	BIASIdentity	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “VerifySubject”.
GalleryID	BIASIDType	0..1	C	The identifier of the gallery or population group of which the subject must be a member. Required if an Identity Claim is provided.
Identity	BIASIdentity	1	Y	Includes the identifying information and/or input and reference biometric samples.
IdentityClaim	BIASIDType	0..1	C	An identifier by which a subject is known to a particular gallery or population group. Required if a Reference BIR is not provided.
BiometricData	BIASBiometricDataType	1	Y	An Identity's biometric data.
InputBIR	CBEFF_BIR_Type	1	Y	Maps to specific INCITS BIAS elements as required by that specification.
ReferenceBIR	CBEFF_BIR_Type	0..1	C	Maps to specific INCITS BIAS elements as required by that specification. Required if an Identity Claim is not provided.

Output

Field	Type	#	?	Meaning
VerifySubjectResponse			Y	The response to a VerifySubject operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
Match	boolean	0..1	N	Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.
Score	Score	0..1	N	The score if the biometric information matched.

3.3.2 Aggregate Operations

3.3.2.1 Enroll

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.

Input

Field	Type	#	?	Meaning
EnrollRequest			Y	Adds a new subject or, in an encounter-centric model, a new encounter to the system.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “Enroll”.
ProcessingOptions	ProcessingOptionsType	1	Y		Options that guide how the aggregate service request is processed.
Option	string	0..*	N		An option supported by the implementing system.
InputData	InformationType	1	Y		Contains the input data for the operation, as required by the implementing system.

Output

Field	Type	#	?	Meaning
EnrollResponse			Y	The response to an Enroll operation.
ResponseStatus	ResponseStatus	1	Y	Returned status for the operation.
Return	ReturnCode	1	Y	The return code indicates the return status of the operation.
Message	string	0..1	N	A short message corresponding to the return code.
ReturnData	InformationType	0..1	N	Contains the output data for the response.

3.3.2.2 GetEnrollResults

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.

Input

Field	Type	#	?	Meaning
GetEnrollResultsRequest			Y	Retrieves the enrollment results for the specified token.
GenericRequestParameters	GenericRequestParameters	0..1	N	Common request parameters that can be used to identify the requester.
Application	ApplicationIdentifier	0..1	N	Identifies the requesting application.
ApplicationUser	ApplicationUserIdentifier	0..1	N	Identifies the user or instance of the requesting application.
BIASOperationName	string	0..1	N	Identifies the BIAS operation that is being requested: “GetEnrollResults”.
Token	TokenType