Enrol an entity

Enrolling an entity means storing a person, their attributes, biometric objects, or properties in the biometric store.

Biostore offers these enrol services:

POST api/v3/Identity/Enrol

This method enrols or updates the person into Biostore, with their attributes, and enrols selected biometric objects, and saves or updates person properties.

Remarks

This method enrols or updates the person. If the person does not yet exist, they are stored. If the person already exists, their attributes are updated. The person is identified by their unique name. If incoming attributes are null, the existing attributes are not changed.

Input parameters

Parameter Type Remark
profile string The enrol profile to use. Multiple enrol 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.
id string The name of the person to store, enrol, or update.
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.
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 enrolled.

Output 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.
identity [ identity ] The stored, enrolled or updated person and their attributes.
props string A pipe-deliminated array of name-value pairs of person properties returned.
subtypes [ subtype ] An array of subtypes (samples and/or features) returned.

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

This method enrols or updates the person into Biostore, with their attributes, and enrols selected biometric objects, and saves or updates person properties. This method is identical to POST api/v3/Identity/Enrol, except that the person's name is passed in the URL, rather than in the body.

Input parameters

Parameter Type Remark
profile string The enrol profile to use. Multiple enrol 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.
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.
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 enrolled.

Output parameters

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

References