Base template for BIAS aggregate service requests.
Options that guide how the aggregate service request is processed.
Contains the input data for the aggregate service request.
Base template for BIAS aggregate service responses.
Contains the output data for the aggregate service response.
Identifies an application.
Identifies an application user or instance.
Wraps the various BIAS biometric types.
A list of CBEFF-BIR elements.
Contains biometric information in either a non-XML and an XML representation.
Maps to specific INCITS BIAS elements as required by that specification.
Maps to specific INCITS BIAS elements as required by that specification.
A list of biometric data elements.
The service failed for an unknown reason.
A requested capability is not supported by the service implementation.
The data in a service input parameter is invalid.
Biometric sample quality is too poor for the service to succeed.
The input BIR is empty or in an invalid or unrecognized format.
The service could not validate the signature, if used, on the input BIR.
The service could not decrypt an encrypted input BIR.
The input encounter ID is empty or in an invalid format.
The input subject ID is empty or in an invalid format.
The subject referenced by the input subject ID does not exist.
The gallery referenced by the input gallery ID does not exist.
The encounter referenced by the input encounter ID does not exist.
The biographic data format is not known or not supported.
The identity referenced by the input identity claim does not exist.
The identity claim requested is already in use.
The data requested for deletion does not exist.
Defines the error information associated with a SOAP fault.
References an error code.
Provides an explanation of the fault.
Provides detailed information about a BIAS fault, such as trace details.
Defines a single element for encapsulating the data associated
with an Identity. Includes the Identity's reference identifiers,
biographic data, and biometric data.
A system unique identifier for a subject.
An identifier by which a subject is known to a particular gallery or population group.
The identifier of an encounter associated with the subject, required for encounter-centric models.
A list of encounters associated with a subject.
An Identity's biographic data.
An Identity's biographic data elements that are stored in the implementing system.
An Identity's biometric data.
A BIAS identifier
Defines a single biographic data element.
The name of the biographic data item.
The data type for the biographic data item.
The value assigned to the biographic data item.
Defines a set of biographic data that is formatted according to the specified format.
The name of the biographic data format. Use these names for common formats: FBI-EFTS, FBI-EBTS, DOD-EBTS, INT-I, NIEM, xNAL, HR-XML.
The version of the biographic data format (e.g., “7.1" for FBI-EFTS or “2.0" for NIEM).
Reference to a URI/IRI describing the biographic data format. For example: (FBI-EFTS) www.fbibiospecs.org, (DOD-EBTS) www.biometrics.dod.mil, (INT-I) www.interpol.int, (NIEM) www.niem.gov, (xNAL) www.oasis-open.org, (HR-XML) www.hr-xml.org.
The biographic data format type. Use these types for common formats: ASCII (e.g., for non-XML versions of FBI-EFTS, FBI-EBTS, DOD-EFTS, or INT-I), XML (e.g., for NIEM, xNAL, and HR-XML or future version of FBI-EBTS).
Biographic data formatted according to a specific format.
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.
The last name of a subject.
The first name of a subject.
A single biographic data element.
A set of biographic data information.
Provides descriptive information about biometric data, such as
the biometric type, subtype, and format, contained in the BDB of
the CBEFF-BIR.
The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.
The number of biometric records having the biometric type recorded in the biometric type field.
More specifically defines the type of biometric data stored in the biometric record, as defined by CBEFF.
Identifies the standards body, working group, industry consortium, or other CBEFF biometric organization that has defined the format for the biometric data.
Identifies the specific biometric data format specified by the CBEFF biometric organization recorded in the BDB Format Owner field.
A list of biometric data elements.
Data structure containing information about a biometric record.
Defines a set of candidates, utilizing the Candidate Type to
represent each element in the set.
A single candidate.
Defines a single candidate as a possible match in response to a
biometric identification request.
The match score.
The rank of the candidate in relation to other candidates for the same biometric identification operation.
Biographic data associated with the candidate match.
Biometric data associated with the candidate match.
Defines a set of capabilities.
A single capability.
A list of capability items.
A data element accepted as optional input by the implementing system for the aggregate services.
A data element required as input by the implementing system for the aggregate services.
A processing option supported by the implementing system for the aggregate services.
A data element returned by the implementing system for the aggregate services.
Describes the processing logic of an aggregate service supported by the implementing system.
Identifies a biographic data set supported by the implementing system.
A patron format supported by the implementing system.
A classification algorithm type supported by the implementing system.
Identifies the conformance class of the BIAS implementation.
A gallery or population group supported by the implementing system.
Identifies whether the implementing system is person-centric or encounter-centric based.
Identifies the use of match scores returned by the implementing system.
A quality algorithm vendor and algorithm vendor product ID supported by the implementing system.
A biometric type supported by the implementing system.
A transform operation type supported by the implementing system.
Defines a single capability supported by an implementing system.
The name of the capability.
An identifier assigned to the capability by the implementing system.
A description of the capability.
A value assigned to the capability.
A secondary value supporting the capability.
Contains additional information for the supported capability.
A list of CBEFF-BIR elements.
CBEFF structure containing information about a biometric sample.
Represents biometric information, with either a non-XML or XML representation.
The result of a classification.
Type of classification algorithm that was used to perform the classification.
Contains information on classification results and the algorithm used to determine the classification.
The result of the classification.
Identifies the type of classification algorithm that was used to perform the classification.
Defines a set of encounters.
The identifier of an encounter.
Contains at a minimum two sets of fusion input
elements, as input to the PerformFusion request.
A set of fusion information.
Represents the information necessary to perform a fusion operation.
The type of biological or behavioral data stored in the biometric record, as defined by CBEFF.
More specifically defines the type of biometric data stored in the biometric record.
The owner or vendor of the algorithm used to determine the score or decision.
The Algorithm Owner's identifier for the specific algorithm product and version used to determine the score or decision.
The similarity score assigned by the matching algorithm.
The match decision assigned by the matching algorithm.
Common request paramters that can be used to identify the requester.
Identifies the requesting application.
Identifers the user or instance of the requesting application.
Identifers the BIAS operation name that is being requested.
Allows for an unlimited number of data element types, and it does
not specify nor require any particular data element.
Provides a method to filter the amount of information returned in
a search of biometric data.
Limits the returned information to a specific type of biometric, as defined by CBEFF.
A Boolean flag indicating if biometric subtype information should be returned.
The result of a fusion method.
BIAS aggregate services support the ability to include various
processing options which direct and possibly control the business
logic for that service. The ProcessingOptionsType provides a
method to represent those options. Processing options should be
defined by the implementing system.
An option supported by the implementing system.
The vendor's ID for a particular product.
Contains information about a biometric sample's quality and the algorithm used to compute the quality.
The quality of a biometric sample.
The vendor of the qualilty algorithm used to determine the quality score.
The vendor's ID for the algorithm used to determine the quality.
The version of the algorithm used to determine the quality.
Base template for BIAS primitive service requests.
The return code indicates the return status of the operation.
A short message corresponding to the return code.
Base template for BIAS responses.
Returned status for the operation.
BIAS Operation Return Codes
Success
Match result or quality score.
Defines a token that is returned for asynchronous processing.
A value returned by the implementing system that is used to retrieve the results to a service at a later time.
A date and time at which point the token expires and the service results are no longer guaranteed to be available.
Identifies a vendor.
For a description or definition of each data element, see the
referenced CBEFF standards in the CBEFF_XML_BIR_Type schema.
The version of a component.
Register a subject to a given gallery or population group.
The identifier of the gallery or population group to which the subject will be added.
The identity to add to the gallery.
The response to an AddSubjectToGallery request.
Calculate a quality score for a given biometric.
Data structure containing a single biometric sample for which a quality score is to be determined.
Specifies a particular algorithm vendor and vender product ID.
The response to a CheckQuality request.
Contains the quality information for the submitted biometric sample.
Classifies a biometric sample.
Data structure containing a single biometric sample for which the classification is to be determined.
The response to a ClassifyBiometricData request, containing
the classification of a biometric sample.
Information on the results and type of classification performed.
Create a new subject record.
The response to a CreateSubject request, containing the subject
ID of the new subject record.
Contains the subject ID of the new subject record.
Erase all of the biographic data associated with a given
subject record or, in the encounter-centric model, with a
given encounter.
Contains either the subject ID or encounter ID reference.
The response to a DeleteBiographicData request.
Erase all of the biometric data associated with a given
subject record or, in the encounter-centric model, with a
given encounter.
Contains either the subject ID or encounter ID reference.
The response to a DeleteBiometricData request.
Delete an existing subject record and, in an encounter-centric
model, any associated encounter information.
Subject ID of the identity to delete.
The response to a DeleteSubject request.
Remove the registration of a subject from a gallery or
population group.
The identifier of the gallery or population group from which the subject will be deleted.
The identity to remove from the gallery.
The response to a DeleteSubjectFromGallery request.
Retrieve the identification results for a specified token,
which was returned by the Identify Subject service.
A value used to retrieve the results of an IdentifySubject request.
The response to a GetIdentifySubjectResults request, which includes a candidate list.
A rank-ordered list of candidates that have a likelihood of matching the input biometric sample.
Perform an identification search against a given gallery for
a given biometric.
The identifier of the gallery or population group which will be searched.
Contains the BIR, a data structure containing the biometric sample for the search.
The maximum size of the candidate list that should be returned.
The response to an IdentifySubject request, returning a
rank-ordered candidate list.
A rank-ordered list of candidates that have a likelihood of matching the input biometric sample; returned with successful synchronous request processing.
A token used to retrieve the results of the IdentifySubject request; returned with asynchronous request processing.
Lists the biographic data elements stored for a subject.
Identifies the subject or, in the encounter-centric model, a subject and an encounter.
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.
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.
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.
Lists the biometric data elements stored for a subject. Note
that no actual biometric data is returned by this service (see
the RetrieveBiometricInformation service to obtain the biometric
data).
Identifies the subject or, in the encounter-centric model, a subject and an encounter.
Indicates what biometric information should be returned.
The response to a ListBiometricData request, containing a list
of biometric data elements stored for a subject. In the
encounter-centric model, the biometric data elements for a
specific encounter are returned. If an encounter ID is not
specified and encounter data exists for the subject, the list
of encounter IDs which contain biometric data is returned.
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.
Accepts either match score or match decision information and creates a fused match result.
Score or decision input information to the fusion method.
The response to the PerformFusion request.
Indicates the result of the fusion method
Returns a list of the capabilities, options, galleries, etc.
that are supported by the BIAS implementation.
The response to a QueryCapabilities request.
A list of capabilities supported by the BIAS implementation.
Retrieves the biographic data associated with a subject ID.
Identifies the subject or, in the encounter-centric model, a subject and an encounter.
The response to a RetrieveBiographicInformation request,
containing the biographic data associated with a subject ID. In
the encounter-centric model, the biographic data associated with
a specified encounter is returned. If the encounter ID is not
specified in the encounter-centric model, the biographic
information associated with the most recent encounter is returned.
Includes the set of biographic data associated with a subject.
Retrieves the biometric data associated with a subject ID.
Identifies the subject or, in the encounter-centric model, a subject and an encounter.
The type of biological or behavioral data to retrieve.
The response to a RetrieveBiometricInformation request,
containing the biometric data associated with a subject ID. In
the encounter-centric model, the biometric data associated with
a specified encounter is returned. If the encounter ID is not
specified in the encounter-centric model, the biometric
information associated with the most recent encounter is returned.
Includes the biometric data associated with a subject.
Associates biographic data to a given subject record.
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to store.
The response to a SetBiographicData request.
In an encounter-centric model, identifies the encounter ID assigned to a new encounter.
Associates biometric data to a given subject record.
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to store.
The response to a SetBiometricData request.
In an encounter-centric model, identifies the encounter ID assigned to a new encounter.
Transforms or processes a given biometric in one format into a new target format.
Data structure containing the biometric information to be transformed.
Value indicating the type of transformation to perform.
Specifies controls for the requested transform operation.
The response to a TransformBiometricData request.
Data structure containing the new, transformed biometric information.
Updates the biographic data for a given subject record.
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biographic data to update.
The response to an UpdateBiographicData request.
Updates a single biometric sample for a given subject record.
Identifies the subject or, in the encounter-centric model, a subject and an encounter, and includes the biometric data to update.
Value indicating if the input biometric sample should be merged with any existing biometric information.
The response to an UpdateBiometricData request.
Performs a 1:1 verification match between a given biometric and
either a claim to identity in a given gallery or another given
biometric.
The identifier of the gallery or population group of which the subject must be a member.
Includes the identifying information and/or input and reference biometric samples.
The response to a VerifySubject request.
Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.
The score if the biometric information matched.
The Enroll aggregate service adds a new subject or, in an
encounter-centric model, a new encounter to the system. This may
be accomplished in a number of different ways according to
system requirements and/or resources. If the Enroll aggregate
service is implemented as a synchronous service, the
implementing system immediately processes the request and
returns the results in the ReturnData parameter. If the Enroll
aggregate service is implemented as an asynchronous service, the
implementing system returns a token in the ReturnData
parameter, which is an indication that the request is being
handled asynchronously. In this case, the GetEnrollResults
service is used to poll for the results of the Enroll request.
The response to an Enroll request.
The GetEnrollResults aggregate service retrieves the enrollment
results for the specified token. This service is used in
conjunction with the Enroll aggregate service. If the Enroll
aggregate service is implemented as an asynchronous service, the
implementing system returns a token, and the GetEnrollResults
service is used to poll for the results of the original Enroll
request.
A value used to retrieve the results of the Enroll request.
The response to a GetEnrollResults request.
The GetIdentifyResults aggregate service retrieves the
identification results for the specified token. This service is
used in conjunction with the Identify aggregate service. If the
Identify aggregate service is implemented as an asynchronous
service, the implementing system returns a token, and the
GetIdentifyResults service is used to poll for the results of
the original Identify request.
A value used to retrieve the results of the Identify request.
The response to a GetIdentifyResults request.
The GetVerifyResults aggregate service retrieves the verification
results for the specified token. This service is used in
conjunction with the Verify aggregate service. If the Verify
aggregate service is implemented as an asynchronous service, the
implementing system returns a token, and the GetVerifyResults
service is used to poll for the results of the original Verify
request.
A value used to retrieve the results of the Verify request.
The response to a GetVerifyResults request.
Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.
The score if the biometric information matched.
The Identify aggregate service performs an identification
function according to system requirements and/or resources. If
the Identify aggregate service is implemented as a synchronous
service, the implementing system immediately processes the
request and returns the results in the ReturnData parameter. If
the Identify aggregate service is implemented as an asynchronous
service, the implementing system returns a token in the
ReturnData parameter, which is an indication that the request is
being handled asynchronously. In this case, the
GetIdentifyResults service is used to poll for the results of
the Identify request.
The response to an Identify request.
The RetrieveInformation aggregate service retrieves requested
information about a subject, or in an encounter-centric model
about an encounter. In a person-centric model, this aggregate
service may be used to retrieve both biographic and biometric
information for a subject record. In an encounter-centric model,
this aggregate service may be used to retrieve biographic and/or
biometric information for either a single encounter or all
encounters. Either a SubjectID or EncounterID must be specified
in the Identify parameter.
Options that guide how the service request is processed, and may identify what type(s) of information should be returned.
Includes the identifier of the subject or encounter.
The response to a RetrieveInformation request.
The Verify aggregate service performs a 1:1 verification
function according to system requirements and/or resources.
Either the IdentityClaim or ReferenceBIR input data elements in
the Identity parameter are required. If the Verify aggregate
service is implemented as a synchronous service, the
implementing system immediately processes the request and returns
the results in the ReturnData parameter. If the Verify aggregate
service is implemented as an asynchronous service, the
implementing system returns a token in the ReturnData parameter,
which is an indication that the request is being handled
asynchronously. In this case, the GetVerifyResults service is
used to poll for the results of the Verify request.
Includes either the IdentityClaim or ReferenceBIR.
The identifier of the gallery or population group of which the subject must be a member.
The response to a Verify request.
Indicates if the Input BIR matched either the biometric information associated with the Identity Claim or the Reference BIR.
The score if the biometric information matched.