Identify an entity

Identifying an entity means establishing who a person is on the basis of their biometric objects. This is achieved by comparing a current biometric object with stored biometric objects of all or selected persons in Biostore, and determining with whom the biometric features match.

Identification is performed in two different ways:

  • An identification search compares a current biometric object of an unknown person with stored biometric objects of known persons, with the objective of determining the identity of the person.
  • A de-duplication search compares stored biometric objects of a known person with stored biometric objects of other known persons, with the objective of determining if the same person is enrolled with multiple different identities.

Biostore offers these enrol services:

POST api/v3/Identity/Identify

This method performs an identification search in Biostore, and returns any hits which may have been found.

Remarks

Input parameters

Parameter Type Remark
profile string The identify profile to use. Multiple identify profiles can be configured for different use cases.
attn string The name of the attending user.
ref string A unique transaction reference, to identify transactions in the audit trail or in reports.
location string A location where this transaction originates. This is an application-defined value.
seg string The name of the identification segment to search. This allows segmenting the database to avoid searching the entire database.
name string The name of the person to de-duplicate.
status PersonStatus? The status attribute of the person. If null, 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.
process-mode BiometricProcessModes? The process mode. Determines which gallery features are used for identification.
process-sample-class int? The type of gallery samples to be used for identification. Not used.
process-feature-class int? The type of gallery features to be used for identification.
retrieve-mode BiometricProcessModes? The retrieve mode. Determines which gallery features are returned after identification.
retrieve-sample-class int? The type of gallery samples to be returned after identification. Not used.
retrieve-feature-class int? The type of gallery features to be returned after identification.
props string A pipe-deliminated array of name-value pairs of person properties.
subtypes [ subtype ] An array of subtypes (samples and/or features) to be used as samples for identification.

Output parameters

Parameter Type Remark
result int The result code. For identification, 0 indicates no-hit, 1 indicates hit, and > 1000 indicates failure.
msg string An informational success or failure message.
name string The name of the person identified.
http int The HTTP result code.
ref string The unique transaction reference, which was passed in or internally generated.
identity [ identity ] The stored, enrolled or updated person and their attributes.
subtypes [ subtype ] An array of subtypes (samples and/or features) 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.
comp [ comparison ] An array of comparisons performed.

POST api/v3/Identity/Identify/{name}

This method performs an identification search in Biostore, and returns any hits which may have been found. This method is identical to POST api/v3/Identity/Identify, except that the person's name is passed in the URL, rather than in the body.

Input parameters

Parameter Type Remark
profile string The identify profile to use. Multiple identify profiles can be configured for different use cases.
attn string The name of the attending user.
ref string A unique transaction reference, to identify transactions in the audit trail or in reports.
location string A location where this transaction originates. This is an application-defined value.
seg string The name of the identification segment to search. This allows segmenting the database to avoid searching the entire database.
status PersonStatus? The status attribute of the person. If null, 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.
process-mode BiometricProcessModes? The process mode. Determines which gallery features are used for identification.
process-sample-class int? The type of gallery samples to be used for identification. Not used.
process-feature-class int? The type of gallery features to be used for identification.
retrieve-mode BiometricProcessModes? The retrieve mode. Determines which gallery features are returned after identification.
retrieve-sample-class int? The type of gallery samples to be returned after identification. Not used.
retrieve-feature-class int? The type of gallery features to be returned after identification.
props string A pipe-deliminated array of name-value pairs of person properties.
subtypes [ subtype ] An array of subtypes (samples and/or features) to be used as samples for identification.

Output parameters

Output parameters are identical to POST api/v3/Identity/Identify.

References