- Registration β Creates a liveness record for a user.
- Authentication β Compares a new liveness capture to an existing record.
Authentication Flow
Step 1: Create an Authentication Flow
Create an Easy Authentication Flow in the dashboard before starting any session. The flow gives you awidget_id, which you need to launch the widget.
Step 2: Registration (When No Liveness Record Exists)
If the user has no stored liveness record, open the authentication widget without areference_id.
Widget URL format:
- The user completes liveness capture.
- A new liveness record is created.
- A Reference ID (Auth ID) is generated.
- The session appears under the Customers tab.
reference_id from the webhook or from the dashboard. You need it for later authentication.
Step 3: Authentication (Re-Authentication)
To authenticate a user who already has a liveness record, open the widget with that userβsreference_id.
Widget URL format:
- The user completes liveness capture.
- The new capture is compared to the stored liveness record.
- An authentication result is returned.
- The session appears under the Authentications tab.
Status Values
| Status | Meaning |
|---|---|
| success | Liveness matched the existing record |
| failed | Liveness did not match |
| abandoned | User did not finish the flow |
Dashboard Logging
Customers Tab
Shows:- Registration sessions
- Liveness base records
- Reference ID
- Auth ID
- Session ID
- Timestamp
Authentications Tab
Shows:- All re-authentication attempts
- Reference ID
- Auth ID
- Session ID
- Status (success, failed, or abandoned)
- Timestamp
Linking EasyOnboard (Optional)
If you use EasyOnboard:- The EasyOnboard flow must include a liveness step.
- Link the EasyOnboard flow in Easy Authentication.
- Liveness from onboarding is then used as the registration record.
- A Reference ID is created and can be reused for authentication.
Integration Methods
You can open the widget by:- Redirect URL
- JavaScript WebView
- Embedded iframe
reference_id (Auth ID) in the request.
Important Rules
- No
reference_idmeans registration (new liveness record). - Valid
reference_idmeans authentication (match against existing record). - Invalid
reference_idcauses authentication to fail. - Authentication does not replace or overwrite the registration record.
- Registration and authentication sessions are logged in separate tabs.
Best Practices
- Store
reference_idsecurely in your system. - Use authentication only for high-risk or sensitive actions.
- Use Authentication Analysis to track success and failure patterns.