Single Identity Operations

List of identities

Upon entering a service instance, the list of registered identities will be displayed. All identities will be listed by their user ID, ascending by default. The name, email, and portrait of the identity are also displayed. There are up to 10 identities displayed on each page, and you can switch between different pages by clicking the pagination button at the bottom.

Identities can be quickly filtered by user ID, first name, last name, or email address. The search function is available in forward-matching, so type the keyword from its beginning. The total number at the bottom automatically updates and reflects the number of identities after filtering conditions.

Type is another possible filter. Multiple types can be selected at the same time to filter some specific identity types.

Add an identity

Add a single identity by clicking Add Identity at the top of the identity list.

On the identity entry page, you can upload a face photo and enter some identity information of the identity. To complete adding, click Add. To cancel adding, click Cancel.

Portrait

A portrait upload must use the facial recognition function based on registered identities. The upload is optional, but if no portrait is ever uploaded, the identity cannot be used in facial recognition features, like solutions or OpenAPI.

Identity Manager also offers two other options related to portraits, Do not store the image file after upload and Do not perform a quality check.

Pin Code

A Pin Code is a customizable set of numbers to separate similar faces in the same instance. It is required if you upload the portrait. If a similar portrait is uploaded with the same Pin Code, you will get an error message and get rejected. You can try changing the Pin Code or confirm whether the identity is duplicated.

Check the table below for the details of the Pin Code.

File storage

Selecting Do not store the image file after upload will delete the original portrait file after the upload. This will keep the facial recognition features available but not store the file to address the need for privacy. Since the portrait file is not stored, you will only see an icon representing that portrait is selected to be not stored after its last upload.

Quality check

Identity Manager offers a quality check option to filter out low-quality portraits to achieve better accuracy in facial recognition. Due to the highly-developed server-side facial recognition model, the quality check of registration is less critical than before. You can turn it off if you think the systemical checking standard is too strict for the registration portraits.

For requirements, details of the portrait, and the quality check, please refer to the Portrait sector.

Identity information

Identity Manager allows storing detailed information about identities. A User ID is the primary key to identity and must be uniquely set. The email field can be null but should be unique if set. All other information fields are optional, but distinguishing different identities will be more convenient if provided. The Valid from and Valid to field value will be applied to some solution services that used Identity Manager as the identity base.

Below is a table of fixed fields of an identity.

* The regular expression of email.

/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/

Additional information

If the template has been configured for this service instance, custom fields will be displayed according to their creation order on the Identity adding page.

Suppose we have the following custom fields.

In addition to the Basic Information, there will be an "Other Information" area on the page. In this area, all custom fields are displayed with the controls corresponding to their types. All the entries are optional unless any fields are set not nullable. If the values are given, the minimum and the maximum validation will be applied. Refer to the Template section for more details.

Check the details of an identity

After the identity is created, click Edit on the right side of the identity you want to proceed with, and the identity detail page will be displayed.

On the identity detail page, there is a QR code link used for Lobby Base APP. Click the QR Code button to get the QR Code image. For more details, refer to the guides for Lobby Base APP. Copy or download the QR Code image for guest registration.

Update the User ID of an identity

The User ID is usually used as the resource indicator of an identity. It can be updated individually by Clicking the Change button next to the User ID.

Enter the new User ID, and click Change to finish updating the User ID. Please notice that the new User ID should also follow the regular expression and uniqueness rule of User ID.

Update an identity

On the identity detail page, you can type in any information you want to update and re-upload a photo to update the portrait.

You can change or remove the portrait by clicking the portrait area.

To delete the portrait, click Delete photo and Agree to delete it.

📘

About photo deletion

The behavior of photo deletion is different from selecting Do not store the image file after upload.

Deleting the photo will disable the facial recognition capability of this identity, while selecting Do not store the image file after upload will dispose the image file but still ensures that facial recognition works for this identity.

Select the corresponding fields to update the portrait, options, and Pin Code, and click Update.

To update fixed filed values, fill in the changed values and click Update to finish the update.

Delete an identity

On the identity detail page, click Delete identity at the bottom to delete the identity.

Once the identity is deleted, it cannot be used in facial recognition or recovered.

Delete multiple identities

On the identity list page, multiple identities can be deleted simultaneously.
Check all the identities you want to delete, click the trash can icon, and click Agree to finish the deletion process.