Verify an entity

Verifying an entity means establishing if a person is who they claim to be. This is achieved by comparing a current biometric object with stored biometric objects of the same person, and determining if the biometric features match.

BioClient.Web offers these verify verbs:

verify-feature

This method verifies the person against their enrolled biometric objects, and returns selected biometric objects and properties.

Usage

Call the Javascript method bioClient.verify_feature(). This method is defined bioclient-plugin.js and calls build_verify_feature to build the BioClient.Web command, and calls verified_feature to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class verify-feature. It is recommended to use these event handlers.

Remarks

The method verifies the person name against the biometric store, identified by the storeName. If no store name is provided, the current, default adapter is used.

If the subtype is NoInformation, then this method clears the current record, captures a sample, extracts a feature from the sample, and then performs the verification. To capture a sample, the sensor identified by the sensorName is used. If no sensor name is provided, the current, default adapter is used. The featureClass determines the class of the feature to be extracted. The current engine must support this feature class. featureOptions are used by the feature extractor, depending on its capabilities.

If the subtype is Any or any specified other subtype, then this method performs the verification against specified features of the current record. The type and subtype determine which features are selected.

Input parameters

Parameter Type Value Remark
command string verify-feature The command to be executed.
storeName string The unique name of the store adapter to use. If null, the current adapter is used.
sensorName string The unique name of the sensor adapter to use. If null, the current adapter is used.
name string The unique name of the identity to be verified.
type BiometricType The biometric type of features selected for verification, or captured before verification.
subtype BiometricSubtype The biometric subtype of features selected for verification, or captured before verification.
featureClass int? The class of features to extract, or to select from the current record. If null, all features are selected.
featureOptions string Options used by the feature extractor.

Output parameters

Parameter Type Value Remark
command string verify-feature The command which was executed.
status string Success The success or failure status.
result result The result of the verification operation.
person person The verified person and their attributes.
features [ feature ] An array of returned features if requested. Currently not supported.
samples [ sample ] An array of returned samples if requested. Currently not supported.

compare-intra

This method compares the current person with its biometric features against itself.

Usage

Call the Javascript method bioClient.compare_intra(). This method is defined bioclient-plugin.js and calls build_compare_intra to build the BioClient.Web command, and calls compared_intra to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class compare-intra. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string compare-intra The command to be executed.

Output parameters

Parameter Type Value Remark
command string compare-intra The command which was executed.
status string Success The success or failure status.
isMatch boolean An indicator if the comparison resulted in a match.
match BiometricMatches An indicator if the comparison resulted in a match.
score double The matching score.
result result The result of the verification operation.

compare-feature

This method compares the current person with its biometric pairs, against a person retrieved from the store. This method performs a local verification only, first retrieving from the store. This is particularly useful for cache comparisons, but can also be used for local verification against the store. This method does not modify the current person record. It retrieves from the store and performs the verification without overriding the current record.

Usage

Call the Javascript method bioClient.compare_feature(). This method is defined bioclient-plugin.js and calls build_compare_feature to build the BioClient.Web command, and calls compared_feature to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class compare-feature. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string compare-feature The command to be executed.
storeName string The unique name of the store adapter to use. If null, the current adapter is used.
name string The unique name of the identity to be retrieved and compared.
featureClass int? The class of features to retrieve from the store. If null, all features are selected.

Output parameters

Parameter Type Value Remark
command string compare-feature The command which was executed.
status string Success The success or failure status.
isMatch boolean An indicator if the comparison resulted in a match.
match BiometricMatches An indicator if the comparison resulted in a match.
score double The matching score.
result result The result of the verification operation.

References