BioClient.Web Javascript reference
BioClient R2 did use a simplified version of the BioClient Javascript plugin, which is documented in this section.
When using this version with the BioClient R3 service, adjustments may be required to build parameters and response content.
Methods
bc_capture_feature
Captures a sample using the current sensor, and extracts a feature from the sample, using the current engine.
| Parameter |
Value |
Remark |
| command |
capture-feature |
The command to be executed. |
| type |
e.g. 'Fingerprint' |
The biometric type to be captured. |
| subtype |
e.g. 'LeftThumb', 'Any' |
The biometric subtype to be captured. |
| featureClass |
e.g. 'BioKeyVST' |
The feature class of the feature to be extracted. |
| featureOptions |
- |
The engine-specific options to be used when extracting the feature. |
Output parameters:
| Parameter |
Value |
Remark |
| standard |
Standard result params |
Standard result parameters as defined below. |
| feature |
A feature object |
Properties of the captured and extracted feature |
bc_verify_feature
Verifies features in the current record against the current store.
| Parameter |
Value |
Remark |
| command |
verify-feature |
The command to be executed. |
| featureClass |
e.g. 'BioKeyVST' |
The feature class to be used for verification. |
Output parameters:
| Parameter |
Value |
Remark |
| standard |
Standard result params |
Standard result parameters as defined below. |
| result |
A result object |
The verification result |
| person |
A person object |
Properties of the returned person |
| samples |
An array of sample objects |
Properties of returned samples |
| features |
An array of feature objects |
Properties of returned features |
bc_clear_current
Clears the current record
| Parameter |
Value |
Remark |
| command |
clear-current |
The command to be executed. |
Output parameters:
| Parameter |
Value |
Remark |
| standard |
Standard result params |
Standard result parameters as defined below. |
bc_select_adapter
Select a sensor, engine, store, or cache
| Parameter |
Value |
Remark |
| command |
select-adapter |
The command to be executed. |
| type |
e.g. 'Store' |
The type of adapter to be selected. |
| unique |
e.g. 'Amaqele.Biostore2.250' |
The unique name of the adapter to be selected. |
Output parameters:
| Parameter |
Value |
Remark |
| standard |
Standard result params |
Standard result parameters as defined below. |
| type |
e.g. 'Store' |
The type of adapter selected. |
| unique |
e.g. 'Amaqele.Biostore2.250' |
The unique name of the adapter selected. |
Standard output parameters
| Parameter |
Value |
Remark |
| command |
capture-feature |
The command being executed. |
| status |
Success, Warning, Error |
The result status, indicading success, warning, or error. |
| message |
[Any message] |
An error or warning message |
Sample and feature objects
| Parameter |
Value |
Remark |
| type |
e.g. 'Fingerprint' |
The biometric type of the sample or feature. |
| subtype |
e.g. 'LeftThumb', 'Any' |
The biometric subtype of the sample or feature. |
| classNumber |
e.g. 711 |
The class of the sample or feature, as an integer. |
| biometricStatus |
e.g. 'Normal' |
The biometric status of the sample or feature. |
| scale |
e.g. 500 |
The scale or resolution of the sample or feature as captured. |
| created |
e.g. '2019-01-01 12:01' |
The date/time when the the sample or feature was captured. |
| guid |
A guid |
A guid assigned to the sample or feature, allowing association between samples and features. |
| quality |
e.g. 0.85 |
The quality rating of the sample or feature as captured. |
Person objects
| Parameter |
Value |
Remark |
| name |
e.g. 'Person-14' |
The biometric name of the person. |
| created |
e.g. 'Person-14' |
The date/time when the person was first enrolled. |
| status |
e.g. 'Approved' |
The biometric status of the person. |
| substatus |
e.g. 2 |
The biometric substatus of the person. |
| group |
e.g. 1 |
The enrollment group of the person. |
| subgroup |
e.g. 2 |
The enrollment subgroup of the person. |
Verification result objects
| Parameter |
Value |
Remark |
| match |
e.g. true |
Indicator if the verification resulted in a match. |
| score |
e.g. 0.995 |
The matching score of the verififcatiom. |
Javascript files
| Filename |
Remark |
| bioclient.js |
The entry methods for all biometric operations for web pages. |
| bioclient-capitec.js |
Capitec Connect specific extensions. |
| bioclient-net-razor.js |
Application-specific build and result methods, called by bioclient.js |