Common input and output parameters

Biostore services use common input and output parameters for processing a person or identity.

identity

The identity structure describes a person and their attributes.

Parameter	Type	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.
subtypes	[ subtype ]	An array of subtypes (samples and/or features) returned.

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	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	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.
features	[ feature ]	An array of enrolled features.
samples	[ sample ]	An array of enrolled samples.

feature

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

Parameter	Type	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.
class-number	int	The biometric class number of the biometric object.
scale	double	The scale of the biometric object.
created	DateTime	The date/time when the biometric object was created.
quality	double	The quality rating of the biometric object.
addl	string	Additional data which may be relevant to this biometric 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	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.
class-number	int	The biometric class number of the biometric object.
scale	double	The scale of the biometric object.
created	DateTime	The date/time when the biometric object was created.
quality	double	The quality rating of the biometric object.
addl	string	Additional data which may be relevant to this biometric object.
data	byte[]	The biometric data of the object.

comparison

The comparison structure describes the result of a single verification operation.

Parameter	Type	Remark
match	bool	An indicator if the single verification resulted in a match.
tri-match	BiometricMatches	An indicator if the single verification resulted in a rri-state match.
type	BiometricType	The biometric type of the matched biometric features.
sample-subtype	BiometricSubtype	The biometric subtype of the sample (provided) biometric object.
gallery-subtype	BiometricSubtype	The biometric subtype of the gallery (stored) biometric object.
sample-class	int	The biometric class number of the sample (provided) biometric object.
gallery-class	int	The biometric class number of the gallery (stored) biometric object.
sample-name	string	The name of the person of the sample (provided) biometric object. Often empty.
gallery-name	string	The name of the person of the gallery (stored) biometric object.
score	double	The normalised matching score, expressed as a percentage probability.
native	double	The native matching score, expressed as an engine-specific value.
data	string	Additional matching data, as provided by the engine.

result

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

Parameter	Type	Value	Remark
match	bool		An indicator if the verification resulted in a match.
score	double		The normalised matching score, expressed as a percentage probability.

Output parameters

The table below shows all output parameters used in Biostore services. Different services use different subsets of these parameters.

Parameter	Type	Remark
result	int	The result code. For enrolment, 0 indicates success, > 1000 indicates failure.
msg	string	An informational success or failure message.
name	string	The name of the person stored, enroled, or updated.
http	int	The HTTP result code.
ref	string	The unique transaction reference, which was passed in or internally generated.
props	string	A pipe-deliminated array of name-value pairs of person properties returned.
base	int	The number of persons covered in a retrieval, update, or identification search.
searched	int	The number of persons actually searched in an identification search.
names	string[]	The names of persons retrieved, or found during identification searches.
identity	[ identity ]	The stored, enrolled or updated person and their attributes.
subtypes	[ subtype ]	An array of subtypes (samples and/or features) returned.
comp	[ comparison ]	An array of comparisons performed.
data	string	A JSON string, depending on the biometric request.
values	string[]	A set of values, depending on the biometric request.