Common input and output parameters

BioClient.Web verbs us common input and output parameters for processing a person or identity.

person

The person structure describes a person and their attributes.

Parameter	Type	Value	Remark
id	long		The ID of the person. This is the ID internal to the store. Not all stores use IDs.
name	string		The unique name of the identity.
created	DateTime		The date/time when the person was created and first stored.
modified	DateTime		The date/time when the person was modified and last updated.
status	PersonStatus		The status attribute of the person. If None, the current status is not changed.
substatus	int?		The substatus attribute of the person. If null, the current substatus is not changed.
group	int?		The group attribute of the person. If null, the current group is not changed.
subgroup	int?		The subgroup attribute of the person. If null, the current subgroup is not changed.

properties

The properties structure describes a person property. Properties are mostly used in arrays of properties. Stores may or may not support person properties.

Parameter	Type	Value	Remark
name	string		The name of the property.
value	string		The value of the property.

subtype

The subtype structure describes a biometric set or subtype. Subtypes are mostly used in arrays of subtypes.

Parameter	Type	Value	Remark
type	BiometricType		The biometric type of the biometric set.
subtype	BiometricSubtype		The biometric subtype of the biometric set.
status	BiometricSubtypeStatus		The biometric status of the biometric set.
created	DateTime		The date/time when the biometric set was created.
modified	DateTime		The date/time when the biometric set was modified and last updated.

feature

The feature structure describes a biometric feature. Features are mostly used in arrays of features.

Parameter	Type	Value	Remark
type	BiometricType		The biometric type of the biometric object.
subtype	BiometricSubtype		The biometric subtype of the biometric object.
class	FeatureClass		The biometric class of the biometric object.
classNumber	int		The biometric class number of the biometric object.
biometricStatus	BiometricSubtypeStatus		The biometric status of the biometric object.
scale	double		The scale of the biometric object.
created	DateTime		The date/time when the biometric object was created.
guid	GUID		The GUID of the biometric object. Not all stores use GUIDs.
quality	double		The quality rating of the biometric object.
length	int		The length of the biometric data of the object.
data	byte[]		The biometric data of the object.

sample

The sample structure describes a biometric sample. Samples are mostly used in arrays of samples.

Parameter	Type	Value	Remark
type	BiometricType		The biometric type of the biometric object.
subtype	BiometricSubtype		The biometric subtype of the biometric object.
class	SampleClass		The biometric class of the biometric object.
classNumber	int		The biometric class number of the biometric object.
biometricStatus	BiometricSubtypeStatus		The biometric status of the biometric object.
scale	double		The scale of the biometric object.
created	DateTime		The date/time when the biometric object was created.
guid	GUID		The GUID of the biometric object. Not all stores use GUIDs.
quality	double		The quality rating of the biometric object.
length	int		The length of the biometric data of the object.
data	byte[]		The biometric data of the object.

result

The result structure describes a biometric result of a verification operation.

Parameter	Type	Value	Remark
isMatch	bool		An indicator if the verification resulted in a match.
match	BiometricMatches		An enumeration indicating the verification match.
score	double		The normalised matching score, expressed as a percentage probability.
count	int		The number of subresults contained in the result.
base	int		The number of persons covered in an identifcation search.
searched	int		The number of persons actually searched in an identifcation search.
compares	int		The number of comparisons performed.
matchedIdentity	int		The name of the first matched identity.
matchedGallery	int		The matched gallery subtypes.
matchedSample	int		The matched sample subtypes.

The BiometricMatches enumeration can contain several values describing the verification or identification result.

Name	Value	Remark
None	0	Not a valid result.
NotComparable	1	A comparison could not be performed.
NoMatch	2	No match.
AmberMatch	3	AMBER match between the threshold and upper threshold (identifications only)
Match	4	Match above the upper threshold, if any.