Main Workflows¶
Most common use cases are:
- enroll users: by providing a selfie and some user data like the
acs_id(access control system id) - manage an event: create an event at a facility and add attendees that were previously enrolled.
- manage members: create, retrieve, or remove members, which are enrolled subscribers with continuous access through all tenant terminals.
Below the typical workflows for these use cases are described.
Enroll users¶
User enrollment (also known as user registration), can be done one by one, by providing a base64 selfie and the user's identification data (acs_id at least).
The acs_id is the access control system id in the customer's system. Our system's access points will emit access granted using this acs_id.
A user_id will be returned, necessary for later operations (like adding an attendee to an event), and a biometric credential will be issued but not distributed yet. This credential can be reused during the whole user’s lifecycle and will be distributed to authentication terminals whenever necessary if the user is added as attendee to events.
Also check API docs:
Manage an event and add attendees¶
In order to propagate enrolled users’s credentials to authentication terminals an event must be created at a facility for a specific time range, and the desired enrolled users must be added as attendees (providing the user_id) to the event.
The basic workflow requires creating the event which will return the event_id, and then adding attendees one by one.
Also check API docs:
Manage Members¶
Members are enrolled subscribers with continuous access across all tenant terminals. Unlike attendees, whose access is limited to specific events, members have persistent access until they are removed.
The basic workflow requires creating a member, which will issue a credential stored in the Members DB. This credential is later synchronized with all access points, ensuring continuous access. Members can also be removed, which revokes their credentials from all access points.
Also check API docs:
